Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Workfront Docmetadatalinkgroup API

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

$.info
$.paths['/docmetadatalinkgroup/{id}'].get
$.paths['/docmetadatalinkgroup/{id}'].delete
$.paths['/docmetadatalinkgroup'].get
$.paths['/docmetadatalinkgroup'].post
$.paths['/docmetadatalinkgroup'].delete
$.paths['/docmetadatalinkgroup/count'].get
$.paths['/docmetadatalinkgroup/search'].get
$.paths['/docmetadatalinkgroup/report'].get
$.paths['/docmetadatalinkgroup/getMetadataDetailsForDocument'].put
$.paths['/docmetadatalinkgroup/getMetadataForDocument'].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 Docmetadatalinkgroup API
  version: 1.0.0
extends: openapi/adobe-suite-docmetadatalinkgroup-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: 10
- target: $.paths['/docmetadatalinkgroup/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a document metadata link group
      effect: read
      questions:
      - How can I look up one document metadata link group by its ID?
      - Can I choose which fields come back for a single metadata link group?
      instructions:
      - text: Show document metadata link group {id}.
        slots:
          id: path.id
      - text: Fetch metadata link group {id} with fields {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/docmetadatalinkgroup/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a document metadata link group
      effect: destructive
      questions:
      - Can I remove one document metadata link group I no longer need?
      - Is a forced delete possible for a single metadata link group?
      instructions:
      - text: Delete document metadata link group {id}.
        slots:
          id: path.id
      - text: Remove the doc metadata link group {id}, forcing it if necessary.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/docmetadatalinkgroup'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch several metadata link groups by ID
      effect: read
      questions:
      - Can I retrieve multiple document metadata link groups in one request by their IDs?
      - Which call gets a batch of doc metadata link groups at once?
      instructions:
      - text: Get the document metadata link groups {id} in bulk.
        slots:
          id: query.id
      - text: Bulk fetch link groups {id}, returning only {fields}.
        slots:
          id: query.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/docmetadatalinkgroup'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a document metadata link group
      effect: write
      questions:
      - How do I create a new group that links metadata to a document?
      - Can I add doc metadata link groups through the API?
      instructions:
      - text: Create a new document metadata link group.
      - text: Add a docmetadatalinkgroup and return fields {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/docmetadatalinkgroup'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete document metadata link groups
      effect: destructive
      questions:
      - Is there a way to delete many document metadata link groups at once?
      - Can several metadata link groups be removed in one call?
      instructions:
      - text: Bulk delete the document metadata link groups {id}.
        slots:
          id: query.id
      - text: 'Remove all of these metadata link groups together: {id}.'
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/docmetadatalinkgroup/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count document metadata link groups
      effect: read
      questions:
      - How many document metadata link groups exist?
      - Can I count only the link groups matching a filter?
      instructions:
      - text: Count the document metadata link groups.
      - text: Tell me how many metadata link groups match {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/docmetadatalinkgroup/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search document metadata link groups
      effect: read
      questions:
      - What's the way to search document metadata link groups by attributes?
      - Can I sort and paginate a metadata link group search?
      instructions:
      - text: Search document metadata link groups where {filters}.
        slots:
          filters: query.filters
      - text: Find link groups matching {filters} with list options {listOptions}.
        slots:
          filters: query.filters
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/docmetadatalinkgroup/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Report on document metadata link groups
      effect: read
      questions:
      - Can I get an aggregated report over document metadata link groups?
      - Is there a summary report for metadata link groups?
      instructions:
      - text: Run a report on document metadata link groups.
      - text: Generate a metadata link group report filtered by {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/docmetadatalinkgroup/getMetadataDetailsForDocument'].put
  update:
    x-apievangelist-phrasing:
      intent: Get detailed metadata for a linked document
      effect: read
      questions:
      - How do I get the detailed metadata for a document stored with an external provider?
      - Can I see full metadata details, not just values, for one document?
      instructions:
      - text: Get the metadata details for document {documentID}.
        slots:
          documentID: query.documentID
      - text: Show full metadata details for document {documentID} from provider {documentProviderID}.
        slots:
          documentID: query.documentID
          documentProviderID: query.documentProviderID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/docmetadatalinkgroup/getMetadataForDocument'].put
  update:
    x-apievangelist-phrasing:
      intent: Get metadata values for a document
      effect: read
      questions:
      - What metadata is attached to a given document?
      - Can I read a document's metadata by its integration type?
      instructions:
      - text: Get the metadata for document {documentID}.
        slots:
          documentID: query.documentID
      - text: Read the metadata of document {documentID} using integration type {externalIntegrationType}.
        slots:
          documentID: query.documentID
          externalIntegrationType: query.externalIntegrationType
      method: generated
      generated: '2026-09-26'