Create OpenAPI specification for FIWARE-NGSI v2

[ccsr]

Please create an OpenAPI specification for FIWARE-NGSI v2. Same as issue https://github.com/Fiware/specifications/issues/1

[fgalan]

Looking to FIWARE Developers Guidelines (https://forge.fiware.org/plugins/mediawiki/wiki/fiware/index.php/Developer_Guidelines) using Apiary as API specification format is mandatory:

Should you want to benefit from FIWARE automatic documentation generation systems you MUST use markdown for documentation and Apiary Blue Print for API specification.

Is the FIWARE Developers Guideline obsolete? Has been OpenAPI discussed as alternative to Apiary in some of the FIWARE governance bodies (TSC, etc.)?

Probably I'm missing something :) @jmcanterafonseca could you provide feedback on this?

[jmcanterafonseca]

well, If someone wants to do that I'm fine but now our main target is ETSI ISG CIM. It can be found a very preliminary version of the Swagger spec at https://github.com/jmcanterafonseca/ETSI_CIM_Swagger

perhaps someone can modify it to match NGSIv2 if there is interest.

[chicco785]

not sure it's 100% complete or correct, but I have a swagger spec of NGSIv2: https://swaggerhub.com/apis/chicco785/ngsi/v2 we use it to generate python and nodejs/javascript clients

[chicco785]

btw, in apiary now you can create api specs from swagger format. also this can be of help: https://github.com/LucyBot-Inc/api-spec-converter

[jason-fox]

@fgalan - The Developer Guidelines you quoted continue:

A link to the API Reference Documentation. Apiary Blueprints SHOULD be used. We recommend the usage of Apiary if you want to benefit from tools (to be released soon) that will allow to automatically generate FIWARE specifications.

I therefore assume that the official Open API specification is now the auto-generated one at:

• https://github.com/Fiware/specifications

If this is the correct, does this mean that this issue now obsolete?