Skip to content

Rename LAML bin to CXML Script #162

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 12 commits into from
Apr 25, 2025
Merged

Conversation

diego-signalwire
Copy link
Contributor

@diego-signalwire diego-signalwire commented Apr 7, 2025

REST API Update Pull Request

Related Issue

https://github.com/signalwire/prime-rails/pull/7069

Description

  • Update LAML Bins endpoint to cXML Scripts
  • Update External LAML Handler endpoints to CXML Webhook

Type of Change

  • New endpoint
  • Update to existing endpoint

Motivation and Context

LaML Bins now is being called CXML Scripts
External LaML Handlers Bins now is being called CXML Webhooks

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.

Copy link

netlify bot commented Apr 7, 2025

Deploy Preview for signalwire-docs ready!

Name Link
🔨 Latest commit 0dfff0d
🔍 Latest deploy log https://app.netlify.com/sites/signalwire-docs/deploys/680b75174657810008fc5274
😎 Deploy Preview https://deploy-preview-162--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 8, 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
(=) ⚪
71/100
(=) ⚪
91/100
(=) ⚪
44/100
(=) ⚪
70/100
(=) ⚪
692
(=) ⚪
390
(+6) 🔴
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 14, 2025 16:29
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.

Looks great, just one spot where we have CXML Application instead of CXML Webhook!

cassieemb
cassieemb previously approved these changes Apr 17, 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 https://deploy-preview-162--signalwire-docs.netlify.app/rest/signalwire-rest/endpoints/fabric/external-laml-handler

Per the description at the top, external laml handlers should be renamed to CXML Webhook, however they are still showing as external laml handlers. Perhaps the changes werent moved to the _spec_.yaml file.

Additionally, once this is fixed, Ill need to go in and add redirects from the old links to the new links, then we should be good to go! :)

@Devon-White Devon-White merged commit b7c59bc into main Apr 25, 2025
6 checks passed
@Devon-White Devon-White deleted the diego/13616/align-laml-vs-cxml-docs branch April 25, 2025 12:48
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.

4 participants