Skip to content

Sanitize internal TODOs from JSON API OpenAPI - #1226

Merged
danielporterda merged 2 commits into
mainfrom
sanitize-json-api-todos
Aug 5, 2026
Merged

Sanitize internal TODOs from JSON API OpenAPI#1226
danielporterda merged 2 commits into
mainfrom
sanitize-json-api-todos

Conversation

@danielporterda

@danielporterda danielporterda commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

Right now when we publish openapi specs, we leave in TODO lines. This PR strips them out.

Summary

  • remove standalone internal TODO(<tracker>) lines from the JSON Ledger API OpenAPI view model
  • apply the same sanitizer to the published Mintlify spec and versioned snapshots used by the details/history page
  • retain the upstream 3.4 and 3.5 OpenAPI fixtures verbatim
  • regenerate the checked-in OpenAPI output, removing the two exposed TODO(#27670) lines

This 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/allocate now shows only the useful synchronizer description and requirement; the internal alias tracker note is absent.

External party allocation synchronizer description without the internal TODO

External party topology generation

POST /v2/parties/external/generate-topology likewise keeps its synchronizer description and requirement without exposing the tracker note.

External party topology synchronizer description without the internal TODO

Screenshots are from DCO-signed asset commit bed2ba9f.

Validation

  • 49 passed — JSON API OpenAPI and generated-reference updater tests
  • targeted JSON API reference regeneration is idempotent
  • 3.4 and 3.5 source fixture checksums are unchanged
  • focused Ruff undefined-name checks pass
  • git diff --check
  • mintlify validate
  • hosted browser verification of both affected endpoint pages

Signed-off-by: danielporterda <daniel.porter@digitalasset.com>
@mintlify

mintlify Bot commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
cantonfoundation 🟢 Ready View Preview Aug 4, 2026, 7:32 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@danielporterda
danielporterda marked this pull request as ready for review August 5, 2026 15:50
@danielporterda
danielporterda enabled auto-merge (squash) August 5, 2026 15:50
@danielporterda
danielporterda merged commit 6d03d06 into main Aug 5, 2026
4 checks passed
@danielporterda
danielporterda deleted the sanitize-json-api-todos branch August 5, 2026 15:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants