Skip to content
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

Add missing base content #11

Open
wants to merge 1 commit into
base: faruk/typespec/convert-cxml-application
Choose a base branch
from

Conversation

imfaruk
Copy link

@imfaruk imfaruk commented Dec 31, 2024

REST API Update Pull Request

Related Issue

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

Description

All Fabric resource types(Call Flow, AI agent, Cxml Application etc) shares a base content. Here is a Get endpoint of a Cxml Application Fabric Resource.

{
    "id": "99151cf8-9548-4860-ba70-a8de824f3312",
    "project_id": "e8f48a64-d62b-4bd5-a8d6-b26824a19cb5",
    "display_name": "Test Voice Handler ",
    "type": "cxml_application",
    "created_at": "2024-07-31T22:25:14Z",
    "updated_at": "2024-07-31T22:25:14Z",
    "cxml_application": {
        "id": "cd2b14c0-6cb6-4901-b306-0347de81fcda",
        "name": "Test Voice Handler ",
        "handle_calls_using": "script",
        "call_handler_url": "https://bowl-test.signalwire.com/laml-bins/00b49f7a-dbf8-492c-9db3-139cd77320e5",
        "call_handler_method": "POST",
        "handle_fallback_using": "script",
        "call_handler_fallback_url": "https://bowl-test.signalwire.com/laml-bins/e59fcfbd-0046-4ed0-9e48-141a3c79beaf",
        "call_handler_fallback_method": "POST",
        "call_status_callback_url": "",
        "call_status_callback_method": "POST"
    }
}

id, project_id, display_name, type, created_at, updated_at are base content. The key cxml_application and its content can differ depending on the type of Fabric Resource.

All the Fabric Resources endpoints that are in TypeSpec are missing this base conent.

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.

@imfaruk imfaruk changed the base branch from main to faruk/typespec/convert-cxml-application December 31, 2024 11:15
Copy link

netlify bot commented Dec 31, 2024

Deploy Preview for signalwire-docs ready!

Name Link
🔨 Latest commit 5963252
🔍 Latest deploy log https://app.netlify.com/sites/signalwire-docs/deploys/6773d25af19440000859c980
😎 Deploy Preview https://deploy-preview-11--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.

@imfaruk imfaruk changed the title Faruk/add missing base content Add missing base content Dec 31, 2024
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.

1 participant