# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Densify Subscriptions API
  version: 1.0.0
extends: openapi/densify-subscriptions-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 10
- target: $.paths['/subscriptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List cloud subscriptions (default alias)
      effect: read
      questions:
      - Can I list my subscriptions without specifying a platform?
      - Which global subscriptions exist on the default cloud platform?
      instructions:
      - text: List subscriptions using the default cloud alias.
      - text: List {type} subscriptions on the default endpoint for owner {owner}.
        slots:
          type: query.type
          owner: query.owner
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{platformType}'].get
  update:
    x-apievangelist-phrasing:
      intent: List subscriptions for a platform
      effect: read
      questions:
      - Which recommendation subscriptions exist for containers?
      - Can an admin list another user's private subscriptions?
      instructions:
      - text: List all subscriptions for the {platformType} platform.
        slots:
          platformType: path.platformType
      - text: List {platformType} subscriptions owned by {owner}.
        slots:
          platformType: path.platformType
          owner: query.owner
      - text: Show subscription {subscriptionRef} in the {platformType} subscription list.
        slots:
          subscriptionRef: query.subscriptionRef
          platformType: path.platformType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{platformType}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create subscriptions in bulk
      effect: write
      questions:
      - How do I create several recommendation subscriptions in one request?
      - What happens if one subscription in a bulk create fails?
      instructions:
      - text: Create a batch of new {platformType} subscriptions.
        slots:
          platformType: path.platformType
      - text: Set up multiple {platformType} subscriptions in one all-or-nothing request.
        slots:
          platformType: path.platformType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{platformType}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several subscriptions at once
      effect: destructive
      questions:
      - Can I delete a set of subscriptions in one call?
      - Does one failed delete stop the rest of a bulk subscription delete?
      instructions:
      - text: Delete a list of {platformType} subscriptions by ID.
        slots:
          platformType: path.platformType
      - text: Remove several {platformType} subscriptions in one call.
        slots:
          platformType: path.platformType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{platformType}/{subscriptionRef}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a subscription's current results
      effect: read
      questions:
      - What recommendations does a subscription return right now, on demand?
      - What's the maximum number of results a subscription can return in one call?
      instructions:
      - text: Get the current results for {platformType} subscription {subscriptionRef}.
        slots:
          platformType: path.platformType
          subscriptionRef: path.subscriptionRef
      - text: Pull up to {limit} results for {platformType} subscription {subscriptionRef}.
        slots:
          limit: query.limit
          platformType: path.platformType
          subscriptionRef: path.subscriptionRef
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{platformType}/{subscriptionRef}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a subscription's settings
      effect: write
      questions:
      - How do I change a subscription's webhook or schedule?
      - Can an admin promote a private subscription to global?
      - Can I make a subscription dormant so it stops scheduled posts?
      instructions:
      - text: Replace {platformType} subscription {subscriptionRef} with name {subscriptionName}.
        slots:
          platformType: path.platformType
          subscriptionRef: path.subscriptionRef
          subscriptionName: requestBody.subscriptionName
      - text: Set {platformType} subscription {subscriptionRef} active flag to {active}.
        slots:
          platformType: path.platformType
          subscriptionRef: path.subscriptionRef
          active: requestBody.active
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{platformType}/{subscriptionRef}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one subscription
      effect: destructive
      questions:
      - How do I delete a single subscription?
      - Can I remove just one subscription by its ID?
      instructions:
      - text: Delete {platformType} subscription {subscriptionRef}.
        slots:
          platformType: path.platformType
          subscriptionRef: path.subscriptionRef
      - text: Remove the single subscription {subscriptionRef} on {platformType}.
        slots:
          subscriptionRef: path.subscriptionRef
          platformType: path.platformType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionRef}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get subscription results (default cloud alias)
      effect: read
      questions:
      - Can I get a subscription's results without naming the platform in the path?
      - Is there a short endpoint for cloud subscription results?
      instructions:
      - text: Get results for subscription {subscriptionRef} using the default cloud alias.
        slots:
          subscriptionRef: path.subscriptionRef
      - text: Pull {limit} results for subscription {subscriptionRef} on the platform-less endpoint.
        slots:
          limit: query.limit
          subscriptionRef: path.subscriptionRef
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{platformType}/{subscriptionRef}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a subscription's trigger and webhook status
      effect: read
      questions:
      - When was my subscription last triggered and did it succeed?
      - Did the subscription's webhook delivery fail?
      instructions:
      - text: Check the status of {platformType} subscription {subscriptionRef}.
        slots:
          platformType: path.platformType
          subscriptionRef: path.subscriptionRef
      - text: Show last trigger and webhook status for {platformType} subscription {subscriptionRef}.
        slots:
          platformType: path.platformType
          subscriptionRef: path.subscriptionRef
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionRef}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check subscription status (default cloud alias)
      effect: read
      questions:
      - Can I check a subscription's status without specifying a platform?
      - Is there a short endpoint for cloud subscription status?
      instructions:
      - text: Check status for subscription {subscriptionRef} using the default cloud alias.
        slots:
          subscriptionRef: path.subscriptionRef
      - text: Show whether subscription {subscriptionRef} last fired successfully, via the cloud alias.
        slots:
          subscriptionRef: path.subscriptionRef
      method: generated
      generated: '2026-10-01'