Skip to content

docs: document waitpoint token API endpoints #3130

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

Merged
isshaddad merged 8 commits into from
Feb 25, 2026
Merged

docs: document waitpoint token API endpoints #3130

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
5840753
added POST /api/v1/waitpoints/tokens docs
isshaddad Feb 25, 2026
2302c1b
added GET /api/v1/waitpoints/tokens/{waitpointId} docs
isshaddad Feb 25, 2026
e62a4a0
added GET /api/v1/waitpoints/tokens docs
isshaddad Feb 25, 2026
8e1232e
added POST /api/v1/waitpoints/tokens/{waitpointId}/complete docs
isshaddad Feb 25, 2026
a1dd6ac
added POST /api/v1/waitpoints/tokens/{waitpointId}/callback/{callback…
isshaddad Feb 25, 2026
4bf3c15
coderabbit review
isshaddad Feb 25, 2026
b69b5ce
added more response codes
isshaddad Feb 25, 2026
442a07c
Merge branch 'main' into docs/document-waitpoint-endpoints
isshaddad Feb 25, 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
10 changes: 10 additions & 0 deletions docs/docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -302,6 +302,16 @@
"management/deployments/promote"
]
},
{
"group": "Waitpoints API",
"pages": [
"management/waitpoints/create",
"management/waitpoints/list",
"management/waitpoints/retrieve",
"management/waitpoints/complete",
"management/waitpoints/complete-callback"
]
},
{
"group": "Query API",
"pages": ["management/query/execute"]
Expand Down
4 changes: 4 additions & 0 deletions docs/management/waitpoints/complete-callback.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: "Complete a waitpoint token via HTTP callback"
openapi: "v3-openapi POST /api/v1/waitpoints/tokens/{waitpointId}/callback/{callbackHash}"
---
4 changes: 4 additions & 0 deletions docs/management/waitpoints/complete.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: "Complete a waitpoint token"
openapi: "v3-openapi POST /api/v1/waitpoints/tokens/{waitpointId}/complete"
---
4 changes: 4 additions & 0 deletions docs/management/waitpoints/create.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: "Create a waitpoint token"
openapi: "v3-openapi POST /api/v1/waitpoints/tokens"
---
4 changes: 4 additions & 0 deletions docs/management/waitpoints/list.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: "List waitpoint tokens"
openapi: "v3-openapi GET /api/v1/waitpoints/tokens"
---
4 changes: 4 additions & 0 deletions docs/management/waitpoints/retrieve.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: "Retrieve a waitpoint token"
openapi: "v3-openapi GET /api/v1/waitpoints/tokens/{waitpointId}"
---
Loading