Sentry · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sentry Crons Check Ins API

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

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/organizations/{organization_id_or_slug}/monitors/{monitor_id_or_slug}/checkins/'].get
$.paths['/projects/{organization_id_or_slug}/{project_id_or_slug}/monitors/{monitor_id_or_slug}/checkins/'].get

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 Sentry Crons Check Ins API
  version: 1.0.0
extends: openapi/sentry-system-check-ins-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['/organizations/{organization_id_or_slug}/monitors/{monitor_id_or_slug}/checkins/'].get
  update:
    x-apievangelist-phrasing:
      intent: List a cron monitor's check-ins
      effect: read
      questions:
      - How can I see every check-in a cron monitor has recorded?
      - Did my scheduled job check in on time recently?
      instructions:
      - text: List check-ins for monitor {monitor} in organization {org}.
        slots:
          monitor: path.monitor_id_or_slug
          org: path.organization_id_or_slug
      - text: Show the next page of check-ins for monitor {monitor} from cursor {cursor}.
        slots:
          monitor: path.monitor_id_or_slug
          cursor: query.cursor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{organization_id_or_slug}/{project_id_or_slug}/monitors/{monitor_id_or_slug}/checkins/'].get
  update:
    x-apievangelist-phrasing:
      intent: List a monitor's check-ins within a project
      effect: read
      questions:
      - Can I pull a monitor's check-ins scoped to one project?
      - Where do I see check-in history for a cron job under a specific project?
      instructions:
      - text: List check-ins for monitor {monitor} in project {project} of {org}.
        slots:
          monitor: path.monitor_id_or_slug
          project: path.project_id_or_slug
          org: path.organization_id_or_slug
      - text: Show project {project}'s check-in history for monitor {monitor}.
        slots:
          project: path.project_id_or_slug
          monitor: path.monitor_id_or_slug
      method: generated
      generated: '2026-09-26'