Oracle Cloud Infrastructure · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Oracle Cloud Monitoring Alarms API

6 actions 6 updates phrasing extends openapi/oracle-cloud-alarms-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/alarms'].get

$.paths['/alarms'].post

$.paths['/alarms/{alarmId}'].get

$.paths['/alarms/{alarmId}'].put

$.paths['/alarms/{alarmId}'].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 Oracle Cloud Monitoring Alarms API
  version: 1.0.0
extends: openapi/oracle-cloud-alarms-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['/alarms'].get
  update:
    x-apievangelist-phrasing:
      intent: List monitoring alarms in a compartment
      effect: read
      questions:
      - What monitoring alarms are set up in my compartment?
      - Where can I see every alarm defined for a compartment?
      instructions:
      - text: List the alarms in compartment {compartmentId}.
        slots:
          compartmentId: query.compartmentId
      - text: Show all monitoring alarms configured under {compartmentId}.
        slots:
          compartmentId: query.compartmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/alarms'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a monitoring alarm
      effect: write
      questions:
      - How do I create an alarm that fires when a metric query crosses a threshold?
      - Can an alarm send notifications to a topic when it triggers?
      - What severity levels can I give a new alarm?
      instructions:
      - text: 'Create alarm {displayName} in {compartmentId}: {query} on {namespace} in {metricCompartmentId}, {severity}, enabled {isEnabled}, notify {destinations}.'
        slots:
          displayName: requestBody.displayName
          compartmentId: requestBody.compartmentId
          namespace: requestBody.namespace
          query: requestBody.query
          severity: requestBody.severity
          isEnabled: requestBody.isEnabled
          destinations: requestBody.destinations
          metricCompartmentId: requestBody.metricCompartmentId
      - text: Set up a {severity} alarm named {displayName} watching {query} in {namespace}, compartment {compartmentId}.
        slots:
          severity: requestBody.severity
          displayName: requestBody.displayName
          query: requestBody.query
          namespace: requestBody.namespace
          compartmentId: requestBody.compartmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/alarms/{alarmId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an alarm's definition
      effect: read
      questions:
      - What query and severity does a particular alarm use?
      - Is a given alarm currently enabled?
      instructions:
      - text: Get alarm {alarmId}.
        slots:
          alarmId: path.alarmId
      - text: Show the query and destinations of alarm {alarmId}.
        slots:
          alarmId: path.alarmId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/alarms/{alarmId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change an alarm's query, severity or status
      effect: write
      questions:
      - How do I disable an alarm without deleting it?
      - Can I change the threshold query or severity of an existing alarm?
      instructions:
      - text: Set alarm {alarmId} enabled to {isEnabled}.
        slots:
          alarmId: path.alarmId
          isEnabled: requestBody.isEnabled
      - text: Change the query of alarm {alarmId} to {query} and severity to {severity}.
        slots:
          alarmId: path.alarmId
          query: requestBody.query
          severity: requestBody.severity
      method: generated
      generated: '2026-09-26'
- target: $.paths['/alarms/{alarmId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a monitoring alarm
      effect: destructive
      questions:
      - How do I permanently remove an alarm?
      - Can I delete an alarm I no longer need?
      instructions:
      - text: Delete alarm {alarmId}.
        slots:
          alarmId: path.alarmId
      - text: Permanently remove monitoring alarm {alarmId}.
        slots:
          alarmId: path.alarmId
      method: generated
      generated: '2026-09-26'