Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Workfront Externalsection API

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

$.info
$.paths['/externalsection/{id}'].get
$.paths['/externalsection/{id}'].put
$.paths['/externalsection/{id}'].delete
$.paths['/externalsection'].get
$.paths['/externalsection'].put
$.paths['/externalsection'].post
$.paths['/externalsection'].delete
$.paths['/externalsection/count'].get
$.paths['/externalsection/search'].get
$.paths['/externalsection/report'].get
$.paths['/externalsection/calculateIframeURL'].put
$.paths['/externalsection/calculateIframeURLS'].put
$.paths['/externalsection/calculateURL'].put
$.paths['/externalsection/calculateURLS'].put

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 Adobe Workfront Externalsection API
  version: 1.0.0
extends: openapi/adobe-suite-externalsection-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: 14
- target: $.paths['/externalsection/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one external section by ID
      effect: read
      questions:
      - How do I look up a single external page section in Workfront?
      - Can I choose which fields are returned for one external section?
      instructions:
      - text: Show me external section {id}.
        slots:
          id: path.id
      - text: Get external section {id} returning only {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/externalsection/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit an external section
      effect: write
      questions:
      - How do I change the settings of an existing external page section?
      - Can I update the URL or name of one embedded external section?
      instructions:
      - text: Update external section {id} with the new settings I give you.
        slots:
          id: path.id
      - text: Edit external section {id} and return {fields} after saving.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/externalsection/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an external section
      effect: destructive
      questions:
      - How do I remove one embedded external page section?
      - Can I force the removal of an external section that is still in use?
      instructions:
      - text: Delete external section {id}.
        slots:
          id: path.id
      - text: Force remove external section {id} even if it is referenced.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/externalsection'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch several external sections by ID
      effect: read
      questions:
      - Can I retrieve a batch of external sections using a list of IDs?
      - Is there a way to load many external page sections in one request?
      instructions:
      - text: Fetch external sections {ids} together.
        slots:
          ids: query.id
      - text: Load the external sections with IDs {ids} and include {fields}.
        slots:
          ids: query.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/externalsection'].put
  update:
    x-apievangelist-phrasing:
      intent: Bulk edit external sections
      effect: write
      questions:
      - Can I update many external page sections in a single bulk call?
      - How do I mass-change settings across external sections?
      instructions:
      - text: Bulk update these external sections with my changes.
      - text: Mass edit the external sections and return {fields} for each.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/externalsection'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or copy an external section
      effect: write
      questions:
      - How do I add a new external page section that embeds another site?
      - Can I create an external section by copying an existing one?
      instructions:
      - text: Create a new external section with the URL and name I provide.
      - text: Copy external section {source} into a new one.
        slots:
          source: query.copySourceID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/externalsection'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete external sections
      effect: destructive
      questions:
      - Can I delete several external page sections at once?
      - Is there a bulk removal for external sections?
      instructions:
      - text: Delete all of external sections {ids}.
        slots:
          ids: query.id
      - text: Remove the batch of external sections {ids} in one request.
        slots:
          ids: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/externalsection/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count external sections
      effect: read
      questions:
      - How many external page sections are configured?
      - Can I count only the external sections matching a filter?
      instructions:
      - text: Count all external sections.
      - text: Tell me how many external sections match {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/externalsection/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search external sections
      effect: read
      questions:
      - How do I find external sections that match certain criteria?
      - Can I sort and page through external section search results?
      instructions:
      - text: Search external sections where {filters}.
        slots:
          filters: query.filters
      - text: Find external sections matching {filters} and show {fields}.
        slots:
          filters: query.filters
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/externalsection/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run an aggregated report on external sections
      effect: read
      questions:
      - Can I get grouped report data about external sections?
      - What report options can summarize external section records?
      instructions:
      - text: Run an external section report for {filters}.
        slots:
          filters: query.filters
      - text: Produce an aggregated external sections report with options {options}.
        slots:
          options: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/externalsection/calculateIframeURL'].put
  update:
    x-apievangelist-phrasing:
      intent: Build the iframe URL for one external section
      effect: write
      questions:
      - How do I get the resolved iframe URL an external section will embed for an object?
      - Can I compute the embedded frame address for a section on a specific record?
      instructions:
      - text: Calculate the iframe URL for external section {section} on {obj_type} {obj}.
        slots:
          section: query.externalSectionID
          obj_type: query.objCode
          obj: query.objID
      - text: Resolve the embedded frame address of section {section}.
        slots:
          section: query.externalSectionID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/externalsection/calculateIframeURLS'].put
  update:
    x-apievangelist-phrasing:
      intent: Build iframe URLs for several external sections
      effect: write
      questions:
      - Can I compute the iframe URLs for multiple external sections at once?
      - Is there a batch way to resolve embedded frame addresses for many sections on one record?
      instructions:
      - text: Calculate iframe URLs for external sections {sections} on {obj_type} {obj}.
        slots:
          sections: query.externalSectionIDs
          obj_type: query.objCode
          obj: query.objID
      - text: Resolve all embedded frame links for sections {sections} in one call.
        slots:
          sections: query.externalSectionIDs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/externalsection/calculateURL'].put
  update:
    x-apievangelist-phrasing:
      intent: Resolve the plain URL of one external section
      effect: write
      questions:
      - How do I get the final target URL, not the iframe version, for an external section?
      - Can I resolve the link an external section points to for a given object?
      instructions:
      - text: Calculate the target URL of external section {section} for {obj_type} {obj}.
        slots:
          section: query.externalSectionID
          obj_type: query.objCode
          obj: query.objID
      - text: Work out the plain link external section {section} opens.
        slots:
          section: query.externalSectionID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/externalsection/calculateURLS'].put
  update:
    x-apievangelist-phrasing:
      intent: Resolve plain URLs for several external sections
      effect: write
      questions:
      - Can I resolve the target links of several external sections together?
      - Is there a batch call that returns the non-iframe URLs for many sections?
      instructions:
      - text: Calculate the target URLs of sections {sections} for {obj_type} {obj}.
        slots:
          sections: query.externalSectionIDs
          obj_type: query.objCode
          obj: query.objID
      - text: Work out the plain links for external sections {sections} at once.
        slots:
          sections: query.externalSectionIDs
      method: generated
      generated: '2026-09-26'