DoiT · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for DoiT Reports API

8 actions 8 updates phrasing extends openapi/doit-reports-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for DoiT's API. It is a proposal applied on top of the contract, not a document DoiT publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 8

$.info
$.paths['/analytics/v1/reports'].get
$.paths['/analytics/v1/reports'].post
$.paths['/analytics/v1/reports/query'].post
$.paths['/analytics/v1/reports/{id}'].get
$.paths['/analytics/v1/reports/{id}'].delete
$.paths['/analytics/v1/reports/{id}'].patch
$.paths['/analytics/v1/reports/{id}/config'].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 DoiT Reports API
  version: 1.0.0
extends: openapi/doit-reports-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['/analytics/v1/reports'].get
  update:
    x-apievangelist-phrasing:
      intent: List Cloud Analytics reports
      effect: read
      questions:
      - Which cost reports do I have access to?
      - Can I list reports created within a time window?
      instructions:
      - text: List all my reports.
      - text: List reports created after {since}.
        slots:
          since: query.minCreationTime
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/v1/reports'].post
  update:
    x-apievangelist-phrasing:
      intent: Create and save a report
      effect: write
      questions:
      - How do I save a new cost report?
      - Can I put a new report straight into a folder?
      instructions:
      - text: Create report {name} with config {config}.
        slots:
          name: requestBody.name
          config: requestBody.config
      - text: Save a new report {name} in folder {folderId}.
        slots:
          name: requestBody.name
          folderId: requestBody.folderId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/v1/reports/query'].post
  update:
    x-apievangelist-phrasing:
      intent: Run an ad hoc cost query
      effect: read
      questions:
      - Can I run a cost query without saving it as a report?
      - How do I get cost data for a one-off configuration?
      instructions:
      - text: Run a query with config {config}.
        slots:
          config: requestBody.config
      - text: Run an unsaved cost query using {config}.
        slots:
          config: requestBody.config
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/v1/reports/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a report's results
      effect: read
      questions:
      - How do I get the numbers from a saved report?
      - Can I get report results for a custom date range?
      instructions:
      - text: Get results of report {id}.
        slots:
          id: path.id
      - text: Get report {id} results from {startDate} to {endDate}.
        slots:
          id: path.id
          startDate: query.startDate
          endDate: query.endDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/v1/reports/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a report
      effect: destructive
      questions:
      - How do I delete a saved report?
      - Can I permanently remove a Cloud Analytics report?
      instructions:
      - text: Delete report {id}.
        slots:
          id: path.id
      - text: Remove report {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/v1/reports/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a saved report
      effect: write
      questions:
      - How do I change the configuration of an existing report?
      - Can I rename a report or add labels to it?
      instructions:
      - text: Update report {id} with config {config}.
        slots:
          id: path.id
          config: requestBody.config
      - text: Rename report {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/v1/reports/{id}/config'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a report's configuration
      effect: read
      questions:
      - What settings and filters does a report use?
      - Can I see a report's configuration without its results?
      instructions:
      - text: Get the configuration of report {id}.
        slots:
          id: path.id
      - text: Show the filters and settings of report {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'