# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for BrowserStack Automate REST Projects API
  version: 1.0.0
extends: openapi/browserstack-projects-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['/automate/projects.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List Automate projects
      effect: read
      questions:
      - What projects do I have in BrowserStack Automate?
      - Where can I see all the test projects on my account?
      instructions:
      - text: List all my Automate projects.
      - text: Show me every project on the account with its id.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/automate/projects/{projectId}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of one project
      effect: read
      questions:
      - How do I look up the details of a single Automate project?
      - What can I see about one specific project by its id?
      instructions:
      - text: Get the details of project {projectId}.
        slots:
          projectId: path.projectId
      - text: Show me project {projectId}.
        slots:
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/automate/projects/{projectId}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename a project
      effect: write
      questions:
      - Can I rename an existing Automate project?
      - How do I change a project's display name?
      instructions:
      - text: Rename project {projectId} to {name}.
        slots:
          projectId: path.projectId
          name: requestBody.name
      - text: Update the name of project {projectId}.
        slots:
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/automate/projects/{projectId}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an empty project
      effect: destructive
      questions:
      - How do I delete an Automate project?
      - Why can't I delete a project that still has builds or sessions in it?
      instructions:
      - text: Delete project {projectId}.
        slots:
          projectId: path.projectId
      - text: Remove the empty project {projectId} from my account.
        slots:
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/automate/projects/{projectId}/badge_key'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a project's status badge key
      effect: read
      questions:
      - How do I get the status badge key to show build status in my README?
      - Where do I find the badge key for a project's build status badge?
      instructions:
      - text: Get the status badge key for project {projectId}.
        slots:
          projectId: path.projectId
      - text: Fetch the badge key so I can embed project {projectId}'s status badge.
        slots:
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'