Scope3 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Scope3 Release Updates API

3 actions 3 updates phrasing extends openapi/scope3-release-updates-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['/release-updates'].get

$.paths['/release-updates/seen'].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 Release Updates API
  version: 1.0.0
extends: openapi/scope3-release-updates-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['/release-updates'].get
  update:
    x-apievangelist-phrasing:
      intent: List release updates for me
      effect: read
      questions:
      - What's new in the platform that affects my account?
      - Can I browse features I'm not using yet?
      instructions:
      - text: List release updates for me.
      - text: Show release updates in scope {scope} since {since}.
        slots:
          scope: query.scope
          since: query.since
      method: generated
      generated: '2026-10-01'
- target: $.paths['/release-updates/seen'].post
  update:
    x-apievangelist-phrasing:
      intent: Mark release updates as seen
      effect: write
      questions:
      - Can I mark all the release notes I've read as seen?
      - Does marking release updates seen ever move backward?
      instructions:
      - text: Mark release updates seen through {seenThrough}.
        slots:
          seenThrough: requestBody.seenThrough
      - text: Advance my release update watermark to {seenThrough}.
        slots:
          seenThrough: requestBody.seenThrough
      method: generated
      generated: '2026-10-01'