Densify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Kubex Subscriptions Suppressions API

9 actions 9 updates phrasing extends openapi/densify-subscriptions-suppressions-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Densify's API. It is a proposal applied on top of the contract, not a document Densify publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 9

$.info
$.paths['/subscriptions/{platformType}/suppressions'].get
$.paths['/subscriptions/{platformType}/suppressions'].put
$.paths['/subscriptions/{platformType}/suppressions'].post
$.paths['/subscriptions/{platformType}/suppressions'].delete
$.paths['/subscriptions/{platformType}/suppressions/{suppressionRef}'].get
$.paths['/subscriptions/{platformType}/suppressions/{suppressionRef}'].put
$.paths['/subscriptions/{platformType}/suppressions/{suppressionRef}'].delete
$.paths['/subscriptions/suppressions'].get

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Kubex Subscriptions Suppressions API
  version: 1.0.0
extends: openapi/densify-subscriptions-suppressions-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: 8
- target: $.paths['/subscriptions/{platformType}/suppressions'].get
  update:
    x-apievangelist-phrasing:
      intent: List suppressions for a platform
      effect: read
      questions:
      - Which suppressions are defined for my containers subscriptions?
      - Can I list just my private suppressions?
      instructions:
      - text: List suppressions for the {platformType} platform.
        slots:
          platformType: path.platformType
      - text: List {type} suppressions in the {platformType} catalog.
        slots:
          type: query.type
          platformType: path.platformType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{platformType}/suppressions'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace several suppressions at once
      effect: write
      questions:
      - Can I update multiple suppressions in one request?
      - Do I have to supply every field when bulk-replacing suppressions?
      instructions:
      - text: Replace a batch of suppressions in the {platformType} catalog.
        slots:
          platformType: path.platformType
      - text: Overwrite multiple {platformType} suppressions in one all-or-nothing edit.
        slots:
          platformType: path.platformType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{platformType}/suppressions'].post
  update:
    x-apievangelist-phrasing:
      intent: Add suppressions in bulk
      effect: write
      questions:
      - How do I suppress a resource tag or container label from subscription results?
      - What's the difference between an attribute suppression and a property suppression?
      instructions:
      - text: Add new suppressions to the {platformType} catalog.
        slots:
          platformType: path.platformType
      - text: Create attribute or property suppressions for {platformType} subscriptions.
        slots:
          platformType: path.platformType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{platformType}/suppressions'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several suppressions at once
      effect: destructive
      questions:
      - Can I delete a list of suppressions in one call?
      - Why would a suppression fail to delete?
      instructions:
      - text: Delete a list of suppressions from the {platformType} catalog.
        slots:
          platformType: path.platformType
      - text: Remove multiple suppressions from {platformType} in one request.
        slots:
          platformType: path.platformType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{platformType}/suppressions/{suppressionRef}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one suppression
      effect: read
      questions:
      - How do I look up a single suppression by its ID?
      - What attribute or property does a given suppression hide?
      instructions:
      - text: Get suppression {suppressionRef} from the {platformType} catalog.
        slots:
          suppressionRef: path.suppressionRef
          platformType: path.platformType
      - text: Show the details of {platformType} suppression {suppressionRef}.
        slots:
          platformType: path.platformType
          suppressionRef: path.suppressionRef
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{platformType}/suppressions/{suppressionRef}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a single suppression
      effect: write
      questions:
      - How do I change what attribute one suppression hides?
      - Can I rename an existing suppression?
      instructions:
      - text: Replace suppression {suppressionRef} in {platformType} with name {suppressionName}.
        slots:
          suppressionRef: path.suppressionRef
          platformType: path.platformType
          suppressionName: requestBody.suppressionName
      - text: Set suppression {suppressionRef} in {platformType} named {suppressionName} to hide attribute {attributeName}.
        slots:
          suppressionRef: path.suppressionRef
          platformType: path.platformType
          suppressionName: requestBody.suppressionName
          attributeName: requestBody.attributeName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{platformType}/suppressions/{suppressionRef}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one suppression
      effect: destructive
      questions:
      - How do I remove a single suppression?
      - What happens if I delete a suppression that subscriptions still reference?
      instructions:
      - text: Delete suppression {suppressionRef} from the {platformType} catalog.
        slots:
          suppressionRef: path.suppressionRef
          platformType: path.platformType
      - text: Remove the single suppression {suppressionRef} from {platformType}.
        slots:
          suppressionRef: path.suppressionRef
          platformType: path.platformType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/suppressions'].get
  update:
    x-apievangelist-phrasing:
      intent: List suppressions (default cloud alias)
      effect: read
      questions:
      - Can I list suppressions without naming the platform?
      - Is there a short endpoint for cloud suppressions?
      instructions:
      - text: List suppressions using the default cloud alias.
      - text: Show cloud suppressions without specifying a platform.
      method: generated
      generated: '2026-10-01'