# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Confluence Cloud REST User properties API
  version: 1.0.0
extends: openapi/confluence-user-properties-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/wiki/rest/api/user/{userId}/property'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's property keys
      effect: read
      questions:
      - What properties has an app stored against a Confluence user?
      - Does listing user properties return values or only the keys?
      instructions:
      - text: List the property keys stored for user {userId}.
        slots:
          userId: path.userId
      - text: Show the first {limit} property keys for user {userId}.
        slots:
          limit: query.limit
          userId: path.userId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/user/{userId}/property/{key}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user property by key
      effect: read
      questions:
      - What value is saved under a specific property key for a user?
      - Can I read one user's stored preference by key?
      instructions:
      - text: Get property {key} for user {userId}.
        slots:
          key: path.key
          userId: path.userId
      - text: Read the value of user {userId}'s {key} property.
        slots:
          userId: path.userId
          key: path.key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/user/{userId}/property/{key}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a user property's value
      effect: write
      questions:
      - How do I change the value of an existing user property?
      - Can I rename a user property key when updating it?
      instructions:
      - text: Set existing property {key} for user {userId} to {value}.
        slots:
          key: path.key
          userId: path.userId
          value: requestBody.value
      - text: Overwrite user {userId}'s {key} property with {value}.
        slots:
          userId: path.userId
          key: path.key
          value: requestBody.value
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/user/{userId}/property/{key}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a user property
      effect: write
      questions:
      - How do I store a new custom setting on a user account?
      - Can I save app data against a user under my own key?
      instructions:
      - text: Create a new property {key} for user {userId} with value {value}.
        slots:
          key: path.key
          userId: path.userId
          value: requestBody.value
      - text: Add property {key} = {value} to user {userId} for the first time.
        slots:
          key: path.key
          value: requestBody.value
          userId: path.userId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/user/{userId}/property/{key}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a user property
      effect: destructive
      questions:
      - Can I remove a stored property from a user?
      - What happens to the user when one of their properties is deleted?
      instructions:
      - text: Delete property {key} from user {userId}.
        slots:
          key: path.key
          userId: path.userId
      - text: Remove user {userId}'s {key} property.
        slots:
          userId: path.userId
          key: path.key
      method: generated
      generated: '2026-10-01'