# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Archbee Spaces API
  version: 1.0.0
extends: openapi/archbee-spaces-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 9
- target: $.paths['/spaces'].get
  update:
    x-apievangelist-phrasing:
      intent: List documentation spaces
      effect: read
      questions:
      - Which documentation spaces can I access?
      - Can I page through my Archbee spaces a few at a time?
      instructions:
      - text: List all my documentation spaces.
      - text: List my spaces, {limit} per page, page {page}.
        slots:
          limit: query.limit
          page: query.page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/spaces'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a space with name and visibility
      effect: write
      questions:
      - How do I create a docs space and set whether it's public or private?
      - Can I give a new space a description and visibility setting when creating it?
      instructions:
      - text: Create a space named {name} with {visibility} visibility.
        slots:
          name: requestBody.name
          visibility: requestBody.visibility
      - text: Create space {name} described as {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/spaces/{spaceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a documentation space's details
      effect: read
      questions:
      - How do I look up the details of one specific docs space?
      - What settings does a particular space have?
      instructions:
      - text: Get the details of space {spaceId}.
        slots:
          spaceId: path.spaceId
      - text: Show me docs space {spaceId}.
        slots:
          spaceId: path.spaceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/spaces/{spaceId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a space by its path id
      effect: destructive
      questions:
      - How do I delete a documentation space along with all of its content?
      - Does deleting a space by its id also remove all its pages?
      instructions:
      - text: Delete space {spaceId} and all its content.
        slots:
          spaceId: path.spaceId
      - text: Remove documentation space {spaceId} via the spaces endpoint.
        slots:
          spaceId: path.spaceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/space/clone'].post
  update:
    x-apievangelist-phrasing:
      intent: Clone a space into a space group
      effect: write
      questions:
      - How do I duplicate an existing docs space?
      - Can I clone a space into a different space group?
      instructions:
      - text: Clone the current space.
      - text: Clone this space into space group {targetSpaceGroupId}.
        slots:
          targetSpaceGroupId: requestBody.targetSpaceGroupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/space/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a space with AI, review or branching
      effect: write
      questions:
      - Can I create a space that turns on AI, the review system or branching from the start?
      - How do I create a new space inside an existing space group and inherit the API key?
      instructions:
      - text: Create a space called {name} in space group {docSpaceGroupId}.
        slots:
          name: requestBody.name
          docSpaceGroupId: requestBody.docSpaceGroupId
      - text: Create space {name} with branching enabled set to {isBranchingSystemEnabled}.
        slots:
          name: requestBody.name
          isBranchingSystemEnabled: requestBody.isBranchingSystemEnabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/space/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a space by target space id
      effect: destructive
      questions:
      - How do I delete a space by passing its id in the request body?
      - Is there a legacy space-delete endpoint that takes a target space id?
      instructions:
      - text: Delete target space {targetSpaceId} using the legacy delete endpoint.
        slots:
          targetSpaceId: requestBody.targetSpaceId
      - text: Remove space {targetSpaceId} with the body-based delete call.
        slots:
          targetSpaceId: requestBody.targetSpaceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/space/publish'].post
  update:
    x-apievangelist-phrasing:
      intent: Publish a space's documents
      effect: write
      questions:
      - How do I publish my docs so readers see the latest changes?
      - Can I publish to a preview environment before going live?
      instructions:
      - text: Publish this space to the {environment} environment.
        slots:
          environment: requestBody.environment
      - text: Publish my docs live.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/space/update'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a space's access, hostname or links
      effect: write
      questions:
      - How do I set a custom hostname for my documentation space?
      - Can I change a space's public access control and authentication settings?
      - How do I link one space to other spaces?
      instructions:
      - text: Set the space's custom hostname config to {hostnamePart}.
        slots:
          hostnamePart: requestBody.hostnamePart
      - text: Update the space's public access control to {publicAccessControlPart}.
        slots:
          publicAccessControlPart: requestBody.publicAccessControlPart
      - text: 'Link the space to these spaces: {spaceLinks}.'
        slots:
          spaceLinks: requestBody.spaceLinks
      method: generated
      generated: '2026-09-26'