riigikogu-kantselei / api

Public issue tracker for Open data API at the Chancellery of the Riigikogu
https://api.riigikogu.ee/
GNU General Public License v3.0
10 stars 0 forks source link

API documentation #2

Closed ottomattas closed 6 years ago

ottomattas commented 7 years ago

There needs to be a current, usable and attractive documentation!

At the moment, we have a plan where documentation will be a mix of automatic and handwritten text (probably) using the following for tools:

We have taken Spotify's WEB-API as an example for us.

ottomattas commented 7 years ago

Initial discussion in okestonia/opendata-issue-tracker#60

moll commented 6 years ago

I noticed there's something generated by Swagger at https://aavik.riigikogu.ee/swagger-ui.html, but it too doesn't include collective-addresses. Is it fresh? Is it supposed to be the canonical documentation?

janesmae commented 6 years ago

The current documentation is provided via the link on the website: https://aavik.riigikogu.ee/ Collective-addresses section can be found under "documents".