add HCP Vagrant Box Registry API docs #2572
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
📦 Next.js Bundle AnalysisThis analysis was generated by the next.js bundle analysis action 🤖 New Page AddedThe following page was added to the bundle from the code in this PR:
|
zchsh
requested review from
a team,
pbortnick and
chrisroberts
and removed request for
a team
|
Just as a note: sidebar content was discussed previously with @zchsh and he provided options and examples for how we can make adjustments in our proto generation to address it (links noted in description). Those updates should be applied at some point next week. |
pbortnick
approved these changes
Sep 12, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🔗 Relevant links
🗒️ What
Adds HCP Vagrant Box Registry API docs to /hcp/api-docs/vagrant-box-registry.
🛠️ How
Sources OpenAPI JSON specs from https://github.com/hashicorp/hcp-specs/tree/main/specs/cloud-vagrant-box-registry, and renders them with the existing OpenAPI docs template.
📸 Design Screenshot
🧪 Testing
💭 Anything else?
Sidebar is a bit rough
Upstream in the spec file, authors could add
tagvalues to more intentionally group operations. For an example of this, see the HCP Consul spec file, and the resulting HCP Consul docs.