# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for airbyte-api Public Workspaces API
  version: 1.0.0
extends: openapi/airbyte-public-workspaces-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: 6
- target: $.paths['/workspaces'].get
  update:
    x-apievangelist-phrasing:
      intent: List workspaces
      effect: read
      questions:
      - What workspaces do I have access to?
      - Can I include deleted workspaces in the list?
      instructions:
      - text: List all my workspaces.
      - text: List workspaces including deleted ones, up to {limit} results.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a workspace
      effect: write
      questions:
      - How do I create a new workspace?
      - Can I create a workspace in a specific organization and region?
      instructions:
      - text: Create a workspace named {name}.
        slots:
          name: requestBody.name
      - text: Create workspace {name} in organization {organizationId} in region {regionId}.
        slots:
          name: requestBody.name
          organizationId: requestBody.organizationId
          regionId: requestBody.regionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/{workspaceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a workspace's details
      effect: read
      questions:
      - How do I look up one workspace's settings?
      - Which region and notifications does a workspace have configured?
      instructions:
      - text: Get workspace {workspaceId}.
        slots:
          workspaceId: path.workspaceId
      - text: Show the details of workspace {workspaceId}.
        slots:
          workspaceId: path.workspaceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/{workspaceId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a workspace
      effect: destructive
      questions:
      - How do I delete a workspace?
      - Can I remove a workspace I no longer need?
      instructions:
      - text: Delete workspace {workspaceId}.
        slots:
          workspaceId: path.workspaceId
      - text: Remove the workspace {workspaceId}.
        slots:
          workspaceId: path.workspaceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/{workspaceId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a workspace's name, region or notifications
      effect: write
      questions:
      - How do I rename an existing workspace?
      - Can I change a workspace's notification settings?
      instructions:
      - text: Rename workspace {workspaceId} to {name}.
        slots:
          workspaceId: path.workspaceId
          name: requestBody.name
      - text: Update notifications on workspace {workspaceId} to {notifications}.
        slots:
          workspaceId: path.workspaceId
          notifications: requestBody.notifications
      - text: Move workspace {workspaceId} to region {regionId}.
        slots:
          workspaceId: path.workspaceId
          regionId: requestBody.regionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/{workspaceId}/oauthCredentials'].put
  update:
    x-apievangelist-phrasing:
      intent: Set workspace OAuth override credentials for a connector
      effect: write
      questions:
      - How do I use my own OAuth app credentials for a connector in just one workspace?
      - Can I override the default OAuth credentials for a source in a single workspace?
      instructions:
      - text: Set OAuth override credentials for {actorType} {name} in workspace {workspaceId} to {configuration}.
        slots:
          actorType: requestBody.actorType
          name: requestBody.name
          workspaceId: path.workspaceId
          configuration: requestBody.configuration
      - text: Use my own OAuth app {configuration} for {actorType} connector {name} in workspace {workspaceId} only.
        slots:
          configuration: requestBody.configuration
          actorType: requestBody.actorType
          name: requestBody.name
          workspaceId: path.workspaceId
      method: generated
      generated: '2026-09-26'