Tray.ai · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Tray Ai Solutions API

5 actions 5 updates phrasing extends openapi/tray-ai-solutions-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 5

$.info
$.paths['/graphql#getSolutions'].post
$.paths['/ '].post
$.paths['/core/v1/solutions/{solutionId}/releases/previews'].post
$.paths['/core/v1/solutions/{solutionId}/releases'].post

OpenAPI Overlay

Raw ↑
# 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 Solutions API
  version: 1.0.0
extends: openapi/tray-ai-solutions-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: 4
- target: $.paths['/graphql#getSolutions'].post
  update:
    x-apievangelist-phrasing:
      intent: Query published solutions via GraphQL
      effect: read
      questions:
      - Which published integrations are available in my embedded application, queried over GraphQL?
      - Can I paginate the GraphQL getSolutions query?
      instructions:
      - text: Run the getSolutions GraphQL query {query} with my master token.
        slots:
          query: requestBody.query
      - text: Query GraphQL for published solutions using pagination variables {variables}.
        slots:
          variables: requestBody.variables
      method: generated
      generated: '2026-09-26'
- target: $.paths['/         '].post
  update:
    x-apievangelist-phrasing:
      intent: Get solutions via the embedded root endpoint
      effect: read
      questions:
      - Can I list solutions by posting to the embedded root endpoint with a master token?
      - Which embedded root call returns the solutions I have built?
      instructions:
      - text: Post a get-solutions request to the embedded root with {variables}.
        slots:
          variables: requestBody.variables
      - text: Fetch solutions through the embedded root endpoint.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/core/v1/solutions/{solutionId}/releases/previews'].post
  update:
    x-apievangelist-phrasing:
      intent: Preview the impact of publishing a solution
      effect: read
      questions:
      - Will publishing my draft solution introduce breaking changes for existing instances?
      - Can I check a release's impact before I publish it?
      instructions:
      - text: Preview the publish impact for solution {solution}.
        slots:
          solution: path.solutionId
      - text: Check for breaking changes before releasing solution {solution}.
        slots:
          solution: path.solutionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/core/v1/solutions/{solutionId}/releases'].post
  update:
    x-apievangelist-phrasing:
      intent: Publish a draft solution
      effect: write
      questions:
      - How do I publish my draft solution so instances get the new version?
      - Are solution instances upgraded automatically when I publish?
      instructions:
      - text: Publish the draft of solution {solution}.
        slots:
          solution: path.solutionId
      - text: Release solution {solution} and auto-upgrade instances if nothing breaks.
        slots:
          solution: path.solutionId
      method: generated
      generated: '2026-09-26'