# 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 Content Properties API
  version: 1.0.0
extends: openapi/atlassian-content-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/content/{id}/property'].get
  update:
    x-apievangelist-phrasing:
      intent: List properties stored on a page
      effect: read
      questions:
      - What custom properties has my app stored on a Confluence page?
      - Can I filter a page's properties by key?
      instructions:
      - text: List the content properties on page {id}.
        slots:
          id: path.id
      - text: Show properties on content {id} with key {key}.
        slots:
          id: path.id
          key: query.key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}/property'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a property to a page, key in the body
      effect: write
      questions:
      - How do I store my own JSON metadata on a Confluence page?
      - Can I create a content property by sending both key and value in the request body?
      instructions:
      - text: Create property {key} with value {value} on content {id}.
        slots:
          key: requestBody.key
          value: requestBody.value
          id: path.id
      - text: Attach a new content property to page {id}, sending key {key} and value {value} in the body.
        slots:
          id: path.id
          key: requestBody.key
          value: requestBody.value
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}/property/{key}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one property on a page
      effect: read
      questions:
      - What value is stored under a particular property key on a page?
      - Can I read a property from a page's draft?
      instructions:
      - text: Get property {key} from content {id}.
        slots:
          key: path.key
          id: path.id
      - text: Read the value of {key} on the {status} version of page {id}.
        slots:
          key: path.key
          status: query.status
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}/property/{key}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a page property's value
      effect: write
      questions:
      - How do I change the value of an existing content property?
      - Why do I need to bump the version number when updating a page property?
      instructions:
      - text: Update property {key} on content {id} to {value} at version {version}.
        slots:
          key: path.key
          id: path.id
          value: requestBody.value
          version: requestBody.version
      - text: Overwrite page {id}'s {key} property with {value}, version {version}.
        slots:
          id: path.id
          key: path.key
          value: requestBody.value
          version: requestBody.version
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}/property/{key}'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a property to a page under a key in the URL
      effect: write
      questions:
      - Is there a create-property call where the key goes in the URL path?
      - Can I add a property at a specific key path and send only the value?
      instructions:
      - text: Create property at key path {key} on content {id} with value {value}.
        slots:
          key: path.key
          id: path.id
          value: requestBody.value
      - text: Post value {value} to new property URL {key} of page {id}.
        slots:
          value: requestBody.value
          key: path.key
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}/property/{key}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a property from a page
      effect: destructive
      questions:
      - How do I remove metadata my app stored on a page?
      - Can I delete a single content property by key?
      instructions:
      - text: Delete property {key} from content {id}.
        slots:
          key: path.key
          id: path.id
      - text: Remove the {key} property from page {id}.
        slots:
          key: path.key
          id: path.id
      method: generated
      generated: '2026-10-01'