# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Atlassian The Confluence Cloud REST Space Properties API
  version: 1.0.0
extends: openapi/atlassian-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: 6
- target: $.paths['/wiki/rest/api/space/{spaceKey}/property'].get
  update:
    x-apievangelist-phrasing:
      intent: List a Confluence space's properties
      effect: read
      questions:
      - What key-value properties are stored on this Confluence space?
      - Can I page through a space's properties with a limit?
      instructions:
      - text: List the properties of space {spaceKey}.
        slots:
          spaceKey: path.spaceKey
      - text: Show up to {limit} properties of space {spaceKey}.
        slots:
          limit: query.limit
          spaceKey: path.spaceKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/space/{spaceKey}/property'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a space property with the key in the body
      effect: write
      questions:
      - How do I store a new key-value property on a Confluence space?
      - Do I need admin permission on a space to add a property?
      instructions:
      - text: Create property {key} with value {value} on space {spaceKey}.
        slots:
          key: requestBody.key
          value: requestBody.value
          spaceKey: path.spaceKey
      - text: Add a space property to {spaceKey} passing key {key} and value {value} in the body.
        slots:
          spaceKey: path.spaceKey
          key: requestBody.key
          value: requestBody.value
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/space/{spaceKey}/property/{key}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one Confluence space property
      effect: read
      questions:
      - How do I read a single property value stored on a space?
      - What version is a space property currently at?
      instructions:
      - text: Get property {key} from space {spaceKey}.
        slots:
          key: path.key
          spaceKey: path.spaceKey
      - text: Read the value of space property {key} on {spaceKey}.
        slots:
          key: path.key
          spaceKey: path.spaceKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/space/{spaceKey}/property/{key}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a space property's value
      effect: write
      questions:
      - How do I change the value of an existing space property?
      - Can I rename a space property's key, or only change its value?
      instructions:
      - text: Update property {key} on space {spaceKey} to {value} at version {version}.
        slots:
          key: path.key
          spaceKey: path.spaceKey
          value: requestBody.value
          version: requestBody.version
      - text: Set space property {key} in {spaceKey} to value {value}, bumping version to {version}.
        slots:
          key: path.key
          spaceKey: path.spaceKey
          value: requestBody.value
          version: requestBody.version
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/space/{spaceKey}/property/{key}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a space property with the key in the path
      effect: write
      questions:
      - Can I create a space property by putting its key in the URL instead of the body?
      - Which space property create call takes only a value in the body?
      instructions:
      - text: Create space property at key {key} in {spaceKey} with only value {value} in the body.
        slots:
          key: path.key
          spaceKey: path.spaceKey
          value: requestBody.value
      - text: Add property {key} to space {spaceKey} via the key-in-path endpoint with value {value}.
        slots:
          key: path.key
          spaceKey: path.spaceKey
          value: requestBody.value
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/space/{spaceKey}/property/{key}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Confluence space property
      effect: destructive
      questions:
      - How do I remove a property from a Confluence space?
      - Who can delete space properties?
      instructions:
      - text: Delete property {key} from space {spaceKey}.
        slots:
          key: path.key
          spaceKey: path.spaceKey
      - text: Remove space property {key} on {spaceKey}.
        slots:
          key: path.key
          spaceKey: path.spaceKey
      method: generated
      generated: '2026-10-01'