IntegrationOS · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for One Link Templates API

6 actions 6 updates phrasing extends openapi/integration-os-link-templates-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/v1/link-templates/organizations/{org_id}'].get

$.paths['/v1/link-templates/organizations/{org_id}'].post

$.paths['/v1/link-templates/organizations/{org_id}/{id}'].get

$.paths['/v1/link-templates/organizations/{org_id}/{id}'].put

$.paths['/v1/link-templates/organizations/{org_id}/{id}'].delete

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 One Link Templates API
  version: 1.0.0
extends: openapi/integration-os-link-templates-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/v1/link-templates/organizations/{org_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: List connect link templates
      effect: read
      questions:
      - Which link templates has my organization set up?
      - Can I page through all the branded connect-link templates?
      instructions:
      - text: List link templates for organization {org_id}.
        slots:
          org_id: path.org_id
      - text: Show {limit} of org {org_id}'s link templates per page.
        slots:
          org_id: path.org_id
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/link-templates/organizations/{org_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a connect link template
      effect: write
      questions:
      - How do I create a branded template for customer connect links?
      - Can a link template carry its own welcome and success messages plus light and dark logos?
      instructions:
      - text: Create template {name} in org {org_id} titled {customer_facing_name}, welcome {welcome_message}, success {success_message}, rules {connector_rules}.
        slots:
          name: requestBody.name
          org_id: path.org_id
          customer_facing_name: requestBody.customerFacingName
          welcome_message: requestBody.welcomeMessage
          success_message: requestBody.successMessage
          connector_rules: requestBody.connectorRules
      - text: Make a new link template for org {org_id} with logo {light_logo_url}.
        slots:
          org_id: path.org_id
          light_logo_url: requestBody.lightLogoUrl
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/link-templates/organizations/{org_id}/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a link template
      effect: read
      questions:
      - How do I view the settings of one existing link template?
      - What connector rules and messages does a given template use?
      instructions:
      - text: Get link template {id} in organization {org_id}.
        slots:
          id: path.id
          org_id: path.org_id
      - text: Show the configuration of template {id} for org {org_id}.
        slots:
          id: path.id
          org_id: path.org_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/link-templates/organizations/{org_id}/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a link template
      effect: write
      questions:
      - Can I change the welcome message on a link template I already made?
      - How do I swap the dark-mode logo on an existing connect template?
      instructions:
      - text: Update link template {id} in org {org_id} with welcome message {welcome_message}.
        slots:
          id: path.id
          org_id: path.org_id
          welcome_message: requestBody.welcomeMessage
      - text: Set the dark logo on existing template {id} for org {org_id} to {dark_logo_url}.
        slots:
          id: path.id
          org_id: path.org_id
          dark_logo_url: requestBody.darkLogoUrl
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/link-templates/organizations/{org_id}/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a link template
      effect: destructive
      questions:
      - How do I remove a link template we no longer use?
      - Can I delete a connect-link template from my organization?
      instructions:
      - text: Delete link template {id} in organization {org_id}.
        slots:
          id: path.id
          org_id: path.org_id
      - text: Remove template {id} from org {org_id}.
        slots:
          id: path.id
          org_id: path.org_id
      method: generated
      generated: '2026-10-01'