# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Notifications Notification Control Plane API
  version: 1.0.0
extends: openapi/oracle-cloud-notificationcontrolplane-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: 22
- target: $.paths['/publisherMapGroups'].get
  update:
    x-apievangelist-phrasing:
      intent: List publisher map groups in a compartment
      effect: read
      questions:
      - Which publisher map groups are set up in my compartment?
      - Where can I see all the groups that bundle my notification publisher maps?
      instructions:
      - text: List the publisher map groups in compartment {compartmentId}.
        slots:
          compartmentId: query.compartmentId
      - text: Show every publisher map group defined under compartment {compartmentId}.
        slots:
          compartmentId: query.compartmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/publisherMapGroups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a publisher map group
      effect: write
      questions:
      - How do I bundle several publisher maps into one group for notifications?
      - Can I create a publisher map group with a description and tags?
      instructions:
      - text: Create a publisher map group named {name} in compartment {compartmentId}.
        slots:
          name: requestBody.name
          compartmentId: requestBody.compartmentId
      - text: Create publisher map group {name} in compartment {compartmentId} containing maps {publisherMapIds}.
        slots:
          name: requestBody.name
          compartmentId: requestBody.compartmentId
          publisherMapIds: requestBody.publisherMapIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/publisherMapGroups/{publisherMapGroupId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a publisher map group's configuration
      effect: read
      questions:
      - Which publisher maps are included in a particular publisher map group?
      - What does a given publisher map group's configuration look like?
      instructions:
      - text: Get publisher map group {publisherMapGroupId}.
        slots:
          publisherMapGroupId: path.publisherMapGroupId
      - text: Show the maps inside publisher map group {publisherMapGroupId}.
        slots:
          publisherMapGroupId: path.publisherMapGroupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/publisherMapGroups/{publisherMapGroupId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change the maps in a publisher map group
      effect: write
      questions:
      - How do I change which publisher maps belong to a group?
      - Can I update a locked publisher map group by overriding its lock?
      instructions:
      - text: Set the publisher maps in group {publisherMapGroupId} to {publisherMapIds}.
        slots:
          publisherMapGroupId: path.publisherMapGroupId
          publisherMapIds: requestBody.publisherMapIds
      - text: Update the description of publisher map group {publisherMapGroupId} to {description}.
        slots:
          publisherMapGroupId: path.publisherMapGroupId
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/publisherMapGroups/{publisherMapGroupId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a publisher map group
      effect: destructive
      questions:
      - How do I remove a publisher map group I no longer use?
      - Can I delete a publisher map group that has a lock on it?
      instructions:
      - text: Delete publisher map group {publisherMapGroupId}.
        slots:
          publisherMapGroupId: path.publisherMapGroupId
      - text: 'Delete publisher map group {publisherMapGroupId}, overriding its lock: {isLockOverride}.'
        slots:
          publisherMapGroupId: path.publisherMapGroupId
          isLockOverride: query.isLockOverride
      method: generated
      generated: '2026-09-26'
- target: $.paths['/publisherMapGroups/{publisherMapGroupId}/actions/addLock'].post
  update:
    x-apievangelist-phrasing:
      intent: Lock a publisher map group
      effect: write
      questions:
      - How do I protect a publisher map group from being changed or deleted?
      - Can I put a resource lock on a publisher map group?
      instructions:
      - text: Add a lock to publisher map group {publisherMapGroupId}.
        slots:
          publisherMapGroupId: path.publisherMapGroupId
      - text: Lock publisher map group {publisherMapGroupId} with {AddResourceLockDetails}.
        slots:
          publisherMapGroupId: path.publisherMapGroupId
          AddResourceLockDetails: body.AddResourceLockDetails
      method: generated
      generated: '2026-09-26'
- target: $.paths['/publisherMapGroups/{publisherMapGroupId}/actions/removeLock'].post
  update:
    x-apievangelist-phrasing:
      intent: Unlock a publisher map group
      effect: write
      questions:
      - How do I take the lock off a publisher map group?
      - Can I remove a delete-protection lock from a publisher map group?
      instructions:
      - text: Remove the lock from publisher map group {publisherMapGroupId}.
        slots:
          publisherMapGroupId: path.publisherMapGroupId
      - text: Unlock publisher map group {publisherMapGroupId} using {RemoveResourceLockDetails}.
        slots:
          publisherMapGroupId: path.publisherMapGroupId
          RemoveResourceLockDetails: body.RemoveResourceLockDetails
      method: generated
      generated: '2026-09-26'
- target: $.paths['/publisherMaps'].get
  update:
    x-apievangelist-phrasing:
      intent: List publisher maps in a compartment
      effect: read
      questions:
      - What publisher maps exist in my compartment?
      - Where do I see the message body mappings set up for notifications?
      instructions:
      - text: List the publisher maps in compartment {compartmentId}.
        slots:
          compartmentId: query.compartmentId
      - text: Show all individual publisher maps under compartment {compartmentId}.
        slots:
          compartmentId: query.compartmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/publisherMaps'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a publisher map for message formatting
      effect: write
      questions:
      - How do I create a publisher map that maps a message body for a delivery provider?
      - Which provider name and version does a new publisher map need?
      instructions:
      - text: Create publisher map {name} in compartment {compartmentId} for provider {providerName} version {providerVersion} with body map {bodyMap}.
        slots:
          name: requestBody.name
          compartmentId: requestBody.compartmentId
          providerName: requestBody.providerName
          providerVersion: requestBody.providerVersion
          bodyMap: requestBody.bodyMap
      - text: Add a publisher map named {name} for {providerName} {providerVersion} in compartment {compartmentId}, mapping {bodyMap}.
        slots:
          name: requestBody.name
          providerName: requestBody.providerName
          providerVersion: requestBody.providerVersion
          compartmentId: requestBody.compartmentId
          bodyMap: requestBody.bodyMap
      method: generated
      generated: '2026-09-26'
- target: $.paths['/publisherMaps/{publisherMapId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a publisher map's configuration
      effect: read
      questions:
      - What body map does a specific publisher map apply?
      - Which provider and version is a particular publisher map for?
      instructions:
      - text: Get publisher map {publisherMapId}.
        slots:
          publisherMapId: path.publisherMapId
      - text: Show the body mapping in publisher map {publisherMapId}.
        slots:
          publisherMapId: path.publisherMapId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/publisherMaps/{publisherMapId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a publisher map's body mapping
      effect: write
      questions:
      - How do I change the body mapping of an existing publisher map?
      - Can I edit a locked publisher map if I override the lock?
      instructions:
      - text: Replace the body map of publisher map {publisherMapId} with {bodyMap}.
        slots:
          publisherMapId: path.publisherMapId
          bodyMap: requestBody.bodyMap
      - text: Change publisher map {publisherMapId} description to {description}.
        slots:
          publisherMapId: path.publisherMapId
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/publisherMaps/{publisherMapId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a publisher map
      effect: destructive
      questions:
      - How do I delete a single publisher map?
      - Is it possible to delete a publisher map that is locked?
      instructions:
      - text: Delete publisher map {publisherMapId}.
        slots:
          publisherMapId: path.publisherMapId
      - text: Remove publisher map {publisherMapId} with lock override set to {isLockOverride}.
        slots:
          publisherMapId: path.publisherMapId
          isLockOverride: query.isLockOverride
      method: generated
      generated: '2026-09-26'
- target: $.paths['/publisherMaps/{publisherMapId}/actions/addLock'].post
  update:
    x-apievangelist-phrasing:
      intent: Lock a publisher map
      effect: write
      questions:
      - How do I stop a publisher map from being deleted by accident?
      - Can I add a resource lock to an individual publisher map?
      instructions:
      - text: Protect the single publisher map {publisherMapId} with a lock.
        slots:
          publisherMapId: path.publisherMapId
      - text: Lock publisher map {publisherMapId} using {AddResourceLockDetails}.
        slots:
          publisherMapId: path.publisherMapId
          AddResourceLockDetails: body.AddResourceLockDetails
      method: generated
      generated: '2026-09-26'
- target: $.paths['/publisherMaps/{publisherMapId}/actions/removeLock'].post
  update:
    x-apievangelist-phrasing:
      intent: Unlock a publisher map
      effect: write
      questions:
      - How do I remove the lock on a publisher map?
      - Can I release a resource lock from one publisher map?
      instructions:
      - text: Release the lock held on individual publisher map {publisherMapId}.
        slots:
          publisherMapId: path.publisherMapId
      - text: Unlock publisher map {publisherMapId} with {RemoveResourceLockDetails}.
        slots:
          publisherMapId: path.publisherMapId
          RemoveResourceLockDetails: body.RemoveResourceLockDetails
      method: generated
      generated: '2026-09-26'
- target: $.paths['/topics'].get
  update:
    x-apievangelist-phrasing:
      intent: List notification topics in a compartment
      effect: read
      questions:
      - What notification topics exist in my compartment?
      - Can I find a notification topic by its name?
      - Which topics are currently active versus being deleted?
      instructions:
      - text: List the notification topics in compartment {compartmentId}.
        slots:
          compartmentId: query.compartmentId
      - text: Find the topic named {name} in compartment {compartmentId}.
        slots:
          name: query.name
          compartmentId: query.compartmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/topics'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a notification topic
      effect: write
      questions:
      - How do I create a topic in OCI Notifications to send alerts to?
      - Can a new notification topic have a description and tags?
      instructions:
      - text: Create a notification topic named {name} in compartment {compartmentId}.
        slots:
          name: requestBody.name
          compartmentId: requestBody.compartmentId
      - text: Create topic {name} in compartment {compartmentId} described as {description}.
        slots:
          name: requestBody.name
          compartmentId: requestBody.compartmentId
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/topics/{topicId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a notification topic and its API endpoint
      effect: read
      questions:
      - How do I find the API endpoint of a notification topic for publishing?
      - What configuration does a specific notification topic have?
      instructions:
      - text: Get notification topic {topicId}.
        slots:
          topicId: path.topicId
      - text: Show the API endpoint for topic {topicId}.
        slots:
          topicId: path.topicId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/topics/{topicId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a notification topic's description
      effect: write
      questions:
      - How do I change a notification topic's description?
      - Can I retag a topic that already exists?
      instructions:
      - text: Set the description of topic {topicId} to {description}.
        slots:
          topicId: path.topicId
          description: requestBody.description
      - text: Update notification topic {topicId} with description {description} and tags {freeformTags}.
        slots:
          topicId: path.topicId
          description: requestBody.description
          freeformTags: requestBody.freeformTags
      method: generated
      generated: '2026-09-26'
- target: $.paths['/topics/{topicId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a notification topic
      effect: destructive
      questions:
      - How do I delete a notification topic?
      - Can I delete a topic that has a lock on it?
      instructions:
      - text: Delete notification topic {topicId}.
        slots:
          topicId: path.topicId
      - text: 'Remove topic {topicId}, overriding locks: {isLockOverride}.'
        slots:
          topicId: path.topicId
          isLockOverride: query.isLockOverride
      method: generated
      generated: '2026-09-26'
- target: $.paths['/topics/{topicId}/actions/addLock'].post
  update:
    x-apievangelist-phrasing:
      intent: Lock a notification topic
      effect: write
      questions:
      - How do I protect a notification topic from deletion with a lock?
      - Can I add a resource lock to a topic?
      instructions:
      - text: Add a lock to topic {topicId}.
        slots:
          topicId: path.topicId
      - text: Lock notification topic {topicId} using {AddResourceLockDetails}.
        slots:
          topicId: path.topicId
          AddResourceLockDetails: body.AddResourceLockDetails
      method: generated
      generated: '2026-09-26'
- target: $.paths['/topics/{topicId}/actions/changeCompartment'].post
  update:
    x-apievangelist-phrasing:
      intent: Move a notification topic to another compartment
      effect: write
      questions:
      - How do I move a notification topic to a different compartment?
      - Can a topic be relocated within my tenancy?
      instructions:
      - text: Move topic {topicId} to compartment {compartmentId}.
        slots:
          topicId: path.topicId
          compartmentId: requestBody.compartmentId
      - text: Relocate notification topic {topicId} into compartment {compartmentId}.
        slots:
          topicId: path.topicId
          compartmentId: requestBody.compartmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/topics/{topicId}/actions/removeLock'].post
  update:
    x-apievangelist-phrasing:
      intent: Unlock a notification topic
      effect: write
      questions:
      - How do I remove a lock from a notification topic?
      - Can I unlock a topic so it can be deleted?
      instructions:
      - text: Remove the lock from topic {topicId}.
        slots:
          topicId: path.topicId
      - text: Unlock notification topic {topicId} with {RemoveResourceLockDetails}.
        slots:
          topicId: path.topicId
          RemoveResourceLockDetails: body.RemoveResourceLockDetails
      method: generated
      generated: '2026-09-26'