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

Provide documented examples of queries / the patterns for them #54

Closed
obo20 opened this issue Aug 20, 2020 · 0 comments · Fixed by #55
Closed

Provide documented examples of queries / the patterns for them #54

obo20 opened this issue Aug 20, 2020 · 0 comments · Fixed by #55
Labels
dif/trivial Can be confidently tackled by newcomers good first issue Good issue for new contributors help wanted Seeking public contribution on this issue kind/maintenance Work required to avoid breaking changes or harm to project's status quo P1 High: Likely tackled by core team if no one steps up status/ready Ready to be worked topic/docs Improvements or additions to documentation

Comments

@obo20
Copy link

obo20 commented Aug 20, 2020

We need to let implementers of this spec know how to format their queries, specifically when dealing with things like arrays.

As threads like this show: https://stackoverflow.com/questions/11944410/passing-array-in-get-for-a-rest-call

There are many many ways you can do arrays for rest queries. @lidel has told me we've opted to go with the status=pinning,pinned formatting which I think makes sense. However we should definitely document this outside of the YAML for those who are reading the spec from their browser.
@lidel lidel added dif/trivial Can be confidently tackled by newcomers good first issue Good issue for new contributors help wanted Seeking public contribution on this issue kind/maintenance Work required to avoid breaking changes or harm to project's status quo P1 High: Likely tackled by core team if no one steps up status/ready Ready to be worked topic/docs Improvements or additions to documentation labels Aug 21, 2020
lidel added a commit that referenced this issue Aug 26, 2020
@lidel
docs: query params examples
e70f40c 
closes #54
@lidel lidel mentioned this issue Aug 26, 2020
Merged
@lidel lidel closed this as completed in #55 Aug 26, 2020
lidel added a commit that referenced this issue Aug 26, 2020
@lidel
docs: query params examples (#55)
434132e 
closes #54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
dif/trivial Can be confidently tackled by newcomers good first issue Good issue for new contributors help wanted Seeking public contribution on this issue kind/maintenance Work required to avoid breaking changes or harm to project's status quo P1 High: Likely tackled by core team if no one steps up status/ready Ready to be worked topic/docs Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: query params examples ipfs/pinning-services-api-spec
2 participants
@lidel @obo20