Skip to content

Replace native Splice OpenAPI reference pages #1461

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
danielporterda wants to merge 4 commits into
base: reference-history-contracts
Choose a base branch
from
Draft

Replace native Splice OpenAPI reference pages #1461

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1b17e82
Harden manual OpenAPI reference rendering
danielporterda Aug 25, 2026
83501f8
Replace native Splice OpenAPI reference pages
danielporterda Aug 25, 2026
9ffd0ed
Match generated reference colors to the design
danielporterda Aug 26, 2026
c9957c2
Make Splice history follow latest release
danielporterda Aug 26, 2026
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
16 changes: 15 additions & 1 deletion config/mintlify-openapi/splice-openapi/source-artifacts.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
"release_repo": "digital-asset/decentralized-canton-sync",
"tag_regex": "^v(?P<version>0\\.[0-9]+\\.[0-9]+)$",
"min_version": "0.5.10",
"publish_version": "0.7.4",
"asset_template": "{version}_openapi.tar.gz",
"nav_dropdown": "API Reference",
"top_level_group_label": "Splice APIs",
Expand All @@ -23,6 +22,21 @@
"allocation-instruction-v1.yaml",
"allocation-instruction-v2.yaml"
],
"excluded_specs": [
{
"filename": "wallet-internal.yaml",
"reason": "Internal validator API; excluded from the reader-facing Splice API reference."
},
{
"filename": "validator-internal.yaml",
"reason": "Internal validator API; excluded from the reader-facing Splice API reference."
}
],
"legacy_manual_route_baseline": {
"operation_count": 121,
"sha256": "e6b65e1f5e63a55574f95226c7a717c70dfdbe4af524cbad679986c4bff59cc5",
"source": "Mintlify native Splice OpenAPI routes captured before manual-page migration on 2026-08-25"
},
"legacy_cleanup_paths": [
"reference/splice-scan-openapi"
],
Expand Down
2 changes: 1 addition & 1 deletion config/x2mdx/reference-targets.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@
"item_boundary": "operation",
"identity_policy": "openapi.operation_id",
"history_mode": "snapshots",
"version_policy": "configured_publish_version",
"version_policy": "latest_selected_release",
"source_config": "config/mintlify-openapi/splice-openapi/source-artifacts.json",
"reader_output_roots": [
"docs-main/reference/splice-ans-api",
Expand Down
290 changes: 121 additions & 169 deletions docs-main/docs.json
View file
Open in desktop

Large diffs are not rendered by default.

67 changes: 22 additions & 45 deletions docs-main/reference/json-api-reference/delete-v2idps:idp-id.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,24 +36,26 @@ Delete an existing identity provider configuration.
## Protocol Details


<dl class="x2mdx-ref-meta-grid">

<div class="x2mdx-ref-meta-grid">

<div class="x2mdx-ref-meta-item">
<dt>Operation ID</dt>
<dd>deleteV2IdpsIdp-id</dd>
<span class="x2mdx-ref-meta-label">Operation ID</span>
<span class="x2mdx-ref-meta-value">deleteV2IdpsIdp-id</span>
</div>

<div class="x2mdx-ref-meta-item">
<dt>Authentication</dt>
<dd>Bearer token</dd>
<span class="x2mdx-ref-meta-label">Authentication</span>
<span class="x2mdx-ref-meta-value">Bearer token</span>
</div>

<div class="x2mdx-ref-meta-item">
<dt>Published</dt>
<dd>3.5</dd>
<span class="x2mdx-ref-meta-label">Published</span>
<span class="x2mdx-ref-meta-value">3.5</span>
</div>

</dl>
</div>



## Inputs
Expand All @@ -68,10 +70,7 @@ Delete an existing identity provider configuration.



<ParamField path="idp-id" type="string" required>

-
</ParamField>
<ParamField path="idp-id" type="string" required />



Expand Down Expand Up @@ -125,9 +124,7 @@ Does not (yet) contain any data.



<ResponseField name="value" type="string" required>
-
</ResponseField>
<ResponseField name="value" type="string" required />



Expand All @@ -151,63 +148,43 @@ Does not (yet) contain any data.



<ResponseField name="code" type="string" required>
-
</ResponseField>
<ResponseField name="code" type="string" required />



<ResponseField name="cause" type="string" required>
-
</ResponseField>
<ResponseField name="cause" type="string" required />



<ResponseField name="correlationId" type="string">
-
</ResponseField>
<ResponseField name="correlationId" type="string" />



<ResponseField name="traceId" type="string">
-
</ResponseField>
<ResponseField name="traceId" type="string" />



<ResponseField name="context" type="Map_String" required>
-
</ResponseField>
<ResponseField name="context" type="Map_String" required />



<ResponseField name="resources" type="Tuple2_String_String[]">
-
</ResponseField>
<ResponseField name="resources" type="Tuple2_String_String[]" />



<ResponseField name="errorCategory" type="integer (int32)" required>
-
</ResponseField>
<ResponseField name="errorCategory" type="integer (int32)" required />



<ResponseField name="grpcCodeValue" type="integer (int32)">
-
</ResponseField>
<ResponseField name="grpcCodeValue" type="integer (int32)" />



<ResponseField name="retryInfo" type="string">
-
</ResponseField>
<ResponseField name="retryInfo" type="string" />



<ResponseField name="definiteAnswer" type="boolean">
-
</ResponseField>
<ResponseField name="definiteAnswer" type="boolean" />



Expand Down
71 changes: 23 additions & 48 deletions docs-main/reference/json-api-reference/delete-v2users:user-id.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,24 +36,26 @@ Delete an existing user and all its rights.
## Protocol Details


<dl class="x2mdx-ref-meta-grid">

<div class="x2mdx-ref-meta-grid">

<div class="x2mdx-ref-meta-item">
<dt>Operation ID</dt>
<dd>deleteV2UsersUser-id</dd>
<span class="x2mdx-ref-meta-label">Operation ID</span>
<span class="x2mdx-ref-meta-value">deleteV2UsersUser-id</span>
</div>

<div class="x2mdx-ref-meta-item">
<dt>Authentication</dt>
<dd>Bearer token</dd>
<span class="x2mdx-ref-meta-label">Authentication</span>
<span class="x2mdx-ref-meta-value">Bearer token</span>
</div>

<div class="x2mdx-ref-meta-item">
<dt>Published</dt>
<dd>3.5</dd>
<span class="x2mdx-ref-meta-label">Published</span>
<span class="x2mdx-ref-meta-value">3.5</span>
</div>

</dl>
</div>



## Inputs
Expand All @@ -68,10 +70,7 @@ Delete an existing user and all its rights.



<ParamField path="user-id" type="string" required>

-
</ParamField>
<ParamField path="user-id" type="string" required />



Expand Down Expand Up @@ -99,9 +98,7 @@ Delete an existing user and all its rights.



<ResponseField name="value" type="object" required>
-
</ResponseField>
<ResponseField name="value" type="object" required />



Expand All @@ -125,9 +122,7 @@ Delete an existing user and all its rights.



<ResponseField name="value" type="string" required>
-
</ResponseField>
<ResponseField name="value" type="string" required />



Expand All @@ -151,63 +146,43 @@ Delete an existing user and all its rights.



<ResponseField name="code" type="string" required>
-
</ResponseField>
<ResponseField name="code" type="string" required />



<ResponseField name="cause" type="string" required>
-
</ResponseField>
<ResponseField name="cause" type="string" required />



<ResponseField name="correlationId" type="string">
-
</ResponseField>
<ResponseField name="correlationId" type="string" />



<ResponseField name="traceId" type="string">
-
</ResponseField>
<ResponseField name="traceId" type="string" />



<ResponseField name="context" type="Map_String" required>
-
</ResponseField>
<ResponseField name="context" type="Map_String" required />



<ResponseField name="resources" type="Tuple2_String_String[]">
-
</ResponseField>
<ResponseField name="resources" type="Tuple2_String_String[]" />



<ResponseField name="errorCategory" type="integer (int32)" required>
-
</ResponseField>
<ResponseField name="errorCategory" type="integer (int32)" required />



<ResponseField name="grpcCodeValue" type="integer (int32)">
-
</ResponseField>
<ResponseField name="grpcCodeValue" type="integer (int32)" />



<ResponseField name="retryInfo" type="string">
-
</ResponseField>
<ResponseField name="retryInfo" type="string" />



<ResponseField name="definiteAnswer" type="boolean">
-
</ResponseField>
<ResponseField name="definiteAnswer" type="boolean" />



Expand Down
Loading