Common Room · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Common Room Core Right to be Forgotten API

2 actions 2 updates phrasing extends openapi/common-room-right-to-be-forgotten-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Common Room's API. It is a proposal applied on top of the contract, not a document Common Room publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/user/{email}'].delete

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 Common Room Core Right to be Forgotten API
  version: 1.0.0
extends: openapi/common-room-right-to-be-forgotten-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 1
- target: $.paths['/user/{email}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Request anonymization of a contact by email
      effect: destructive
      questions:
      - How do I honor a right-to-be-forgotten request for a contact?
      - Is a contact's PII removed right away or queued after I request it?
      instructions:
      - text: Anonymize the contact with email {email}.
        slots:
          email: path.email
      - text: Erase the personal data of {email} under a right-to-be-forgotten request.
        slots:
          email: path.email
      method: generated
      generated: '2026-10-01'