Oracle Cloud Infrastructure · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Events API

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

$.info

$.paths['/rules'].get

$.paths['/rules'].post

$.paths['/rules/{ruleId}'].get

$.paths['/rules/{ruleId}'].put

$.paths['/rules/{ruleId}'].delete

$.paths['/rules/{ruleId}/actions/changeCompartment'].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 Events API
  version: 1.0.0
extends: openapi/oracle-cloud-events-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: 6
- target: $.paths['/rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List event rules in a compartment
      effect: read
      questions:
      - What event rules are set up in my compartment?
      - Can I list only the event rules that are active, or find one by name?
      instructions:
      - text: List the event rules in compartment {compartmentId}.
        slots:
          compartmentId: query.compartmentId
      - text: Find event rules named {displayName} in compartment {compartmentId}.
        slots:
          displayName: query.displayName
          compartmentId: query.compartmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an event rule
      effect: write
      questions:
      - How do I trigger a notification or function when a resource event happens in Oracle Cloud?
      - What condition and actions does a new event rule need?
      instructions:
      - text: Create an enabled event rule {displayName} in compartment {compartmentId} matching {condition} and running actions {actions}.
        slots:
          displayName: requestBody.displayName
          compartmentId: requestBody.compartmentId
          condition: requestBody.condition
          actions: requestBody.actions
      - text: Set up event rule {displayName} in compartment {compartmentId} with condition {condition}, actions {actions}, enabled {isEnabled}.
        slots:
          displayName: requestBody.displayName
          compartmentId: requestBody.compartmentId
          condition: requestBody.condition
          actions: requestBody.actions
          isEnabled: requestBody.isEnabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rules/{ruleId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an event rule
      effect: read
      questions:
      - Which events does a particular rule match and what does it do?
      - Is my event rule currently enabled?
      instructions:
      - text: Show event rule {ruleId}.
        slots:
          ruleId: path.ruleId
      - text: Get the condition and actions of rule {ruleId}.
        slots:
          ruleId: path.ruleId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rules/{ruleId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update or disable an event rule
      effect: write
      questions:
      - Can I temporarily disable an event rule without deleting it?
      - How do I change the condition an existing event rule matches on?
      instructions:
      - text: Disable event rule {ruleId}.
        slots:
          ruleId: path.ruleId
      - text: Change the condition of rule {ruleId} to {condition}.
        slots:
          ruleId: path.ruleId
          condition: requestBody.condition
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rules/{ruleId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an event rule
      effect: destructive
      questions:
      - How do I delete an event rule I no longer need?
      - Can I permanently remove a rule so it stops firing actions?
      instructions:
      - text: Delete event rule {ruleId}.
        slots:
          ruleId: path.ruleId
      - text: Remove rule {ruleId} permanently.
        slots:
          ruleId: path.ruleId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rules/{ruleId}/actions/changeCompartment'].post
  update:
    x-apievangelist-phrasing:
      intent: Move an event rule to another compartment
      effect: write
      questions:
      - Can I move an event rule into a different compartment?
      - Which call relocates a rule within the same tenancy?
      instructions:
      - text: Move event rule {ruleId} to compartment {compartmentId}.
        slots:
          ruleId: path.ruleId
          compartmentId: requestBody.compartmentId
      - text: Relocate rule {ruleId} into compartment {compartmentId}.
        slots:
          ruleId: path.ruleId
          compartmentId: requestBody.compartmentId
      method: generated
      generated: '2026-09-26'