# 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 Subscribe API
  version: 1.0.0
extends: openapi/adobe-suite-subscribe-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: 13
- target: $.paths['/subscribe/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one subscription record
      effect: read
      questions:
      - How do I look up a single Workfront subscription record by its ID?
      - Can I choose which fields come back for one subscription?
      instructions:
      - text: Get subscription record {id}.
        slots:
          id: path.id
      - text: Fetch subscribe record {id} with only the fields {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscribe/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a subscription record
      effect: destructive
      questions:
      - Can I delete one subscription record outright?
      - Is there a force flag when removing a single subscription?
      instructions:
      - text: Delete subscription record {id}.
        slots:
          id: path.id
      - text: Force-delete subscribe record {id} with force {force}.
        slots:
          id: path.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscribe'].get
  update:
    x-apievangelist-phrasing:
      intent: Get several subscription records by ID
      effect: read
      questions:
      - Can I fetch a batch of subscription records if I know their IDs?
      - What's the way to load multiple subscribe records in one request?
      instructions:
      - text: Get the subscription records with IDs {ids}.
        slots:
          ids: query.id
      - text: Bulk-fetch subscribe records {ids} returning {fields}.
        slots:
          ids: query.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscribe'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a subscription record
      effect: write
      questions:
      - How do I create a new subscription record directly?
      - Can I add a subscribe record and pick which fields are returned?
      instructions:
      - text: Create a subscription record with the details I give you.
      - text: Add a subscribe record and return its {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscribe'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several subscription records
      effect: destructive
      questions:
      - Can I delete a batch of subscription records in one call?
      - What happens if I force a bulk delete of subscribe records?
      instructions:
      - text: Delete the subscription records {ids}.
        slots:
          ids: query.id
      - text: Bulk force-delete subscribe records {ids} with force {force}.
        slots:
          ids: query.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscribe/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count subscription records
      effect: read
      questions:
      - How many subscription records exist?
      - Can I count only the subscriptions that match a filter?
      instructions:
      - text: Count all subscription records.
      - text: Tell me how many subscriptions match {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscribe/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search subscription records
      effect: read
      questions:
      - How can I find subscription records matching certain conditions?
      - Can a subscription search be sorted or limited with list options?
      instructions:
      - text: Search subscription records matching {filters}.
        slots:
          filters: query.filters
      - text: Find subscriptions where {filters}, returning {fields} with list options {listOptions}.
        slots:
          filters: query.filters
          fields: query.fields
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscribe/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run a report on subscription records
      effect: read
      questions:
      - Can I produce an aggregated report of subscriptions?
      - What report data is available on subscribe records filtered by conditions?
      instructions:
      - text: Run a subscription report filtered by {filters}.
        slots:
          filters: query.filters
      - text: Build a subscribe report using list options {listOptions}.
        slots:
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscribe/addSubscribers'].put
  update:
    x-apievangelist-phrasing:
      intent: Subscribe other users to an object
      effect: write
      questions:
      - How do I subscribe teammates to updates on a project or task?
      - Can I add several users as subscribers to one object at once?
      instructions:
      - text: Add users {userIDs} as subscribers to {objCode} {objID}.
        slots:
          userIDs: query.userIDs
          objCode: query.objCode
          objID: query.objID
      - text: Subscribe {userIDs} to updates on object {objID} of type {objCode}.
        slots:
          userIDs: query.userIDs
          objID: query.objID
          objCode: query.objCode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscribe/removeSubscribers'].put
  update:
    x-apievangelist-phrasing:
      intent: Remove subscribers from an object
      effect: write
      questions:
      - How do I stop other users from getting updates on an object?
      - Can I remove several subscribers from one task or project in one call?
      instructions:
      - text: Remove users {userIDs} as subscribers from {objCode} {objID}.
        slots:
          userIDs: query.userIDs
          objCode: query.objCode
          objID: query.objID
      - text: Take {userIDs} off the subscriber list of object {objID} ({objCode}).
        slots:
          userIDs: query.userIDs
          objID: query.objID
          objCode: query.objCode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscribe/subscribes'].put
  update:
    x-apievangelist-phrasing:
      intent: Subscribe myself to several objects
      effect: write
      questions:
      - Can I follow several projects or tasks myself in one request?
      - Which call subscribes the current user to a list of objects?
      instructions:
      - text: Subscribe me to objects {objIDs} of types {objCodes}.
        slots:
          objIDs: query.objIDs
          objCodes: query.objCodes
      - text: Start following {objCodes} items {objIDs} for me.
        slots:
          objCodes: query.objCodes
          objIDs: query.objIDs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscribe/unsubscribes'].put
  update:
    x-apievangelist-phrasing:
      intent: Unsubscribe myself from several objects
      effect: write
      questions:
      - How do I stop following several objects I'm subscribed to?
      - Can I unsubscribe the current user from a list of tasks at once?
      instructions:
      - text: Unsubscribe me from objects {objIDs} of types {objCodes}.
        slots:
          objIDs: query.objIDs
          objCodes: query.objCodes
      - text: Stop my updates on {objCodes} items {objIDs}.
        slots:
          objCodes: query.objCodes
          objIDs: query.objIDs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscribe/subscribers'].get
  update:
    x-apievangelist-phrasing:
      intent: List who is subscribed to an object
      effect: read
      questions:
      - Who is subscribed to updates on this project or task?
      - Can I see the subscriber list for one object?
      instructions:
      - text: List the subscribers of {objCode} {objID}.
        slots:
          objCode: query.objCode
          objID: query.objID
      - text: Show who follows object {objID} of type {objCode}.
        slots:
          objID: query.objID
          objCode: query.objCode
      method: generated
      generated: '2026-09-26'