Cloudflare · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cloudflare Memberships API

5 actions 5 updates phrasing extends openapi/cloudflare-memberships-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Cloudflare's API. It is a proposal applied on top of the contract, not a document Cloudflare publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/memberships'].get
$.paths['/memberships/{membership_id}'].get
$.paths['/memberships/{membership_id}'].put
$.paths['/memberships/{membership_id}'].delete

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 Cloudflare Memberships API
  version: 1.0.0
extends: openapi/cloudflare-memberships-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: 4
- target: $.paths['/memberships'].get
  update:
    x-apievangelist-phrasing:
      intent: List the accounts I'm a member of
      effect: read
      questions:
      - Which Cloudflare accounts do I have access to?
      - Can I see only the account invitations that are still pending?
      - Is there a way to find my membership in an account by the account's name?
      instructions:
      - text: List my account memberships with status {status}.
        slots:
          status: query.status
      - text: Find my membership in the account named {account_name}.
        slots:
          account_name: query.account.name
      - text: Show page {page} of my memberships, ordered by {order}.
        slots:
          page: query.page
          order: query.order
      method: generated
      generated: '2026-09-26'
- target: $.paths['/memberships/{membership_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the details of one account membership
      effect: read
      questions:
      - What status is a specific membership of mine in?
      - Can I look up one account membership by its ID?
      instructions:
      - text: Show the details of membership {membership_id}.
        slots:
          membership_id: path.membership_id
      - text: Get membership {membership_id} so I can check its status.
        slots:
          membership_id: path.membership_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/memberships/{membership_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Accept or reject an account invitation
      effect: write
      questions:
      - How do I accept an invitation to join a Cloudflare account?
      - Can I decline an account invite I received?
      instructions:
      - text: Accept the account invitation for membership {membership_id}.
        slots:
          membership_id: path.membership_id
      - text: Set membership {membership_id} invitation to {status}.
        slots:
          membership_id: path.membership_id
          status: requestBody.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/memberships/{membership_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Leave an account by removing a membership
      effect: destructive
      questions:
      - Can I remove myself from an account I no longer need access to?
      - What does deleting an account membership do?
      instructions:
      - text: Delete membership {membership_id}.
        slots:
          membership_id: path.membership_id
      - text: Remove me from the account tied to membership {membership_id}.
        slots:
          membership_id: path.membership_id
      method: generated
      generated: '2026-09-26'