Archbee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Archbee Public Organization API

3 actions 3 updates phrasing extends openapi/archbee-organization-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['/team/display-rules'].get

$.paths['/team/export'].get

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 Organization API
  version: 1.0.0
extends: openapi/archbee-organization-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['/team/display-rules'].get
  update:
    x-apievangelist-phrasing:
      intent: Export an organization's display rules
      effect: read
      questions:
      - How do I get a list of all display rules set up for my team?
      - Which conditional display rules does my organization have?
      instructions:
      - text: Export the display rules for team {teamId}.
        slots:
          teamId: requestBody.teamId
      - text: List every display rule in organization {teamId}.
        slots:
          teamId: requestBody.teamId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/team/export'].get
  update:
    x-apievangelist-phrasing:
      intent: Export all of an organization's data
      effect: read
      questions:
      - How do I back up all my team's spaces, documents and assets from Archbee?
      - Can I export just one space instead of the whole organization?
      - Is it possible to get a download link to the export zip instead of the file itself?
      instructions:
      - text: Export all data for team {teamId}.
        slots:
          teamId: requestBody.teamId
      - text: Export team {teamId} as a link to a zip archive.
        slots:
          teamId: requestBody.teamId
      - text: Export only the current space's data for team {teamId}.
        slots:
          teamId: requestBody.teamId
      method: generated
      generated: '2026-09-26'