Scope3 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Scope3 Buyer Signup API

2 actions 2 updates phrasing extends openapi/scope3-signup-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 2

$.info

$.paths['/auth/buyer-signup-intake'].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 Signup API
  version: 1.0.0
extends: openapi/scope3-signup-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: 1
- target: $.paths['/auth/buyer-signup-intake'].post
  update:
    x-apievangelist-phrasing:
      intent: Request buyer access
      effect: write
      questions:
      - Can I apply for buyer access to the platform?
      - Does submitting the buyer signup form create an account right away?
      instructions:
      - text: Request buyer access for {first_name} {last_name} at {company}, email {email}.
        slots:
          first_name: requestBody.first_name
          last_name: requestBody.last_name
          company: requestBody.company
          email: requestBody.email
      - text: Submit a buyer signup for {email} ({first_name} {last_name}, {company}) with a pilot budget of {pilot_budget}.
        slots:
          email: requestBody.email
          first_name: requestBody.first_name
          last_name: requestBody.last_name
          company: requestBody.company
          pilot_budget: requestBody.pilot_budget
      method: generated
      generated: '2026-10-01'