Archbee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Archbee Public Space Groups API

3 actions 3 updates phrasing extends openapi/archbee-space-groups-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Archbee's API. It is a proposal applied on top of the contract, not a document Archbee publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/space-group/create'].post

$.paths['/space-group/delete'].delete

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 Archbee Public Space Groups API
  version: 1.0.0
extends: openapi/archbee-space-groups-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: 2
- target: $.paths['/space-group/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a space group
      effect: write
      questions:
      - How do I create a group to organize several documentation spaces?
      - Can I enable AI, reviews or branching when setting up a new space group?
      instructions:
      - text: Create a space group named {name}.
        slots:
          name: requestBody.name
      - text: Create space group {name} with AI enabled set to {isLlmEnabled}.
        slots:
          name: requestBody.name
          isLlmEnabled: requestBody.isLlmEnabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/space-group/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a space group
      effect: destructive
      questions:
      - How do I remove a space group I no longer need?
      - Can I delete an Archbee space group by its id?
      instructions:
      - text: Delete space group {spaceGroupId}.
        slots:
          spaceGroupId: requestBody.spaceGroupId
      - text: Remove the space group {spaceGroupId}.
        slots:
          spaceGroupId: requestBody.spaceGroupId
      method: generated
      generated: '2026-09-26'