Scope3 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Scope3 Buyer Optimization Suggestions API

5 actions 5 updates phrasing extends openapi/scope3-optimization-suggestions-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/optimization-suggestions'].get

$.paths['/optimization-suggestions/{suggestionId}'].get

$.paths['/optimization-suggestions/{suggestionId}/approve'].post

$.paths['/optimization-suggestions/{suggestionId}/reject'].post

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 Scope3 Buyer Optimization Suggestions API
  version: 1.0.0
extends: openapi/scope3-optimization-suggestions-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: 4
- target: $.paths['/optimization-suggestions'].get
  update:
    x-apievangelist-phrasing:
      intent: List optimization suggestions
      effect: read
      questions:
      - What optimization suggestions are waiting for my review?
      - Can I see suggestions for just one campaign or media buy?
      instructions:
      - text: List pending optimization suggestions.
      - text: Show optimization suggestions for campaign {campaign_id} with status {status}.
        slots:
          campaign_id: query.campaignId
          status: query.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/optimization-suggestions/{suggestionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: View one optimization suggestion
      effect: read
      questions:
      - What exactly would a given optimization suggestion change?
      - Can I look up a single suggestion by its id before deciding?
      instructions:
      - text: Show optimization suggestion {suggestion_id}.
        slots:
          suggestion_id: path.suggestionId
      - text: Get the details of suggestion {suggestion_id}.
        slots:
          suggestion_id: path.suggestionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/optimization-suggestions/{suggestionId}/approve'].post
  update:
    x-apievangelist-phrasing:
      intent: Approve an optimization suggestion
      effect: write
      questions:
      - How do I accept a recommended optimization so it gets applied?
      - What happens to a suggestion's proposed change once I approve it?
      instructions:
      - text: Approve optimization suggestion {suggestion_id}.
        slots:
          suggestion_id: path.suggestionId
      - text: Accept suggestion {suggestion_id} and queue its change.
        slots:
          suggestion_id: path.suggestionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/optimization-suggestions/{suggestionId}/reject'].post
  update:
    x-apievangelist-phrasing:
      intent: Reject an optimization suggestion
      effect: write
      questions:
      - Can I decline a recommended optimization and say why?
      - Is a reason required when turning down a suggestion?
      instructions:
      - text: Reject optimization suggestion {suggestion_id}.
        slots:
          suggestion_id: path.suggestionId
      - text: Decline suggestion {suggestion_id} because {reason}.
        slots:
          suggestion_id: path.suggestionId
          reason: requestBody.reason
      method: generated
      generated: '2026-10-01'