DoiT · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for DoiT Folders API

6 actions 6 updates phrasing extends openapi/doit-folders-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 6

$.info
$.paths['/analytics/v1/folders'].get
$.paths['/analytics/v1/folders'].post
$.paths['/analytics/v1/folders/{id}'].get
$.paths['/analytics/v1/folders/{id}'].delete
$.paths['/analytics/v1/folders/{id}'].patch

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 Folders API
  version: 1.0.0
extends: openapi/doit-folders-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: 5
- target: $.paths['/analytics/v1/folders'].get
  update:
    x-apievangelist-phrasing:
      intent: List Cloud Analytics folders
      effect: read
      questions:
      - What folders do we have for organizing reports?
      - Can I page through all Cloud Analytics folders?
      instructions:
      - text: List all folders.
      - text: Show me Cloud Analytics folders, {n} per page.
        slots:
          n: query.maxResults
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/v1/folders'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a folder
      effect: write
      questions:
      - How do I make a folder to organize reports and allocations?
      - Can I create a subfolder inside another folder?
      instructions:
      - text: Create folder {name}.
        slots:
          name: requestBody.name
      - text: Create folder {name} inside folder {parentFolderId}.
        slots:
          name: requestBody.name
          parentFolderId: requestBody.parentFolderId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/v1/folders/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a folder
      effect: read
      questions:
      - How do I see one folder's details?
      - Can I look up a folder by ID?
      instructions:
      - text: Get folder {id}.
        slots:
          id: path.id
      - text: Show me folder {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/v1/folders/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a folder
      effect: destructive
      questions:
      - What happens to reports when I delete their folder?
      - Does deleting a folder also remove its nested folders?
      instructions:
      - text: Delete folder {id}.
        slots:
          id: path.id
      - text: Remove folder {id} and its subfolders.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/v1/folders/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or move a folder
      effect: write
      questions:
      - How do I rename an existing folder?
      - Can I move a folder under a different parent or back to the top level?
      instructions:
      - text: Rename folder {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Move folder {id} under {parentFolderId}.
        slots:
          id: path.id
          parentFolderId: requestBody.parentFolderId
      method: generated
      generated: '2026-10-01'