Checkly · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Checkly Public Dashboards API

6 actions 6 updates phrasing extends openapi/checkly-dashboards-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 6

$.info

$.paths['/v1/dashboards'].get

$.paths['/v1/dashboards'].post

$.paths['/v1/dashboards/{dashboardId}'].get

$.paths['/v1/dashboards/{dashboardId}'].put

$.paths['/v1/dashboards/{dashboardId}'].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 Checkly Public Dashboards API
  version: 1.0.0
extends: openapi/checkly-dashboards-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: 5
- target: $.paths['/v1/dashboards'].get
  update:
    x-apievangelist-phrasing:
      intent: List dashboards
      effect: read
      questions:
      - Which public dashboards have I created in Checkly?
      - Can I page through my dashboards?
      instructions:
      - text: List all my dashboards.
      - text: Show page {page} of my dashboards.
        slots:
          page: query.page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/dashboards'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a dashboard
      effect: write
      questions:
      - How do I publish a dashboard showing only checks with certain tags?
      - Can a dashboard be private or served on my own domain?
      - What happens if the custom URL I pick for a dashboard is already taken?
      instructions:
      - text: Create a dashboard with header {header}.
        slots:
          header: requestBody.header
      - text: Create dashboard {header} at subdomain {customUrl} showing checks tagged {tags}.
        slots:
          header: requestBody.header
          customUrl: requestBody.customUrl
          tags: requestBody.tags
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/dashboards/{dashboardId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a dashboard
      effect: read
      questions:
      - What tags and display settings does a specific dashboard use?
      - Is there a rate limit on fetching a dashboard?
      instructions:
      - text: Show dashboard {dashboardId}.
        slots:
          dashboardId: path.dashboardId
      - text: Get the configuration of dashboard {dashboardId}.
        slots:
          dashboardId: path.dashboardId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/dashboards/{dashboardId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a dashboard
      effect: write
      questions:
      - Can I make an existing dashboard private?
      - How do I change the refresh rate on a dashboard I already published?
      instructions:
      - text: Set dashboard {dashboardId} private to {isPrivate}.
        slots:
          dashboardId: path.dashboardId
          isPrivate: requestBody.isPrivate
      - text: Change dashboard {dashboardId} to refresh every {refreshRate} seconds.
        slots:
          dashboardId: path.dashboardId
          refreshRate: requestBody.refreshRate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/dashboards/{dashboardId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a dashboard
      effect: destructive
      questions:
      - How do I take down a dashboard permanently?
      - Can a deleted dashboard be recovered?
      instructions:
      - text: Delete dashboard {dashboardId}.
        slots:
          dashboardId: path.dashboardId
      - text: Permanently remove dashboard {dashboardId}.
        slots:
          dashboardId: path.dashboardId
      method: generated
      generated: '2026-09-26'