# 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 API v2 Space Properties API
  version: 1.0.0
extends: openapi/confluence-space-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['/spaces/{space-id}/properties'].get
  update:
    x-apievangelist-phrasing:
      intent: List a space's properties
      effect: read
      questions:
      - What key-value properties are stored on a space?
      - Can I look up a space property by its key?
      instructions:
      - text: List the properties of space {space}.
        slots:
          space: path.space-id
      - text: Find the property with key {key} in space {space}.
        slots:
          space: path.space-id
          key: query.key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/spaces/{space-id}/properties'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a property to a space
      effect: write
      questions:
      - How do I store custom key-value data on a space?
      - Can my app save a setting against a space?
      instructions:
      - text: Create property {key} with value {value} on space {space}.
        slots:
          space: path.space-id
          key: requestBody.key
          value: requestBody.value
      - text: Store {value} under a new key {key} for space {space}.
        slots:
          space: path.space-id
          key: requestBody.key
          value: requestBody.value
      method: generated
      generated: '2026-10-01'
- target: $.paths['/spaces/{space-id}/properties/{property-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a space property
      effect: read
      questions:
      - How do I read one space property by its ID?
      - What value is saved in a particular space property?
      instructions:
      - text: Get property {property} of space {space}.
        slots:
          space: path.space-id
          property: path.property-id
      - text: Show the value of space {space}'s property {property}.
        slots:
          space: path.space-id
          property: path.property-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/spaces/{space-id}/properties/{property-id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a space property
      effect: write
      questions:
      - How do I change the value of an existing space property?
      - Do I need to bump a version when editing a space property?
      instructions:
      - text: Set property {property} of space {space} to {value}.
        slots:
          space: path.space-id
          property: path.property-id
          value: requestBody.value
      - text: Update space {space}'s property {property} to {value} as version {version}.
        slots:
          space: path.space-id
          property: path.property-id
          value: requestBody.value
          version: requestBody.version
      method: generated
      generated: '2026-10-01'
- target: $.paths['/spaces/{space-id}/properties/{property-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a space property
      effect: destructive
      questions:
      - Can I remove a property I stored on a space?
      - How do I clean up an unused space property?
      instructions:
      - text: Delete property {property} from space {space}.
        slots:
          space: path.space-id
          property: path.property-id
      - text: Remove space {space}'s property {property}.
        slots:
          space: path.space-id
          property: path.property-id
      method: generated
      generated: '2026-10-01'