Confluence · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluence Cloud REST API v2 App Properties API

5 actions 5 updates phrasing extends openapi/confluence-app-properties-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Confluence's API. It is a proposal applied on top of the contract, not a document Confluence publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/app/properties'].get

$.paths['/app/properties/{propertyKey}'].get

$.paths['/app/properties/{propertyKey}'].put

$.paths['/app/properties/{propertyKey}'].delete

OpenAPI Overlay

# 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 App Properties API
  version: 1.0.0
extends: openapi/confluence-app-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: 4
- target: $.paths['/app/properties'].get
  update:
    x-apievangelist-phrasing:
      intent: List my Forge app's stored properties
      effect: read
      questions:
      - How does my Forge app read all the properties it has stored in Confluence?
      - Can I page through Forge app properties with a cursor?
      instructions:
      - text: List all of this Forge app's properties.
      - text: Get {limit} Forge app properties per page.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/app/properties/{propertyKey}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read one Forge app property
      effect: read
      questions:
      - How do I fetch a single stored value for my Forge app by key?
      - Does reading a Forge app property require an asApp request?
      instructions:
      - text: Get Forge app property {propertyKey}.
        slots:
          propertyKey: path.propertyKey
      - text: Read the value stored under app key {propertyKey}.
        slots:
          propertyKey: path.propertyKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/app/properties/{propertyKey}'].put
  update:
    x-apievangelist-phrasing:
      intent: Save a Forge app property
      effect: write
      questions:
      - How does my Forge app store a setting in Confluence?
      - Will writing a Forge app property overwrite an existing value with the same key?
      instructions:
      - text: Create or update Forge app property {propertyKey}.
        slots:
          propertyKey: path.propertyKey
      - text: Save a value under app property key {propertyKey}.
        slots:
          propertyKey: path.propertyKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/app/properties/{propertyKey}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Forge app property
      effect: destructive
      questions:
      - How do I clear a stored setting from my Forge app?
      - Can a Forge app remove a property it no longer uses?
      instructions:
      - text: Delete Forge app property {propertyKey}.
        slots:
          propertyKey: path.propertyKey
      - text: Remove the app setting stored as {propertyKey}.
        slots:
          propertyKey: path.propertyKey
      method: generated
      generated: '2026-10-01'