DoiT · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for DoiT Dimensions API

3 actions 3 updates phrasing extends openapi/doit-dimensions-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 3

$.info
$.paths['/analytics/v1/dimension'].get
$.paths['/analytics/v1/dimensions'].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 Dimensions API
  version: 1.0.0
extends: openapi/doit-dimensions-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: 2
- target: $.paths['/analytics/v1/dimension'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a dimension by type and key
      effect: read
      questions:
      - How do I look up one dimension by its type and key?
      - What does a single Cloud Analytics dimension look like?
      instructions:
      - text: Get the dimension of type {type} with key {id}.
        slots:
          type: query.type
          id: query.id
      - text: Look up dimension {id} of type {type}.
        slots:
          type: query.type
          id: query.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/v1/dimensions'].get
  update:
    x-apievangelist-phrasing:
      intent: List dimensions
      effect: read
      questions:
      - Which dimensions can I use in Cloud Analytics?
      - Can I filter or sort the dimensions list?
      instructions:
      - text: List all dimensions I have access to.
      - text: List dimensions matching filter {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-10-01'