Elastic Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Kibana Maintenance Window API

8 actions 8 updates phrasing extends openapi/elk-stack-maintenance-window-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Elastic Stack's API. It is a proposal applied on top of the contract, not a document Elastic Stack publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 8

$.info

$.paths['/api/maintenance_window'].post

$.paths['/api/maintenance_window/_find'].get

$.paths['/api/maintenance_window/{id}'].get

$.paths['/api/maintenance_window/{id}'].delete

$.paths['/api/maintenance_window/{id}'].patch

$.paths['/api/maintenance_window/{id}/_archive'].post

$.paths['/api/maintenance_window/{id}/_unarchive'].post

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 Kibana Maintenance Window API
  version: 1.0.0
extends: openapi/elk-stack-maintenance-window-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: 7
- target: $.paths['/api/maintenance_window'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a maintenance window
      effect: write
      questions:
      - How do I silence alert notifications during a planned deployment?
      - Can I schedule a recurring maintenance window that only covers some alerts?
      instructions:
      - text: Create a maintenance window {title} on schedule {schedule}.
        slots:
          title: requestBody.title
          schedule: requestBody.schedule
      - text: Schedule maintenance window {title} for {schedule} scoped to {scope}.
        slots:
          title: requestBody.title
          schedule: requestBody.schedule
          scope: requestBody.scope
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/maintenance_window/_find'].get
  update:
    x-apievangelist-phrasing:
      intent: Search maintenance windows
      effect: read
      questions:
      - Which maintenance windows are running right now?
      - Can I find maintenance windows created by a specific user?
      instructions:
      - text: Find maintenance windows with status {status}.
        slots:
          status: query.status
      - text: Search for maintenance windows titled {title}.
        slots:
          title: query.title
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/maintenance_window/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a maintenance window
      effect: read
      questions:
      - When does a particular maintenance window start and end?
      - What alerts does a given maintenance window cover?
      instructions:
      - text: Get maintenance window {id}.
        slots:
          id: path.id
      - text: Show the schedule and scope of maintenance window {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/maintenance_window/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a maintenance window
      effect: destructive
      questions:
      - How do I permanently delete a maintenance window?
      - Can I remove a maintenance window instead of just archiving it?
      instructions:
      - text: Delete maintenance window {id}.
        slots:
          id: path.id
      - text: Permanently remove maintenance window {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/maintenance_window/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit a maintenance window
      effect: write
      questions:
      - How do I extend or reschedule an existing maintenance window?
      - Can I disable a maintenance window temporarily?
      instructions:
      - text: Change the schedule of maintenance window {id} to {schedule}.
        slots:
          id: path.id
          schedule: requestBody.schedule
      - text: Set enabled to {enabled} on maintenance window {id}.
        slots:
          enabled: requestBody.enabled
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/maintenance_window/{id}/_archive'].post
  update:
    x-apievangelist-phrasing:
      intent: Archive a maintenance window
      effect: write
      questions:
      - How do I end a maintenance window early by archiving it?
      - Can I archive a maintenance window I no longer need but keep its record?
      instructions:
      - text: Archive maintenance window {id}.
        slots:
          id: path.id
      - text: End maintenance window {id} now by archiving it.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/maintenance_window/{id}/_unarchive'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore an archived maintenance window
      effect: write
      questions:
      - How do I bring back a maintenance window that was archived?
      - Can an archived maintenance window be reactivated?
      instructions:
      - text: Unarchive maintenance window {id}.
        slots:
          id: path.id
      - text: Restore archived maintenance window {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'