Densify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Kubex Subscriptions Properties API

9 actions 9 updates phrasing extends openapi/densify-subscriptions-properties-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}/properties'].get
$.paths['/subscriptions/{platformType}/properties'].put
$.paths['/subscriptions/{platformType}/properties'].post
$.paths['/subscriptions/{platformType}/properties'].delete
$.paths['/subscriptions/{platformType}/properties/{propertyRef}'].get
$.paths['/subscriptions/{platformType}/properties/{propertyRef}'].put
$.paths['/subscriptions/{platformType}/properties/{propertyRef}'].delete
$.paths['/subscriptions/properties'].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 Properties API
  version: 1.0.0
extends: openapi/densify-subscriptions-properties-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}/properties'].get
  update:
    x-apievangelist-phrasing:
      intent: List subscription properties for a platform
      effect: read
      questions:
      - Which properties are in the containers catalog for subscriptions?
      - Can I list only global subscription properties?
      instructions:
      - text: List the properties in the {platformType} catalog.
        slots:
          platformType: path.platformType
      - text: Show only {type}-scoped properties for {platformType}, owned by {owner}.
        slots:
          type: query.type
          platformType: path.platformType
          owner: query.owner
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{platformType}/properties'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace several properties at once
      effect: write
      questions:
      - Can I edit several catalog properties in one request?
      - Is a bulk property replace all-or-nothing?
      instructions:
      - text: Replace a batch of existing properties in the {platformType} catalog.
        slots:
          platformType: path.platformType
      - text: Overwrite multiple {platformType} catalog properties in one all-or-nothing edit.
        slots:
          platformType: path.platformType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{platformType}/properties'].post
  update:
    x-apievangelist-phrasing:
      intent: Add properties to a catalog in bulk
      effect: write
      questions:
      - How do I add new properties to the subscription catalog?
      - Do property names need to be unique in the catalog?
      instructions:
      - text: Add a set of new properties to the {platformType} catalog.
        slots:
          platformType: path.platformType
      - text: Register several properties in the {platformType} subscription catalog at once.
        slots:
          platformType: path.platformType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{platformType}/properties'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several properties at once
      effect: destructive
      questions:
      - Can I delete multiple catalog properties in one call?
      - Why can't some properties be deleted?
      instructions:
      - text: Delete a list of properties from the {platformType} catalog.
        slots:
          platformType: path.platformType
      - text: Remove multiple unused properties from the {platformType} catalog.
        slots:
          platformType: path.platformType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{platformType}/properties/{propertyRef}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one catalog property
      effect: read
      questions:
      - How do I look up a single subscription property by its ID?
      - What's configured on a specific catalog property?
      instructions:
      - text: Get property {propertyRef} from the {platformType} catalog.
        slots:
          propertyRef: path.propertyRef
          platformType: path.platformType
      - text: Show the details of {platformType} catalog property {propertyRef}.
        slots:
          platformType: path.platformType
          propertyRef: path.propertyRef
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{platformType}/properties/{propertyRef}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a single property
      effect: write
      questions:
      - How do I rename one catalog property or change its alias?
      - Can I make a private property global?
      instructions:
      - text: Replace property {propertyRef} in {platformType} with name {propertyName}.
        slots:
          propertyRef: path.propertyRef
          platformType: path.platformType
          propertyName: requestBody.propertyName
      - text: Set property {propertyRef} in {platformType} to {propertyName} with alias {aliasName}.
        slots:
          propertyRef: path.propertyRef
          platformType: path.platformType
          propertyName: requestBody.propertyName
          aliasName: requestBody.aliasName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{platformType}/properties/{propertyRef}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one property
      effect: destructive
      questions:
      - How do I remove a single property from the catalog?
      - What happens if I delete a property a subscription still uses?
      instructions:
      - text: Delete property {propertyRef} from the {platformType} catalog.
        slots:
          propertyRef: path.propertyRef
          platformType: path.platformType
      - text: Remove the single property {propertyRef} from {platformType}.
        slots:
          propertyRef: path.propertyRef
          platformType: path.platformType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/properties'].get
  update:
    x-apievangelist-phrasing:
      intent: List properties (default cloud alias)
      effect: read
      questions:
      - Can I list catalog properties without naming a platform?
      - Is there a short endpoint for the cloud property catalog?
      instructions:
      - text: List properties using the default cloud alias.
      - text: Show the cloud property catalog without specifying a platform.
      method: generated
      generated: '2026-10-01'