Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Workfront Billingrecord API

12 actions 12 updates phrasing extends openapi/adobe-suite-billingrecord-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['/billingrecord/{id}'].get
$.paths['/billingrecord/{id}'].put
$.paths['/billingrecord/{id}'].delete
$.paths['/billingrecord'].get
$.paths['/billingrecord'].put
$.paths['/billingrecord'].post
$.paths['/billingrecord'].delete
$.paths['/billingrecord/count'].get
$.paths['/billingrecord/search'].get
$.paths['/billingrecord/report'].get
$.paths['/billingrecord/calculateDataExtension'].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 Billingrecord API
  version: 1.0.0
extends: openapi/adobe-suite-billingrecord-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['/billingrecord/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a billing record by ID
      effect: read
      questions:
      - What amounts and status does a specific billing record in Workfront show?
      - Can I choose which fields to return for one billing record?
      instructions:
      - text: Show me billing record {id}.
        slots:
          id: path.id
      - text: Get billing record {id} with fields {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/billingrecord/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a billing record
      effect: write
      questions:
      - How do I change the description or status of an existing billing record?
      - Can I mark one billing record as invoiced?
      instructions:
      - text: Update billing record {id} with these changes.
        slots:
          id: path.id
      - text: Edit billing record {id} and return {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/billingrecord/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a billing record
      effect: destructive
      questions:
      - How do I remove a billing record created by mistake?
      - Is force needed to delete a billing record that has hours attached?
      instructions:
      - text: Delete billing record {id}.
        slots:
          id: path.id
      - text: Force-delete billing record {id}, force {force}.
        slots:
          id: path.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/billingrecord'].get
  update:
    x-apievangelist-phrasing:
      intent: Get several billing records by their IDs
      effect: read
      questions:
      - Can I fetch multiple billing records at once?
      - What's the call for loading billing records from a list of IDs?
      instructions:
      - text: Get billing records {id}.
        slots:
          id: query.id
      - text: Load billing records {id} together, including {fields}.
        slots:
          id: query.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/billingrecord'].put
  update:
    x-apievangelist-phrasing:
      intent: Bulk-update several billing records
      effect: write
      questions:
      - Can I update many billing records in a single request?
      - Is there a bulk edit for billing records?
      instructions:
      - text: Apply these changes to all the billing records I list in one bulk edit.
      - text: Bulk-edit my billing records and return {fields} for each.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/billingrecord'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a billing record
      effect: write
      questions:
      - How do I create a billing record for a project?
      - Can I add a new billing record through the API?
      instructions:
      - text: Create a billing record for this project and billing period.
      - text: Create a new billing record and return {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/billingrecord'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several billing records at once
      effect: destructive
      questions:
      - Can I delete a batch of billing records together?
      - What does the force flag do on a bulk billing record delete?
      instructions:
      - text: Delete billing records {id} in bulk.
        slots:
          id: query.id
      - text: Force-remove billing records {id}, with force {force}.
        slots:
          id: query.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/billingrecord/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count billing records
      effect: read
      questions:
      - How many billing records do we have?
      - Can I count only billing records matching a filter, like one project?
      instructions:
      - text: Count all billing records.
      - text: Count billing records matching {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/billingrecord/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search billing records
      effect: read
      questions:
      - How do I find billing records for a certain project or date?
      - Can I paginate through billing record search results?
      instructions:
      - text: Search billing records where {filters}.
        slots:
          filters: query.filters
      - text: Find billing records matching {filters}, returning {fields}, list options {listOptions}.
        slots:
          filters: query.filters
          fields: query.fields
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/billingrecord/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run a report over billing records
      effect: read
      questions:
      - Can I get billing record totals grouped by project?
      - Which call returns aggregated report output for billing records?
      instructions:
      - text: Run a billing record report for {filters}.
        slots:
          filters: query.filters
      - text: Build a billing report with list options {listOptions}.
        slots:
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/billingrecord/calculateDataExtension'].put
  update:
    x-apievangelist-phrasing:
      intent: Recalculate custom data on a billing record
      effect: write
      questions:
      - How do I recalculate the calculated custom fields on a billing record?
      - Can I refresh a billing record's data extension after its inputs change?
      instructions:
      - text: Recalculate the data extension for billing record {ID}.
        slots:
          ID: query.ID
      - text: Refresh calculated custom fields on billing record {ID}.
        slots:
          ID: query.ID
      method: generated
      generated: '2026-09-26'