Checkly · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Checkly Public Deployment Triggers API

3 actions 3 updates phrasing extends openapi/checkly-deployment-triggers-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Checkly's API. It is a proposal applied on top of the contract, not a document Checkly publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/v1/deployment-triggers'].get
$.paths['/v1/deployment-triggers'].post

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Checkly Public Deployment Triggers API
  version: 1.0.0
extends: openapi/checkly-deployment-triggers-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['/v1/deployment-triggers'].get
  update:
    x-apievangelist-phrasing:
      intent: List deployment triggers
      effect: read
      questions:
      - Which checks run automatically after my GitHub deployments?
      - What deployment triggers are configured in my account?
      instructions:
      - text: List all my deployment triggers.
      - text: Show which repos have deployment triggers set up.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/deployment-triggers'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a check after each GitHub deployment
      effect: write
      questions:
      - How do I run my checks against a preview URL every time GitHub deploys?
      - Can I only trigger on deployments to environments matching a pattern?
      - Which deployment providers are supported?
      instructions:
      - text: Create a deployment trigger for repo {repoName} ({repoId}) that runs check {checkId}.
        slots:
          repoName: requestBody.repoName
          repoId: requestBody.repoId
          checkId: requestBody.checkId
      - text: Run check group {groupId} on deploys to {repoName} ({repoId}) for environments matching {environmentRegexFilter}.
        slots:
          groupId: requestBody.groupId
          repoName: requestBody.repoName
          repoId: requestBody.repoId
          environmentRegexFilter: requestBody.environmentRegexFilter
      method: generated
      generated: '2026-09-26'