# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Confluence Space API
  version: 1.0.0
extends: openapi/confluence-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['/spaces'].get
  update:
    x-apievangelist-phrasing:
      intent: List spaces
      effect: read
      questions:
      - What spaces exist on my Confluence site?
      - Can I filter spaces by type, status or label?
      - Is there a way to list only archived spaces?
      instructions:
      - text: List all spaces on the site.
      - text: List spaces with status {status}.
        slots:
          status: query.status
      - text: Find spaces labelled {labels}.
        slots:
          labels: query.labels
      method: generated
      generated: '2026-10-01'
- target: $.paths['/spaces'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a space with role assignments
      effect: write
      questions:
      - How do I create a space and assign roles to people at the same time?
      - Can I create a new space from a template key using the newer spaces endpoint?
      - Can a role-based space copy access settings from another space?
      instructions:
      - text: Create a space named {name} with role assignments {roleAssignments}.
        slots:
          name: requestBody.name
          roleAssignments: requestBody.roleAssignments
      - text: Create space {name} from template {templateKey} on the role-based spaces endpoint.
        slots:
          name: requestBody.name
          templateKey: requestBody.templateKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/spaces/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a space by id
      effect: read
      questions:
      - What details can I see for one space if I know its id?
      - Can I get a space's description in a particular format?
      instructions:
      - text: Show space {id}.
        slots:
          id: path.id
      - text: Get space {id} with its description in {description_format} format.
        slots:
          id: path.id
          description_format: query.description-format
      method: generated
      generated: '2026-10-01'
- target: $.paths['/spaces/{id}/pages'].get
  update:
    x-apievangelist-phrasing:
      intent: List pages in a space
      effect: read
      questions:
      - Which pages live in a particular space?
      - Can I list only the top-level pages of a space rather than all of them?
      instructions:
      - text: List all pages in space {id}.
        slots:
          id: path.id
      - text: List the root-level pages of space {id} at depth {depth}.
        slots:
          id: path.id
          depth: query.depth
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/space'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a space with explicit permissions
      effect: write
      questions:
      - How do I create a space with a key and permissions on the classic REST endpoint?
      - Can I set space labels at the moment I create a space?
      instructions:
      - text: Create a space called {name} with key {key} using the classic space API.
        slots:
          name: requestBody.name
          key: requestBody.key
      - text: Create space {name} granting permissions {permissions}.
        slots:
          name: requestBody.name
          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 space only I can see
      effect: write
      questions:
      - How do I make a personal space nobody else can view?
      - What does a private space restrict compared to a normal one?
      instructions:
      - text: Create a private space named {name} visible only to me.
        slots:
          name: requestBody.name
      - text: Set up private space {name} with key {key}.
        slots:
          name: requestBody.name
          key: requestBody.key
      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:
      - Can I rename a space or change its homepage through the API?
      - Why can't I change space permissions when updating a space?
      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: Permanently delete a space
      effect: destructive
      questions:
      - How do I permanently delete a space without sending it to the trash?
      - Is a space gone immediately when the delete call returns?
      instructions:
      - text: Permanently delete space {spaceKey}.
        slots:
          spaceKey: path.spaceKey
      - text: Start the long-running deletion of space {spaceKey}.
        slots:
          spaceKey: path.spaceKey
      method: generated
      generated: '2026-10-01'