Skip to content

Conversation

@diego-signalwire
Copy link
Contributor

REST API Update Pull Request

Related Issue

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

Description

Update documentation for https://{{Space}}/api/fabric/subscribers/tokens as this now returns a refresh token.
Update documentation for https://{{Space}}/api/fabric/guests/tokens as this now returns a refresh token.
Add documentation for https://faruk.lvh.me/api/fabric/subscribers/tokens/refresh

Type of Change

  • New endpoint
  • Update to existing endpoint

Motivation and Context

We have recently added a refresh token endpoint here https://github.com/signalwire/prime-rails/pull/7263.

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.

@netlify
Copy link

netlify bot commented Jun 2, 2025

Deploy Preview for signalwire-docs ready!

Name Link
🔨 Latest commit a68be76
🔍 Latest deploy log https://app.netlify.com/projects/signalwire-docs/deploys/684092dfc823d300088ab65e
😎 Deploy Preview https://deploy-preview-301--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.

@github-actions
Copy link

github-actions bot commented Jun 2, 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
(+1.0) 🟢
72/100
(+1.0) 🟢
90/100
(=) ⚪
44/100
(=) ⚪
70/100
(=) ⚪
700
(+8) 🔴
399
(+2) 🔴
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 73/100
(=) ⚪
70/100
(=) ⚪
87/100
(=) ⚪
40/100
(=) ⚪
68/100
(=) ⚪
321
(=) ⚪
233
(=) ⚪
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 marked this pull request as ready for review June 2, 2025 16:05
cassieemb
cassieemb previously approved these changes Jun 2, 2025
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!

@Devon-White
Copy link
Contributor

LGTM!

@Devon-White Devon-White merged commit aa8a1f5 into main Jun 4, 2025
6 checks passed
@Devon-White Devon-White deleted the diego/14799/update-document-for-refresh-token branch June 4, 2025 18:59
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.

5 participants