Skip to content

Conversation

Devon-White
Copy link
Contributor

Add externalDocs, tag metadata, and info in spec.

REST API Update Pull Request

Description

Added

  • externalDocs
  • tag metadata
  • info in spec.
  • status_url
  • status_events

Corrected Response Schema

Type of Change

  • New endpoint
  • Update to existing endpoint

Motivation and Context

Why is this change required? What problem does it solve?

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.

Add externalDocs, tag metadata, and info in spec.
@netlify
Copy link

netlify bot commented Jul 31, 2025

Deploy Preview for signalwire-docs ready!

Name Link
🔨 Latest commit eee9d70
🔍 Latest deploy log https://app.netlify.com/projects/signalwire-docs/deploys/68f6399b23f2cb000897c739
😎 Deploy Preview https://deploy-preview-431--signalwire-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 25 (🔴 down 3 from production)
Accessibility: 91 (no change from production)
Best Practices: 92 (no change from production)
SEO: 89 (no change from production)
PWA: -
View the detailed breakdown and full score reports

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

@github-actions
Copy link

github-actions bot commented Jul 31, 2025

yarn run v1.22.22
$ /home/runner/work/docs/docs/node_modules/.bin/ts-node tools/scripts/generate-matrix.ts

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
specs/compatibility-api/_spec_.yaml 72/100
(=) ⚪
69/100
(=) ⚪
79/100
(=) ⚪
39/100
(=) ⚪
65/100
(=) ⚪
468
(=) ⚪
368
(=) ⚪
View
specs/signalwire-rest/calling-api/tsp-output/@typespec/openapi3/openapi.yaml 99/100
(+1.0) 🟢
99/100
(+4.0) 🟢
100/100
(=) ⚪
83/100
(+31.0) 🟢
95/100
(+9.0) 🟢
12
(-4) 🟢
1
(-4) 🟢
View
specs/signalwire-rest/chat-api/tsp-output/@typespec/openapi3/openapi.yaml 98/100
(=) ⚪
95/100
(=) ⚪
100/100
(=) ⚪
52/100
(=) ⚪
86/100
(=) ⚪
10
(=) ⚪
3
(=) ⚪
View
specs/signalwire-rest/datasphere-api/tsp-output/@typespec/openapi3/openapi.yaml 97/100
(=) ⚪
94/100
(=) ⚪
100/100
(=) ⚪
52/100
(=) ⚪
86/100
(=) ⚪
49
(=) ⚪
17
(=) ⚪
View
specs/signalwire-rest/fabric-api/tsp-output/@typespec/openapi3/openapi.yaml 99/100
(=) ⚪
99/100
(=) ⚪
100/100
(=) ⚪
84/100
(=) ⚪
95/100
(=) ⚪
557
(=) ⚪
2
(=) ⚪
View
specs/signalwire-rest/fax-api/tsp-output/@typespec/openapi3/openapi.yaml 99/100
(=) ⚪
99/100
(=) ⚪
100/100
(=) ⚪
84/100
(=) ⚪
95/100
(=) ⚪
10
(=) ⚪
1
(=) ⚪
View
specs/signalwire-rest/logs-api/tsp-output/@typespec/openapi3/openapi.yaml 98/100
(=) ⚪
95/100
(=) ⚪
100/100
(=) ⚪
52/100
(=) ⚪
86/100
(=) ⚪
9
(=) ⚪
4
(=) ⚪
View
specs/signalwire-rest/message-api/tsp-output/@typespec/openapi3/openapi.yaml 99/100
(=) ⚪
99/100
(=) ⚪
100/100
(=) ⚪
84/100
(=) ⚪
95/100
(=) ⚪
10
(=) ⚪
1
(=) ⚪
View
specs/signalwire-rest/project-api/_spec_.yaml 76/100
(=) ⚪
73/100
(=) ⚪
69/100
(=) ⚪
36/100
(=) ⚪
64/100
(=) ⚪
21
(=) ⚪
14
(=) ⚪
View
specs/signalwire-rest/pubsub-api/tsp-output/@typespec/openapi3/openapi.yaml 99/100
(=) ⚪
99/100
(=) ⚪
100/100
(=) ⚪
84/100
(=) ⚪
95/100
(=) ⚪
5
(=) ⚪
1
(=) ⚪
View
specs/signalwire-rest/space-api/_spec_.yaml Failed to process
specs/signalwire-rest/video-api/_spec_.yaml 86/100
(=) ⚪
85/100
(=) ⚪
86/100
(=) ⚪
39/100
(=) ⚪
74/100
(=) ⚪
179
(=) ⚪
131
(=) ⚪
View
specs/signalwire-rest/voice-api/tsp-output/@typespec/openapi3/openapi.yaml 99/100
(=) ⚪
99/100
(=) ⚪
100/100
(=) ⚪
84/100
(=) ⚪
95/100
(=) ⚪
10
(=) ⚪
1
(=) ⚪
View

Done in 147.78s.

@Devon-White Devon-White merged commit f6ce3df into main Oct 20, 2025
6 checks passed
@Devon-White Devon-White deleted the Devon/Calling-api-updates branch October 20, 2025 16:45
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.

2 participants