Tray.ai · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Tray Ai Deployments API

4 actions 4 updates phrasing extends openapi/tray-ai-deployments-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Tray.ai's API. It is a proposal applied on top of the contract, not a document Tray.ai publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/connectors/{connectorName}/versions/{connectorVersion}/deploy'].post

$.paths['/cdk/v1/deployments/connectors/{connector-name}/versions/{connector-version}/deploy-connector-from-source'].post

$.paths['/cdk/v1/deployments/connectors/{connector-name}/versions/{connector-version}/{id}'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Tray Ai Deployments API
  version: 1.0.0
extends: openapi/tray-ai-deployments-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/connectors/{connectorName}/versions/{connectorVersion}/deploy'].post
  update:
    x-apievangelist-phrasing:
      intent: Deploy a CDK connector bundle
      effect: write
      questions:
      - How do I deploy a connector I built with the Connector Development Kit?
      - Must the connector name and version match my connector.json when deploying a bundle?
      instructions:
      - text: Deploy CDK connector {connector} version {version} from bundle {bundle}.
        slots:
          connector: path.connectorName
          version: path.connectorVersion
          bundle: requestBody.connectorBundle
      - text: Upload the built bundle for {connector} {version} to Tray.
        slots:
          connector: path.connectorName
          version: path.connectorVersion
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cdk/v1/deployments/connectors/{connector-name}/versions/{connector-version}/deploy-connector-from-source'].post
  update:
    x-apievangelist-phrasing:
      intent: Deploy a connector from source
      effect: write
      questions:
      - Can Tray build and deploy my custom connector straight from source?
      - Which call starts a deployment from source for a connector version?
      instructions:
      - text: Start a from-source deployment of connector {connector} version {version}.
        slots:
          connector: path.connector-name
          version: path.connector-version
      - text: Kick off deploy-from-source for {connector} {version}.
        slots:
          connector: path.connector-name
          version: path.connector-version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cdk/v1/deployments/connectors/{connector-name}/versions/{connector-version}/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a connector deployment's status
      effect: read
      questions:
      - Has my connector deployment finished yet?
      - What status is a given connector deployment in?
      instructions:
      - text: Check the status of deployment {deployment} for connector {connector} version {version}.
        slots:
          deployment: path.id
          connector: path.connector-name
          version: path.connector-version
      - text: Tell me whether deployment {deployment} of {connector} {version} succeeded.
        slots:
          deployment: path.id
          connector: path.connector-name
          version: path.connector-version
      method: generated
      generated: '2026-09-26'