# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Harness Catalog Custom Properties API
  version: 1.0.0
extends: openapi/harness-catalogcustomproperties-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: 8
- target: $.paths['/v1/catalog/custom-properties'].post
  update:
    x-apievangelist-phrasing:
      intent: Set a custom property on matching catalog entities
      effect: write
      questions:
      - How do I set a custom property across many catalog entities at once?
      - Can I dry-run a bulk custom property update before applying it?
      instructions:
      - text: Set property {property} to {value} on all catalog entities matching {filter}.
        slots:
          property: requestBody.property
          value: requestBody.value
          filter: requestBody.filter
      - text: Bulk ingest custom property {property} for entities matching {filter} as a dry run.
        slots:
          property: requestBody.property
          filter: requestBody.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/catalog/custom-properties'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a custom property from matching entities
      effect: destructive
      questions:
      - Can I remove a custom property from every catalog entity that matches a filter?
      - Is there a way to skip certain entities when bulk-deleting a property?
      instructions:
      - text: Remove property {property} from all catalog entities matching {filter}.
        slots:
          property: requestBody.property
          filter: requestBody.filter
      - text: Bulk delete custom property {property} for filter {filter}.
        slots:
          property: requestBody.property
          filter: requestBody.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/catalog/custom-properties/entity'].get
  update:
    x-apievangelist-phrasing:
      intent: Get custom properties for a catalog entity
      effect: read
      questions:
      - What custom properties are set on a particular catalog entity?
      - Can I see all custom metadata attached to one service in the catalog?
      instructions:
      - text: Get the custom properties of entity {entity}.
        slots:
          entity: query.entity_ref
      - text: Show custom metadata for catalog entity {entity}.
        slots:
          entity: query.entity_ref
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/catalog/custom-properties/entity'].post
  update:
    x-apievangelist-phrasing:
      intent: Set custom properties on one catalog entity
      effect: write
      questions:
      - How do I add a custom property to a single catalog entity?
      - Can I set several custom properties on one entity in one call?
      instructions:
      - text: Set property {property} to {value} on entity {entity}.
        slots:
          property: requestBody.property
          value: requestBody.value
          entity: requestBody.entity_ref
      - text: Ingest these custom properties onto catalog entity {entity}.
        slots:
          entity: requestBody.entity_ref
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/catalog/custom-properties/entity'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove custom properties from one entity
      effect: destructive
      questions:
      - Can I delete a custom property from just one catalog entity?
      - How do I clear several custom properties on a single entity?
      instructions:
      - text: Remove property {property} from entity {entity}.
        slots:
          property: requestBody.property
          entity: requestBody.entity_ref
      - text: Clear these custom properties on catalog entity {entity}.
        slots:
          entity: requestBody.entity_ref
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/catalog/custom-properties/property'].get
  update:
    x-apievangelist-phrasing:
      intent: Find entities that have a custom property
      effect: read
      questions:
      - Which catalog entities have a given custom property set?
      - Can I list every entity tagged with a particular custom property?
      instructions:
      - text: List entities that have custom property {property}.
        slots:
          property: query.property
      - text: Find catalog entities using property {property} and show their values.
        slots:
          property: query.property
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/catalog/custom-properties/property'].post
  update:
    x-apievangelist-phrasing:
      intent: Apply one custom property to a list of entities
      effect: write
      questions:
      - Can I set the same custom property on a specific list of entities?
      - How do I assign one property value to several named entities?
      instructions:
      - text: Set property {property} to {value} on entities {entities}.
        slots:
          property: requestBody.property
          value: requestBody.value
          entities: requestBody.entity_refs
      - text: Apply custom property {property} to this list of entity refs.
        slots:
          property: requestBody.property
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/catalog/custom-properties/property'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a custom property from listed entities
      effect: destructive
      questions:
      - Can I unset a custom property on a specific list of entities?
      - How do I strip one property off a handful of named catalog entities?
      instructions:
      - text: Remove property {property} from entities {entities}.
        slots:
          property: requestBody.property
          entities: requestBody.entity_refs
      - text: Unset custom property {property} on entity {entity}.
        slots:
          property: requestBody.property
          entity: requestBody.entity_ref
      method: generated
      generated: '2026-09-26'