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

automate Swagger json updates #74

Closed
kremalicious opened this issue Nov 28, 2018 · 2 comments · Fixed by #219
Closed

automate Swagger json updates #74

kremalicious opened this issue Nov 28, 2018 · 2 comments · Fixed by #219

Comments

@kremalicious
Copy link
Contributor

kremalicious commented Nov 28, 2018

For Aquarius and Brizo we need to find a way to get the most recent Swagger spec as json into the docs build process. At the moment they simply live as manually copied json files in /data.

Ideally, the json file just sits in the original repository, and is updated automatically during every release process. During docs build process I can then either get it through GitHub GraphQL API, or a normal fetch.

We could also fetch it remotely from somewhere else, a Swagger client is already in the docs site.

@ttmc
Copy link
Contributor

ttmc commented Apr 5, 2019

Handy tip for now: We have some live, online Aquarius instances and you can ask those for the Swagger spec (i.e. something like data/aquarius.json). For example, see https://nginx-aquarius.dev-ocean.com/spec

Unfortunately, that JSON is not exactly what the docs site wants. Even after I add the top-level "basePath" and "host" fields to it, errors arise.

@kremalicious
Copy link
Contributor Author

fetching them remotely would be actually nice, already doing that with the Pet Store example https://github.com/oceanprotocol/docs/blob/master/gatsby-node.js#L41

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 a pull request may close this issue.

2 participants