Confluence · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluence Cloud REST Space settings API

3 actions 3 updates phrasing extends openapi/confluence-space-settings-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 3

$.info

$.paths['/wiki/rest/api/space/{spaceKey}/settings'].get

$.paths['/wiki/rest/api/space/{spaceKey}/settings'].put

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 Space settings API
  version: 1.0.0
extends: openapi/confluence-space-settings-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: 2
- target: $.paths['/wiki/rest/api/space/{spaceKey}/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a space's settings
      effect: read
      questions:
      - What settings are configured for a particular space?
      - Is route override enabled on a space?
      instructions:
      - text: Show the settings for space {spaceKey}.
        slots:
          spaceKey: path.spaceKey
      - text: Get the configuration of space {spaceKey}.
        slots:
          spaceKey: path.spaceKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/space/{spaceKey}/settings'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a space's settings
      effect: write
      questions:
      - How do I turn route override on or off for a space?
      - Can I change a space's content mode?
      instructions:
      - text: Set route override to {routeOverrideEnabled} for space {spaceKey}.
        slots:
          routeOverrideEnabled: requestBody.routeOverrideEnabled
          spaceKey: path.spaceKey
      - text: Change the content mode of space {spaceKey} to {contentMode}.
        slots:
          spaceKey: path.spaceKey
          contentMode: requestBody.contentMode
      method: generated
      generated: '2026-10-01'