Skip to content

orienteering-oss/eventor-api-openapi-spec-json

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

31 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

eventor-api-openapi-spec-json

Travis build status

⚠️ NB: this is an unofficial JSON version of the API. See orienteering-oss/eventor-api-openapi-spec for an unofficial XML version (that is closer / equal to the official version of the API).

JSON version of the OpenAPI spec / Swagger for the Eventor API: openapi.yml.

You can browse the Swagger UI for this spec, but it will not work because of CORS. You can use it to browse and create cURL commands that you can execute in your own terminal. Or you could import the OpenAPI spec into Postman and make your calls from there.

What is Eventor? Eventor is the event system for orienteering races in different countries, so if you want to arrange an orienteering event, you will probably register it in your local Eventor system to make other people see it and for them to register to your event (and where you can upload results after the event is done).

Usage of the Eventor API

To use the Eventor API, you need an API key.

The different Eventor websites are:

Add /api/documentation to either of the URLs to get the documentation for that particular Eventor website (the documentation is also included in the OpenAPI specification).

How did I create this

I have previously manually assembled an OpenAPI spec for the Eventor API with the XML content in mind. I have also previously converted the IOF v3 XSD into a JSON Schema with Jackson (see repo iof-orienteering-data-schemas). So I followed a guide on how to convert JSON schema to OpenAPI spec, using the openapi-contrib/json-schema-to-openapi-schema JavaScript library. This gave me a new file containing the IOF v3 JSON Schema as an OpenAPI spec. Then I copied this into the components section of the existing OpenAPI spec, and started using the correct $refs for request bodys and responses.

See also