BigPanda · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Bigpanda Environments API
12 actions
12 updates
phrasing
extends
openapi/bigpanda-environments-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.
What the actions change
x-apievangelist-phrasing
Targets 12
$.info
$.paths['/resources/v2.0/environments'].get
$.paths['/resources/v2.0/environments'].post
$.paths['/resources/v2.0/environments/{id}'].get
$.paths['/resources/v2.0/environments/{id}'].delete
$.paths['/resources/v2.0/environments-groups'].get
$.paths['/resources/v2.0/environments-groups'].post
$.paths['/resources/v2.0/environments/{environment_id}'].get
$.paths['/resources/v2.0/environments/{environment_id}'].delete
$.paths['/resources/v2.0/environments/{environment_id}'].patch
$.paths['/resources/v2.0/environments-groups/{group_id}'].put
$.paths['/resources/v2.0/environments-groups/{group_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 Bigpanda Environments API
version: 1.0.0
extends: openapi/bigpanda-environments-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: 11
- target: $.paths['/resources/v2.0/environments'].get
update:
x-apievangelist-phrasing:
intent: List incident environments
effect: read
questions:
- Which environments are set up in my BigPanda organization?
- Can I see all incident grouping environments at once?
instructions:
- text: List all environments.
- text: Show every incident grouping environment we have.
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/v2.0/environments'].post
update:
x-apievangelist-phrasing:
intent: Create an incident grouping environment
effect: write
questions:
- How do I create an environment that groups incidents by a condition?
- What does a new environment need, a name and a condition?
instructions:
- text: Create environment {name} with condition {condition}.
slots:
name: requestBody.name
condition: requestBody.condition
- text: Add environment {name} for {condition}, described as {description}.
slots:
name: requestBody.name
condition: requestBody.condition
description: requestBody.description
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/v2.0/environments/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get an environment by ID (basic)
effect: read
questions:
- Can I fetch a single environment's basic definition by its ID?
- What condition does a given environment use?
instructions:
- text: Get environment {id}.
slots:
id: path.id
- text: Show the condition behind environment {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/v2.0/environments/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an environment by ID (basic)
effect: destructive
questions:
- Is there a simple way to delete an environment by ID?
- Can I remove an environment I created for testing?
instructions:
- text: Delete environment {id}.
slots:
id: path.id
- text: Remove test environment {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/v2.0/environments-groups'].get
update:
x-apievangelist-phrasing:
intent: List environment groups
effect: read
questions:
- How are my environments organized into groups?
- Which environment groups exist and what do they contain?
instructions:
- text: List all environment groups.
- text: Show each environment group and its environments.
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/v2.0/environments-groups'].post
update:
x-apievangelist-phrasing:
intent: Create an environment group
effect: write
questions:
- Can I bundle several environments into one group?
- How do I create an environment group for a team?
instructions:
- text: Create environment group {name} containing {environment_ids}.
slots:
name: requestBody.name
environment_ids: requestBody.environment_ids
- text: Make a new environment group called {name}.
slots:
name: requestBody.name
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/v2.0/environments/{environment_id}'].get
update:
x-apievangelist-phrasing:
intent: Get an environment with roles and filter
effect: read
questions:
- Which roles can see a particular environment and what filter does it use?
- Can I retrieve full environment details including its group?
instructions:
- text: Retrieve full details of environment {environment_id}.
slots:
environment_id: path.environment_id
- text: Show roles and filter for environment {environment_id}.
slots:
environment_id: path.environment_id
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/v2.0/environments/{environment_id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an environment (user API key)
effect: destructive
questions:
- How do I delete an environment with my user API key?
- Can I drop an environment nobody uses any more?
instructions:
- text: Delete environment {environment_id} using my user API key.
slots:
environment_id: path.environment_id
- text: Drop the unused environment {environment_id}.
slots:
environment_id: path.environment_id
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/v2.0/environments/{environment_id}'].patch
update:
x-apievangelist-phrasing:
intent: Update an environment's filter and access
effect: write
questions:
- Can I change which roles have read-only access to an environment?
- How do I move an environment into a different environment group?
- Can I edit the incident filter of an existing environment?
instructions:
- text: Rename environment {environment_id} to {name} and set filter {filter}.
slots:
environment_id: path.environment_id
name: requestBody.name
filter: requestBody.filter
- text: Move environment {environment_id} named {name} into group {environment_group_id}.
slots:
environment_id: path.environment_id
name: requestBody.name
environment_group_id: requestBody.environment_group_id
- text: Give roles {read_only_roles} read-only access to environment {environment_id} ({name}).
slots:
read_only_roles: requestBody.read_only_roles
environment_id: path.environment_id
name: requestBody.name
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/v2.0/environments-groups/{group_id}'].put
update:
x-apievangelist-phrasing:
intent: Update an environment group
effect: write
questions:
- Can I change which environments belong to a group?
- How do I rename an environment group?
instructions:
- text: Set environment group {group_id} to contain {environment_ids}.
slots:
group_id: path.group_id
environment_ids: requestBody.environment_ids
- text: Rename environment group {group_id} to {name}.
slots:
group_id: path.group_id
name: requestBody.name
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/v2.0/environments-groups/{group_id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an environment group
effect: destructive
questions:
- Can I remove an environment group I no longer need?
- What's the call to delete an environment group by ID?
instructions:
- text: Delete environment group {group_id}.
slots:
group_id: path.group_id
- text: Remove the environment group with ID {group_id}.
slots:
group_id: path.group_id
method: generated
generated: '2026-09-26'