{"openapi":"3.1.0","info":{"title":"Fjelia race library","summary":"Open calendar of running, trail, cycling, brevet, triathlon races and hiking events.","description":"Free and keyless, 60 requests per minute per IP. Every record names its source; attribute accordingly. Organisers can submit or correct their events.","license":{"name":"Facts with attribution; see /v1/sources"},"version":"0.1.0"},"paths":{"/v1/search":{"get":{"tags":["search"],"summary":"Typeahead search by name or place","operationId":"search_v1_search_get","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":80,"title":"Q"}},{"name":"sport","in":"query","required":false,"schema":{"anyOf":[{"enum":["run","trail","road_bike","gravel","brevet","mtb","rtf","ctf","triathlon","swimrun","hike"],"type":"string"},{"type":"null"}],"title":"Sport"}},{"name":"near","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"lat,lon rounded to 0.1°","title":"Near"},"description":"lat,lon rounded to 0.1°"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":20,"minimum":1,"default":8,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/races":{"get":{"tags":["calendar"],"summary":"Filtered calendar of races (one row per distance)","operationId":"races_v1_races_get","parameters":[{"name":"sport","in":"query","required":false,"schema":{"anyOf":[{"enum":["run","trail","road_bike","gravel","brevet","mtb","rtf","ctf","triathlon","swimrun","hike"],"type":"string"},{"type":"null"}],"title":"Sport"}},{"name":"country","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^[A-Z]{2}$"},{"type":"null"}],"title":"Country"}},{"name":"region","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Region"}},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"From"}},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"To"}},{"name":"min_km","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Min Km"}},{"name":"max_km","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Max Km"}},{"name":"min_gain_m","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Min Gain M"}},{"name":"near","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Near"}},{"name":"radius_km","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":100,"title":"Radius Km"}},{"name":"has_course","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Has Course"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/stats":{"get":{"tags":["calendar"],"summary":"Counts for the upcoming calendar","operationId":"stats_v1_stats_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v1/places":{"get":{"tags":["search"],"summary":"Towns for the radius search (GeoNames, worldwide)","description":"Towns with a name that starts with q: names as typed first (the browser's list hides others), exact ones\nbefore longer ones, then by population.\nEach town under the spelling that matched (\"München\", \"Munich\"). Coordinates rounded to 0.1°.\nTown data: GeoNames (CC BY 4.0).","operationId":"places_v1_places_get","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":60,"title":"Q"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":20,"minimum":1,"default":8,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/calendar":{"get":{"tags":["calendar"],"summary":"Upcoming editions with a summary of their races","operationId":"calendar_v1_calendar_get","parameters":[{"name":"sport","in":"query","required":false,"schema":{"anyOf":[{"enum":["run","trail","road_bike","gravel","brevet","mtb","rtf","ctf","triathlon","swimrun","hike"],"type":"string"},{"type":"null"}],"title":"Sport"}},{"name":"category","in":"query","required":false,"schema":{"anyOf":[{"enum":["running","road-running","marathon","half-marathon","10k","ultra-run","trail","ultra-trail","cycling","road_bike","rtf","ctf","brevet","gravel","mtb","hiking","triathlon","swimrun"],"type":"string"},{"type":"null"}],"title":"Category"}},{"name":"region","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Region"}},{"name":"near","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"lat,lon rounded to 0.1°","title":"Near"},"description":"lat,lon rounded to 0.1°"},{"name":"radius_km","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":5,"default":50,"title":"Radius Km"}},{"name":"min_km","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Min Km"}},{"name":"max_km","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Max Km"}},{"name":"min_gain_m","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Min Gain M"}},{"name":"sort","in":"query","required":false,"schema":{"enum":["date","gain","distance","steep","new"],"type":"string","description":"steep: most climbing per km (running, trail and hiking courses of 10 km or more; over 200 m/km counts as a data error); new: recently added","default":"date","title":"Sort"},"description":"steep: most climbing per km (running, trail and hiking courses of 10 km or more; over 200 m/km counts as a data error); new: recently added"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":30,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/events/{event_id}":{"get":{"tags":["records"],"summary":"Event with its editions","operationId":"event_v1_events__event_id__get","parameters":[{"name":"event_id","in":"path","required":true,"schema":{"type":"string","title":"Event Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/editions/{edition_id}":{"get":{"tags":["records"],"summary":"Edition with its races","operationId":"edition_v1_editions__edition_id__get","parameters":[{"name":"edition_id","in":"path","required":true,"schema":{"type":"string","title":"Edition Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/races/{race_id}":{"get":{"tags":["records"],"summary":"One race (distance) with course summary","operationId":"race_v1_races__race_id__get","parameters":[{"name":"race_id","in":"path","required":true,"schema":{"type":"string","title":"Race Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/races/{race_id}/course.gpx":{"get":{"tags":["records"],"summary":"Course GPX (redirect to the organiser's file)","operationId":"course_v1_races__race_id__course_gpx_get","parameters":[{"name":"race_id","in":"path","required":true,"schema":{"type":"string","title":"Race Id"}}],"responses":{"302":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/sources":{"get":{"tags":["records"],"summary":"Sources and attribution","operationId":"sources_v1_sources_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v1/submissions":{"post":{"tags":["contribute"],"summary":"Submit a race; published after moderation under CC-BY-4.0","operationId":"submit_v1_submissions_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmissionIn"}}},"required":true},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/leads":{"post":{"tags":["contribute"],"summary":"Suggest races by their web addresses (up to 100); the facts are read from the organisers' pages","description":"Queues each address for moderation (fjelia-admin); once approved the extractor reads it and publishes\nonly what it finds on that page.","operationId":"leads_v1_leads_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeadsIn"}}},"required":true},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/corrections":{"post":{"tags":["contribute"],"summary":"Report a change or ask for removal","operationId":"correct_v1_corrections_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorrectionIn"}}},"required":true},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"CorrectionIn":{"properties":{"event_id":{"type":"string","maxLength":120,"title":"Event Id"},"message":{"type":"string","maxLength":2000,"minLength":5,"title":"Message"},"contact_email":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Contact Email"}},"type":"object","required":["event_id","message"],"title":"CorrectionIn"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"LeadsIn":{"properties":{"urls":{"items":{"type":"string","maxLength":2083,"minLength":1,"format":"uri"},"type":"array","maxItems":100,"minItems":1,"title":"Urls"},"contact_email":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Contact Email"}},"type":"object","required":["urls"],"title":"LeadsIn"},"RaceIn":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}],"title":"Name"},"distance_km":{"type":"number","maximum":5000.0,"exclusiveMinimum":0.0,"title":"Distance Km"},"elevation_gain_m":{"anyOf":[{"type":"integer","maximum":50000.0,"minimum":0.0},{"type":"null"}],"title":"Elevation Gain M"},"start_time":{"anyOf":[{"type":"string","pattern":"^\\d{2}:\\d{2}$"},{"type":"null"}],"title":"Start Time"}},"type":"object","required":["distance_km"],"title":"RaceIn"},"SubmissionIn":{"properties":{"name":{"type":"string","maxLength":200,"minLength":3,"title":"Name"},"sport":{"type":"string","enum":["run","trail","road_bike","gravel","brevet","mtb","rtf","ctf","triathlon","swimrun","hike"],"title":"Sport"},"country":{"type":"string","pattern":"^[A-Z]{2}$","title":"Country"},"place":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}],"title":"Place"},"date_start":{"type":"string","format":"date","title":"Date Start"},"date_end":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date End"},"website":{"anyOf":[{"type":"string","maxLength":2083,"minLength":1,"format":"uri"},{"type":"null"}],"title":"Website"},"registration_url":{"anyOf":[{"type":"string","maxLength":2083,"minLength":1,"format":"uri"},{"type":"null"}],"title":"Registration Url"},"races":{"items":{"$ref":"#/components/schemas/RaceIn"},"type":"array","maxItems":20,"minItems":1,"title":"Races"},"submitter_role":{"type":"string","enum":["organizer","athlete"],"title":"Submitter Role","default":"athlete"},"contact_email":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Contact Email"},"licence_accepted":{"type":"boolean","const":true,"title":"Licence Accepted"}},"type":"object","required":["name","sport","country","date_start","races","licence_accepted"],"title":"SubmissionIn"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}