Skip to content

Document relay rest api endpoints #326

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.

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

diego-signalwire
Copy link
Contributor

@diego-signalwire diego-signalwire commented Jun 16, 2025

REST API Update Pull Request

Related Issue

https://github.com/signalwire/cloud-product/issues/14888

Description

Document endpoints:

GET https://{{Space}}/api/relay/rest/queues
GET https://{{Space}}/api/relay/rest/queues/:id
PUT https://{{Space}}/api/relay/rest/queues/:id
DELETE https://{{Space}}/api/relay/rest/queues/:id POST https://{{Space}}/api/relay/rest/queues

Type of Change

  • [x ] New endpoint
  • [] Update to existing endpoint

Checklist:

  • I have read and fully understand the process for updating the REST API
  • [] Mandatory fields are present in the TypeSpec files.
  • TypeSpec files successfully compiled OpenAPI spec files.
    • No new warnings were generated during the compilation process.
  • OpenAPI spec files were validated with a SWAGGER UI tool to ensure they are correct.
  • The DevEx team has been alerted with the new changed by including the team/developer-experience label in the PR.

Additional Notes

Add any other context about the pull request here.

GET https://{{Space}}/api/relay/rest/queues
GET https://{{Space}}/api/relay/rest/queues/:id
PUT https://{{Space}}/api/relay/rest/queues/:id
DELETE https://{{Space}}/api/relay/rest/queues/:id
POST https://{{Space}}/api/relay/rest/queues
Copy link

netlify bot commented Jun 16, 2025

Deploy Preview for signalwire-docs ready!

Name Link
🔨 Latest commit b8bb052
🔍 Latest deploy log https://app.netlify.com/projects/signalwire-docs/deploys/68599bafaab3d10008d79771
😎 Deploy Preview https://deploy-preview-326--signalwire-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@diego-signalwire diego-signalwire marked this pull request as ready for review June 16, 2025 11:49
Copy link

github-actions bot commented Jun 16, 2025

OpenAPI Specification Analysis

Changes are compared to the main branch:

  • 🟢 Improvements (higher scores or fewer issues)
  • 🔴 Regressions (lower scores or more issues)
  • ⚪ No changes
Spec Docs Completeness SDK Gen Security Overall Warnings Errors Report
api/compatibility-api/_spec_.yaml 72/100
(=) ⚪
69/100
(=) ⚪
79/100
(=) ⚪
39/100
(=) ⚪
65/100
(=) ⚪
448
(=) ⚪
360
(=) ⚪
View
api/signalwire-rest/calling-api/tsp-output/@typespec/openapi3/openapi.yaml 98/100
(=) ⚪
95/100
(=) ⚪
97/100
(=) ⚪
50/100
(=) ⚪
85/100
(=) ⚪
20
(=) ⚪
6
(=) ⚪
View
api/signalwire-rest/chat-api/tsp-output/@typespec/openapi3/openapi.yaml 98/100
(=) ⚪
95/100
(=) ⚪
97/100
(=) ⚪
50/100
(=) ⚪
85/100
(=) ⚪
12
(=) ⚪
4
(=) ⚪
View
api/signalwire-rest/datasphere-api/tsp-output/@typespec/openapi3/openapi.yaml 97/100
(=) ⚪
94/100
(=) ⚪
96/100
(=) ⚪
52/100
(=) ⚪
85/100
(=) ⚪
65
(=) ⚪
17
(=) ⚪
View
api/signalwire-rest/fabric-api/_spec_.yaml 75/100
(=) ⚪
72/100
(=) ⚪
90/100
(=) ⚪
44/100
(=) ⚪
70/100
(=) ⚪
700
(=) ⚪
399
(=) ⚪
View
api/signalwire-rest/fax-api/_spec_.yaml 38/100
(=) ⚪
35/100
(=) ⚪
86/100
(=) ⚪
39/100
(=) ⚪
50/100
(=) ⚪
18
(=) ⚪
15
(=) ⚪
View
api/signalwire-rest/message-api/_spec_.yaml 53/100
(=) ⚪
50/100
(=) ⚪
86/100
(=) ⚪
38/100
(=) ⚪
57/100
(=) ⚪
18
(=) ⚪
11
(=) ⚪
View
api/signalwire-rest/project-api/_spec_.yaml 76/100
(=) ⚪
73/100
(=) ⚪
69/100
(=) ⚪
36/100
(=) ⚪
64/100
(=) ⚪
21
(=) ⚪
14
(=) ⚪
View
api/signalwire-rest/pubsub-api/_spec_.yaml 98/100
(=) ⚪
95/100
(=) ⚪
88/100
(=) ⚪
36/100
(=) ⚪
80/100
(=) ⚪
11
(=) ⚪
6
(=) ⚪
View
api/signalwire-rest/space-api/_spec_.yaml 74/100
(+1.0) 🟢
71/100
(+1.0) 🟢
88/100
(+1.0) 🟢
40/100
(=) ⚪
69/100
(+1.0) 🟢
349
(+28) 🔴
246
(+13) 🔴
View
api/signalwire-rest/video-api/_spec_.yaml 86/100
(=) ⚪
85/100
(=) ⚪
86/100
(=) ⚪
39/100
(=) ⚪
74/100
(=) ⚪
179
(=) ⚪
131
(=) ⚪
View
api/signalwire-rest/voice-api/_spec_.yaml 53/100
(=) ⚪
50/100
(=) ⚪
86/100
(=) ⚪
38/100
(=) ⚪
57/100
(=) ⚪
18
(=) ⚪
11
(=) ⚪
View

@diego-signalwire diego-signalwire requested a review from a team June 16, 2025 19:36
glanotte
glanotte previously approved these changes Jun 17, 2025
@diego-signalwire diego-signalwire marked this pull request as draft June 20, 2025 13:55
@diego-signalwire diego-signalwire marked this pull request as ready for review June 23, 2025 14:03
Copy link
Contributor

@cassieemb cassieemb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good, just one question about the recording path ID that is referenced in a few places

Copy link
Contributor

@cassieemb cassieemb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants