Skip to content

Add SIP endpoints documentation #148

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

Merged
merged 9 commits into from
Apr 25, 2025
Merged

Conversation

diego-signalwire
Copy link
Contributor

REST API Update Pull Request

Related Issue

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

Description

Add documentation for the new Fabric SIP endpoints.

Type of Change

  • New endpoint
  • Update to existing endpoint

Motivation and Context

We added CRUD endpoints to manage the SIP gateways. This PR add the documentation for these endpoints.

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.

Copy link

netlify bot commented Apr 2, 2025

Deploy Preview for signalwire-docs ready!

Name Link
🔨 Latest commit 0a1725b
🔍 Latest deploy log https://app.netlify.com/sites/signalwire-docs/deploys/680b63d34af0b100087e44e3
😎 Deploy Preview https://deploy-preview-148--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 site configuration.

Copy link

github-actions bot commented Apr 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
(=) ⚪
51/100
(=) ⚪
85/100
(=) ⚪
65
(=) ⚪
18
(=) ⚪
View
api/signalwire-rest/fabric-api/_spec_.yaml 74/100
(+1.0) 🟢
71/100
(+1.0) 🟢
91/100
(+1.0) 🟢
44/100
(=) ⚪
70/100
(+1.0) 🟢
692
(+46) 🔴
384
(+13) 🔴
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 April 2, 2025 16:07
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.

This is looking good, I have a few thoughts! let me know what you think

cassieemb
cassieemb previously approved these changes Apr 3, 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

@diego-signalwire Looks like the new endpoints need to be migrated to the _spec_.yml file to generate the docs.

@diego-signalwire
Copy link
Contributor Author

@diego-signalwire Looks like the new endpoints need to be migrated to the _spec_.yml file to generate the docs.

done @Devon-White!
I initially planned to hold off on updating the spec.yml file until the PR was approved, and forgot to do it.

@Devon-White Devon-White merged commit 8180e88 into main Apr 25, 2025
6 checks passed
@Devon-White Devon-White deleted the diego/13745/sip-gateways-endpoints branch April 25, 2025 10:40
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