Skip to content

Commit 863dbe8

Browse files
authored
docs: document waitpoint token API endpoints (#3130)
Adds REST API documentation for the 5 waitpoint token endpoints (`/api/v1/waitpoints/tokens`), including create, list, retrieve, complete, and HTTP callback. Also adds the `publicAccessToken` security scheme used by the complete endpoint. <!-- mintlify-editor-comments:start --> Mintlify --- 0 threads from 0 users in Mintlify - No unresolved comments <!-- mintlify-editor-comments:end --> <!-- mintlify-comment--> <a href="https://dashboard.mintlify.com/trigger/trigger/editor/docs%2Fdocument-waitpoint-endpoints?source=pr_comment" target="_blank" rel="noopener noreferrer"><picture><source media="(prefers-color-scheme: dark)" srcset="https://d3gk2c5xim1je2.cloudfront.net/assets/open-mintlify-editor-dark.svg"><source media="(prefers-color-scheme: light)" srcset="https://d3gk2c5xim1je2.cloudfront.net/assets/open-mintlify-editor-light.svg"><img src="https://d3gk2c5xim1je2.cloudfront.net/assets/open-mintlify-editor-light.svg" alt="Open in Mintlify Editor"></picture></a> <!-- /mintlify-comment -->
1 parent 39dd91b commit 863dbe8

File tree

7 files changed

+554
-0
lines changed

7 files changed

+554
-0
lines changed

docs/docs.json

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -302,6 +302,16 @@
302302
"management/deployments/promote"
303303
]
304304
},
305+
{
306+
"group": "Waitpoints API",
307+
"pages": [
308+
"management/waitpoints/create",
309+
"management/waitpoints/list",
310+
"management/waitpoints/retrieve",
311+
"management/waitpoints/complete",
312+
"management/waitpoints/complete-callback"
313+
]
314+
},
305315
{
306316
"group": "Query API",
307317
"pages": ["management/query/execute"]
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: "Complete a waitpoint token via HTTP callback"
3+
openapi: "v3-openapi POST /api/v1/waitpoints/tokens/{waitpointId}/callback/{callbackHash}"
4+
---
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: "Complete a waitpoint token"
3+
openapi: "v3-openapi POST /api/v1/waitpoints/tokens/{waitpointId}/complete"
4+
---
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: "Create a waitpoint token"
3+
openapi: "v3-openapi POST /api/v1/waitpoints/tokens"
4+
---
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: "List waitpoint tokens"
3+
openapi: "v3-openapi GET /api/v1/waitpoints/tokens"
4+
---
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: "Retrieve a waitpoint token"
3+
openapi: "v3-openapi GET /api/v1/waitpoints/tokens/{waitpointId}"
4+
---

0 commit comments

Comments
 (0)