# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Harness Kinds API
  version: 1.0.0
extends: openapi/harness-kinds-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: 7
- target: $.paths['/v1/kinds'].get
  update:
    x-apievangelist-phrasing:
      intent: List catalog entity kinds
      effect: read
      questions:
      - What entity kinds exist in my software catalog?
      - Can I list only the custom kinds my team defined?
      instructions:
      - text: List all catalog kinds.
      - text: Show custom kinds only, with custom set to {custom}.
        slots:
          custom: query.custom
      - text: Search kinds for {search_term}.
        slots:
          search_term: query.search_term
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/kinds'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom catalog kind
      effect: write
      questions:
      - How do I define a new kind of entity for the catalog?
      - What schema do I need to provide when creating a kind?
      instructions:
      - text: Create kind {identifier} described as {description} with schema {schema}.
        slots:
          identifier: requestBody.identifier
          description: requestBody.description
          schema: requestBody.schema
      - text: Add a new kind {identifier} named {name}, schema {schema}, description {description}.
        slots:
          identifier: requestBody.identifier
          name: requestBody.name
          schema: requestBody.schema
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/kinds/{identifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a catalog kind
      effect: read
      questions:
      - How is a specific entity kind defined?
      - Can I look up one kind's schema and icon by identifier?
      instructions:
      - text: Get kind {identifier}.
        slots:
          identifier: path.identifier
      - text: Show the definition of custom kind {identifier}.
        slots:
          identifier: path.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/kinds/{identifier}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a catalog kind
      effect: write
      questions:
      - Can I change the schema of a kind that's already in use?
      - How do I update a kind's display name or icon?
      instructions:
      - text: Update kind {identifier} with schema {schema}.
        slots:
          identifier: path.identifier
          schema: requestBody.schema
      - text: Change the icon of kind {identifier} to {icon}.
        slots:
          identifier: path.identifier
          icon: requestBody.icon
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/kinds/{identifier}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a catalog kind
      effect: destructive
      questions:
      - How do I remove a custom kind from the catalog?
      - Is it possible to delete a kind I created by mistake?
      instructions:
      - text: Delete kind {identifier}.
        slots:
          identifier: path.identifier
      - text: Remove the custom kind {identifier} from the catalog.
        slots:
          identifier: path.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/kinds/schema'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the meta-schema for defining kinds
      effect: read
      questions:
      - What schema format do kind definitions have to follow?
      - Where can I see the base schema a kind must conform to?
      instructions:
      - text: Get the kind definition meta-schema.
      - text: Show the base schema that every kind must follow.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/kinds/schema/validate'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate a kind schema
      effect: read
      questions:
      - Can I check my kind schema is valid before I create the kind?
      - Will a kind schema I've drafted be accepted?
      instructions:
      - text: 'Validate this kind schema: {schema}.'
        slots:
          schema: requestBody.schema
      - text: Check whether schema {schema} is a valid kind definition.
        slots:
          schema: requestBody.schema
      method: generated
      generated: '2026-09-26'