Rewrite operationId cross-references for path-style anchors#21
Merged
Rewrite operationId cross-references for path-style anchors#21
Conversation
When `anchor-style: path` is configured, endpoint descriptions and schema docs may still contain fragment links using operationId style (e.g. `(#getTask)`). These become broken since the rendered headings use path-style anchors (e.g. `#get-/v1/tasks/-id-`). This adds a post-processing pass that rewrites all operationId fragment references in the generated markdown to their path-style equivalents. - `buildOperationIdToPathMap()` creates the reverse lookup - `rewriteOperationIdRefs()` rewrites `(#operationId)` patterns - Applied as a single pass over the full output for completeness (catches references in schema property descriptions, not just endpoint descriptions)
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
1 participant
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
When
anchor-style: pathis configured, endpoint descriptions and schema property docs may still contain fragment links using operationId style (e.g.(#getTask)). These become broken since the rendered headings use path-style anchors (e.g.#get-/v1/tasks/-id-).This adds a post-processing pass that rewrites all operationId fragment references in the generated markdown to their path-style equivalents:
buildOperationIdToPathMap()creates the reverse lookup from operationId to path-style anchorrewriteOperationIdRefs()rewrites(#operationId)patterns in markdown textTest plan
buildOperationIdToPathMapandrewriteOperationIdRefsanchor-style: path