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

Better documentation #11

Closed
jschaeff opened this issue Nov 23, 2022 · 2 comments
Closed

Better documentation #11

jschaeff opened this issue Nov 23, 2022 · 2 comments
Assignees

Comments

@jschaeff
Copy link
Collaborator

No description provided.

@jschaeff
Copy link
Collaborator Author

I updated the openAPI specifications:

  • review of the descriptions
  • change of the server / URL
  • adding a _nodes method to get list of nodes (needs to be implemented)
  • set datacenter parameter as an array, which enum values are among the /_nodes result (need to be finished)

@vpet98 could you:

  • look at the best way to generate the documentation of the webservice directly ? Like for exemple with https://pypi.org/project/openapi-ui-bundles/
  • finish the work on the API description by adding default values, specifying when multiple values are possible (look at the openapi spec)
  • implement _nodes method
  • rename health to _health
  • enable '*' wildcard on Net/Sta/Loc/Cha selection parametes
  • datacenters : set '*' as default value or put in description that empty means all datacenters.

@vpet98
Copy link
Contributor

vpet98 commented Jan 19, 2023

The way it is implemented, leaving for example station field empty means all stations, like in fdsn webservice. Shall I change this so that leaving station empty means a default station e.g. CIEL? The '*' wildcards are enabled.

Also, shall I add a format parameter at /dataselect/stat method as you added at specs?

@vpet98 vpet98 closed this as completed Feb 4, 2023
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

No branches or pull requests

2 participants