Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
348 changes: 165 additions & 183 deletions README.md

Large diffs are not rendered by default.

527 changes: 527 additions & 0 deletions package-lock.json

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions provider-dev/docgen/provider-data/headerContent1.txt
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
---
title: REPLACEME
title: pagerduty
hide_title: false
hide_table_of_contents: false
keywords:
- REPLACEME
- pagerduty
- stackql
- infrastructure-as-code
- configuration-as-data
- cloud inventory
description: Query, deploy and manage REPLACEME resources using SQL
description: Query, manage, and integrate PagerDuty resources using SQL
custom_edit_url: null
image: /img/stackql-REPLACEME-provider-featured-image.png
image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png
id: 'provider-intro'
---

import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';

REPLACEME with description for the provider.
Incident management platform for real-time operations and response workflows.
10 changes: 5 additions & 5 deletions provider-dev/docgen/provider-data/headerContent2.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,18 @@ See also:

## Installation

To pull the latest version of the `REPLACEME` provider, run the following command:
To pull the latest version of the `pagerduty` provider, run the following command:

```bash
REGISTRY PULL REPLACEME;
REGISTRY PULL pagerduty;
```
> To view previous provider versions or to pull a specific provider version, see [here](https://stackql.io/docs/language-spec/registry).

## Authentication

The following system environment variables are used for authentication by default:

- <CopyableCode code="REPLACEME" /> - REPLACEME API token (see <a href="REPLACEME>How to Create a Personal Access Token</a>)
- <CopyableCode code="PAGERDUTY_API_TOKEN" /> - PagerDuty API token (see <a href="https://support.pagerduty.com/docs/api-access-keys#section-generating-a-general-access-rest-api-key">Creating a PagerDuty API Token</a>)

These variables are sourced at runtime (from the local machine or as CI variables/secrets).

Expand All @@ -27,15 +27,15 @@ To use different environment variables (instead of the defaults), use the `--aut

```bash

AUTH='{ "REPLACEME": { "type": "bearer", "credentialsenvvar": "REPLACEME" }}'
AUTH='{ "pagerduty": { "type": "bearer", "credentialsenvvar": "YOUR_PAGERDUTY_API_TOKEN_VAR" }}'
stackql shell --auth="${AUTH}"

```
or using PowerShell:

```powershell

$Auth = "{ 'REPLACEME': { 'type': 'bearer', 'credentialsenvvar': 'REPLACEME' }}"
$Auth = "{ 'pagerduty': { 'type': 'bearer', 'credentialsenvvar': 'YOUR_PAGERDUTY_API_TOKEN_VAR' }}"
stackql.exe shell --auth=$Auth

```
Expand Down
Empty file removed provider-dev/openapi/.gitkeep
Empty file.
327 changes: 327 additions & 0 deletions provider-dev/openapi/src/pagerduty/v00.00.00000/provider.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,327 @@
id: pagerduty
name: pagerduty
version: v00.00.00000
providerServices:
abilities:
id: 'abilities:v00.00.00000'
name: abilities
preferred: true
service:
$ref: pagerduty/v00.00.00000/services/abilities.yaml
title: PagerDuty API - Abilities
version: v00.00.00000
description: |
This Describes Your Account'S Abilities By Feature Name. For Example `"Teams"`.
An Ability May Be Available To Your Account Based On Things Like Your Pricing Plan Or Account State.
add_ons:
id: 'add_ons:v00.00.00000'
name: add_ons
preferred: true
service:
$ref: pagerduty/v00.00.00000/services/add_ons.yaml
title: PagerDuty API - Add Ons
version: v00.00.00000
description: |
Developers Can Write Their Own Functionality To Insert Into PagerDuty'S UI.
analytics:
id: 'analytics:v00.00.00000'
name: analytics
preferred: true
service:
$ref: pagerduty/v00.00.00000/services/analytics.yaml
title: PagerDuty API - Analytics
version: v00.00.00000
description: |
Provides Enriched Incident Data.
audit:
id: 'audit:v00.00.00000'
name: audit
preferred: true
service:
$ref: pagerduty/v00.00.00000/services/audit.yaml
title: PagerDuty API - Audit
version: v00.00.00000
description: |
Provides Audit Record Data.
automation_actions:
id: 'automation_actions:v00.00.00000'
name: automation_actions
preferred: true
service:
$ref: pagerduty/v00.00.00000/services/automation_actions.yaml
title: PagerDuty API - Automation Actions
version: v00.00.00000
description: Automation Actions
business_services:
id: 'business_services:v00.00.00000'
name: business_services
preferred: true
service:
$ref: pagerduty/v00.00.00000/services/business_services.yaml
title: PagerDuty API - Business Services
version: v00.00.00000
description: Business Services
change_events:
id: 'change_events:v00.00.00000'
name: change_events
preferred: true
service:
$ref: pagerduty/v00.00.00000/services/change_events.yaml
title: PagerDuty API - Change Events
version: v00.00.00000
description: Change Events
custom_fields:
id: 'custom_fields:v00.00.00000'
name: custom_fields
preferred: true
service:
$ref: pagerduty/v00.00.00000/services/custom_fields.yaml
title: PagerDuty API - Custom Fields
version: v00.00.00000
description: Custom Fields
escalation_policies:
id: 'escalation_policies:v00.00.00000'
name: escalation_policies
preferred: true
service:
$ref: pagerduty/v00.00.00000/services/escalation_policies.yaml
title: PagerDuty API - Escalation Policies
version: v00.00.00000
description: Escalation Policies
event_orchestrations:
id: 'event_orchestrations:v00.00.00000'
name: event_orchestrations
preferred: true
service:
$ref: pagerduty/v00.00.00000/services/event_orchestrations.yaml
title: PagerDuty API - Event Orchestrations
version: v00.00.00000
description: Event Orchestrations
extensions:
id: 'extensions:v00.00.00000'
name: extensions
preferred: true
service:
$ref: pagerduty/v00.00.00000/services/extensions.yaml
title: PagerDuty API - Extensions
version: v00.00.00000
description: |
Extensions Are Representations Of Extension Schema Objects That Are Attached To Services.
extension_schemas:
id: 'extension_schemas:v00.00.00000'
name: extension_schemas
preferred: true
service:
$ref: pagerduty/v00.00.00000/services/extension_schemas.yaml
title: PagerDuty API - Extension Schemas
version: v00.00.00000
description: Extension Schemas
incidents:
id: 'incidents:v00.00.00000'
name: incidents
preferred: true
service:
$ref: pagerduty/v00.00.00000/services/incidents.yaml
title: PagerDuty API - Incidents
version: v00.00.00000
description: |
An Incident Represents A Problem Or An Issue That Needs To Be Addressed And Resolved. Incidents Trigger On A Service, Which Prompts Notifications To Go Out To On-Call Responders Per The Service'S Escalation Policy.
incident_workflows:
id: 'incident_workflows:v00.00.00000'
name: incident_workflows
preferred: true
service:
$ref: pagerduty/v00.00.00000/services/incident_workflows.yaml
title: PagerDuty API - Incident Workflows
version: v00.00.00000
description: Incident Workflows
licenses:
id: 'licenses:v00.00.00000'
name: licenses
preferred: true
service:
$ref: pagerduty/v00.00.00000/services/licenses.yaml
title: PagerDuty API - Licenses
version: v00.00.00000
description: |
Licenses Are Allocated To Users To Allow For Per-User Access To PagerDuty Functionality Within An Account.
log_entries:
id: 'log_entries:v00.00.00000'
name: log_entries
preferred: true
service:
$ref: pagerduty/v00.00.00000/services/log_entries.yaml
title: PagerDuty API - Log Entries
version: v00.00.00000
description: Log Entries
maintenance_windows:
id: 'maintenance_windows:v00.00.00000'
name: maintenance_windows
preferred: true
service:
$ref: pagerduty/v00.00.00000/services/maintenance_windows.yaml
title: PagerDuty API - Maintenance Windows
version: v00.00.00000
description: Maintenance Windows
notifications:
id: 'notifications:v00.00.00000'
name: notifications
preferred: true
service:
$ref: pagerduty/v00.00.00000/services/notifications.yaml
title: PagerDuty API - Notifications
version: v00.00.00000
description: |
A Notification Is Created When An Incident Is Triggered Or Escalated.
on_calls:
id: 'on_calls:v00.00.00000'
name: on_calls
preferred: true
service:
$ref: pagerduty/v00.00.00000/services/on_calls.yaml
title: PagerDuty API - On Calls
version: v00.00.00000
description: |
An On-Call Represents A Contiguous Unit Of Time For Which A User Will Be On Call For A Given Escalation Policy And Escalation Rules
paused_incident_reports:
id: 'paused_incident_reports:v00.00.00000'
name: paused_incident_reports
preferred: true
service:
$ref: pagerduty/v00.00.00000/services/paused_incident_reports.yaml
title: PagerDuty API - Paused Incident Reports
version: v00.00.00000
description: Paused Incident Reports
priorities:
id: 'priorities:v00.00.00000'
name: priorities
preferred: true
service:
$ref: pagerduty/v00.00.00000/services/priorities.yaml
title: PagerDuty API - Priorities
version: v00.00.00000
description: |
A Priority Is A Label Representing The Importance And Impact Of An Incident. This Feature Is Only Available On Standard And Enterprise Plans.
response_plays:
id: 'response_plays:v00.00.00000'
name: response_plays
preferred: true
service:
$ref: pagerduty/v00.00.00000/services/response_plays.yaml
title: PagerDuty API - Response Plays
version: v00.00.00000
description: Response Plays
rulesets:
id: 'rulesets:v00.00.00000'
name: rulesets
preferred: true
service:
$ref: pagerduty/v00.00.00000/services/rulesets.yaml
title: PagerDuty API - Rulesets
version: v00.00.00000
description: |
Rulesets Allow You To Route Events To An Endpoint And Create Collections Of Event Rules, Which Define Sets Of Actions To Take Based On Event Content.
schedules:
id: 'schedules:v00.00.00000'
name: schedules
preferred: true
service:
$ref: pagerduty/v00.00.00000/services/schedules.yaml
title: PagerDuty API - Schedules
version: v00.00.00000
description: |
A Schedule Determines The Time Periods That Users Are On-Call.
services:
id: 'services:v00.00.00000'
name: services
preferred: true
service:
$ref: pagerduty/v00.00.00000/services/services.yaml
title: PagerDuty API - Services
version: v00.00.00000
description: |
A Service May Represent An Application, Component, Or Team You Wish To Open Incidents Against.
service_dependencies:
id: 'service_dependencies:v00.00.00000'
name: service_dependencies
preferred: true
service:
$ref: pagerduty/v00.00.00000/services/service_dependencies.yaml
title: PagerDuty API - Service Dependencies
version: v00.00.00000
description: Service Dependencies
status_dashboards:
id: 'status_dashboards:v00.00.00000'
name: status_dashboards
preferred: true
service:
$ref: pagerduty/v00.00.00000/services/status_dashboards.yaml
title: PagerDuty API - Status Dashboards
version: v00.00.00000
description: Status Dashboards
tags:
id: 'tags:v00.00.00000'
name: tags
preferred: true
service:
$ref: pagerduty/v00.00.00000/services/tags.yaml
title: PagerDuty API - Tags
version: v00.00.00000
description: |
A Tag Is Applied To Escalation Policies, Teams Or Users And Can Be Used To Filter Them.
teams:
id: 'teams:v00.00.00000'
name: teams
preferred: true
service:
$ref: pagerduty/v00.00.00000/services/teams.yaml
title: PagerDuty API - Teams
version: v00.00.00000
description: |
A Team Is A Collection Of Users And Escalation Policies That Represent A Group Of People Within An Organization.
templates:
id: 'templates:v00.00.00000'
name: templates
preferred: true
service:
$ref: pagerduty/v00.00.00000/services/templates.yaml
title: PagerDuty API - Templates
version: v00.00.00000
description: |
Templates Is A New Feature Which Will Allow Customers To Create Message Templates To Be Leveraged By (But Not Limited To) Status Updates. The API Will Be Secured To Customers With The Status Updates Entitlements.
users:
id: 'users:v00.00.00000'
name: users
preferred: true
service:
$ref: pagerduty/v00.00.00000/services/users.yaml
title: PagerDuty API - Users
version: v00.00.00000
description: |
Users Are Members Of A PagerDuty Account That Have The Ability To Interact With Incidents And Other Data On The Account.
vendors:
id: 'vendors:v00.00.00000'
name: vendors
preferred: true
service:
$ref: pagerduty/v00.00.00000/services/vendors.yaml
title: PagerDuty API - Vendors
version: v00.00.00000
description: |
A PagerDuty Vendor Represents A Specific Type Of Integration. AWS Cloudwatch, Splunk, Datadog Are All Examples Of Vendors
webhooks:
id: 'webhooks:v00.00.00000'
name: webhooks
preferred: true
service:
$ref: pagerduty/v00.00.00000/services/webhooks.yaml
title: PagerDuty API - Webhooks
version: v00.00.00000
description: |
A Webhook Is A Way To Receive Events That Occur On The PagerDuty Platform Via An HTTP POST Request.
V3 Webhooks Are Set Up By Creating A Webhook Subscription.
config:
auth:
type: api_key
valuePrefix: Token token=
credentialsenvvar: PAGERDUTY_API_TOKEN
Loading
Loading