Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Reactor Libraries API

31 actions 31 updates phrasing extends openapi/adobe-suite-libraries-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 31 · first 16 shown; the file carries all of them

$.info
$.paths['/properties/{PROPERTY_ID}/libraries'].get
$.paths['/properties/{PROPERTY_ID}/libraries'].post
$.paths['/libraries/{LIBRARY_ID}'].get
$.paths['/libraries/{LIBRARY_ID}'].delete
$.paths['/libraries/{LIBRARY_ID}'].patch
$.paths['/libraries/{LIBRARY_ID}/property'].get
$.paths['/libraries/{LIBRARY_ID}/builds'].get
$.paths['/libraries/{LIBRARY_ID}/builds'].post
$.paths['/libraries/{LIBRARY_ID}/environment'].get
$.paths['/libraries/{LIBRARY_ID}/upstream_library'].get
$.paths['/libraries/{LIBRARY_ID}/data_elements'].get
$.paths['/libraries/{LIBRARY_ID}/relationships/data_elements'].get
$.paths['/libraries/{LIBRARY_ID}/relationships/data_elements'].post
$.paths['/libraries/{LIBRARY_ID}/relationships/data_elements'].delete
$.paths['/libraries/{LIBRARY_ID}/relationships/data_elements'].patch

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Reactor Libraries API
  version: 1.0.0
extends: openapi/adobe-suite-libraries-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: 30
- target: $.paths['/properties/{PROPERTY_ID}/libraries'].get
  update:
    x-apievangelist-phrasing:
      intent: List the libraries in a tags property
      effect: read
      questions:
      - What libraries exist in my Adobe tags property?
      - Can I filter a property's libraries by state or only show stale ones?
      - Which libraries in this property were updated recently?
      instructions:
      - text: List the libraries in property {property}.
        slots:
          property: path.PROPERTY_ID
      - text: Show libraries in property {property} that are in state {state}.
        slots:
          property: path.PROPERTY_ID
          state: query.state
      - text: Find the library named {name} in property {property}.
        slots:
          property: path.PROPERTY_ID
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/properties/{PROPERTY_ID}/libraries'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a library in a tags property
      effect: write
      questions:
      - How do I start a new library to bundle tag changes for publishing?
      - What do I need to supply to create a library under a property?
      instructions:
      - text: Create a new library in property {property}.
        slots:
          property: path.PROPERTY_ID
      - text: 'Set up a library in property {property} using this definition: {data}.'
        slots:
          property: path.PROPERTY_ID
          data: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/libraries/{LIBRARY_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a library's details
      effect: read
      questions:
      - How do I look up one tags library by its ID?
      - What state is a given library in right now?
      instructions:
      - text: Show me library {library}.
        slots:
          library: path.LIBRARY_ID
      - text: Get the current state and name of library {library}.
        slots:
          library: path.LIBRARY_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/libraries/{LIBRARY_ID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a library
      effect: destructive
      questions:
      - How do I permanently remove a tags library I no longer need?
      - Can I delete a library outright rather than just detaching its resources?
      instructions:
      - text: Delete library {library}.
        slots:
          library: path.LIBRARY_ID
      - text: Remove library {library} entirely.
        slots:
          library: path.LIBRARY_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/libraries/{LIBRARY_ID}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename a library or move it through publishing
      effect: write
      questions:
      - How do I rename a tags library?
      - Can I transition a library to submitted or approved through the API?
      - What action do I send to move a library to the next publishing state?
      instructions:
      - text: 'Rename library {library} with this payload: {data}.'
        slots:
          library: path.LIBRARY_ID
          data: requestBody.data
      - text: Submit library {library} for approval in the publishing flow.
        slots:
          library: path.LIBRARY_ID
      - text: Approve library {library} so it can be published.
        slots:
          library: path.LIBRARY_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/libraries/{LIBRARY_ID}/property'].get
  update:
    x-apievangelist-phrasing:
      intent: Find which property a library belongs to
      effect: read
      questions:
      - Which tags property owns this library?
      - How do I get from a library back to its parent property?
      instructions:
      - text: Show the property that library {library} belongs to.
        slots:
          library: path.LIBRARY_ID
      - text: Get the parent property of library {library}.
        slots:
          library: path.LIBRARY_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/libraries/{LIBRARY_ID}/builds'].get
  update:
    x-apievangelist-phrasing:
      intent: List a library's builds
      effect: read
      questions:
      - How do I see all the builds that were made from a library?
      - Can I filter a library's builds by build status?
      instructions:
      - text: List the builds for library {library}.
        slots:
          library: path.LIBRARY_ID
      - text: Show builds of library {library} with status {status}.
        slots:
          library: 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 library
      effect: write
      questions:
      - How do I kick off a build for a tags library?
      - Do I need to send a payload when building a library?
      instructions:
      - text: Build library {library}.
        slots:
          library: path.LIBRARY_ID
      - text: Start a new build of library {library} now.
        slots:
          library: path.LIBRARY_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/libraries/{LIBRARY_ID}/environment'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the environment a library is assigned to
      effect: read
      questions:
      - Which environment is this library currently deployed to?
      - How do I see full details of a library's environment?
      instructions:
      - text: Show the environment assigned to library {library}.
        slots:
          library: path.LIBRARY_ID
      - text: Get environment details for library {library}.
        slots:
          library: path.LIBRARY_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/libraries/{LIBRARY_ID}/upstream_library'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a library's upstream library
      effect: read
      questions:
      - What library sits upstream of this one in the publishing flow?
      - How can I see the library this one builds on top of?
      instructions:
      - text: Show the upstream library of library {library}.
        slots:
          library: path.LIBRARY_ID
      - text: Get the library upstream from {library}.
        slots:
          library: path.LIBRARY_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/libraries/{LIBRARY_ID}/data_elements'].get
  update:
    x-apievangelist-phrasing:
      intent: List the data elements in a library
      effect: read
      questions:
      - What data elements are included in a given library?
      - How do I page through the full data element records a library contains?
      instructions:
      - text: List the data elements in library {library}.
        slots:
          library: path.LIBRARY_ID
      - text: Show full data element details for library {library}.
        slots:
          library: path.LIBRARY_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/libraries/{LIBRARY_ID}/relationships/data_elements'].get
  update:
    x-apievangelist-phrasing:
      intent: List a library's data element links
      effect: read
      questions:
      - How do I get just the IDs of data elements linked to a library?
      - Can I see a library's data element relationships without full records?
      instructions:
      - text: List the data element relationship IDs for library {library}.
        slots:
          library: path.LIBRARY_ID
      - text: Show which data element IDs are linked to library {library}.
        slots:
          library: path.LIBRARY_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/libraries/{LIBRARY_ID}/relationships/data_elements'].post
  update:
    x-apievangelist-phrasing:
      intent: Add data elements to a library
      effect: write
      questions:
      - How do I add data elements to an existing library?
      - Can I attach several data elements to a library in one call?
      instructions:
      - text: Add data elements {data} to library {library}.
        slots:
          library: path.LIBRARY_ID
          data: requestBody.data
      - text: Include these data elements in library {library}.
        slots:
          library: path.LIBRARY_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/libraries/{LIBRARY_ID}/relationships/data_elements'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove data elements from a library
      effect: destructive
      questions:
      - How do I take specific data elements out of a library?
      - Can I detach a data element from a library without deleting it?
      instructions:
      - text: Remove data elements {data} from library {library}.
        slots:
          library: path.LIBRARY_ID
          data: requestBody.data
      - text: Detach these data elements from library {library}.
        slots:
          library: path.LIBRARY_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/libraries/{LIBRARY_ID}/relationships/data_elements'].patch
  update:
    x-apievangelist-phrasing:
      intent: Replace all data elements in a library
      effect: write
      questions:
      - How do I overwrite a library's full set of data elements at once?
      - Is there a way to swap every data element in a library for a new list?
      instructions:
      - text: Replace the data elements in library {library} with {data}.
        slots:
          library: path.LIBRARY_ID
          data: requestBody.data
      - text: Reset library {library} so it holds only these data elements.
        slots:
          library: path.LIBRARY_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/libraries/{LIBRARY_ID}/relationships/environment'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the environment link of a library
      effect: read
      questions:
      - How do I see just the environment ID a library is linked to?
      - Is this library attached to any environment at all?
      instructions:
      - text: Show the environment relationship for library {library}.
        slots:
          library: path.LIBRARY_ID
      - text: Check whether library {library} is linked to an environment.
        slots:
          library: path.LIBRARY_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/libraries/{LIBRARY_ID}/relationships/environment'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unassign a library from its environment
      effect: destructive
      questions:
      - How do I detach a library from its environment?
      - Can I clear a library's environment assignment?
      instructions:
      - text: Remove the environment from library {library}.
        slots:
          library: path.LIBRARY_ID
      - text: Unassign library {library} from its environment.
        slots:
          library: path.LIBRARY_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/libraries/{LIBRARY_ID}/relationships/environment'].patch
  update:
    x-apievangelist-phrasing:
      intent: Assign a library to an environment
      effect: write
      questions:
      - How do I point a library at a development or staging environment?
      - Can I change which environment a library is assigned to?
      instructions:
      - text: Assign library {library} to environment {data}.
        slots:
          library: path.LIBRARY_ID
          data: requestBody.data
      - text: Set the environment for library {library}.
        slots:
          library: path.LIBRARY_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/libraries/{LIBRARY_ID}/extensions'].get
  update:
    x-apievangelist-phrasing:
      intent: List the extensions in a library
      effect: read
      questions:
      - What extensions are packaged in this library?
      - How do I get full extension records for a library?
      instructions:
      - text: List the extensions in library {library}.
        slots:
          library: path.LIBRARY_ID
      - text: Show full extension details for library {library}.
        slots:
          library: path.LIBRARY_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/libraries/{LIBRARY_ID}/relationships/extensions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a library's extension links
      effect: read
      questions:
      - How do I get only the extension IDs linked to a library?
      - Can I see a library's extension relationships as bare references?
      instructions:
      - text: List the extension relationship IDs for library {library}.
        slots:
          library: path.LIBRARY_ID
      - text: Show which extension IDs are linked to library {library}.
        slots:
          library: path.LIBRARY_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/libraries/{LIBRARY_ID}/relationships/extensions'].post
  update:
    x-apievangelist-phrasing:
      intent: Add extensions to a library
      effect: write
      questions:
      - How do I add an extension to a library before building it?
      - Can I add more than one extension to a library at once?
      instructions:
      - text: Add extensions {data} to library {library}.
        slots:
          library: path.LIBRARY_ID
          data: requestBody.data
      - text: Include these extensions in library {library}.
        slots:
          library: path.LIBRARY_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/libraries/{LIBRARY_ID}/relationships/extensions'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove extensions from a library
      effect: destructive
      questions:
      - How do I take extensions out of a library?
      - Can I drop an extension from a library without deleting the extension itself?
      instructions:
      - text: Remove the extensions from library {library}.
        slots:
          library: path.LIBRARY_ID
      - text: Detach extensions from library {library}.
        slots:
          library: path.LIBRARY_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/libraries/{LIBRARY_ID}/relationships/extensions'].patch
  update:
    x-apievangelist-phrasing:
      intent: Replace all extensions in a library
      effect: write
      questions:
      - How do I overwrite the whole set of extensions in a library?
      - Is there a call that swaps every extension in a library for a new list?
      instructions:
      - text: Replace the extensions in library {library} with {data}.
        slots:
          library: path.LIBRARY_ID
          data: requestBody.data
      - text: Reset library {library} so it holds only these extensions.
        slots:
          library: path.LIBRARY_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/libraries/{LIBRARY_ID}/rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List the rules in a library
      effect: read
      questions:
      - Which rules are included in a given library?
      - How do I get full rule records for everything in a library?
      instructions:
      - text: List the rules in library {library}.
        slots:
          library: path.LIBRARY_ID
      - text: Show full rule details for library {library}.
        slots:
          library: path.LIBRARY_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/libraries/{LIBRARY_ID}/relationships/rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List a library's rule links
      effect: read
      questions:
      - How do I get only the rule IDs linked to a library?
      - Can I list a library's rule relationships without the full rule data?
      instructions:
      - text: List the rule relationship IDs for library {library}.
        slots:
          library: path.LIBRARY_ID
      - text: Show which rule IDs are linked to library {library}.
        slots:
          library: path.LIBRARY_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/libraries/{LIBRARY_ID}/relationships/rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Add rules to a library
      effect: write
      questions:
      - How do I add rules to a library I'm preparing to publish?
      - Can I attach several rules to a library in a single request?
      instructions:
      - text: Add rules {data} to library {library}.
        slots:
          library: path.LIBRARY_ID
          data: requestBody.data
      - text: Include these rules in library {library}.
        slots:
          library: path.LIBRARY_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/libraries/{LIBRARY_ID}/relationships/rules'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove rules from a library
      effect: destructive
      questions:
      - How do I take rules out of a library?
      - Can I detach a rule from a library but keep the rule itself?
      instructions:
      - text: Remove rules {data} from library {library}.
        slots:
          library: path.LIBRARY_ID
          data: requestBody.data
      - text: Detach these rules from library {library}.
        slots:
          library: path.LIBRARY_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/libraries/{LIBRARY_ID}/relationships/rules'].patch
  update:
    x-apievangelist-phrasing:
      intent: Replace all rules in a library
      effect: write
      questions:
      - How do I overwrite a library's entire rule list at once?
      - Is there a way to swap every rule in a library for a new set?
      instructions:
      - text: Replace the rules in library {library} with {data}.
        slots:
          library: path.LIBRARY_ID
          data: requestBody.data
      - text: Reset library {library} so it holds only these rules.
        slots:
          library: path.LIBRARY_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/libraries/{LIBRARY_ID}/notes'].get
  update:
    x-apievangelist-phrasing:
      intent: List the notes on a library
      effect: read
      questions:
      - What notes have people left on this library?
      - Can I search a library's notes by their text?
      instructions:
      - text: List the notes on library {library}.
        slots:
          library: path.LIBRARY_ID
      - text: Find notes on library {library} that mention {text}.
        slots:
          library: path.LIBRARY_ID
          text: query.text
      method: generated
      generated: '2026-09-26'
- target: $.paths['/libraries/{LIBRARY_ID}/notes'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a note to a library
      effect: write
      questions:
      - How do I leave a comment on a tags library for my team?
      - Can I attach a note to a library through the API?
      instructions:
      - text: Add a note to library {library}.
        slots:
          library: path.LIBRARY_ID
      - text: Leave a note on library {library} explaining this release.
        slots:
          library: path.LIBRARY_ID
      method: generated
      generated: '2026-09-26'