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

use dynamic URLs for OpenAPI definitions #426

Closed
3 tasks
LakshmiLavanyaKasturi opened this issue Jul 28, 2023 · 5 comments · Fixed by #525
Closed
3 tasks

use dynamic URLs for OpenAPI definitions #426

LakshmiLavanyaKasturi opened this issue Jul 28, 2023 · 5 comments · Fixed by #525
Assignees
@rafaelcr
Labels
docathon

Comments

@LakshmiLavanyaKasturi
Copy link
Contributor

LakshmiLavanyaKasturi commented Jul 28, 2023 •
edited
Loading

  • The ask is to have OpenAPI JSON files for stacks blockchain API, Ordinals API, and Metadata API in the respective product repos and pulled to the docs repo using the Docusaurus plugin.
  • Investigate and fix the APIs to show in Alphabetical order.
  • Investigate if YAML is allowed in the docusaurus-preset-openapi

Relates to #419
@github-project-automation github-project-automation bot moved this to 🆕 New in Hiro Docs Jul 28, 2023
Merged
@LakshmiLavanyaKasturi
Copy link
Contributor Author

LakshmiLavanyaKasturi commented Jul 31, 2023 •
edited
Loading

@rafaelcr, can you please prioritize this issue as we plan to release the API-Execute experience this week. Thanks!

@LakshmiLavanyaKasturi LakshmiLavanyaKasturi moved this from 🆕 New to 🏗 In Progress in Hiro Docs Jul 31, 2023
@LakshmiLavanyaKasturi LakshmiLavanyaKasturi moved this from 🏗 In Progress to 📋 Backlog in Hiro Docs Aug 1, 2023
@LakshmiLavanyaKasturi
Copy link
Contributor Author

Per timelines, we are hardcoding the JSON files into the docs repo. However, this issue must be addressed to ensure JSON file automation from the remote API repos. @rafaelcr, Please confirm if you can prioritize this issue to finish this iteration. Thanks!

@LakshmiLavanyaKasturi LakshmiLavanyaKasturi self-assigned this Aug 8, 2023
@LakshmiLavanyaKasturi
Copy link
Contributor Author

@rafaelcr, Checking in to see if you have any updates on this issue. Please let me know if I can help in any way if you are swamped. Thanks!

This was referenced Aug 18, 2023
Merged
Merged
Merged
@LakshmiLavanyaKasturi LakshmiLavanyaKasturi moved this from 📋 Backlog to 🏗 In Progress in Hiro Docs Aug 21, 2023
@LakshmiLavanyaKasturi LakshmiLavanyaKasturi moved this from 🏗 In Progress to 📋 Backlog in Hiro Docs Aug 21, 2023
@LakshmiLavanyaKasturi LakshmiLavanyaKasturi moved this from 📋 Backlog to 🏗 In Progress in Hiro Docs Sep 5, 2023
@LakshmiLavanyaKasturi
Copy link
Contributor Author

Blocked by the following error. Investigating still.

[ERROR] ValidationError: Invalid configuration object. Webpack has been initialized using a configuration object that does not match the API schema.

@LakshmiLavanyaKasturi LakshmiLavanyaKasturi moved this from 🏗 In Progress to 📋 Backlog in Hiro Docs Sep 5, 2023
@rafaelcr
Copy link
Contributor

rafaelcr commented Oct 2, 2023

Blocked by hirosystems/api-toolkit#3

@rafaelcr rafaelcr changed the title Create OpenAPI JSON files for all the API's in their respective product repos. use dynamic URLs for OpenAPI definitions Oct 3, 2023
@rafaelcr rafaelcr mentioned this issue Oct 4, 2023
Merged
@github-project-automation github-project-automation bot moved this from 📋 Backlog to ✅ Done in Hiro Docs Oct 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@rafaelcr rafaelcr

Labels
docathon
Projects
No open projects
Hiro Docs
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: download openapi definitions from vercel when building docs hirosystems/docs
3 participants
@rafaelcr @mefrem @LakshmiLavanyaKasturi