BrowserStack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for BrowserStack Automate REST Builds API

4 actions 4 updates phrasing extends openapi/browserstack-builds-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for BrowserStack's API. It is a proposal applied on top of the contract, not a document BrowserStack publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/automate/builds.json'].get

$.paths['/automate/builds/{buildId}.json'].put

$.paths['/automate/builds/{buildId}.json'].delete

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 BrowserStack Automate REST Builds API
  version: 1.0.0
extends: openapi/browserstack-builds-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['/automate/builds.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List recent test builds
      effect: read
      questions:
      - How do I see my recent BrowserStack Automate builds?
      - Can I filter my builds to only the ones that failed or are still running?
      - Is there a way to page through older builds?
      instructions:
      - text: List my {limit} most recent Automate builds.
        slots:
          limit: query.limit
      - text: Show builds with status {status}.
        slots:
          status: query.status
      - text: List builds starting at offset {offset}.
        slots:
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/automate/builds/{buildId}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename a test build
      effect: write
      questions:
      - Can I rename a build after its tests have run?
      - How do I change the name shown on an existing Automate build?
      instructions:
      - text: Rename build {buildId} to {name}.
        slots:
          buildId: path.buildId
          name: requestBody.name
      - text: Update the name of build {buildId}.
        slots:
          buildId: path.buildId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/automate/builds/{buildId}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a test build
      effect: destructive
      questions:
      - How do I delete an old build from my Automate dashboard?
      - Can I remove a build I no longer need through the API?
      instructions:
      - text: Delete build {buildId}.
        slots:
          buildId: path.buildId
      - text: Remove the Automate build {buildId} permanently.
        slots:
          buildId: path.buildId
      method: generated
      generated: '2026-10-01'