# 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 Data Plane API
  version: 1.0.0
extends: openapi/oracle-cloud-notificationdataplane-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: 12
- target: $.paths['/smsNumbers'].get
  update:
    x-apievangelist-phrasing:
      intent: List SMS numbers for an SMS provider
      effect: read
      questions:
      - Which SMS numbers are registered with my SMS provider?
      - Can I filter SMS numbers by state or by when they were last updated?
      instructions:
      - text: List the SMS numbers for SMS provider {smsProviderId}.
        slots:
          smsProviderId: query.smsProviderId
      - text: Show SMS numbers for provider {smsProviderId} in state {state}.
        slots:
          smsProviderId: query.smsProviderId
          state: query.state
      - text: List SMS numbers for provider {smsProviderId} updated since {startTime}.
        slots:
          smsProviderId: query.smsProviderId
          startTime: query.startTime
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List subscriptions for a compartment or topic
      effect: read
      questions:
      - Who is subscribed to my notification topic?
      - Can I list all subscriptions in a compartment regardless of topic?
      instructions:
      - text: List the subscriptions in compartment {compartmentId}.
        slots:
          compartmentId: query.compartmentId
      - text: List the subscriptions on topic {topicId} in compartment {compartmentId}.
        slots:
          topicId: query.topicId
          compartmentId: query.compartmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe an endpoint to a topic
      effect: write
      questions:
      - How do I subscribe an email address to a notification topic?
      - Which protocols can a topic subscription use, such as email, custom HTTPS or a function?
      - Does a new subscription stay pending until the endpoint confirms it?
      instructions:
      - text: Subscribe {endpoint} to topic {topicId} over {protocol} in compartment {compartmentId}.
        slots:
          endpoint: requestBody.endpoint
          topicId: requestBody.topicId
          protocol: requestBody.protocol
          compartmentId: requestBody.compartmentId
      - text: Send a confirmation link to email {endpoint} for topic {topicId}, protocol {protocol}, compartment {compartmentId}.
        slots:
          endpoint: requestBody.endpoint
          topicId: requestBody.topicId
          protocol: requestBody.protocol
          compartmentId: requestBody.compartmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{id}/confirmation'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a subscription's confirmation result
      effect: read
      questions:
      - How do I check the confirmation details of a subscription using its token?
      - What does a subscription's confirmation look like after the endpoint accepts?
      instructions:
      - text: Get the confirmation details for subscription {id} using token {token} and protocol {protocol}.
        slots:
          id: path.id
          token: query.token
          protocol: query.protocol
      - text: Check confirmation of subscription {id} with token {token} over {protocol}.
        slots:
          id: path.id
          token: query.token
          protocol: query.protocol
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{id}/resendConfirmation'].post
  update:
    x-apievangelist-phrasing:
      intent: Resend a subscription confirmation
      effect: write
      questions:
      - How do I resend the confirmation link for a pending subscription?
      - The subscriber never got the confirmation email, can I send it again?
      instructions:
      - text: Resend the confirmation for subscription {id}.
        slots:
          id: path.id
      - text: Send the subscription confirmation message again for {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{id}/unsubscription'].get
  update:
    x-apievangelist-phrasing:
      intent: Unsubscribe a subscription from its topic
      effect: destructive
      questions:
      - How do I unsubscribe an endpoint from a topic with its unsubscribe token?
      - Can a subscriber opt out of topic messages themselves?
      instructions:
      - text: Unsubscribe subscription {id} using token {token} and protocol {protocol}.
        slots:
          id: path.id
          token: query.token
          protocol: query.protocol
      - text: Opt {endpoint} out of subscription {id} with token {token} over {protocol}.
        slots:
          endpoint: query.endpoint
          id: path.id
          token: query.token
          protocol: query.protocol
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a subscription's configuration
      effect: read
      questions:
      - Is a particular subscription confirmed or still pending?
      - What delivery policy does a given subscription use?
      instructions:
      - text: Get subscription {subscriptionId}.
        slots:
          subscriptionId: path.subscriptionId
      - text: Show the endpoint and status of subscription {subscriptionId}.
        slots:
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a subscription's delivery policy
      effect: write
      questions:
      - How do I change the retry delivery policy of a subscription?
      - Can I retag a subscription after it's created?
      instructions:
      - text: Set the delivery policy of subscription {subscriptionId} to {deliveryPolicy}.
        slots:
          subscriptionId: path.subscriptionId
          deliveryPolicy: requestBody.deliveryPolicy
      - text: Update the tags on subscription {subscriptionId} to {freeformTags}.
        slots:
          subscriptionId: path.subscriptionId
          freeformTags: requestBody.freeformTags
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a subscription
      effect: destructive
      questions:
      - How do I delete a subscription as the topic administrator?
      - Can I permanently remove a subscription by its OCID?
      instructions:
      - text: Delete subscription {subscriptionId}.
        slots:
          subscriptionId: path.subscriptionId
      - text: Remove subscription {subscriptionId} from its topic.
        slots:
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/actions/changeCompartment'].post
  update:
    x-apievangelist-phrasing:
      intent: Move a subscription to another compartment
      effect: write
      questions:
      - How do I move a subscription into a different compartment?
      - Can subscriptions be relocated independently of their topic's compartment?
      instructions:
      - text: Move subscription {subscriptionId} to compartment {compartmentId}.
        slots:
          subscriptionId: path.subscriptionId
          compartmentId: requestBody.compartmentId
      - text: Relocate subscription {subscriptionId} into compartment {compartmentId}.
        slots:
          subscriptionId: path.subscriptionId
          compartmentId: requestBody.compartmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptionsPriorConfirmation'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an already-confirmed active subscription
      effect: write
      questions:
      - Can I create a subscription that starts active without sending a confirmation URL?
      - Is there a way to add a pre-confirmed subscriber to a topic?
      instructions:
      - text: Create a pre-confirmed subscription for {endpoint} on topic {topicId} via {protocol} in compartment {compartmentId}.
        slots:
          endpoint: requestBody.endpoint
          topicId: requestBody.topicId
          protocol: requestBody.protocol
          compartmentId: requestBody.compartmentId
      - text: Add {endpoint} to topic {topicId} as an active {protocol} subscription in {compartmentId} with no confirmation step.
        slots:
          endpoint: requestBody.endpoint
          topicId: requestBody.topicId
          protocol: requestBody.protocol
          compartmentId: requestBody.compartmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/topics/{topicId}/messages'].post
  update:
    x-apievangelist-phrasing:
      intent: Publish a message to a topic
      effect: write
      questions:
      - How do I send a notification message to everyone subscribed to a topic?
      - What is the size limit for a message published to a topic?
      - Can I give a published message a title as well as a body?
      instructions:
      - text: Publish {body} to topic {topicId}.
        slots:
          body: requestBody.body
          topicId: path.topicId
      - text: Send a message titled {title} with body {body} to topic {topicId}.
        slots:
          title: requestBody.title
          body: requestBody.body
          topicId: path.topicId
      method: generated
      generated: '2026-09-26'