Add Short Code Endpoints

[cassieemb]

REST API Update Pull Request

Related Issue

If there's an issue available, link it here: Issue #17328

Description

We have an endpoint under relay/rest that lists short codes in the same way that the /phone_numbers endpoint does. However, all three of the supported actions (index, show, update) are currently undocumented. This PR adds the three endpoints, request params, and response bodies.

Type of Change

• New endpoint
• Update to existing endpoint

Motivation and Context

I noticed this was missing, and verified it was working as intended. Since it's working and there is no reason for it to be hidden, we should expose it to customers to allow them programmatic control.

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.

Notes

This worked for me in a SWAGGER tool, but I couldn't get it to show on the website build locally - not sure if I'm missing a step for that part, so I thought I'd push it to see if it built correctly here.
It does look correct to me on the preview now!

[netlify]

❌ Deploy Preview for signalwire-docs failed.

Name	Link
🔨 Latest commit	31b3ba8
🔍 Latest deploy log	https://app.netlify.com/projects/signalwire-docs/deploys/696a1aba16eacb00083b6ba8

[github-actions]

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 (=) ⚪	476 (=) ⚪	373 (=) ⚪	View
specs/signalwire-rest/calling-api/tsp-output/@typespec/openapi3/openapi.yaml	99/100 (=) ⚪	99/100 (=) ⚪	100/100 (=) ⚪	83/100 (=) ⚪	95/100 (=) ⚪	6 (=) ⚪	1 (=) ⚪	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	❌	❌	❌	❌	❌	❌	❌	Failed to process
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	77/100 (+1.0) 🟢	74/100 (+1.0) 🟢	88/100 (=) ⚪	40/100 (=) ⚪	70/100 (+1.0) 🟢	398 (+18) 🔴	287 (+12) 🔴	View
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 (=) ⚪	15 (=) ⚪	1 (=) ⚪	View

Done in 138.91s.

[diego-signalwire]

LGTM!