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.

Sign up for GitHub

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

Jump to bottom

OBIS API v3 docs suggestions #59

Open
7yl4r opened this issue Jul 20, 2022 · 0 comments
Open

OBIS API v3 docs suggestions #59

7yl4r opened this issue Jul 20, 2022 · 0 comments

Comments

@7yl4r
Copy link
Contributor

7yl4r commented Jul 20, 2022

I am continuing an ongoing conversation with @pieterprovoost and @ayushanand18 here. To summarize discussion so far:

  • The OBIS API documentation is comprised of:
    • the swagger endpoint api.obis.org
    • robis & pybobis docs
    • this manual

I have the following suggestions:

  1. pagination of results from the API should probably be explained a bit.
  2. a short note on how the usage of hasextensions might exclude a lot of results might be helpful.

I will suggest changes to address these once I have the extant swagger file(s).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@7yl4r