Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Workfront Docmetadatalink API

9 actions 9 updates phrasing extends openapi/adobe-suite-docmetadatalink-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['/docmetadatalink/{id}'].get

$.paths['/docmetadatalink/{id}'].delete

$.paths['/docmetadatalink'].get

$.paths['/docmetadatalink'].post

$.paths['/docmetadatalink'].delete

$.paths['/docmetadatalink/count'].get

$.paths['/docmetadatalink/search'].get

$.paths['/docmetadatalink/report'].get

OpenAPI Overlay

# 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 Docmetadatalink API
  version: 1.0.0
extends: openapi/adobe-suite-docmetadatalink-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['/docmetadatalink/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one document metadata link
      effect: read
      questions:
      - How do I view a single document metadata link record?
      - Can I fetch one doc metadata link with selected fields?
      instructions:
      - text: Show document metadata link {id}.
        slots:
          id: path.id
      - text: Get doc metadata link {id} with fields {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/docmetadatalink/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a document metadata link
      effect: destructive
      questions:
      - How do I remove a metadata link from a document?
      - Is there a force option when deleting a doc metadata link?
      instructions:
      - text: Delete document metadata link {id}.
        slots:
          id: path.id
      - text: Force-delete doc metadata link {id} with force {force}.
        slots:
          id: path.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/docmetadatalink'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch several document metadata links
      effect: read
      questions:
      - Can I load multiple doc metadata links by their IDs?
      - Which call returns a batch of known document metadata links?
      instructions:
      - text: Fetch document metadata links {id}.
        slots:
          id: query.id
      - text: Get doc metadata links {id} showing only {fields}.
        slots:
          id: query.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/docmetadatalink'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a document metadata link
      effect: write
      questions:
      - How do I link metadata to a document?
      - Can I create a doc metadata link and get fields back?
      instructions:
      - text: Create a new document metadata link.
      - text: Create a doc metadata link and return {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/docmetadatalink'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete many document metadata links
      effect: destructive
      questions:
      - Can I bulk delete doc metadata links?
      - What does force do when deleting several document metadata links?
      instructions:
      - text: Delete document metadata links {id}.
        slots:
          id: query.id
      - text: Bulk delete doc metadata links {id} with force {force}.
        slots:
          id: query.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/docmetadatalink/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count document metadata links
      effect: read
      questions:
      - How many document metadata links exist?
      - Can I count doc metadata links that match a filter?
      instructions:
      - text: Count all document metadata links.
      - text: Count doc metadata links matching {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/docmetadatalink/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search document metadata links
      effect: read
      questions:
      - Which doc metadata links match certain criteria?
      - Can I search document metadata links and page through results?
      instructions:
      - text: Search document metadata links where {filters}.
        slots:
          filters: query.filters
      - text: Find doc metadata links matching {filters} returning {fields}.
        slots:
          filters: query.filters
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/docmetadatalink/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run a document metadata link report
      effect: read
      questions:
      - Can I get an aggregated report of doc metadata links?
      - What grouped totals does a document metadata link report give?
      instructions:
      - text: Run a doc metadata link report filtered by {filters}.
        slots:
          filters: query.filters
      - text: Build a document metadata link report with list options {listOptions}.
        slots:
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'