BigPanda · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for BigPanda Change Risk API

3 actions 3 updates phrasing extends openapi/bigpanda-change-risk-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/change-risk-assessments/{change_number}'].get

$.paths['/change-risk-assessments/{change_number}'].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 BigPanda Change Risk API
  version: 1.0.0
extends: openapi/bigpanda-change-risk-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: 2
- target: $.paths['/change-risk-assessments/{change_number}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a change's risk rating
      effect: read
      questions:
      - What risk rating did BigPanda give a planned change?
      - Can I look up a risk-rated change by its change number?
      instructions:
      - text: Get the risk rating for change {change_number} under profile {profileId}.
        slots:
          change_number: path.change_number
          profileId: query.profileId
      - text: Show how risky change {change_number} was rated using profile {profileId}.
        slots:
          change_number: path.change_number
          profileId: query.profileId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/change-risk-assessments/{change_number}'].post
  update:
    x-apievangelist-phrasing:
      intent: Request a risk rating for a change
      effect: write
      questions:
      - How do I ask BigPanda to assess the risk of a change before we deploy it?
      - Where does a change show up after I request a risk rating?
      instructions:
      - text: Request a risk rating for change {change_number} with profile {profileId}.
        slots:
          change_number: path.change_number
          profileId: query.profileId
      - text: Score the risk of change {change_number} against risk profile {profileId}.
        slots:
          change_number: path.change_number
          profileId: query.profileId
      method: generated
      generated: '2026-09-26'