vocabulary: "1.0.0"

info:
  provider: Archbee
  description: Vocabulary for the Archbee documentation platform API covering spaces, pages, members, and content management.
  created: '2026-04-19'
  modified: '2026-04-19'

operational:
  apis:
    - name: Archbee API
      namespace: archbee-api
      version: '1.0'
      baseUrl: https://api.archbee.com/v1
      status: active

  resources:
    - name: spaces
      description: Documentation spaces for organizing pages and content
      apis: [archbee-api]
      actions: [listSpaces, createSpace, getSpace, deleteSpace]
    - name: pages
      description: Documentation pages within spaces
      apis: [archbee-api]
      actions: [listPages, createPage]
    - name: members
      description: Team members with access to spaces
      apis: [archbee-api]
      actions: [listMembers]

  actions:
    - name: listSpaces
      httpMethod: GET
      pattern: read
      description: List all accessible documentation spaces
    - name: createSpace
      httpMethod: POST
      pattern: write
      description: Create a new documentation space
    - name: getSpace
      httpMethod: GET
      pattern: read
      description: Get space details
    - name: deleteSpace
      httpMethod: DELETE
      pattern: destructive
      description: Delete a documentation space
    - name: listPages
      httpMethod: GET
      pattern: read
      description: List pages in a space
    - name: createPage
      httpMethod: POST
      pattern: write
      description: Create a new page
    - name: listMembers
      httpMethod: GET
      pattern: read
      description: List space members

  schemas:
    documentation:
      - name: Space
        description: Documentation space with pages and visibility settings
        properties: [id, name, slug, visibility, description, pageCount, createdAt]
      - name: Page
        description: Documentation page with content and status
        properties: [id, title, slug, status, content, spaceId, parentId, updatedAt]
      - name: Member
        description: Team member with role in a space
        properties: [id, email, name, role]

  parameters:
    pagination:
      - name: page
        description: Page number for pagination
      - name: limit
        description: Results per page
    filters:
      - name: parentId
        description: Filter pages by parent page ID

  enums:
    visibility:
      - public
      - private
      - password-protected
    page_status:
      - draft
      - published
      - archived
    member_role:
      - owner
      - admin
      - editor
      - viewer
      - commenter

  authentication:
    schemes:
      - type: apiKey
        in: header
        headerName: X-Api-Key
        description: API key from Archbee workspace settings
        usedBy: [Archbee API]

capability:
  workflows: []
  personas:
    - id: technical-writer
      name: Technical Writer
      description: Creates and manages technical documentation content
    - id: developer
      name: Developer
      description: Integrates documentation into developer workflows
    - id: team-admin
      name: Team Admin
      description: Manages documentation spaces, members, and access
  domains:
    - name: Documentation Management
      description: Creating and organizing technical documentation
    - name: Access Management
      description: Managing team access to documentation spaces
    - name: Content Publishing
      description: Publishing and versioning documentation content
  namespaces:
    - type: consumed
      namespace: archbee-api
  binds: []

crossReference:
  - resource: spaces
    operations: [listSpaces, createSpace, getSpace, deleteSpace]
    personas: [technical-writer, team-admin]
  - resource: pages
    operations: [listPages, createPage]
    personas: [technical-writer, developer]
  - resource: members
    operations: [listMembers]
    personas: [team-admin]