Archbee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Archbee Pages API

3 actions 3 updates phrasing extends openapi/archbee-pages-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['/spaces/{spaceId}/pages'].get
$.paths['/spaces/{spaceId}/pages'].post

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Archbee Pages API
  version: 1.0.0
extends: openapi/archbee-pages-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['/spaces/{spaceId}/pages'].get
  update:
    x-apievangelist-phrasing:
      intent: List pages in a documentation space
      effect: read
      questions:
      - What pages exist in a given docs space?
      - Can I list only the child pages under one parent page?
      instructions:
      - text: List the pages in space {spaceId}.
        slots:
          spaceId: path.spaceId
      - text: List pages in space {spaceId} nested under page {parentId}.
        slots:
          spaceId: path.spaceId
          parentId: query.parentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/spaces/{spaceId}/pages'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a page in a documentation space
      effect: write
      questions:
      - How do I add a new page to a docs space?
      - Can I create a page nested under another page with markdown content?
      instructions:
      - text: Create a page titled {title} in space {spaceId}.
        slots:
          title: requestBody.title
          spaceId: path.spaceId
      - text: Add page {title} under parent page {parentId} in space {spaceId}.
        slots:
          title: requestBody.title
          parentId: requestBody.parentId
          spaceId: path.spaceId
      method: generated
      generated: '2026-09-26'