Scope3 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Scope3 Buyer Update Proposals API

3 actions 3 updates phrasing extends openapi/scope3-update-proposals-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 3

$.info

$.paths['/update-proposals/{id}'].get

$.paths['/update-proposals/{id}'].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 Scope3 Buyer Update Proposals API
  version: 1.0.0
extends: openapi/scope3-update-proposals-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: 2
- target: $.paths['/update-proposals/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a media buy update proposal
      effect: read
      questions:
      - Has the seller approved or rejected my media buy change yet?
      - Why was my update proposal rejected?
      instructions:
      - text: Get the status of update proposal {id}.
        slots:
          id: path.id
      - text: Check whether proposal {id} was approved.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/update-proposals/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a pending update proposal
      effect: destructive
      questions:
      - Can I withdraw a media buy change that's still pending?
      - What happens if I cancel a proposal that was already resolved?
      instructions:
      - text: Cancel update proposal {id}.
        slots:
          id: path.id
      - text: Withdraw pending proposal {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'