Datadog APM · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Datadog APM — Service Level Objectives (API v1) Service Level Objective Corrections API

6 actions 6 updates phrasing extends openapi/datadog-apm-service-level-objective-corrections-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Datadog APM's API. It is a proposal applied on top of the contract, not a document Datadog APM publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/api/v1/slo/correction'].get
$.paths['/api/v1/slo/correction'].post
$.paths['/api/v1/slo/correction/{slo_correction_id}'].get
$.paths['/api/v1/slo/correction/{slo_correction_id}'].delete
$.paths['/api/v1/slo/correction/{slo_correction_id}'].patch

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 Datadog APM — Service Level Objectives (API v1) Service Level Objective Corrections API
  version: 1.0.0
extends: openapi/datadog-apm-service-level-objective-corrections-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['/api/v1/slo/correction'].get
  update:
    x-apievangelist-phrasing:
      intent: List all SLO corrections
      effect: read
      questions:
      - What SLO corrections exist across our whole Datadog org?
      - Can I page through SLO corrections beyond the default 25?
      instructions:
      - text: List all SLO corrections in the organization.
      - text: Get {limit} SLO corrections starting at offset {offset}.
        slots:
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/slo/correction'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an SLO correction window
      effect: write
      questions:
      - How do I exclude a maintenance window from my SLO calculations?
      - Can one correction apply to every SLO matching a query instead of a single SLO?
      instructions:
      - text: Create an SLO correction with {correction}.
        slots:
          correction: requestBody.data
      - text: 'Add a correction so last night''s planned downtime doesn''t count against the SLO: {correction}.'
        slots:
          correction: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/slo/correction/{slo_correction_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one SLO correction
      effect: read
      questions:
      - What time window and category does a specific SLO correction cover?
      - Can I look up a correction by its correction ID?
      instructions:
      - text: Get SLO correction {slo_correction_id}.
        slots:
          slo_correction_id: path.slo_correction_id
      - text: Show the details of correction {slo_correction_id}.
        slots:
          slo_correction_id: path.slo_correction_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/slo/correction/{slo_correction_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an SLO correction
      effect: destructive
      questions:
      - How do I permanently remove a correction so that downtime counts against the SLO again?
      - Is deleting an SLO correction reversible?
      instructions:
      - text: Delete SLO correction {slo_correction_id}.
        slots:
          slo_correction_id: path.slo_correction_id
      - text: Permanently remove the correction {slo_correction_id}.
        slots:
          slo_correction_id: path.slo_correction_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/slo/correction/{slo_correction_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an SLO correction
      effect: write
      questions:
      - Can I change the start or end time of a correction I already created?
      - How do I edit the description on an existing SLO correction?
      instructions:
      - text: Update SLO correction {slo_correction_id} with {changes}.
        slots:
          slo_correction_id: path.slo_correction_id
          changes: requestBody.data
      - text: Extend the window of existing correction {slo_correction_id}.
        slots:
          slo_correction_id: path.slo_correction_id
      method: generated
      generated: '2026-09-26'