Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Workfront Exchangerate API

13 actions 13 updates phrasing extends openapi/adobe-suite-exchange-rate-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 13

$.info
$.paths['/exchangerate/{id}'].get
$.paths['/exchangerate/{id}'].put
$.paths['/exchangerate/{id}'].delete
$.paths['/exchangerate'].get
$.paths['/exchangerate'].put
$.paths['/exchangerate'].post
$.paths['/exchangerate'].delete
$.paths['/exchangerate/count'].get
$.paths['/exchangerate/search'].get
$.paths['/exchangerate/report'].get
$.paths['/exchangerate/getCustomerCurrencies'].put
$.paths['/exchangerate/saveCustomerExchangeRates'].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 Exchangerate API
  version: 1.0.0
extends: openapi/adobe-suite-exchange-rate-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: 12
- target: $.paths['/exchangerate/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one currency exchange rate
      effect: read
      questions:
      - What rate is stored on a specific exchange rate record in Workfront?
      - Can I pick which fields come back when fetching a single exchange rate?
      instructions:
      - text: Show exchange rate {id}.
        slots:
          id: path.id
      - text: Get the {fields} of exchange rate {id}.
        slots:
          fields: query.fields
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/exchangerate/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a single exchange rate
      effect: write
      questions:
      - How do I change the conversion rate on one existing exchange rate record?
      - Can I correct the currency on a single exchange rate after it was saved?
      instructions:
      - text: Update exchange rate {id} with the new rate.
        slots:
          id: path.id
      - text: Edit the exchange rate record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/exchangerate/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a single exchange rate
      effect: destructive
      questions:
      - Can I remove one exchange rate that was entered by mistake?
      - Is there a force option when a single exchange rate is still referenced?
      instructions:
      - text: Delete exchange rate {id}.
        slots:
          id: path.id
      - text: Force-delete exchange rate {id} even if it is in use.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/exchangerate'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch several exchange rates by ID
      effect: read
      questions:
      - Can I fetch a batch of exchange rates in one call when I know their IDs?
      - Which exchange rates match a list of record IDs I already have?
      instructions:
      - text: Get exchange rates {ids} in one request.
        slots:
          ids: query.id
      - text: 'Fetch these exchange rate records together: {ids}.'
        slots:
          ids: query.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/exchangerate'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit many exchange rates at once
      effect: write
      questions:
      - Is it possible to update the rates on many exchange rate records in one request?
      - How would I bulk edit exchange rates after a currency revaluation?
      instructions:
      - text: Bulk update all the exchange rates in this list.
      - text: Apply these new values to several exchange rate records at once.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/exchangerate'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a new currency exchange rate
      effect: write
      questions:
      - How do I add a new exchange rate for a foreign currency in Workfront?
      - Can I create exchange rate records for project financials through the API?
      instructions:
      - text: Create a new exchange rate for euros.
      - text: Add an exchange rate record for this currency and rate.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/exchangerate'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several exchange rates by ID
      effect: destructive
      questions:
      - Can I remove a batch of exchange rates in a single call?
      - What does bulk deleting exchange rates require?
      instructions:
      - text: Delete exchange rates {ids}.
        slots:
          ids: query.id
      - text: 'Remove all of these exchange rate records: {ids}.'
        slots:
          ids: query.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/exchangerate/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count exchange rates matching filters
      effect: read
      questions:
      - How many exchange rates are defined in my Workfront instance?
      - What is the number of exchange rates for a particular currency?
      instructions:
      - text: Count exchange rates matching {filters}.
        slots:
          filters: query.filters
      - text: Tell me how many exchange rate records exist.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/exchangerate/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search exchange rates by criteria
      effect: read
      questions:
      - Which exchange rates use a given currency code?
      - Can I search exchange rates with filters and choose the returned fields?
      instructions:
      - text: Search exchange rates where {filters}.
        slots:
          filters: query.filters
      - text: Find exchange rates matching {filters} and return {fields}.
        slots:
          filters: query.filters
          fields: query.fields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/exchangerate/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run an aggregate report on exchange rates
      effect: read
      questions:
      - Can I group and summarize exchange rates in a report query?
      - What does an exchange rate report with grouping and aggregates return?
      instructions:
      - text: Run an exchange rate report grouped by currency filtered on {filters}.
        slots:
          filters: query.filters
      - text: Produce an aggregated report of exchange rates using {listOptions}.
        slots:
          listOptions: query.listOptions
      method: generated
      generated: '2026-10-01'
- target: $.paths['/exchangerate/getCustomerCurrencies'].put
  update:
    x-apievangelist-phrasing:
      intent: List the currencies set up for my customer
      effect: read
      questions:
      - Which currencies are configured for my Workfront customer account?
      - What currencies can I use when entering exchange rates?
      instructions:
      - text: Show the currencies configured for our Workfront account.
      - text: List our customer currencies.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/exchangerate/saveCustomerExchangeRates'].put
  update:
    x-apievangelist-phrasing:
      intent: Save the customer's base currency and rates
      effect: write
      questions:
      - How do I set the base currency and all exchange rates for my account in one go?
      - Can I replace my organization's currency table with a new set of rates?
      instructions:
      - text: Set base currency {baseCurrency} with rates {rates}.
        slots:
          baseCurrency: query.baseCurrency
          rates: query.rates
      - text: Save the customer exchange rate table {rates}.
        slots:
          rates: query.rates
      method: generated
      generated: '2026-10-01'