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

docs: query params examples #55

Merged
merged 1 commit into from
Aug 26, 2020
Merged

docs: query params examples #55

merged 1 commit into from
Aug 26, 2020

Conversation

lidel
Copy link
Member

@lidel lidel commented Aug 26, 2020

This PR fixes examples generated from YAML.
Docs now include inlined examples of how arrays should be passed in each query param:

2020-08-26--17-20-51

Preview: https://ipfs.github.io/pinning-services-api-spec/#specUrl=https://raw.githubusercontent.com/ipfs/pinning-services-api-spec/docs/query-param-examples/ipfs-pinning-service.yaml

Closes #54 cc @andrew @obo20

@lidel lidel requested a review from andrew August 26, 2020 15:25
Copy link

@andrew andrew left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🌮

@lidel lidel merged commit 434132e into master Aug 26, 2020
@lidel lidel deleted the docs/query-param-examples branch August 26, 2020 15:28
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 this pull request may close these issues.

Provide documented examples of queries / the patterns for them
2 participants