Add OpenAPI endpoint history notes

[danielporterda]

Summary

• enrich the generated JSON Ledger API OpenAPI spec with Mintlify-supported x-mint.content endpoint history notes
• compute history from all configured JSON Ledger API source versions, currently 3.4 and 3.5
• add focused tests for added, modified, deprecated, removed, referenced-schema, and idempotent regeneration cases

Preview / screenshots

• Mintlify preview comment: Add OpenAPI endpoint history notes #934 (comment)
• Current hosted preview status: still Building with no preview URL populated. I briefly marked the PR ready twice to trigger preview creation, then restored draft state.
• Expected preview host once Mintlify finishes: https://cantonfoundation-openapi-endpoint-history.mintlify.app
• Screenshots are pending because local npx mintlify dev stayed spinner-only and the hosted Mintlify preview has not produced a URL.

YAML evidence for added endpoint

/livez:
  get:
    x-mint:
      content: |-
        <Note>
        **Endpoint history**: Added in 3.5.
        </Note>

YAML evidence for modified endpoint

/v2/commands/submit-and-wait:
  post:
    x-mint:
      content: |-
        <Note>
        **Endpoint history**: Added in 3.4. Modified in 3.5: description updated; request body schema changed; response `400` description updated.
        </Note>

Validation

• direnv exec . python3 -m pytest tests/test_openapi_history.py tests/test_json_api_openapi.py -q
• direnv exec . python3 -m py_compile scripts/openapi_history.py scripts/generate_json_api_reference.py tests/test_openapi_history.py tests/test_json_api_openapi.py
• direnv exec . npm run generate:json-api-reference
• generated YAML scan for GET /livez, GET /readyz, modified endpoint notes, and absence of x-docs-history
• generator idempotency check using a stable git diff hash after a second regeneration
• git diff --check
• GitHub mintlify validate passed
• GitHub validate-network-variable-tabs passed
• GitHub DCO passed

Notes

• Local npx mintlify validate was attempted but stayed spinner-only for roughly 90 seconds and was stopped; GitHub Mintlify validation passed.
• No tombstone operations are added for removed endpoints; visible history is only injected into current operations.

[mintlify]

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

Project	Status	Preview	Updated (UTC)
cantonfoundation	🟢 Ready	View Preview	Jul 1, 2026, 10:26 PM

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