[doc] Use Apiary for documenting the Management Interface API

telefonicaid / fiware-cygnus

A connector in charge of persisting context data sources into other third-party databases and storage systems, creating a historical view of the context

https://fiware-cygnus.rtfd.io/

GNU Affero General Public License v3.0

64 stars 105 forks source link

[doc] Use Apiary for documenting the Management Interface API #892

Closed frbattid closed 8 years ago

frbattid commented 8 years ago

https://apiary.io/

Actual API file: https://github.com/telefonicaid/fiware-cygnus/blob/develop/cygnus-ngsi/doc/installation_and_administration_guide/management_interface.md

pcoello25 commented 8 years ago

First version is now online.

http://telefonicaid.github.io/fiware-cygnus/api/

I'm testing differents ways of write the information. @frbattid suggested to divide the doc in 4 categories:

Version API
Grouping Rules API
Subscriptions API
Admin API

Changes are being implemented :)

pcoello25 commented 8 years ago

Implemented in https://github.com/telefonicaid/fiware-cygnus/pull/952 (Part 1 -> gh-pages branch) Missing changes in develop branch: Add source files (.apib)

pcoello25 commented 8 years ago

Implemented in https://github.com/telefonicaid/fiware-cygnus/pull/962

pcoello25 commented 8 years ago

Implemented in https://github.com/telefonicaid/fiware-cygnus/pull/989