Outbrain · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Outbrain Amplify Users API

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

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/marketers/{marketerId}/users'].get
$.paths['/marketers/{marketerId}/users'].put
$.paths['/marketers/{marketerId}/users'].delete
$.paths['/invitations/multiple'].post
$.paths['/invitations'].put

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 Outbrain Amplify Users API
  version: 1.0.0
extends: openapi/outbrain-users-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: 5
- target: $.paths['/marketers/{marketerId}/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List users with access to a marketer
      effect: read
      questions:
      - Who has access to my marketer account and what role does each person have?
      - Which users still have a pending invitation to a marketer?
      instructions:
      - text: List all users permitted on marketer {marketerId}.
        slots:
          marketerId: path.marketerId
      - text: Show the roles and statuses of users on marketer {marketerId}.
        slots:
          marketerId: path.marketerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/marketers/{marketerId}/users'].put
  update:
    x-apievangelist-phrasing:
      intent: Enable, disable or change a user's role
      effect: write
      questions:
      - How do I disable a user on a marketer without removing them?
      - Can I change someone's role on a marketer account?
      instructions:
      - text: Disable the user jane@example.com on marketer {marketerId}.
        slots:
          marketerId: path.marketerId
      - text: Change a user's role to account manager on marketer {marketerId}.
        slots:
          marketerId: path.marketerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/marketers/{marketerId}/users'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke a user's access to a marketer
      effect: destructive
      questions:
      - How do I remove someone's access to a marketer account entirely?
      - Can I revoke a user's permission by email address?
      instructions:
      - text: Remove user {email} from marketer {marketerId}.
        slots:
          email: query.email
          marketerId: path.marketerId
      - text: Revoke marketer {marketerId} access for {email}.
        slots:
          marketerId: path.marketerId
          email: query.email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/invitations/multiple'].post
  update:
    x-apievangelist-phrasing:
      intent: Invite new users to a marketer
      effect: write
      questions:
      - How do I invite several new colleagues to a marketer account at once?
      - Can I give new users access by sending invitations?
      instructions:
      - text: Invite these three email addresses to my marketer account.
      - text: Send access invitations to the new team members I list.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/invitations'].put
  update:
    x-apievangelist-phrasing:
      intent: Revoke pending user invitations
      effect: destructive
      questions:
      - How do I cancel an invitation that hasn't been accepted yet?
      - Can I withdraw pending invitations by setting them to revoked?
      instructions:
      - text: Revoke the pending invitation I sent to the contractor.
      - text: Set all outstanding invitations for my marketer to REVOKED.
      method: generated
      generated: '2026-09-26'