IntegrationOS · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for One Connection OAuth Definitions API

4 actions 4 updates phrasing extends openapi/integration-os-connection-oauth-definitions-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 4

$.info

$.paths['/v1/connection-oauth-definitions'].get

$.paths['/v1/connection-oauth-definitions/view/id/{id}'].get

$.paths['/v1/connection-oauth-definitions/view/{platform}'].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 One Connection OAuth Definitions API
  version: 1.0.0
extends: openapi/integration-os-connection-oauth-definitions-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: 3
- target: $.paths['/v1/connection-oauth-definitions'].get
  update:
    x-apievangelist-phrasing:
      intent: List connection OAuth definitions
      effect: read
      questions:
      - Which platforms have OAuth definitions set up for connections?
      - Can I page through every connection OAuth definition?
      instructions:
      - text: List all connection OAuth definitions.
      - text: Show {limit} connection OAuth definitions on page {page}.
        slots:
          limit: query.limit
          page: query.page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/connection-oauth-definitions/view/id/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a connection OAuth definition by id
      effect: read
      questions:
      - How do I fetch one connection OAuth definition when I have its id?
      - What does a single OAuth definition record contain?
      instructions:
      - text: Get connection OAuth definition {id}.
        slots:
          id: path.id
      - text: Retrieve the OAuth definition with id {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/connection-oauth-definitions/view/{platform}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a platform's connection OAuth definition
      effect: read
      questions:
      - How is OAuth configured for connecting a specific platform?
      - Can I look up an OAuth definition by platform name instead of id?
      instructions:
      - text: Show the connection OAuth definition for the {platform} platform.
        slots:
          platform: path.platform
      - text: Look up how {platform} connections authenticate via OAuth.
        slots:
          platform: path.platform
      method: generated
      generated: '2026-10-01'