# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for One OAuth API
  version: 1.0.0
extends: openapi/integration-os-oauth-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: 7
- target: $.paths['/oauth/authorize/actions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a platform's actions for the consent card
      effect: read
      questions:
      - Which actions of a platform can the connect card offer in its custom picker?
      - Can I page through a platform's action catalog during an OAuth consent?
      instructions:
      - text: List the actions for {platform} in consent ceremony {state_key}.
        slots:
          platform: query.platform
          state_key: query.state_key
      - text: Show {limit} {platform} actions per page for the picker in ceremony {state_key}.
        slots:
          limit: query.limit
          platform: query.platform
          state_key: query.state_key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/oauth/authorize/actions/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search a platform's actions in the consent card
      effect: read
      questions:
      - Can the connect card search a platform's actions by text?
      - How do I find a specific action by keyword while picking permissions?
      instructions:
      - text: Search {platform} actions for {query} in consent ceremony {state_key}.
        slots:
          platform: query.platform
          query: query.query
          state_key: query.state_key
      - text: Find picker actions matching {query} on {platform} for ceremony {state_key}.
        slots:
          query: query.query
          platform: query.platform
          state_key: query.state_key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/oauth/authorize/activate'].post
  update:
    x-apievangelist-phrasing:
      intent: Stand up an offered connector during consent
      effect: write
      questions:
      - What happens when an end user picks a connector that is offered but not yet set up?
      - Can the consent card activate a prospective connector so it can be connected?
      instructions:
      - text: Activate connector {connector} for consent ceremony {state_key}.
        slots:
          connector: requestBody.connector
          state_key: query.state_key
      - text: Stand up prospective connector {connector} in ceremony {state_key} so the user can connect it.
        slots:
          connector: requestBody.connector
          state_key: query.state_key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/oauth/authorize/connect'].post
  update:
    x-apievangelist-phrasing:
      intent: Start connecting a platform from the card
      effect: write
      questions:
      - Which platforms can a user still add from the OAuth connect card?
      - How does the card record the OAuth request for the platform a user picks?
      instructions:
      - text: List connectable platforms and open a connect request for ceremony {state_key}.
        slots:
          state_key: query.state_key
      - text: Begin a connection named {name} for identity {identity} in consent ceremony {state_key}.
        slots:
          name: requestBody.name
          identity: requestBody.identity
          state_key: query.state_key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/oauth/authorize/connections'].get
  update:
    x-apievangelist-phrasing:
      intent: List connections the user already holds
      effect: read
      questions:
      - Which of the requested connectors has the signed-in user already connected?
      - Can the connect card avoid asking someone to reconnect an account they have?
      instructions:
      - text: Show the user's existing connections for consent ceremony {state_key}.
        slots:
          state_key: query.state_key
      - text: List already-held connections in ceremony {state_key}, page {page}.
        slots:
          state_key: query.state_key
          page: query.page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/oauth/authorize/context'].get
  update:
    x-apievangelist-phrasing:
      intent: Load the context for a consent ceremony
      effect: read
      questions:
      - What does the connect card need to render an in-progress OAuth consent?
      - Can the card tell whether anyone is signed in before showing sign-in?
      instructions:
      - text: Load the consent ceremony context for state key {state_key}.
        slots:
          state_key: query.state_key
      - text: Check who is signed in for authorization {state_key}.
        slots:
          state_key: query.state_key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/oauth/authorize/prior-grant'].get
  update:
    x-apievangelist-phrasing:
      intent: Read the user's prior grant for reconnect
      effect: read
      questions:
      - What did a user already grant this OAuth client, so a reconnect does not widen it?
      - Can a reconnect card pre-select the account and access level granted before?
      instructions:
      - text: Get the user's existing grant for consent ceremony {state_key}.
        slots:
          state_key: query.state_key
      - text: Read the prior grant for ceremony {state_key} in project {project}.
        slots:
          state_key: query.state_key
          project: header.X-One-Project-Id
      method: generated
      generated: '2026-10-01'