# 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 API
  version: 1.0.0
extends: openapi/atlassian-space-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: 8
- target: $.paths['/wiki/rest/api/space'].get
  update:
    x-apievangelist-phrasing:
      intent: List Confluence spaces
      effect: read
      questions:
      - Which Confluence spaces exist on my site?
      - Can I filter spaces by type, status or label?
      - Is there a way to list only the spaces I've marked as favorites?
      instructions:
      - text: List all Confluence spaces.
      - text: List Confluence spaces with label {label} and status {status}.
        slots:
          label: query.label
          status: query.status
      - text: Show only {type} spaces in Confluence.
        slots:
          type: query.type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/space'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Confluence space
      effect: write
      questions:
      - How do I create a new team space in Confluence?
      - Can I set labels when creating a Confluence space?
      instructions:
      - text: Create a Confluence space with key {key} named {name}.
        slots:
          key: requestBody.key
          name: requestBody.name
      - text: Create space {name} ({key}) with permissions {permissions}.
        slots:
          name: requestBody.name
          key: requestBody.key
          permissions: requestBody.permissions
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/space/_private'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a private Confluence space
      effect: write
      questions:
      - Can I make a Confluence space that only I can see?
      - What's different about a private space versus a normal one?
      instructions:
      - text: Create a private space only visible to me with key {key} and name {name}.
        slots:
          key: requestBody.key
          name: requestBody.name
      - text: Set up my personal private space {name} ({key}) described as {description}.
        slots:
          name: requestBody.name
          key: requestBody.key
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/space/{spaceKey}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Confluence space's details
      effect: read
      questions:
      - What are the name, description and permissions of a given space?
      - Does fetching a space also return its pages?
      instructions:
      - text: Get Confluence space {spaceKey}.
        slots:
          spaceKey: path.spaceKey
      - text: Show details of space {spaceKey} expanded with {expand}.
        slots:
          spaceKey: path.spaceKey
          expand: query.expand
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/space/{spaceKey}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a space's name, description or homepage
      effect: write
      questions:
      - How do I change a Confluence space's homepage?
      - Can I update space permissions through the API?
      instructions:
      - text: Rename space {spaceKey} to {name}.
        slots:
          spaceKey: path.spaceKey
          name: requestBody.name
      - text: Set the homepage of space {spaceKey} to {homepage}.
        slots:
          spaceKey: path.spaceKey
          homepage: requestBody.homepage
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/space/{spaceKey}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Confluence space
      effect: destructive
      questions:
      - Is deleting a Confluence space immediate or a background task?
      - How can I tell when a space deletion has finished?
      instructions:
      - text: Delete Confluence space {spaceKey}.
        slots:
          spaceKey: path.spaceKey
      - text: Permanently remove space {spaceKey} and its content.
        slots:
          spaceKey: path.spaceKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/space/{spaceKey}/content'].get
  update:
    x-apievangelist-phrasing:
      intent: List all content in a space
      effect: read
      questions:
      - What pages and blog posts live in a given space?
      - Can I list just the root-level content of a space?
      instructions:
      - text: List all content in space {spaceKey}.
        slots:
          spaceKey: path.spaceKey
      - text: List content in space {spaceKey} at depth {depth}.
        slots:
          spaceKey: path.spaceKey
          depth: query.depth
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/space/{spaceKey}/content/{type}'].get
  update:
    x-apievangelist-phrasing:
      intent: List one type of content in a space
      effect: read
      questions:
      - Can I list only the blog posts in a Confluence space?
      - Which pages exist in a space, without blog posts mixed in?
      instructions:
      - text: List the {type} content in space {spaceKey}.
        slots:
          type: path.type
          spaceKey: path.spaceKey
      - text: Get {limit} items of type {type} from space {spaceKey}.
        slots:
          limit: query.limit
          type: path.type
          spaceKey: path.spaceKey
      method: generated
      generated: '2026-10-01'