BigPanda · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for BigPanda Alert Tags & Enrichment API
46 actions
46 updates
phrasing
extends
openapi/bigpanda-alert-tags-enrichment-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 46 · first 16 shown; the file carries all of them
$.info
$.paths['/resources/v2.0/alerts-enrichments-jobs/{job_id}'].get
$.paths['/resources/alert-enricher/schemas'].get
$.paths['/resources/alert-enricher/schemas'].post
$.paths['/resources/v2.0/alert-enrichments'].post
$.paths['/resources/v2.1/enrichments-config/tags'].get
$.paths['/resources/v2.1/enrichments-config/tags'].post
$.paths['/resources/v2.1/enrichments-config/tags/{alerttag_name}/enrichments'].post
$.paths['/resources/v2.1/enrichments-config/tags/{alerttag_name}/enrichments'].delete
$.paths['/resources/v2.1/enrichments-config/tags/{alerttag_name}/enrichments'].patch
$.paths['/resources/v2.1/mapping-enrichment'].get
$.paths['/resources/v2.1/mapping-enrichment'].post
$.paths['/resources/alert-enricher/schemas/{schema_id}/rules'].get
$.paths['/resources/alert-enricher/schemas/{schema_id}/rules'].put
$.paths['/resources/alert-enricher/schemas/{schema_id}/rules'].post
$.paths['/resources/alert-enricher/schemas/{schema_id}/rules'].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 Alert Tags & Enrichment API
version: 1.0.0
extends: openapi/bigpanda-alert-tags-enrichment-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: 45
- target: $.paths['/resources/v2.0/alerts-enrichments-jobs/{job_id}'].get
update:
x-apievangelist-phrasing:
intent: Check an Enrichment V2 mapping table upload job
effect: read
questions:
- Has my Enrichment V2 mapping table upload finished processing?
- What status does an Enrichment V2 upload job report while the mapping table is updating?
instructions:
- text: Check the status of Enrichment V2 upload job {job_id}.
slots:
job_id: path.job_id
- text: Tell me whether Enrichment V2 job {job_id} finished updating the mapping table.
slots:
job_id: path.job_id
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/alert-enricher/schemas'].get
update:
x-apievangelist-phrasing:
intent: List advanced mapping schemas
effect: read
questions:
- Which advanced mapping enrichment schemas does the Alert Enricher have set up?
- Can I see every advanced mapping schema in BigPanda at once?
instructions:
- text: List all Alert Enricher advanced mapping schemas.
- text: Pull the full list of advanced mapping enrichment schemas.
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/alert-enricher/schemas'].post
update:
x-apievangelist-phrasing:
intent: Create an advanced mapping schema
effect: write
questions:
- How do I create an advanced mapping schema in the Alert Enricher?
- How many result tags can a single advanced mapping schema produce?
instructions:
- text: Create an advanced mapping schema named {name} of type {type} with config {config}.
slots:
name: requestBody.name
type: requestBody.type
config: requestBody.config
- text: Create an inactive advanced schema {name}, type {type}, config {config}, at execution order {execution_order}.
slots:
name: requestBody.name
type: requestBody.type
config: requestBody.config
execution_order: requestBody.execution_order
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/v2.0/alert-enrichments'].post
update:
x-apievangelist-phrasing:
intent: Create an Enrichment V2 enrichment item
effect: write
questions:
- Can I add a new enrichment item with the older Enrichment V2 API?
- Can an Enrichment V2 enrichment item apply only to alerts that match a condition?
instructions:
- text: Create an Enrichment V2 enrichment item of type {type} with config {config}.
slots:
type: requestBody.type
config: requestBody.config
- text: Add an Enrichment V2 enrichment item that applies only when {when}, with the note {note}.
slots:
when: requestBody.when
note: requestBody.note
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/v2.1/enrichments-config/tags'].get
update:
x-apievangelist-phrasing:
intent: List alert tags (v2.1)
effect: read
questions:
- What alert tags exist in the v2.1 enrichments config?
- Can I pull all alert tags from the current v2.1 tags endpoint?
instructions:
- text: List all alert tags from the v2.1 enrichment config.
- text: Show every configured alert tag using the v2.1 API.
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/v2.1/enrichments-config/tags'].post
update:
x-apievangelist-phrasing:
intent: Create an alert tag
effect: write
questions:
- How do I create a new alert tag with its own enrichments?
- Can I create an alert tag that starts out inactive?
instructions:
- text: Create an active alert tag named {name} described as {description}.
slots:
name: requestBody.name
description: requestBody.description
- text: Create alert tag {name} with enrichments {enrichments} and active set to {active}.
slots:
name: requestBody.name
enrichments: requestBody.enrichments
active: requestBody.active
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/v2.1/enrichments-config/tags/{alerttag_name}/enrichments'].post
update:
x-apievangelist-phrasing:
intent: Add enrichment items to an existing alert tag
effect: write
questions:
- Can I add a composition enrichment to an alert tag I already created?
- What do I send to attach a new extraction rule to an existing tag?
instructions:
- text: Add enrichments {enrichments} to alert tag {alerttag_name}.
slots:
enrichments: requestBody.enrichments
alerttag_name: path.alerttag_name
- text: Create a new extraction enrichment item on the {alerttag_name} tag.
slots:
alerttag_name: path.alerttag_name
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/v2.1/enrichments-config/tags/{alerttag_name}/enrichments'].delete
update:
x-apievangelist-phrasing:
intent: Delete enrichment items from an alert tag
effect: destructive
questions:
- How do I remove a composition or extraction enrichment from an alert tag?
- Can I delete several enrichment items from one tag in a single call?
instructions:
- text: Delete enrichment items {enrichments_ids} from alert tag {alerttag_name}.
slots:
enrichments_ids: requestBody.enrichments_ids
alerttag_name: path.alerttag_name
- text: Remove the extraction enrichment {enrichments_ids} on the {alerttag_name} tag.
slots:
enrichments_ids: requestBody.enrichments_ids
alerttag_name: path.alerttag_name
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/v2.1/enrichments-config/tags/{alerttag_name}/enrichments'].patch
update:
x-apievangelist-phrasing:
intent: Update enrichment items on an alert tag
effect: write
questions:
- Can I edit an extraction enrichment that's already on an alert tag?
- What do I send to change an existing composition enrichment on a tag?
instructions:
- text: Update the existing enrichments on alert tag {alerttag_name} to {enrichments}.
slots:
alerttag_name: path.alerttag_name
enrichments: requestBody.enrichments
- text: Edit the current composition enrichment item on tag {alerttag_name}.
slots:
alerttag_name: path.alerttag_name
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/v2.1/mapping-enrichment'].get
update:
x-apievangelist-phrasing:
intent: List mapping enrichment schemas (v2.1)
effect: read
questions:
- Which mapping enrichment schemas exist in the v2.1 enrichment API?
- Can I list all of my v2.1 mapping enrichment schemas at once?
instructions:
- text: List all v2.1 mapping enrichment schemas.
- text: Show the mapping enrichment schemas configured through v2.1.
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/v2.1/mapping-enrichment'].post
update:
x-apievangelist-phrasing:
intent: Create a mapping enrichment schema (v2.1)
effect: write
questions:
- How do I create a v2.1 mapping enrichment schema before uploading its table?
- Can a new v2.1 mapping schema be limited to alerts matching a condition?
instructions:
- text: Create a v2.1 mapping enrichment schema with config {config}.
slots:
config: requestBody.config
- text: Create a v2.1 mapping enrichment schema that applies when {when}, noted as {note}.
slots:
when: requestBody.when
note: requestBody.note
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/alert-enricher/schemas/{schema_id}/rules'].get
update:
x-apievangelist-phrasing:
intent: Retrieve rows of an advanced mapping table
effect: read
questions:
- Can I fetch only specific rows of an advanced mapping table by their IDs?
- How do I page through all the rows of an Alert Enricher map?
instructions:
- text: Get rows {rule_ids} from advanced map {schema_id}.
slots:
rule_ids: query.rule_ids
schema_id: path.schema_id
- text: List page {page} of the rows in advanced mapping schema {schema_id}, {per_page} per page.
slots:
page: query.page
schema_id: path.schema_id
per_page: query.per_page
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/alert-enricher/schemas/{schema_id}/rules'].put
update:
x-apievangelist-phrasing:
intent: Add or update rows in an advanced map
effect: write
questions:
- Can I upsert rows into an advanced mapping table without re-uploading the CSV?
- What ID does a brand-new row need when I add it to an Alert Enricher map?
instructions:
- text: Upsert these rows into advanced mapping schema {schema_id}.
slots:
schema_id: path.schema_id
- text: Add new rows with freshly generated UUIDs to the advanced map {schema_id}.
slots:
schema_id: path.schema_id
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/alert-enricher/schemas/{schema_id}/rules'].post
update:
x-apievangelist-phrasing:
intent: Upload a full advanced mapping table as CSV
effect: write
questions:
- How do I replace an entire advanced mapping table by uploading a CSV?
- Is the advanced map CSV upload processed asynchronously with a job to track?
instructions:
- text: Upload CSV {csvdata} as the complete table for advanced mapping schema {schema_id}.
slots:
csvdata: requestBody.csvdata
schema_id: path.schema_id
- text: Replace the whole map for advanced schema {schema_id} with the CSV file {csvdata}.
slots:
schema_id: path.schema_id
csvdata: requestBody.csvdata
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/alert-enricher/schemas/{schema_id}/rules'].delete
update:
x-apievangelist-phrasing:
intent: Delete multiple rows from an advanced map
effect: destructive
questions:
- Can I remove a batch of rows from an advanced mapping table in one call?
- Is there a way to bulk-delete rows in an Alert Enricher map?
instructions:
- text: Delete the listed rows from advanced mapping schema {schema_id}.
slots:
schema_id: path.schema_id
- text: Bulk-remove rows from advanced map {schema_id}.
slots:
schema_id: path.schema_id
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/v2.0/alert-enrichments/{mapschema_id}/map'].get
update:
x-apievangelist-phrasing:
intent: Retrieve an Enrichment V2 mapping table
effect: read
questions:
- Can I view the contents of an Enrichment V2 mapping table?
- What rows are in my older Enrichment V2 enrichment map?
instructions:
- text: Get the Enrichment V2 map for mapping schema {mapschema_id}.
slots:
mapschema_id: path.mapschema_id
- text: Show the Enrichment V2 mapping table {mapschema_id}.
slots:
mapschema_id: path.mapschema_id
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/v2.0/alert-enrichments/{mapschema_id}/map'].post
update:
x-apievangelist-phrasing:
intent: Add rows to an Enrichment V2 mapping table
effect: write
questions:
- Can I append rows to an existing Enrichment V2 mapping table?
- What operation do I send to add rows to an Enrichment V2 map?
instructions:
- text: Add rows {value} to Enrichment V2 mapping table {mapschema_id} with op {op}.
slots:
value: requestBody.value
mapschema_id: path.mapschema_id
op: requestBody.op
- text: Append new rows {value} to the Enrichment V2 map {mapschema_id}.
slots:
value: requestBody.value
mapschema_id: path.mapschema_id
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/v2.0/alert-enrichments/{mapschema_id}/map'].patch
update:
x-apievangelist-phrasing:
intent: Update rows in an Enrichment V2 mapping table
effect: write
questions:
- How do I change existing rows in an Enrichment V2 mapping table?
- Can I edit specific rows of an Enrichment V2 map without re-uploading it?
instructions:
- text: Update rows in Enrichment V2 mapping table {mapschema_id} to {value} using op {op}.
slots:
mapschema_id: path.mapschema_id
value: requestBody.value
op: requestBody.op
- text: Edit existing Enrichment V2 map rows in {mapschema_id} to {value}.
slots:
mapschema_id: path.mapschema_id
value: requestBody.value
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/v2.1/mapping-enrichment/{mapschema_id}/map'].get
update:
x-apievangelist-phrasing:
intent: Retrieve a v2.1 mapping enrichment table
effect: read
questions:
- Can I page through a v2.1 mapping enrichment table as JSON?
- What format does a v2.1 mapping table come back in after its CSV upload?
instructions:
- text: Get page {page} of v2.1 mapping table {mapschema_id}.
slots:
page: query.page
mapschema_id: path.mapschema_id
- text: Show the v2.1 mapping enrichment table {mapschema_id}, {per_page} rows per page.
slots:
mapschema_id: path.mapschema_id
per_page: query.per_page
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/v2.1/mapping-enrichment/{mapschema_id}/map'].post
update:
x-apievangelist-phrasing:
intent: Upload a v2.1 mapping table from CSV
effect: write
questions:
- How do I upload a CSV mapping table for a v2.1 mapping schema?
- What content type does the v2.1 mapping table CSV upload expect?
instructions:
- text: Upload a CSV as the v2.1 mapping table for schema {mapschema_id}.
slots:
mapschema_id: path.mapschema_id
- text: Upload the enrichment map for v2.1 schema {mapschema_id} with content type {content_type}.
slots:
mapschema_id: path.mapschema_id
content_type: header.Content-Type
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/v2.1/mapping-enrichment/{mapschema_id}/map'].patch
update:
x-apievangelist-phrasing:
intent: Create, update, or delete a v2.1 mapping row
effect: write
questions:
- Can I add, change, or remove a single row in a v2.1 mapping table?
- How do I delete one row from a v2.1 mapping enrichment table?
instructions:
- text: Apply op {op} with row {value} to v2.1 mapping table {mapschema_id}.
slots:
op: requestBody.op
value: requestBody.value
mapschema_id: path.mapschema_id
- text: Remove row {value} from the v2.1 map {mapschema_id}.
slots:
value: requestBody.value
mapschema_id: path.mapschema_id
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/alert-enricher/schemas/{schema_id}'].get
update:
x-apievangelist-phrasing:
intent: Retrieve an advanced mapping schema
effect: read
questions:
- Can I look up one advanced mapping schema's config by ID?
- What settings does a given Alert Enricher schema have?
instructions:
- text: Get advanced mapping schema {schema_id}.
slots:
schema_id: path.schema_id
- text: Show the config of Alert Enricher schema {schema_id}.
slots:
schema_id: path.schema_id
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/alert-enricher/schemas/{schema_id}'].put
update:
x-apievangelist-phrasing:
intent: Update an advanced mapping schema
effect: write
questions:
- Can I rename or reconfigure an existing advanced mapping schema?
- Can I change where an advanced mapping schema falls in the execution order?
instructions:
- text: Update advanced schema {schema_id} with name {name}, type {type} and config {config}.
slots:
schema_id: path.schema_id
name: requestBody.name
type: requestBody.type
config: requestBody.config
- text: Move advanced schema {schema_id} to execution order {execution_order}, keeping name {name}, type {type}, config {config}.
slots:
schema_id: path.schema_id
execution_order: requestBody.execution_order
name: requestBody.name
type: requestBody.type
config: requestBody.config
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/alert-enricher/schemas/{schema_id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an advanced mapping schema
effect: destructive
questions:
- How do I delete an advanced mapping schema I no longer use?
- Can I remove an Alert Enricher schema entirely?
instructions:
- text: Delete advanced mapping schema {schema_id}.
slots:
schema_id: path.schema_id
- text: Remove Alert Enricher schema {schema_id} permanently.
slots:
schema_id: path.schema_id
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/v2.0/alert-enrichments/{enrichment_id}'].get
update:
x-apievangelist-phrasing:
intent: Retrieve an Enrichment V2 enrichment item
effect: read
questions:
- Can I look up a single Enrichment V2 enrichment item by ID?
- What's configured on a specific Enrichment V2 item?
instructions:
- text: Get Enrichment V2 item {enrichment_id}.
slots:
enrichment_id: path.enrichment_id
- text: Show the config of enrichment item {enrichment_id} from Enrichment V2.
slots:
enrichment_id: path.enrichment_id
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/v2.0/alert-enrichments/{enrichment_id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an Enrichment V2 enrichment item
effect: destructive
questions:
- How do I delete one enrichment item in Enrichment V2?
- Can I remove an Enrichment V2 item by its ID?
instructions:
- text: Delete Enrichment V2 item {enrichment_id}.
slots:
enrichment_id: path.enrichment_id
- text: Remove enrichment item {enrichment_id} from Enrichment V2.
slots:
enrichment_id: path.enrichment_id
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/v2.0/alert-enrichments/{enrichment_id}'].patch
update:
x-apievangelist-phrasing:
intent: Update an Enrichment V2 enrichment item
effect: write
questions:
- Can I deactivate an existing Enrichment V2 enrichment item?
- Can I change the condition on an Enrichment V2 item after creating it?
instructions:
- text: Update Enrichment V2 item {enrichment_id} with config {config}.
slots:
enrichment_id: path.enrichment_id
config: requestBody.config
- text: Change the condition on Enrichment V2 item {enrichment_id} to {when}.
slots:
enrichment_id: path.enrichment_id
when: requestBody.when
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/v2.1/enrichments-config/tags/{alerttag_name}'].get
update:
x-apievangelist-phrasing:
intent: Retrieve an alert tag
effect: read
questions:
- Can I look up one alert tag's settings by name?
- What does the v2.1 config say about a specific alert tag?
instructions:
- text: Get alert tag {alerttag_name}.
slots:
alerttag_name: path.alerttag_name
- text: Show the v2.1 definition of the {alerttag_name} tag.
slots:
alerttag_name: path.alerttag_name
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/v2.1/enrichments-config/tags/{alerttag_name}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an alert tag
effect: destructive
questions:
- How do I delete an alert tag I no longer need?
- Can I remove an alert tag from the enrichment config entirely?
instructions:
- text: Delete alert tag {alerttag_name}.
slots:
alerttag_name: path.alerttag_name
- text: Remove the {alerttag_name} tag from the enrichment config.
slots:
alerttag_name: path.alerttag_name
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/v2.1/enrichments-config/tags/{alerttag_name}'].patch
update:
x-apievangelist-phrasing:
intent: Update an alert tag's description or active state
effect: write
questions:
- Can I deactivate an alert tag without deleting it?
- How do I change an alert tag's description?
instructions:
- text: Set the description of alert tag {alerttag_name} to {description}.
slots:
alerttag_name: path.alerttag_name
description: requestBody.description
- text: Set alert tag {alerttag_name} active to {active}.
slots:
alerttag_name: path.alerttag_name
active: requestBody.active
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/alert-enricher/schemas/{schema_id}/rules/{row_id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete one row from an advanced map
effect: destructive
questions:
- Can I delete a single row from an advanced mapping table by its row ID?
- What do I call to remove just one Alert Enricher map row?
instructions:
- text: Delete row {row_id} from advanced mapping schema {schema_id}.
slots:
row_id: path.row_id
schema_id: path.schema_id
- text: Remove Alert Enricher map row {row_id} in schema {schema_id}.
slots:
row_id: path.row_id
schema_id: path.schema_id
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/alert-enricher/schemas/{schema_id}/rules/{row_id}'].patch
update:
x-apievangelist-phrasing:
intent: Update one row in an advanced map
effect: write
questions:
- Can I edit a single row in an advanced mapping table?
- Which row ID do I send to change one Alert Enricher map row?
instructions:
- text: Update row {row_id} in advanced mapping schema {schema_id}.
slots:
row_id: path.row_id
schema_id: path.schema_id
- text: Change the values of Alert Enricher map row {row_id} in {schema_id}, with row id {id}.
slots:
row_id: path.row_id
schema_id: path.schema_id
id: requestBody.id
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/v2.1/mapping-enrichment/{mapschema_id}'].get
update:
x-apievangelist-phrasing:
intent: Retrieve a v2.1 mapping enrichment schema
effect: read
questions:
- Can I view one v2.1 mapping enrichment schema's definition?
- What condition and note are set on a particular v2.1 mapping schema?
instructions:
- text: Get v2.1 mapping enrichment schema {mapschema_id}.
slots:
mapschema_id: path.mapschema_id
- text: Show the definition of v2.1 mapping schema {mapschema_id}.
slots:
mapschema_id: path.mapschema_id
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/v2.1/mapping-enrichment/{mapschema_id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a v2.1 mapping enrichment schema
effect: destructive
questions:
- How do I delete a v2.1 mapping enrichment schema?
- Can I remove a v2.1 mapping schema I set up by mistake?
instructions:
- text: Delete v2.1 mapping enrichment schema {mapschema_id}.
slots:
mapschema_id: path.mapschema_id
- text: Remove v2.1 mapping schema {mapschema_id}.
slots:
mapschema_id: path.mapschema_id
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/v2.1/mapping-enrichment/{mapschema_id}'].patch
update:
x-apievangelist-phrasing:
intent: Update a v2.1 mapping schema's state, condition or note
effect: write
questions:
- Which fields of a v2.1 mapping schema can I still change after creating it?
- Can I turn off a v2.1 mapping enrichment schema without deleting it?
instructions:
- text: Deactivate v2.1 mapping schema {mapschema_id}.
slots:
mapschema_id: path.mapschema_id
- text: Change the condition on v2.1 mapping schema {mapschema_id} to {when} with note {note}.
slots:
mapschema_id: path.mapschema_id
when: requestBody.when
note: requestBody.note
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/v2.0/enrichments-config/tags'].get
update:
x-apievangelist-phrasing:
intent: List alert tags (Enrichment V2)
effect: read
questions:
- Which alert tags does my org have under the older Enrichment V2 API?
- Can I list every alert tag through Enrichment V2?
instructions:
- text: List all alert tags via Enrichment V2.
- text: Show my organization's alert tags using the Enrichment V2 endpoint.
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/v2.0/enrichments-config/tags/{alerttag_name}'].get
update:
x-apievangelist-phrasing:
intent: List a tag's enrichment items (Enrichment V2)
effect: read
questions:
- What enrichment items make up an alert tag in Enrichment V2?
- Can I see all the Enrichment V2 items attached to one tag?
instructions:
- text: List the Enrichment V2 items for tag {alerttag_name}.
slots:
alerttag_name: path.alerttag_name
- text: Show every enrichment item on the {alerttag_name} tag in Enrichment V2.
slots:
alerttag_name: path.alerttag_name
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/v2.1/alert-enrichments-jobs/{job_id}'].get
update:
x-apievangelist-phrasing:
intent: Check a v2.1 mapping table job status
effect: read
questions:
- Did my last v2.1 enrichment change finish?
- What status does a v2.1 mapping table job return?
instructions:
- text: Check v2.1 mapping table job {job_id}.
slots:
job_id: path.job_id
- text: Get the status of v2.1 enrichment job {job_id}.
slots:
job_id: path.job_id
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/alert-enricher/jobs/{job_id}'].get
update:
x-apievangelist-phrasing:
intent: Check an advanced map upload job
effect: read
questions:
- Has my advanced mapping CSV upload finished?
- Can I track an Alert Enricher map upload by its job ID?
instructions:
- text: Check Alert Enricher upload job {job_id}.
slots:
job_id: path.job_id
- text: Get the upload status of advanced map job {job_id}.
slots:
job_id: path.job_id
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/v2.0/enrichments-config/tags/{alerttag_name}/order'].get
update:
x-apievangelist-phrasing:
intent: Get a tag's enrichment item order (Enrichment V2)
effect: read
questions:
- In what order do an alert tag's enrichment items run under Enrichment V2?
- Can I see the Enrichment V2 execution order of the items on one tag?
instructions:
- text: Get the Enrichment V2 item order for tag {alerttag_name}.
slots:
alerttag_name: path.alerttag_name
- text: Show which enrichment items run first on tag {alerttag_name} in Enrichment V2.
slots:
alerttag_name: path.alerttag_name
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/v2.0/enrichments-config/tags/{alerttag_name}/order'].put
update:
x-apievangelist-phrasing:
intent: Reorder a tag's enrichment items (Enrichment V2)
effect: write
questions:
- Can I change which enrichment items run first on a tag with Enrichment V2?
- What order do Enrichment V2 items run in if I never set one for the tag?
instructions:
- text: Reorder the Enrichment V2 items on tag {alerttag_name}.
slots:
alerttag_name: path.alerttag_name
- text: Set a new Enrichment V2 enrichment_order for tag {alerttag_name}.
slots:
alerttag_name: path.alerttag_name
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/v2.0/enrichments-config'].get
update:
x-apievangelist-phrasing:
intent: Get the alert tag execution order (Enrichment V2)
effect: read
questions:
- In what order do my alert tags run under Enrichment V2?
- Can I see the Enrichment V2 alert_tags_order list?
instructions:
- text: Get the Enrichment V2 tag execution order.
- text: Show which alert tags run first in Enrichment V2.
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/v2.0/enrichments-config'].put
update:
x-apievangelist-phrasing:
intent: Reorder alert tags (Enrichment V2)
effect: write
questions:
- Can I change the order my alert tags run in with Enrichment V2?
- How do I move a tag earlier in the Enrichment V2 alert_tags_order?
instructions:
- text: Set the Enrichment V2 tag order to {alert_tags_order}.
slots:
alert_tags_order: query.alert_tags_order
- text: Reorder Enrichment V2 alert tags as {alert_tags_order}.
slots:
alert_tags_order: query.alert_tags_order
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/v2.1/enrichments-config'].put
update:
x-apievangelist-phrasing:
intent: Reorder alert tags (v2.1)
effect: write
questions:
- How do I change the run order of alert tags using v2.1?
- Can I make one tag run before another with the v2.1 config?
instructions:
- text: Set the v2.1 alert tag run order to {alert_tags_order}.
slots:
alert_tags_order: requestBody.alert_tags_order
- text: Update the v2.1 tag run order so tags run as {alert_tags_order}.
slots:
alert_tags_order: requestBody.alert_tags_order
method: generated
generated: '2026-09-26'
# --- truncated at 32 KB (32 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bigpanda/refs/heads/main/overlays/bigpanda-alert-tags-enrichment-api-phrasing-overlay.yaml