Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Reactor Builds API

5 actions 5 updates phrasing extends openapi/adobe-suite-builds-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/libraries/{LIBRARY_ID}/builds'].get

$.paths['/libraries/{LIBRARY_ID}/builds'].post

$.paths['/builds/{BUILD_ID}'].get

$.paths['/builds/{BUILD_ID}'].patch

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 Reactor Builds API
  version: 1.0.0
extends: openapi/adobe-suite-builds-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: 4
- target: $.paths['/libraries/{LIBRARY_ID}/builds'].get
  update:
    x-apievangelist-phrasing:
      intent: List a tags library's builds
      effect: read
      questions:
      - How do I see all the builds that were made from a tags library?
      - Can I filter a library's builds by status or creation date?
      instructions:
      - text: List the builds for library {LIBRARY_ID}.
        slots:
          LIBRARY_ID: path.LIBRARY_ID
      - text: Show builds of library {LIBRARY_ID} with status {status}.
        slots:
          LIBRARY_ID: path.LIBRARY_ID
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/libraries/{LIBRARY_ID}/builds'].post
  update:
    x-apievangelist-phrasing:
      intent: Build a tags library
      effect: write
      questions:
      - How can I create a new build of a library so its changes can be published?
      - Does creating a build need any payload?
      instructions:
      - text: Create a build for library {LIBRARY_ID}.
        slots:
          LIBRARY_ID: path.LIBRARY_ID
      - text: Kick off a new build of tags library {LIBRARY_ID}.
        slots:
          LIBRARY_ID: path.LIBRARY_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/builds/{BUILD_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a build
      effect: read
      questions:
      - How do I check the status of one build by its ID?
      - Can I see the details of a specific tags build?
      instructions:
      - text: Show build {BUILD_ID}.
        slots:
          BUILD_ID: path.BUILD_ID
      - text: Get the status and details of build {BUILD_ID}.
        slots:
          BUILD_ID: path.BUILD_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/builds/{BUILD_ID}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Republish an existing build
      effect: write
      questions:
      - Can I republish a build without creating a new one?
      - Why must the build ID appear in both the path and the payload when republishing?
      instructions:
      - text: Republish build {BUILD_ID} using payload {data}.
        slots:
          BUILD_ID: path.BUILD_ID
          data: requestBody.data
      - text: Push build {BUILD_ID} out again with data {data}.
        slots:
          BUILD_ID: path.BUILD_ID
          data: requestBody.data
      method: generated
      generated: '2026-09-26'