Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian The Confluence Cloud REST Space Settings API

3 actions 3 updates phrasing extends openapi/atlassian-space-settings-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Atlassian's API. It is a proposal applied on top of the contract, not a document Atlassian 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 Atlassian The Confluence Cloud REST Space Settings API
  version: 1.0.0
extends: openapi/atlassian-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 Confluence space's settings
      effect: read
      questions:
      - Is route override enabled for this Confluence space?
      - What settings can I read for a space?
      instructions:
      - text: Get the settings of space {spaceKey}.
        slots:
          spaceKey: path.spaceKey
      - text: Check whether route override is on for 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 Confluence space's settings
      effect: write
      questions:
      - How do I turn route override on or off for a space?
      - Which space setting can be changed through the API?
      instructions:
      - text: Set route override to {routeOverrideEnabled} for space {spaceKey}.
        slots:
          routeOverrideEnabled: requestBody.routeOverrideEnabled
          spaceKey: path.spaceKey
      - text: Update the settings of space {spaceKey}.
        slots:
          spaceKey: path.spaceKey
      method: generated
      generated: '2026-10-01'