search

OpServ-Monitoring / opserv-backend

The backend repository for the opserv monitoring software
GNU General Public License v3.0
3 stars 0 forks source link

Determine REST-API Endpoints and data structures #1

Closed Laberbear closed 7 years ago

Laberbear commented 8 years ago

While these will most likely change in the future, a basic REST-API structure should be atleast documented.

Otherwise Frontend development could be stalled because of this.

EndzeitBegins commented 8 years ago

I'm working on a more detailed documentation right now.

EndzeitBegins commented 7 years ago

Changing any api url from /api to /apiref now redirects to the related (not yet existing) documentation entry on GitHub Pages.

I'll set up a documentation with Jekyll as soon as I've got the time.

EndzeitBegins commented 7 years ago

Jekyll is set up now, it's configuration however will most likely change in the future.

All documents including the rest api reference will be availabe under opserv.org/docs but most endpoints are not fully documented yet.

EndzeitBegins commented 7 years ago

All api endpoints scheduled for the initial release are implemented and listed in the documentation.

We're working on the website and wiki right now. The individual articles in the documentation need to be enriched with more detailed information.

However, as maintaining the documentation is a continous process and frontend development may use the supplied list, this issue can be closed.