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

Feature: Render example JSON response #696

Merged
merged 13 commits into from Nov 2, 2021
Merged

Conversation

akshay-ap
Copy link
Collaborator

Fixes #695

Changes proposed in this PR:

  • Adapt docs repository to render examples from swagger spec

@netlify
Copy link

netlify bot commented Aug 7, 2021

✔️ Deploy Preview for docs-oceanprotocol ready!

🔨 Explore the source changes: 933338e

🔍 Inspect the deploy log: https://app.netlify.com/sites/docs-oceanprotocol/deploys/6154bcdff7103100078fdd9f

😎 Browse the preview: https://deploy-preview-696--docs-oceanprotocol.netlify.app

@akshay-ap akshay-ap marked this pull request as draft August 7, 2021 15:15
@akshay-ap akshay-ap marked this pull request as ready for review August 9, 2021 17:20
@kremalicious
Copy link
Contributor

@akshay-ap
Copy link
Collaborator Author

akshay-ap commented Aug 17, 2021

@kremalicious, we have the Aquarius doc string improvements released under 3.0.1 version. But, current version of Aquarius is 2.2.12 in mainnet. After mainnet is updated, swagger spec will have sample api responses.

@kremalicious
Copy link
Contributor

aquarius.mainnet.oceanprotocol.com will never be updated, see the multi network blog post under Migration to Multi-Network Aquarius

This means we have to also switch to aquarius.oceanprotocol.com here in the docs

@akshay-ap
Copy link
Collaborator Author

We have an issue here for changing swagger url: #716

@akshay-ap
Copy link
Collaborator Author

@alexcos20 To close this PR following url should have Aquarius 3.0.1: https://aquarius.oceanprotocol.com/
Can we upgrade to Aquarius 3.0.1?

@akshay-ap akshay-ap added Type: Documentation Improvements or additions to documentation Type: Enhancement New feature or request labels Sep 17, 2021
@trentmc trentmc marked this pull request as draft September 21, 2021 10:36
@trentmc
Copy link
Member

trentmc commented Sep 21, 2021

This is pending Aquarius 3.0.1.

Once that's ready, we can un-convert from a draft, and request review.

@akshay-ap
Copy link
Collaborator Author

Snippet of feature:
image

@akshay-ap akshay-ap marked this pull request as ready for review September 29, 2021 19:07
@codeclimate
Copy link

codeclimate bot commented Sep 29, 2021

Code Climate has analyzed commit 933338e and detected 0 issues on this pull request.

View more on Code Climate.

@trentmc
Copy link
Member

trentmc commented Nov 2, 2021

This is pending Aquarius 3.0.1.

This is now ready.

Therefore we can approve the PR.

@akshay-ap akshay-ap merged commit 638f4b9 into main Nov 2, 2021
8 checks passed
@akshay-ap akshay-ap deleted the issue-695-add-sample-responses branch November 2, 2021 11:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Documentation Improvements or additions to documentation Type: Enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Adapt docs to render sample api responses of Aquarius
3 participants