Archbee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Archbee Public Access Control API

2 actions 2 updates phrasing extends openapi/archbee-access-control-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 2

$.info

$.paths['/access-control/request'].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 Access Control API
  version: 1.0.0
extends: openapi/archbee-access-control-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: 1
- target: $.paths['/access-control/request'].post
  update:
    x-apievangelist-phrasing:
      intent: Request magic-link access to a docs space
      effect: write
      questions:
      - How can a reader ask to be let into a magic-link protected Archbee docs portal?
      - Does requesting magic-link access give the reader access right away, or does an admin have to approve it?
      - Why would a magic-link access request be refused with a 400 error?
      instructions:
      - text: Submit a magic-link access request for {email}.
        slots:
          email: requestBody.email
      - text: Ask the space admin to add {email} to the magic-link whitelist.
        slots:
          email: requestBody.email
      method: generated
      generated: '2026-09-26'