Archbee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Archbee Public API Reference API

3 actions 3 updates phrasing extends openapi/archbee-api-reference-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['/info-api-reference'].get

$.paths['/sync-api-reference'].post

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 API Reference API
  version: 1.0.0
extends: openapi/archbee-api-reference-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['/info-api-reference'].get
  update:
    x-apievangelist-phrasing:
      intent: Get info about an imported OpenAPI tree
      effect: read
      questions:
      - How do I see details about an OpenAPI reference I already imported into my docs?
      - What information can I get back about an existing API reference tree?
      instructions:
      - text: Show me the info for the OpenAPI tree {docTreeId}.
        slots:
          docTreeId: requestBody.docTreeId
      - text: Get details of the imported API reference category {docTreeId}.
        slots:
          docTreeId: requestBody.docTreeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sync-api-reference'].post
  update:
    x-apievangelist-phrasing:
      intent: Import or re-sync an OpenAPI file as API reference
      effect: write
      questions:
      - How do I push an updated OpenAPI spec so my API reference docs refresh?
      - Can I import a YAML or zipped OpenAPI file to generate a new API reference section?
      - Is it possible to turn on Try It so readers can call the API from the published reference?
      instructions:
      - text: Sync {file} into the existing API reference tree {docTreeId}.
        slots:
          file: requestBody.file
          docTreeId: requestBody.docTreeId
      - text: Import {file} as a brand-new API reference section with a models category.
        slots:
          file: requestBody.file
      - text: Re-sync {file} into tree {docTreeId} and enable Try It set to {openApiTryIt}.
        slots:
          file: requestBody.file
          docTreeId: requestBody.docTreeId
          openApiTryIt: requestBody.openApiTryIt
      method: generated
      generated: '2026-09-26'