Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Content API. Content fragment API

9 actions 9 updates phrasing extends openapi/adobe-suite-content-fragment-api-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 9

$.info
$.paths['/fragments'].get
$.paths['/fragments'].post
$.paths['/fragments/{fragmentId}'].get
$.paths['/fragments/{fragmentId}'].put
$.paths['/fragments/{fragmentId}'].patch
$.paths['/fragments/publications'].post
$.paths['/fragments/{fragmentId}/liveFragment'].get
$.paths['/fragments/{fragmentId}/lastPublicationStatus'].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 Content API. Content fragment API
  version: 1.0.0
extends: openapi/adobe-suite-content-fragment-api-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: 8
- target: $.paths['/fragments'].get
  update:
    x-apievangelist-phrasing:
      intent: List content fragments
      effect: read
      questions:
      - Which content fragments exist in my sandbox?
      - Can I filter fragments by name or type and sort the list?
      - How many fragments can I pull back per page?
      instructions:
      - text: List the content fragments in my sandbox.
      - text: List fragments filtered by {property}, sorted by {orderBy}.
        slots:
          property: query.property
          orderBy: query.orderBy
      - text: Show the next {limit} fragments starting after {start}.
        slots:
          limit: query.limit
          start: query.start
      method: generated
      generated: '2026-09-26'
- target: $.paths['/fragments'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a content fragment
      effect: write
      questions:
      - How do I create a new reusable content fragment of a given type?
      - Can I put a new fragment straight into a specific folder?
      instructions:
      - text: Create a {type} fragment named {name}.
        slots:
          type: requestBody.type
          name: requestBody.name
      - text: Create fragment {name} of type {type} in folder {parentFolderId} described as {description}.
        slots:
          name: requestBody.name
          type: requestBody.type
          parentFolderId: requestBody.parentFolderId
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/fragments/{fragmentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a content fragment's details
      effect: read
      questions:
      - What's in a content fragment, including its current draft content?
      - Can I fetch one fragment's detail by its ID?
      instructions:
      - text: Get content fragment {fragmentId}.
        slots:
          fragmentId: path.fragmentId
      - text: Show me the working details of fragment {fragmentId}.
        slots:
          fragmentId: path.fragmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/fragments/{fragmentId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a content fragment
      effect: write
      questions:
      - How do I overwrite a fragment's name, type and content in full?
      - Why does a full fragment update need the current etag in If-Match?
      instructions:
      - text: Replace fragment {fragmentId} with name {name} and type {type}.
        slots:
          fragmentId: path.fragmentId
          name: requestBody.name
          type: requestBody.type
      - text: Fully update fragment {fragmentId} at etag {etag}, moving it to folder {parentFolderId}.
        slots:
          fragmentId: path.fragmentId
          etag: header.If-Match
          parentFolderId: requestBody.parentFolderId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/fragments/{fragmentId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch a fragment's name, description or folder
      effect: write
      questions:
      - Can I change just a fragment's name without resending its content?
      - Which fields can a JSON Patch on a fragment touch?
      instructions:
      - text: Patch fragment {fragmentId} to rename it to the name I give you.
        slots:
          fragmentId: path.fragmentId
      - text: Move fragment {fragmentId} to another folder with a JSON Patch at etag {etag}.
        slots:
          fragmentId: path.fragmentId
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/fragments/publications'].post
  update:
    x-apievangelist-phrasing:
      intent: Publish a content fragment
      effect: write
      questions:
      - How do I publish a fragment so campaigns and journeys can use it?
      - Does publishing a fragment freeze its content?
      instructions:
      - text: Publish content fragment {fragmentId}.
        slots:
          fragmentId: requestBody.fragmentId
      - text: Start a publication of fragment {fragmentId} before I activate the campaign.
        slots:
          fragmentId: requestBody.fragmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/fragments/{fragmentId}/liveFragment'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a fragment's last published content
      effect: read
      questions:
      - What content is live for a fragment from its last successful publication?
      - Can I see the published version rather than the draft of a fragment?
      instructions:
      - text: Get the live published content of fragment {fragmentId}.
        slots:
          fragmentId: path.fragmentId
      - text: Show what fragment {fragmentId} looked like at its last successful publish.
        slots:
          fragmentId: path.fragmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/fragments/{fragmentId}/lastPublicationStatus'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a fragment's last publication status
      effect: read
      questions:
      - Did my last fragment publication succeed, fail or is it still in progress?
      - Can I poll the status of a fragment's most recent publish request?
      instructions:
      - text: Check the last publication status of fragment {fragmentId}.
        slots:
          fragmentId: path.fragmentId
      - text: Tell me whether fragment {fragmentId} finished publishing.
        slots:
          fragmentId: path.fragmentId
      method: generated
      generated: '2026-09-26'