Remove (Old) CXML Applications - 13601

[cassieemb]

REST API Update Pull Request

Related Issue

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

Description

This PR removes the existing CXML Application fabric API endpoints. It is part of the epic to ensure the UI, API, and documentation are all aligned with the latest version of Call Fabric.

Type of Change

• New endpoint
• Update to existing endpoint

Motivation and Context

We are auditing our API endpoints for Call Fabric against the UI and documentation. There are many inconsistencies that have happened through rapid development, and this will undoubtedly be confusing for customers. We should make sure that all reflect the same functionality.

In the first iteration of call fabric, we had an resource type called 'CXML Applications'. (note: this is not the CXML applications you see in the UI - see LaML Applications in main ticket for more detail on this).They were meant to allow a user to select whether they want to use a hosted script or an external URL, and contained the necessary configuration details depending on the answer.

The ability to create or use these has gone away entirely from the UI, but we still have the API endpoints and documentation.

LaML Applications will be renamed CXML Applications for consistency with CXML Webhooks and CXML Scripts, so we to get rid of these first.

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

The build is failing on compilation because of a guide that references these deleted endpoints: /compatibility-api/guides/general/creating-and-using-cxml-applications

[ERROR] Error: Unable to build website for locale en-US.
    at tryToBuildLocale (/Users/cassiebowles/Prime/docs/node_modules/@docusaurus/core/lib/commands/build/build.js:78:15)
    at async /Users/cassiebowles/Prime/docs/node_modules/@docusaurus/core/lib/commands/build/build.js:34:9
    ... 4 lines matching cause stack trace ...
    at async file:///Users/cassiebowles/Prime/docs/node_modules/@docusaurus/core/bin/docusaurus.mjs:44:3 {
  [cause]: Error: Docusaurus found broken links!

  Please check the pages of your site in the list below, and make sure you don't reference any path that does not exist.
  Note: it's possible to ignore broken links with the 'onBrokenLinks' Docusaurus configuration, and let the build pass.

  Exhaustive list of all broken links found:
  - Broken link on source page path = /compatibility-api/guides/general/creating-and-using-cxml-applications:
     -> linking to /rest/signalwire-rest/endpoints/fabric/c-xml-application

      at throwError (/Users/cassiebowles/Prime/docs/node_modules/@docusaurus/logger/lib/logger.js:80:11)
      at reportBrokenLinks (/Users/cassiebowles/Prime/docs/node_modules/@docusaurus/core/lib/server/brokenLinks.js:250:47)
      at handleBrokenLinks (/Users/cassiebowles/Prime/docs/node_modules/@docusaurus/core/lib/server/brokenLinks.js:282:5)
      at executeBrokenLinksCheck (/Users/cassiebowles/Prime/docs/node_modules/@docusaurus/core/lib/commands/build/buildLocale.js:91:47)
      at /Users/cassiebowles/Prime/docs/node_modules/@docusaurus/core/lib/commands/build/buildLocale.js:70:67
      at Object.async (/Users/cassiebowles/Prime/docs/node_modules/@docusaurus/logger/lib/perfLogger.js:42:47)
      at buildLocale (/Users/cassiebowles/Prime/docs/node_modules/@docusaurus/core/lib/commands/build/buildLocale.js:70:31)
      at async runBuildLocaleTask (/Users/cassiebowles/Prime/docs/node_modules/@docusaurus/core/lib/commands/build/build.js:93:5)
      at async /Users/cassiebowles/Prime/docs/node_modules/@docusaurus/core/lib/commands/build/build.js:74:13
      at async tryToBuildLocale (/Users/cassiebowles/Prime/docs/node_modules/@docusaurus/core/lib/commands/build/build.js:70:9)
      at async /Users/cassiebowles/Prime/docs/node_modules/@docusaurus/core/lib/commands/build/build.js:34:9
      at async mapAsyncSequential (/Users/cassiebowles/Prime/docs/node_modules/@docusaurus/utils/lib/jsUtils.js:21:24)
      at async Command.build (/Users/cassiebowles/Prime/docs/node_modules/@docusaurus/core/lib/commands/build/build.js:33:5)
      at async Promise.all (index 0)
      at async runCLI (/Users/cassiebowles/Prime/docs/node_modules/@docusaurus/core/lib/commands/cli.js:56:5)
      at async file:///Users/cassiebowles/Prime/docs/node_modules/@docusaurus/core/bin/docusaurus.mjs:44:3

I'm not sure whether we want to delete the document, or modify it, or something along those lines? I left it alone for now

[netlify]

❌ Deploy Preview for signalwire-docs failed.

Name	Link
🔨 Latest commit	d012b7f
🔍 Latest deploy log	https://app.netlify.com/sites/signalwire-docs/deploys/67f83123683dc400080dd368

[github-actions]

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	73/100 (-1.0) 🔴	70/100 (-1.0) 🔴	90/100 (-1.0) 🔴	44/100 (=) ⚪	69/100 (-1.0) 🔴	646 (-45) 🟢	371 (-11) 🟢	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

[netlify]

✅ Deploy Preview for signalwire-docs ready!

Name	Link
🔨 Latest commit	af1c013
🔍 Latest deploy log	https://app.netlify.com/sites/signalwire-docs/deploys/6802b2aca9b76a0008479e46
😎 Deploy Preview	https://deploy-preview-188--signalwire-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

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

[imfaruk]

LGTM!