API Evangelist conversational phrasing for Adobe Workfront Announcement API

# 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 Announcement API
  version: 1.0.0
extends: openapi/adobe-suite-announcement-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: 12
- target: $.paths['/announcement/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an announcement by ID
      effect: read
      questions:
      - What does a particular Workfront announcement say and who was it sent to?
      - Can I pick which fields come back when I open one announcement?
      instructions:
      - text: Show me announcement {id}.
        slots:
          id: path.id
      - text: Open announcement {id} and return only {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/announcement/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an announcement
      effect: write
      questions:
      - How do I fix a typo in an announcement I already wrote?
      - Can I change the subject of one announcement?
      instructions:
      - text: Update announcement {id} with this new text.
        slots:
          id: path.id
      - text: Edit announcement {id} and return {fields} after saving.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/announcement/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an announcement
      effect: destructive
      questions:
      - How do I remove an announcement that shouldn't have gone out?
      - Does deleting a single announcement need the force flag?
      instructions:
      - text: Delete announcement {id}.
        slots:
          id: path.id
      - text: Force-delete announcement {id} with force {force}.
        slots:
          id: path.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/announcement'].get
  update:
    x-apievangelist-phrasing:
      intent: Get several announcements by their IDs
      effect: read
      questions:
      - Can I fetch a handful of announcements in one request?
      - What's the call to load announcements when I have a list of their IDs?
      instructions:
      - text: Get announcements {id}.
        slots:
          id: query.id
      - text: Load announcements {id} together with fields {fields}.
        slots:
          id: query.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/announcement'].put
  update:
    x-apievangelist-phrasing:
      intent: Bulk-update several announcements
      effect: write
      questions:
      - Can I edit a number of announcements in one call?
      - Is there a bulk update for announcements?
      instructions:
      - text: Apply these changes to all the announcements I list as one bulk edit.
      - text: Bulk-edit my announcements and return {fields} for each.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/announcement'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an announcement
      effect: write
      questions:
      - How do I post a new system announcement to Workfront users?
      - Can I draft an announcement through the API?
      instructions:
      - text: Create an announcement with this subject and message.
      - text: Create a new announcement and give me back {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/announcement'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several announcements at once
      effect: destructive
      questions:
      - Can I clean up old announcements in bulk?
      - What does force change when deleting many announcements?
      instructions:
      - text: Delete announcements {id} in bulk.
        slots:
          id: query.id
      - text: Force-remove announcements {id} together, force {force}.
        slots:
          id: query.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/announcement/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count announcements
      effect: read
      questions:
      - How many announcements have been created so far?
      - Can I count just the announcements that match a filter?
      instructions:
      - text: Count all announcements.
      - text: Count announcements matching {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/announcement/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search announcements
      effect: read
      questions:
      - How do I find announcements sent in a certain date range?
      - Can I sort and page through announcement search results?
      instructions:
      - text: Search announcements where {filters}.
        slots:
          filters: query.filters
      - text: Find announcements matching {filters}, return {fields}, list options {listOptions}.
        slots:
          filters: query.filters
          fields: query.fields
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/announcement/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run a report over announcements
      effect: read
      questions:
      - Can I get grouped totals of announcements, say by type?
      - Which call gives aggregate report output for announcements?
      instructions:
      - text: Run an announcement report for {filters}.
        slots:
          filters: query.filters
      - text: Build a report on announcements using list options {listOptions}.
        slots:
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/announcement/announcementDraftsForUser'].get
  update:
    x-apievangelist-phrasing:
      intent: List my draft announcements
      effect: read
      questions:
      - Which announcements have I drafted but not sent yet?
      - Where can I see my unsent announcement drafts?
      instructions:
      - text: List my draft announcements.
      - text: Show the announcements I still have in drafts.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/announcement/sentAnnouncementsForUser'].get
  update:
    x-apievangelist-phrasing:
      intent: List announcements I have sent
      effect: read
      questions:
      - What announcements have I already sent out?
      - Can I see a history of announcements sent by me?
      instructions:
      - text: List the announcements I have sent.
      - text: Show my sent announcement history.
      method: generated
      generated: '2026-09-26'