# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Jira Cloud platform REST User properties API
  version: 1.0.0
extends: openapi/jira-user-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: 4
- target: $.paths['/rest/api/3/user/properties'].get
  update:
    x-apievangelist-phrasing:
      intent: List property keys stored on a user
      effect: read
      questions:
      - What custom properties are stored against a user?
      - Can I list a user's property keys by account ID?
      instructions:
      - text: List the property keys for user {accountId}.
        slots:
          accountId: query.accountId
      - text: Show which custom data keys user {accountId} has.
        slots:
          accountId: query.accountId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/user/properties/{propertyKey}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a user property value
      effect: read
      questions:
      - How do I read a custom property saved on a user?
      - Can I fetch one user property by key?
      instructions:
      - text: Get property {propertyKey} for user {accountId}.
        slots:
          propertyKey: path.propertyKey
          accountId: query.accountId
      - text: Read the {propertyKey} value stored on user {accountId}.
        slots:
          propertyKey: path.propertyKey
          accountId: query.accountId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/user/properties/{propertyKey}'].put
  update:
    x-apievangelist-phrasing:
      intent: Store a custom property on a user
      effect: write
      questions:
      - Can I store custom data against a Jira user?
      - How do I set or overwrite a user property?
      instructions:
      - text: Set property {propertyKey} on user {accountId}.
        slots:
          propertyKey: path.propertyKey
          accountId: query.accountId
      - text: Save custom data under {propertyKey} for user {accountId}.
        slots:
          propertyKey: path.propertyKey
          accountId: query.accountId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/user/properties/{propertyKey}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a property from a user
      effect: destructive
      questions:
      - How do I delete a custom property from a user?
      - What permission is needed to remove a user's property?
      instructions:
      - text: Delete property {propertyKey} from user {accountId}.
        slots:
          propertyKey: path.propertyKey
          accountId: query.accountId
      - text: Clear the {propertyKey} data on user {accountId}.
        slots:
          propertyKey: path.propertyKey
          accountId: query.accountId
      method: generated
      generated: '2026-09-26'