Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Workfront Journalentry API

8 actions 8 updates phrasing extends openapi/adobe-suite-journal-entry-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 8

$.info
$.paths['/journalentry/{id}'].get
$.paths['/journalentry'].get
$.paths['/journalentry/count'].get
$.paths['/journalentry/search'].get
$.paths['/journalentry/report'].get
$.paths['/journalentry/like'].put
$.paths['/journalentry/unlike'].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 Journalentry API
  version: 1.0.0
extends: openapi/adobe-suite-journal-entry-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 7
- target: $.paths['/journalentry/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single journal entry
      effect: read
      questions:
      - How do I read one journal entry from Workfront's update history?
      - Can I choose which fields a journal entry returns?
      instructions:
      - text: Show journal entry {id}.
        slots:
          id: path.id
      - text: Get journal entry {id} with fields {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/journalentry'].get
  update:
    x-apievangelist-phrasing:
      intent: Get several journal entries by ID
      effect: read
      questions:
      - Can I load a list of journal entries by their IDs at once?
      - What's the bulk way to fetch journal entries?
      instructions:
      - text: Fetch journal entries {id}.
        slots:
          id: query.id
      - text: Bulk get journal entries {id} with only {fields}.
        slots:
          id: query.id
          fields: query.fields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/journalentry/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count journal entries matching filters
      effect: read
      questions:
      - How many journal entries were logged for a project?
      - Can I count journal entries that match a filter?
      instructions:
      - text: Count all journal entries.
      - text: Count journal entries matching {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-10-01'
- target: $.paths['/journalentry/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search journal entries
      effect: read
      questions:
      - How do I find journal entries recording a particular change?
      - Can I sort and page journal entry search results?
      instructions:
      - text: Search journal entries where {filters}.
        slots:
          filters: query.filters
      - text: Search journal entries matching {filters} with list options {listOptions}.
        slots:
          filters: query.filters
          listOptions: query.listOptions
      method: generated
      generated: '2026-10-01'
- target: $.paths['/journalentry/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run a report over journal entries
      effect: read
      questions:
      - Can I get an aggregated report of journal entries?
      - What does a journal entry report give me that a search doesn't?
      instructions:
      - text: Run a journal entry report filtered by {filters}.
        slots:
          filters: query.filters
      - text: Generate a journal entry report with list options {listOptions}.
        slots:
          listOptions: query.listOptions
      method: generated
      generated: '2026-10-01'
- target: $.paths['/journalentry/like'].put
  update:
    x-apievangelist-phrasing:
      intent: Like a journal entry
      effect: write
      questions:
      - How do I like an update in someone's journal feed?
      - Can I react to a journal entry through the API?
      instructions:
      - text: Like journal entry {ID}.
        slots:
          ID: query.ID
      - text: Add my like to update {ID}.
        slots:
          ID: query.ID
      method: generated
      generated: '2026-10-01'
- target: $.paths['/journalentry/unlike'].put
  update:
    x-apievangelist-phrasing:
      intent: Remove a like from a journal entry
      effect: write
      questions:
      - How do I take back a like I put on a journal entry?
      - Can I unlike an update I liked by mistake?
      instructions:
      - text: Unlike journal entry {ID}.
        slots:
          ID: query.ID
      - text: Remove my like from update {ID}.
        slots:
          ID: query.ID
      method: generated
      generated: '2026-10-01'