# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Method Opal API
  version: 1.0.0
extends: openapi/methodfi-opal-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['/opal/token'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the current Opal session
      effect: read
      questions:
      - What state is the Opal session behind my token in?
      - Can I check an Opal session's progress using its token?
      instructions:
      - text: Get the Opal session for my current token on API version {version}.
        slots:
          version: header.Method-Version
      - text: Show the state of the active Opal session.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/opal/token'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an Opal token and session
      effect: write
      questions:
      - How do I launch Opal for an existing entity in a given mode?
      - Can I create an extra Opal token for a session that already exists?
      instructions:
      - text: Create an Opal token for entity {entity} in mode {mode}.
        slots:
          entity: requestBody.entity_id
          mode: requestBody.mode
      - text: Create another Opal token for existing session {session}.
        slots:
          session: requestBody.session_id
      - text: Start an Opal session in mode {mode} for new entity {entity_details}.
        slots:
          mode: requestBody.mode
          entity_details: requestBody.entity
      method: generated
      generated: '2026-10-01'
- target: $.paths['/opal/token'].delete
  update:
    x-apievangelist-phrasing:
      intent: Deactivate the current Opal token
      effect: destructive
      questions:
      - How do I stop an Opal token from being used again?
      - Can I revoke the Opal token I'm authenticated with?
      instructions:
      - text: Deactivate my current Opal token on API version {version}.
        slots:
          version: header.Method-Version
      - text: Revoke the authenticated Opal token now.
      method: generated
      generated: '2026-10-01'