Skip to content

docs: add Cursor command for navigation updates based on OAS changes#1591

Open
PedroAntunesCosta wants to merge 3 commits intomasterfrom
add-navigation-update-command
Open

docs: add Cursor command for navigation updates based on OAS changes#1591
PedroAntunesCosta wants to merge 3 commits intomasterfrom
add-navigation-update-command

Conversation

@PedroAntunesCosta
Copy link
Contributor

@PedroAntunesCosta PedroAntunesCosta commented Jan 28, 2026

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-schemas and devportal repositories are cloned to the same parent directory in your local workspace, as it references files across repositories using relative paths.

Changes

  • Added .cursor/commands/navigation-update-for-api-ref.md command documentation with:
    • Step-by-step workflow for analyzing OAS changes and updating navigation
    • Prerequisites and setup requirements
    • Example usage and workflow
    • Git command best practices for automated agents

Why

This command streamlines the process of keeping the dev portal navigation in sync with OpenAPI schema changes by:

  • Using git to detect changes in OAS files
  • Intelligently mapping changes to navigation structure updates
  • Handling slug mappings for new/removed API files
  • Supporting various update scenarios (new endpoints, removed endpoints, reorganized tags)

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

@PedroAntunesCosta PedroAntunesCosta added the documentation Improvements or additions to documentation label Jan 28, 2026
@PedroAntunesCosta PedroAntunesCosta self-assigned this Jan 28, 2026
@github-actions
Copy link

Thanks for your contribution. The .json file will be checked now with Spectral.

@PedroAntunesCosta PedroAntunesCosta requested a review from a team January 28, 2026 23:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant