Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Workfront Useravailability API

9 actions 9 updates phrasing extends openapi/adobe-suite-useravailability-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['/useravailability/{id}'].get
$.paths['/useravailability/{id}'].delete
$.paths['/useravailability'].get
$.paths['/useravailability'].post
$.paths['/useravailability'].delete
$.paths['/useravailability/count'].get
$.paths['/useravailability/search'].get
$.paths['/useravailability/report'].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 Adobe Workfront Useravailability API
  version: 1.0.0
extends: openapi/adobe-suite-useravailability-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['/useravailability/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one user availability record
      effect: read
      questions:
      - What does a specific user availability entry show?
      - Can I retrieve one availability record by ID?
      instructions:
      - text: Get user availability record {id}.
        slots:
          id: path.id
      - text: Show availability entry {id} with fields {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/useravailability/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a user availability record
      effect: destructive
      questions:
      - How do I remove one user availability entry?
      - Can I force delete an availability record?
      instructions:
      - text: Delete user availability {id}.
        slots:
          id: path.id
      - text: Force delete availability record {id} with force {force}.
        slots:
          id: path.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/useravailability'].get
  update:
    x-apievangelist-phrasing:
      intent: Get several availability records by ID
      effect: read
      questions:
      - Can I fetch multiple user availability records in one call?
      - How do I look up a batch of availability entries by ID?
      instructions:
      - text: Get user availability records {id}.
        slots:
          id: query.id
      - text: Fetch availability entries {id} returning {fields}.
        slots:
          id: query.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/useravailability'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a user availability record
      effect: write
      questions:
      - How do I record a user's availability for capacity planning?
      - Can I add a new availability entry through the API?
      instructions:
      - text: Create a new user availability record.
      - text: Add a user availability entry and return {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/useravailability'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several availability records
      effect: destructive
      questions:
      - Can I bulk delete user availability records?
      - How do I remove many availability entries at once?
      instructions:
      - text: Delete user availability records {id}.
        slots:
          id: query.id
      - text: Bulk delete availability entries {id} with force {force}.
        slots:
          id: query.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/useravailability/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count user availability records
      effect: read
      questions:
      - How many user availability records exist?
      - Can I count availability entries that match a filter?
      instructions:
      - text: Count the user availability records.
      - text: Count availability records matching {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/useravailability/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search user availability records
      effect: read
      questions:
      - How do I find availability entries for a particular user?
      - Can I search availability records by date?
      instructions:
      - text: Search user availability matching {filters}.
        slots:
          filters: query.filters
      - text: Find availability records matching {filters} with list options {listOptions}.
        slots:
          filters: query.filters
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/useravailability/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run a report on user availability
      effect: read
      questions:
      - Can I get an aggregated availability report across users?
      - What grouped totals exist for user availability?
      instructions:
      - text: Run a user availability report.
      - text: Report on user availability filtered by {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'