Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Reactor Hosts API

7 actions 7 updates phrasing extends openapi/adobe-suite-hosts-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 7

$.info
$.paths['/properties/{PROPERTY_ID}/hosts'].get
$.paths['/properties/{PROPERTY_ID}/hosts'].post
$.paths['/hosts/{HOST_ID}'].get
$.paths['/hosts/{HOST_ID}'].delete
$.paths['/hosts/{HOST_ID}'].patch
$.paths['/hosts/{HOST_ID}/property'].get

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 Hosts API
  version: 1.0.0
extends: openapi/adobe-suite-hosts-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['/properties/{PROPERTY_ID}/hosts'].get
  update:
    x-apievangelist-phrasing:
      intent: List a property's hosts
      effect: read
      questions:
      - Which hosts deliver my Tags library for a property?
      - Can I filter a property's hosts by name or whether they are enabled?
      instructions:
      - text: List the hosts for property {PROPERTY_ID}.
        slots:
          PROPERTY_ID: path.PROPERTY_ID
      - text: Find hosts named {name} on property {PROPERTY_ID}.
        slots:
          name: query.name
          PROPERTY_ID: path.PROPERTY_ID
      - text: List only hosts with enabled set to {enabled} on property {PROPERTY_ID}.
        slots:
          enabled: query.enabled
          PROPERTY_ID: path.PROPERTY_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/properties/{PROPERTY_ID}/hosts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a host for a property
      effect: write
      questions:
      - How do I add an SFTP or Adobe-managed host to a Tags property?
      - Can I create a new host under a property?
      instructions:
      - text: Create a host on property {PROPERTY_ID} with {data}.
        slots:
          PROPERTY_ID: path.PROPERTY_ID
          data: requestBody.data
      - text: Add an SFTP host to property {PROPERTY_ID}.
        slots:
          PROPERTY_ID: path.PROPERTY_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hosts/{HOST_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a host
      effect: read
      questions:
      - What are the settings of a particular Tags host?
      - Can I look up a host by its ID?
      instructions:
      - text: Get host {HOST_ID}.
        slots:
          HOST_ID: path.HOST_ID
      - text: Show details for host {HOST_ID}.
        slots:
          HOST_ID: path.HOST_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hosts/{HOST_ID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a host
      effect: destructive
      questions:
      - Can I delete a host that a property no longer uses?
      - What is removed when I delete a Tags host?
      instructions:
      - text: Delete host {HOST_ID}.
        slots:
          HOST_ID: path.HOST_ID
      - text: Remove host {HOST_ID} from its property.
        slots:
          HOST_ID: path.HOST_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hosts/{HOST_ID}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an SFTP host
      effect: write
      questions:
      - Can I edit a host, and which host types allow updates?
      - How do I change the server path on an SFTP host?
      instructions:
      - text: Update SFTP host {HOST_ID} with {data}.
        slots:
          HOST_ID: path.HOST_ID
          data: requestBody.data
      - text: Change the settings of host {HOST_ID} as I describe.
        slots:
          HOST_ID: path.HOST_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hosts/{HOST_ID}/property'].get
  update:
    x-apievangelist-phrasing:
      intent: Find the property a host belongs to
      effect: read
      questions:
      - Which property does a host belong to?
      - Can I trace a host back to its Tags property?
      instructions:
      - text: Show the property for host {HOST_ID}.
        slots:
          HOST_ID: path.HOST_ID
      - text: Get the owning property of host {HOST_ID}.
        slots:
          HOST_ID: path.HOST_ID
      method: generated
      generated: '2026-09-26'