Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Workfront Risk API

11 actions 11 updates phrasing extends openapi/adobe-suite-risk-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 11

$.info
$.paths['/risk/{id}'].get
$.paths['/risk/{id}'].put
$.paths['/risk/{id}'].delete
$.paths['/risk'].get
$.paths['/risk'].put
$.paths['/risk'].post
$.paths['/risk'].delete
$.paths['/risk/count'].get
$.paths['/risk/search'].get
$.paths['/risk/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 Risk API
  version: 1.0.0
extends: openapi/adobe-suite-risk-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: 10
- target: $.paths['/risk/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one project risk
      effect: read
      questions:
      - How do I look up a single risk logged on a Workfront project?
      - Can I return only certain fields for one risk?
      instructions:
      - text: Get risk {id}.
        slots:
          id: path.id
      - text: Fetch risk {id} with fields {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/risk/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a risk
      effect: write
      questions:
      - How do I update the probability or mitigation of one risk?
      - Can I edit a single risk and get chosen fields back?
      instructions:
      - text: Edit risk {id} with the changes I give you.
        slots:
          id: path.id
      - text: Update risk {id} and return {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/risk/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a risk
      effect: destructive
      questions:
      - How do I remove a risk from a project?
      - Is there a force flag when deleting a risk?
      instructions:
      - text: Delete risk {id}.
        slots:
          id: path.id
      - text: Force-delete risk {id} with force {force}.
        slots:
          id: path.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/risk'].get
  update:
    x-apievangelist-phrasing:
      intent: Get several risks by ID
      effect: read
      questions:
      - Can I fetch multiple risks together if I know their IDs?
      - What's the way to pull a batch of risks in one call?
      instructions:
      - text: Get risks {ids}.
        slots:
          ids: query.id
      - text: Bulk-fetch risks {ids} with fields {fields}.
        slots:
          ids: query.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/risk'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit many risks at once
      effect: write
      questions:
      - Can I update several risks in one request?
      - How do I bulk edit project risks?
      instructions:
      - text: Bulk edit the risks I list with my changes.
      - text: Apply my edits to multiple risks and return {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/risk'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a risk
      effect: write
      questions:
      - How do I log a new risk on a project?
      - Can I create a risk and get specific fields back?
      instructions:
      - text: Create a risk with the details I give you.
      - text: Log a new risk and return {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/risk'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several risks
      effect: destructive
      questions:
      - Can I delete a batch of risks at once?
      - What's the way to remove multiple risks by their IDs?
      instructions:
      - text: Delete risks {ids}.
        slots:
          ids: query.id
      - text: Bulk force-delete risks {ids} with force {force}.
        slots:
          ids: query.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/risk/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count risks
      effect: read
      questions:
      - How many risks are logged across our projects?
      - Can I count just the risks matching a filter?
      instructions:
      - text: Count all risks.
      - text: Count risks matching {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/risk/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search risks
      effect: read
      questions:
      - Which risks match a given project or status?
      - Can I sort and page risk search results?
      instructions:
      - text: Search risks where {filters}.
        slots:
          filters: query.filters
      - text: Search risks for {filters} with {listOptions} and fields {fields}.
        slots:
          filters: query.filters
          listOptions: query.listOptions
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/risk/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run an aggregate report on risks
      effect: read
      questions:
      - Can I get a grouped summary report of risks?
      - What's the way to aggregate risks by project or type?
      instructions:
      - text: Run a risk report filtered by {filters}.
        slots:
          filters: query.filters
      - text: Build a risk report for {filters} with {listOptions}.
        slots:
          filters: query.filters
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'