Densify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Kubex Systems API

7 actions 7 updates phrasing extends openapi/densify-systems-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 7

$.info

$.paths['/systems'].get

$.paths['/systems/{id}'].get

$.paths['/systems/{id}/analysis-details'].post

$.paths['/systems/{id}/analysis-report'].get

$.paths['/systems/{id}/attributes'].put

$.paths['/systems/{id}/attributes'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Kubex Systems API
  version: 1.0.0
extends: openapi/densify-systems-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: 6
- target: $.paths['/systems'].get
  update:
    x-apievangelist-phrasing:
      intent: List systems tracked by data collection
      effect: read
      questions:
      - Which systems has recent data collection picked up?
      - Can I search systems by a partial name?
      - Can I filter systems by platform or cluster?
      instructions:
      - text: List systems whose name contains {name_like}.
        slots:
          name_like: query.name_like
      - text: List systems on platform {platform} in infrastructure group {infrastructure_group}.
        slots:
          platform: query.platform
          infrastructure_group: query.infrastructure_group
      - text: Find the system with cloud resource ID {resource_id}.
        slots:
          resource_id: query.resource_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/systems/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one system's configuration and attributes
      effect: read
      questions:
      - What configuration and attributes does a specific system have?
      - Can I see a system's manufacturer and children details?
      instructions:
      - text: Get system {id}.
        slots:
          id: path.id
      - text: Show configuration for system {id} with details {details}.
        slots:
          id: path.id
          details: query.details
      method: generated
      generated: '2026-10-01'
- target: $.paths['/systems/{id}/analysis-details'].post
  update:
    x-apievangelist-phrasing:
      intent: Get instance type details and optimal targets
      effect: read
      questions:
      - What are the optimal instance types for one of my systems?
      - Can I see alternative instance targets based on spend or effort tolerance?
      instructions:
      - text: Get instance-type details and optimal targets for system {id}.
        slots:
          id: path.id
      - text: Show which instance types system {id} could move to.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/systems/{id}/analysis-report'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a system's impact analysis PDF
      effect: read
      questions:
      - Can I download the Application Owner report for a system as a PDF?
      - Where do I get the impact analysis and recommendation report?
      instructions:
      - text: Download the impact analysis report PDF for system {id}.
        slots:
          id: path.id
      - text: Save the Application Owner report for system {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/systems/{id}/attributes'].put
  update:
    x-apievangelist-phrasing:
      intent: Set or add attribute values on a system
      effect: write
      questions:
      - How do I update attribute values on a system?
      - Can I append a value to a multi-value attribute?
      instructions:
      - text: Update attributes on system {id}.
        slots:
          id: path.id
      - text: Add or change attribute values on system {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/systems/{id}/attributes'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete attribute values from a system
      effect: destructive
      questions:
      - How do I remove an attribute value from a system?
      - Can I clear all values of a multi-value attribute at once?
      instructions:
      - text: Delete attributes from system {id}.
        slots:
          id: path.id
      - text: Clear attribute values from system {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'