ControlUp · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Dex Tags API

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

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/organizations/{orgId}/tags'].get
$.paths['/organizations/{orgId}/tags'].post
$.paths['/organizations/{orgId}/tags/{id}'].get
$.paths['/organizations/{orgId}/tags/{id}'].delete
$.paths['/organizations/{orgId}/tags/{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 Dex Tags API
  version: 1.0.0
extends: openapi/controlup-tags-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: 5
- target: $.paths['/organizations/{orgId}/tags'].get
  update:
    x-apievangelist-phrasing:
      intent: List organization tags
      effect: read
      questions:
      - Which tags are defined in my ControlUp organization?
      - Can I search org tags by key or value label?
      instructions:
      - text: List all tags in organization {orgId}.
        slots:
          orgId: path.orgId
      - text: Find tags with key {key} in organization {orgId}.
        slots:
          key: query.key
          orgId: path.orgId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{orgId}/tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an organization tag
      effect: write
      questions:
      - Can I create a new tag key with a set of allowed values?
      - What do I need to define a new organization tag?
      instructions:
      - text: Create tag {key} in organization {orgId}.
        slots:
          key: requestBody.key
          orgId: path.orgId
      - text: Create tag {key} with values {values} in organization {orgId}.
        slots:
          key: requestBody.key
          values: requestBody.values
          orgId: path.orgId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{orgId}/tags/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve an organization tag
      effect: read
      questions:
      - What values does a specific org tag have?
      - Can I fetch one tag's details by its ID?
      instructions:
      - text: Show tag {id} in organization {orgId}.
        slots:
          id: path.id
          orgId: path.orgId
      - text: Retrieve org tag {id} from organization {orgId}.
        slots:
          id: path.id
          orgId: path.orgId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{orgId}/tags/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an organization tag
      effect: destructive
      questions:
      - Can I remove a tag from my organization?
      - Is deleting an org tag done by its ID?
      instructions:
      - text: Delete tag {id} in organization {orgId}.
        slots:
          id: path.id
          orgId: path.orgId
      - text: Remove org tag {id} from {orgId}.
        slots:
          id: path.id
          orgId: path.orgId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{orgId}/tags/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an organization tag
      effect: write
      questions:
      - Can I add new values to an existing org tag?
      - Can I change a tag's description without touching its values?
      instructions:
      - text: Update the values of tag {id} in organization {orgId} to {values}.
        slots:
          id: path.id
          orgId: path.orgId
          values: requestBody.values
      - text: Set org tag {id} description to {description} in organization {orgId}.
        slots:
          id: path.id
          description: requestBody.description
          orgId: path.orgId
      method: generated
      generated: '2026-09-26'