Archbee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Archbee Public Suggestions API

3 actions 3 updates phrasing extends openapi/archbee-suggestions-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['/suggest-change/discard'].post
$.paths['/suggest-change/merge'].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 Public Suggestions API
  version: 1.0.0
extends: openapi/archbee-suggestions-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['/suggest-change/discard'].post
  update:
    x-apievangelist-phrasing:
      intent: Discard a suggested change
      effect: destructive
      questions:
      - How do I reject a suggested edit without applying it to the doc?
      - What happens to a suggestion document when I discard it?
      instructions:
      - text: Discard suggestion {docId}.
        slots:
          docId: requestBody.docId
      - text: Reject and delete suggested change {docId} without merging.
        slots:
          docId: requestBody.docId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/suggest-change/merge'].post
  update:
    x-apievangelist-phrasing:
      intent: Merge a suggested change into its document
      effect: write
      questions:
      - How do I accept a suggested edit and apply it to the original doc?
      - Which document ids can be merged as suggestions?
      instructions:
      - text: Merge suggestion {docId} into its base document.
        slots:
          docId: requestBody.docId
      - text: Accept suggested change {docId}.
        slots:
          docId: requestBody.docId
      method: generated
      generated: '2026-09-26'