Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Workfront Risktype API

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

$.info
$.paths['/risktype/{id}'].get
$.paths['/risktype/{id}'].put
$.paths['/risktype/{id}'].delete
$.paths['/risktype'].get
$.paths['/risktype'].put
$.paths['/risktype'].post
$.paths['/risktype'].delete
$.paths['/risktype/replace'].put
$.paths['/risktype/count'].get
$.paths['/risktype/search'].get
$.paths['/risktype/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 Risktype API
  version: 1.0.0
extends: openapi/adobe-suite-risktype-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: 11
- target: $.paths['/risktype/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single risk type
      effect: read
      questions:
      - How do I look up one risk type by ID?
      - Can I choose which fields are returned for a risk type?
      instructions:
      - text: Show me risk type {id}.
        slots:
          id: path.id
      - text: Fetch risk type {id} with fields {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/risktype/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a single risk type
      effect: write
      questions:
      - How can I rename or change one risk type?
      - Is editing a risk type by ID supported?
      instructions:
      - text: Edit risk type {id}.
        slots:
          id: path.id
      - text: Update risk type {id} and return {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/risktype/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a single risk type
      effect: destructive
      questions:
      - How do I remove a risk type we don't use?
      - Can I force delete a risk type that projects still reference?
      instructions:
      - text: Delete risk type {id}.
        slots:
          id: path.id
      - text: Force delete risk type {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/risktype'].get
  update:
    x-apievangelist-phrasing:
      intent: Get several risk types by ID at once
      effect: read
      questions:
      - Can I fetch multiple risk types in one call?
      - What's the quickest way to load a known set of risk types?
      instructions:
      - text: Get risk types {id}.
        slots:
          id: query.id
      - text: Bulk fetch risk types {id} returning {fields}.
        slots:
          id: query.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/risktype'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit many risk types in one request
      effect: write
      questions:
      - Is there a bulk edit for risk types?
      - Can I update a batch of risk types together?
      instructions:
      - text: Bulk edit the risk types I send.
      - text: Apply edits to multiple risk types and return {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/risktype'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a risk type
      effect: write
      questions:
      - How do I add a new risk type for project risk tracking?
      - Can I create a risk type and pick the response fields?
      instructions:
      - text: Create a new risk type.
      - text: Create a risk type and return {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/risktype'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several risk types at once
      effect: destructive
      questions:
      - Can I bulk delete risk types by ID?
      - Does bulk deletion of risk types support force?
      instructions:
      - text: Delete risk types {id} in bulk.
        slots:
          id: query.id
      - text: Bulk force-delete risk types {id}.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/risktype/replace'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a risk type with another
      effect: write
      questions:
      - How do I retire a risk type and move its usages to a different one?
      - Can I swap every reference to one risk type for a replacement?
      instructions:
      - text: Replace risk type {id} with {replacementID}.
        slots:
          id: query.id
          replacementID: query.replacementID
      - text: Move all uses of risk type {id} over to risk type {replacementID}.
        slots:
          id: query.id
          replacementID: query.replacementID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/risktype/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count risk types matching a filter
      effect: read
      questions:
      - How many risk types are defined?
      - Can I count only risk types matching a filter?
      instructions:
      - text: Count all risk types.
      - text: Count risk types matching {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/risktype/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search risk types with filters
      effect: read
      questions:
      - How do I search risk types by name?
      - Can I paginate risk type search results?
      instructions:
      - text: Search risk types where {filters}.
        slots:
          filters: query.filters
      - text: Find risk types matching {filters} and return {fields}.
        slots:
          filters: query.filters
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/risktype/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run a report on risk types
      effect: read
      questions:
      - Can I get aggregated report data about risk types?
      - What does a filtered risk type report return?
      instructions:
      - text: Run a risk type report.
      - text: Report on risk types filtered by {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'