Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions config/x2mdx/ledger-api/source-artifacts.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,13 @@
"release_url_template": "https://www.canton.io/releases/canton-open-source-{canton_version}.tar.gz",
"bundle_spec_dir": "openapi/json-ledger-api",
"source_path_prefix": "canton-release-bundle/json-ledger-api",
"manual_api_server": "http://localhost:7575",
"manual_operations": "all",
"legacy_manual_route_baseline": {
"operation_count": 67,
"sha256": "8af28522f2ce85a9cb981ac1cd842260b52f0b024ff4e7574a19549d830fa31e",
"source": "Mintlify native OpenAPI sidebar routes captured before full manual-page migration on 2026-08-24"
},
"publish_version": "3.5",
"versions": [
{
Expand Down
253 changes: 253 additions & 0 deletions config/x2mdx/reference-targets.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,253 @@
{
"schema_version": 1,
"targets": [
{
"id": "json-ledger-api-openapi",
"title": "JSON Ledger API OpenAPI",
"generator": "scripts/generate_json_api_reference.py",
"format": "openapi",
"owner": "digital-asset/docs",
"item_boundary": "operation",
"identity_policy": "openapi.operation_id",
"history_mode": "snapshots",
"version_policy": "configured_publish_version",
"source_config": "config/x2mdx/ledger-api/source-artifacts.json",
"reader_output_roots": [
"docs-main/reference/json-api-reference"
],
"source_artifact_roots": [
"docs-main/openapi/json-ledger-api"
],
"current_page_renderer": "native_mintlify_openapi",
"target_page_renderer": "x2mdx_mdx",
"route_policy": "preserve_or_redirect"
},
{
"id": "json-ledger-api-asyncapi",
"title": "JSON Ledger API AsyncAPI",
"generator": "scripts/generate_json_api_asyncapi_reference.py",
"format": "asyncapi",
"owner": "digital-asset/docs",
"item_boundary": "channel_action",
"identity_policy": "asyncapi.channel_action",
"history_mode": "snapshots",
"version_policy": "configured_publish_version",
"source_config": "config/x2mdx/ledger-api-asyncapi/source-artifacts.json",
"reader_output_roots": [
"docs-main/reference/json-api-asyncapi-reference"
],
"source_artifact_roots": [],
"current_page_renderer": "x2mdx_mdx",
"target_page_renderer": "x2mdx_mdx",
"route_policy": "preserve_or_redirect"
},
{
"id": "ledger-api-grpc",
"title": "Ledger API gRPC",
"generator": "scripts/generate_grpc_ledger_api_reference.py",
"format": "grpc",
"owner": "digital-asset/docs",
"item_boundary": "service_method",
"identity_policy": "protobuf.fully_qualified_service_method",
"history_mode": "snapshots",
"version_policy": "latest_selected_release",
"source_config": "config/x2mdx/grpc-ledger-api-reference/source-artifacts.json",
"reader_output_roots": [
"docs-main/reference/grpc-ledger-api-reference"
],
"source_artifact_roots": [],
"current_page_renderer": "x2mdx_mdx",
"target_page_renderer": "x2mdx_mdx",
"route_policy": "preserve_or_redirect"
},
{
"id": "java-bindings",
"title": "Java bindings",
"generator": "scripts/generate_ledger_bindings_api_reference.py",
"format": "jvm_docs",
"owner": "digital-asset/docs",
"item_boundary": "canonical_symbol",
"identity_policy": "jvm.canonical_symbol",
"history_mode": "snapshots",
"version_policy": "latest_configured_version_per_artifact",
"source_config": "config/x2mdx/ledger-bindings/source-artifacts.json",
"reader_output_roots": [
"docs-main/reference/java-bindings.mdx",
"docs-main/reference/java"
],
"source_artifact_roots": [],
"current_page_renderer": "x2mdx_mdx",
"target_page_renderer": "x2mdx_mdx",
"route_policy": "preserve_or_redirect"
},
{
"id": "daml-standard-library",
"title": "Daml Standard Library",
"generator": "scripts/generate_daml_standard_library_reference.py",
"format": "daml_json",
"owner": "digital-asset/docs",
"item_boundary": "module_entity",
"identity_policy": "daml.canonical_module_entity",
"history_mode": "snapshots",
"version_policy": "configured_publish_version",
"source_config": "config/x2mdx/daml-standard-library/source-artifacts.json",
"reader_output_roots": [
"docs-main/appdev/reference/daml-standard-library"
],
"source_artifact_roots": [],
"current_page_renderer": "x2mdx_mdx",
"target_page_renderer": "x2mdx_mdx",
"route_policy": "preserve_or_redirect"
},
{
"id": "daml-script",
"title": "Daml Script",
"generator": "scripts/generate_daml_script_reference.py",
"format": "daml_json",
"owner": "digital-asset/docs",
"item_boundary": "module_entity",
"identity_policy": "daml.canonical_module_entity",
"history_mode": "snapshots",
"version_policy": "configured_publish_version",
"source_config": "config/x2mdx/daml-script/source-artifacts.json",
"reader_output_roots": [
"docs-main/appdev/reference/daml-script"
],
"source_artifact_roots": [],
"current_page_renderer": "x2mdx_mdx",
"target_page_renderer": "x2mdx_mdx",
"route_policy": "preserve_or_redirect"
},
{
"id": "ledger-api-protobuf",
"title": "Ledger API protobuf",
"generator": "scripts/generate_canton_protobuf_history.py",
"format": "protobuf",
"owner": "digital-asset/docs",
"item_boundary": "service_method",
"identity_policy": "protobuf.fully_qualified_service_method",
"history_mode": "snapshots",
"version_policy": "latest_selected_release",
"source_config": "config/x2mdx/protobuf-history/source-artifacts.json",
"reader_output_roots": [
"docs-main/appdev/reference/protobuf-history"
],
"source_artifact_roots": [],
"current_page_renderer": "x2mdx_mdx",
"target_page_renderer": "x2mdx_mdx",
"route_policy": "preserve_or_redirect"
},
{
"id": "admin-api-protobuf",
"title": "Admin API protobuf",
"generator": "scripts/generate_canton_protobuf_history.py",
"format": "protobuf",
"owner": "digital-asset/docs",
"item_boundary": "service_method",
"identity_policy": "protobuf.fully_qualified_service_method",
"history_mode": "snapshots",
"version_policy": "latest_selected_release",
"source_config": "config/x2mdx/protobuf-history/source-artifacts.json",
"reader_output_roots": [
"docs-main/reference/admin-api/protobuf"
],
"source_artifact_roots": [],
"current_page_renderer": "x2mdx_mdx",
"target_page_renderer": "x2mdx_mdx",
"route_policy": "preserve_or_redirect"
},
{
"id": "wallet-gateway-openrpc",
"title": "Wallet Gateway OpenRPC",
"generator": "scripts/generate_wallet_gateway_openrpc_reference.py",
"format": "openrpc",
"owner": "digital-asset/docs",
"item_boundary": "spec_method",
"identity_policy": "openrpc.spec_method",
"history_mode": "snapshots",
"version_policy": "configured_publish_version",
"source_config": "config/x2mdx/wallet-gateway-openrpc/source-artifacts.json",
"reader_output_roots": [
"docs-main/reference/wallet-gateway-json-rpc"
],
"source_artifact_roots": [],
"current_page_renderer": "x2mdx_mdx",
"target_page_renderer": "x2mdx_mdx",
"route_policy": "preserve_or_redirect"
},
{
"id": "splice-openapi",
"title": "Splice OpenAPI",
"generator": "scripts/generate_splice_mintlify_openapi.py",
"format": "openapi",
"owner": "digital-asset/docs",
"item_boundary": "operation",
"identity_policy": "openapi.operation_id",
"history_mode": "snapshots",
"version_policy": "configured_publish_version",
"source_config": "config/mintlify-openapi/splice-openapi/source-artifacts.json",
"reader_output_roots": [
"docs-main/reference/splice-ans-api",
"docs-main/reference/splice-scan-api",
"docs-main/reference/splice-scan-proxy-api",
"docs-main/reference/splice-scan-streaming-api",
"docs-main/reference/splice-token-metadata-service",
"docs-main/reference/splice-transfer-instruction-api",
"docs-main/reference/splice-transfer-instruction-v2-api",
"docs-main/reference/splice-allocation-api",
"docs-main/reference/splice-allocation-v2-api",
"docs-main/reference/splice-allocation-instruction-api",
"docs-main/reference/splice-allocation-instruction-v2-api",
"docs-main/reference/splice-wallet-api-external"
],
"source_artifact_roots": [
"docs-main/openapi/splice"
],
"current_page_renderer": "native_mintlify_openapi",
"target_page_renderer": "x2mdx_mdx",
"route_policy": "preserve_or_redirect"
},
{
"id": "splice-token-standard-v2-daml",
"title": "Splice Token Standard v2 Daml",
"generator": "scripts/generate_splice_token_standard_v2_reference.py",
"format": "daml_json",
"owner": "digital-asset/docs",
"item_boundary": "module_entity",
"identity_policy": "daml.canonical_module_entity",
"history_mode": "snapshots",
"version_policy": "configured_publish_version",
"source_config": "config/x2mdx/splice-token-standard-v2/source-artifacts.json",
"reader_output_roots": [
"docs-main/sdks-tools/api-reference/splice-daml"
],
"source_artifact_roots": [],
"current_page_renderer": "x2mdx_mdx",
"target_page_renderer": "x2mdx_mdx",
"route_policy": "preserve_or_redirect",
"limitations": [
"The configured source currently provides one publish snapshot, so no cross-version changes can be observed."
]
},
{
"id": "typescript-bindings",
"title": "TypeScript bindings",
"generator": "scripts/generate_typescript_bindings_reference.py",
"format": "typedoc",
"owner": "digital-asset/docs",
"item_boundary": "package_symbol",
"identity_policy": "typedoc.package_symbol",
"history_mode": "snapshots",
"version_policy": "configured_publish_version_per_package",
"source_config": "config/x2mdx/typescript-bindings/source-artifacts.json",
"reader_output_roots": [
"docs-main/reference/typescript.mdx",
"docs-main/reference/typescript"
],
"source_artifact_roots": [],
"current_page_renderer": "x2mdx_mdx",
"target_page_renderer": "x2mdx_mdx",
"route_policy": "preserve_or_redirect"
}
]
}
Loading