Sanitize internal TODOs from JSON API OpenAPI - #1226
Merged
Conversation
Signed-off-by: danielporterda <daniel.porter@digitalasset.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
hrischuk-da
approved these changes
Aug 5, 2026
hrischuk-da
approved these changes
Aug 5, 2026
danielporterda
marked this pull request as ready for review
August 5, 2026 15:50
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.
Right now when we publish openapi specs, we leave in TODO lines. This PR strips them out.
Summary
TODO(<tracker>)lines from the JSON Ledger API OpenAPI view modelTODO(#27670)linesThis addresses the OpenAPI TODO findings in #617. Other non-OpenAPI TODO/TBD findings from that issue remain out of scope.
Hosted preview
External party allocation
POST /v2/parties/external/allocatenow shows only the useful synchronizer description and requirement; the internal alias tracker note is absent.External party topology generation
POST /v2/parties/external/generate-topologylikewise keeps its synchronizer description and requirement without exposing the tracker note.Screenshots are from DCO-signed asset commit
bed2ba9f.Validation
49 passed— JSON API OpenAPI and generated-reference updater testsgit diff --checkmintlify validate