-
Notifications
You must be signed in to change notification settings - Fork 10
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open API spec files #1
Comments
They are in the gh-pages branch (https://github.com/Fiware/specifications/tree/gh-pages) which maps with the automatic web server provided by github.io, e.g: http://fiware.github.io/specifications/ngsiv2/stable/ You are right: the README.md at master branch should explain that. |
Thank you for answer and more information. I looked at the sources and I only find API Blueprint references:
I was expecting to find spec files in Open API format, https://github.com/OAI/OpenAPI-Specification |
A simple question. Where is the source of this content: http://fiware.github.io/specifications/ngsiv2/stable/ ? |
Sources are here in .apib format: https://github.com/telefonicaid/fiware-orion/tree/master/doc/apiary/v2 However, the stable documents shoudn't be touched, as they correspond to "frozen" RC versions of the NGSIv2 API. If you plan to contribute focus on the following ones:
Typically, the second one (cookbook) was aimed at examples. However, it has not been touched (last time 2 years ago ;). Thus, probably it is obsolete and it would be a good contribution to review it, update it and expand it. Maybe @jmcanterafonseca have some feedback regarding this. Regarding Python3, note that .apib are agnostic with regards with programming language. Thus, I'm not sure that is a good place for such examples. |
We are going to migrate progressively to the Swagger Open API Format with the help of tools like https://apimatic.io/transformer Open API Specifications will be hosted by this repository We will start with NGSIv2 specification and IDAS specification. Then owner of other GEs will be asked to perform their migration |
You mean the HTML render of the specification? Or the source (i.e. .apib equivalent in the swagger world)? |
First version of the NGSIv2 specification in Open API Format can be found at http://fiware.github.io/specifications/OpenAPI/ngsiv2/ngsiv2-openapi.json Please note that further tweakings might be needed and contributions from the Community at that respect are welcome |
How do you ensure that the ngsiv2-openspai.json keeps synced with current .apib? The risk of forking (i.e. modifications in some place not applied to the other) is high... Source should be only one, the others be automatic derivations. |
@fgalan there is no longer rendering of Swagger specs as Swagger provides a Swagger UI viewer. We will deploy an instance of the viewer on the FIWARE Lab so anyone can easily browse the Swagger specs. Idea is to have swagger.lab.fiware.org for this purpose. |
Following on from @jmcanterafonseca - a forwarding to the Swagger UI viewer at https://swagger.lab.fiware.org/ is now in place - http://fiware.github.io/specifications/OpenAPI/ngsiv2 (without the JSON file name) will display the latest raw Swagger file from I have updated the README on both |
I have one doubt: Looking to http://fiware.github.io/specifications/OpenAPI/ngsiv2 how do you ensure that a change in https://github.com/telefonicaid/fiware-orion/blob/master/doc/apiary/v2/fiware-ngsiv2-reference.apib (the source of the NGSIv2 specification) is propagated to that web page? For instance, if a new method is defined or a new parameter added to an existing method. (In fact, is the same concern expressed at #1 (comment) but reformulated in a diferent way :) |
Currently a change in This means that:
I'm not entirely sure if it is necessary to maintain the |
@jason-fox if we properly configure this repo gh-pages can be removed @caa06d9c could you take care of reconfiguring and testing everything? |
ok |
The repository is logical place to look for Open API spec (yaml) files for all the FIWARE standardized APIs. Yet there's currently none. If the files are not collected here, then at least add to readme where the files are.
The text was updated successfully, but these errors were encountered: