Outbrain · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Outbrain Marketers API

5 actions 5 updates phrasing extends openapi/outbrain-marketers-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 5

$.info

$.paths['/marketers/{id}'].get

$.paths['/marketers/{id}'].put

$.paths['/marketers'].get

$.paths['/marketers/{marketerId}'].get

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 Outbrain Marketers API
  version: 1.0.0
extends: openapi/outbrain-marketers-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['/marketers/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a marketer with optional extra fields
      effect: read
      questions:
      - Is my marketer account enabled, and when was it last modified?
      - Can I request extra fields when retrieving a marketer's details?
      instructions:
      - text: Show the details and enabled status of marketer {id}.
        slots:
          id: path.id
      - text: Retrieve marketer {id} including extra fields {extraFields}.
        slots:
          id: path.id
          extraFields: query.extraFields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/marketers/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a marketer account's settings
      effect: write
      questions:
      - How do I change settings on my Outbrain marketer account?
      - Can I update a marketer and get extra fields back in the response?
      instructions:
      - text: Update the settings on marketer {id}.
        slots:
          id: path.id
      - text: Change marketer {id} and return extra fields {extraFields}.
        slots:
          id: path.id
          extraFields: query.extraFields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/marketers'].get
  update:
    x-apievangelist-phrasing:
      intent: List marketers my user can access
      effect: read
      questions:
      - Which marketer accounts can my API token access?
      - What marketers are associated with my user?
      instructions:
      - text: List all marketers tied to my login.
      - text: Show me every marketer account I have access to with their IDs.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/marketers/{marketerId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a marketer by its marketer ID
      effect: read
      questions:
      - How do I fetch one marketer when I only have the marketerId?
      - What basic record comes back for a marketer looked up by identifier?
      instructions:
      - text: Look up marketer {marketerId}.
        slots:
          marketerId: path.marketerId
      - text: Fetch the marketer record with identifier {marketerId}.
        slots:
          marketerId: path.marketerId
      method: generated
      generated: '2026-09-26'