Oracle Cloud Infrastructure · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Oracle Cloud Monitoring Metrics API

3 actions 3 updates phrasing extends openapi/oracle-cloud-metrics-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 3

$.info

$.paths['/metrics/actions/summarizeMetricsData'].post

$.paths['/metrics'].get

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 Metrics API
  version: 1.0.0
extends: openapi/oracle-cloud-metrics-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['/metrics/actions/summarizeMetricsData'].post
  update:
    x-apievangelist-phrasing:
      intent: Get aggregated metric data for a query
      effect: read
      questions:
      - How can I pull aggregated CPU or memory metrics for my resources over a time range?
      - Can I set the resolution of the returned metric data points?
      instructions:
      - text: Summarize metric query {query} in namespace {namespace} for compartment {compartmentId}.
        slots:
          query: requestBody.query
          namespace: requestBody.namespace
          compartmentId: query.compartmentId
      - text: Get {query} data from {namespace} in {compartmentId} from {startTime} to {endTime} at resolution {resolution}.
        slots:
          query: requestBody.query
          namespace: requestBody.namespace
          compartmentId: query.compartmentId
          startTime: requestBody.startTime
          endTime: requestBody.endTime
          resolution: requestBody.resolution
      method: generated
      generated: '2026-09-26'
- target: $.paths['/metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: List available metric definitions
      effect: read
      questions:
      - What metrics can I query for resources in my compartment?
      - Which metric names exist within a specific namespace?
      instructions:
      - text: List metric definitions in compartment {compartmentId}.
        slots:
          compartmentId: query.compartmentId
      - text: Show metrics in namespace {namespace} for compartment {compartmentId}.
        slots:
          namespace: query.namespace
          compartmentId: query.compartmentId
      method: generated
      generated: '2026-09-26'