DoiT · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for DoiT Settings API

8 actions 8 updates phrasing extends openapi/doit-settings-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/settings/themes'].get
$.paths['/analytics/v1/settings/themes'].post
$.paths['/analytics/v1/settings/themes/{id}'].get
$.paths['/analytics/v1/settings/themes/{id}'].delete
$.paths['/analytics/v1/settings/themes/{id}'].patch
$.paths['/analytics/v1/settings/active-theme'].get
$.paths['/analytics/v1/settings/active-theme'].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 DoiT Settings API
  version: 1.0.0
extends: openapi/doit-settings-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/settings/themes'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom color themes
      effect: read
      questions:
      - Which custom color themes are defined for our account?
      - Can I see all our chart color themes?
      instructions:
      - text: List all custom themes.
      - text: Show our custom color themes.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/v1/settings/themes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom color theme
      effect: write
      questions:
      - How do I create a chart color theme in our brand colors?
      - What permission do I need to add a custom theme?
      instructions:
      - text: Create theme {name} with primary color {primaryColor} and colors {colors}.
        slots:
          name: requestBody.name
          primaryColor: requestBody.primaryColor
          colors: requestBody.colors
      - text: Add a custom theme {name} using palette {colors} and primary {primaryColor}.
        slots:
          name: requestBody.name
          primaryColor: requestBody.primaryColor
          colors: requestBody.colors
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/v1/settings/themes/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a custom theme
      effect: read
      questions:
      - How do I see the colors in one custom theme?
      - Can I fetch a theme by its ID?
      instructions:
      - text: Get custom theme {id}.
        slots:
          id: path.id
      - text: Show the palette of theme {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/v1/settings/themes/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom theme
      effect: destructive
      questions:
      - How do I delete a color theme we don't use?
      - Who is allowed to delete custom themes?
      instructions:
      - text: Delete custom theme {id}.
        slots:
          id: path.id
      - text: Remove theme {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/v1/settings/themes/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit a custom theme
      effect: write
      questions:
      - How do I change the colors in an existing theme?
      - Can I rename a custom theme?
      instructions:
      - text: Change theme {id} primary color to {primaryColor}.
        slots:
          id: path.id
          primaryColor: requestBody.primaryColor
      - text: Rename custom theme {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/v1/settings/active-theme'].get
  update:
    x-apievangelist-phrasing:
      intent: See my active theme
      effect: read
      questions:
      - Which color theme am I currently using?
      - Am I on the default theme or a custom one?
      instructions:
      - text: Get my active theme.
      - text: Tell me which theme is active for me.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/v1/settings/active-theme'].put
  update:
    x-apievangelist-phrasing:
      intent: Switch my active theme
      effect: write
      questions:
      - How do I switch to a different color theme?
      - Can I go back to the default theme?
      instructions:
      - text: Set my active theme to {themeId}.
        slots:
          themeId: requestBody.themeId
      - text: Switch me to theme {themeId}.
        slots:
          themeId: requestBody.themeId
      method: generated
      generated: '2026-10-01'