# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Device Onboarding Properties API
  version: 1.0.0
extends: openapi/palo-alto-networks-properties-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['/properties'].get
  update:
    x-apievangelist-phrasing:
      intent: List site property definitions
      effect: read
      questions:
      - Which custom properties are defined for my sites?
      - Can I list only properties of a certain type, like integer or string?
      instructions:
      - text: List all site properties.
      - text: Show properties of type {type}.
        slots:
          type: query.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/properties'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a site property definition
      effect: write
      questions:
      - How do I define a new custom property with min and max constraints?
      - Are there reserved names I can't use when creating a property?
      instructions:
      - text: Create property {name} of type {type}.
        slots:
          name: requestBody.name
          type: requestBody.type
      - text: Add {type} property {name} with constraints {constraints}.
        slots:
          type: requestBody.type
          name: requestBody.name
          constraints: requestBody.constraints
      method: generated
      generated: '2026-09-26'
- target: $.paths['/properties/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a property definition
      effect: read
      questions:
      - How do I look up one property definition by its UUID?
      - What type and constraints does a specific property have?
      instructions:
      - text: Get property {id}.
        slots:
          id: path.id
      - text: Show the type and constraints of property {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/properties/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a property definition
      effect: write
      questions:
      - Can I change a property's constraints without breaking sites that use it?
      - How do I rename an existing property?
      instructions:
      - text: Rename property {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Change the constraints on property {id} to {constraints}.
        slots:
          id: path.id
          constraints: requestBody.constraints
      method: generated
      generated: '2026-09-26'
- target: $.paths['/properties/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a property definition
      effect: destructive
      questions:
      - How do I delete a property that no sites use anymore?
      - Why can't I remove a property still referenced by onboarding rules?
      instructions:
      - text: Delete property {id}.
        slots:
          id: path.id
      - text: Remove unused property definition {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'