Skip to content
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

Use swagger and openapi files to automatically check query fields #14

Closed
3 tasks
DDorch opened this issue Aug 30, 2022 · 0 comments · Fixed by #22
Closed
3 tasks

Use swagger and openapi files to automatically check query fields #14

DDorch opened this issue Aug 30, 2022 · 0 comments · Fixed by #22
Milestone

Comments

@DDorch
Copy link
Collaborator

DDorch commented Aug 30, 2022

Each API is described by a swagger file (e.g.: https://hubeau.eaufrance.fr/api/vbeta/qualite_eau_potable/api-docs). The API "ecoulement" is described by an OpenAPI file (https://hubeau.eaufrance.fr/api/vbeta/ecoulement/api-docs) and this last has currently some mistakes (BRGM/hubeau#127).

It's possible by reading these files to automate the check of the fields used in a query accelerating the implementation of new API and keep synchronised evolution of the APIs without the need to update the package.

TODO:

  • add swagger/openapi URL of each APIs in the package configuration
  • read and parse swagger and openapi file
  • extract field list for each already implemented endpoints
@DDorch DDorch added this to the v0.4.0 milestone Sep 11, 2022
DDorch pushed a commit that referenced this issue Feb 13, 2023
DDorch pushed a commit that referenced this issue Feb 13, 2023
DDorch pushed a commit that referenced this issue Feb 13, 2023
- we don't fill the "fields" anymore!

Refs #14
DDorch pushed a commit that referenced this issue Feb 14, 2023
See BRGM/hubeau#127 for the related bug in Hubeau

Refs #14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant