docs: add Cursor command for navigation updates based on OAS changes#1591
Open
PedroAntunesCosta wants to merge 3 commits intomasterfrom
Open
docs: add Cursor command for navigation updates based on OAS changes#1591PedroAntunesCosta wants to merge 3 commits intomasterfrom
PedroAntunesCosta wants to merge 3 commits intomasterfrom
Conversation
|
Thanks for your contribution. The .json file will be checked now with Spectral. |
This file contains hidden or 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
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.
Summary
Adds a new Cursor command that automates navigation file updates when OpenAPI specification files are modified.
Prerequisites
This command requires that both the
openapi-schemasanddevportalrepositories are cloned to the same parent directory in your local workspace, as it references files across repositories using relative paths.Changes
.cursor/commands/navigation-update-for-api-ref.mdcommand documentation with:Why
This command streamlines the process of keeping the dev portal navigation in sync with OpenAPI schema changes by:
Example Workflow
When an OpenAPI schema is updated (e.g., PR #1590 adding a new endpoint to update allocation linked entity), this command can be used to automatically generate the corresponding navigation updates for the dev portal (resulting in PR #1171 adding the new endpoint to the Budgets API navigation).
Key Files Affected
.cursor/commands/navigation-update-for-api-ref.md- New command documentation