Densify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Kubex Analysis Webhook API

6 actions 6 updates phrasing extends openapi/densify-analysis-webhook-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 6

$.info

$.paths['/webhook/analysis/{platformType}'].get

$.paths['/webhook/analysis/{platformType}/{platformSubType}/{analysisId}'].get

$.paths['/webhook/analysis/{platformType}/{platformSubType}/{analysisId}'].put

$.paths['/webhook/analysis/{platformType}/{platformSubType}/{analysisId}'].post

$.paths['/webhook/analysis/{platformType}/{platformSubType}/{analysisId}'].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 Analysis Webhook API
  version: 1.0.0
extends: openapi/densify-analysis-webhook-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: 5
- target: $.paths['/webhook/analysis/{platformType}'].get
  update:
    x-apievangelist-phrasing:
      intent: List analysis webhooks for a platform
      effect: read
      questions:
      - Which analyses already have a results webhook configured for my cloud platform?
      - Can I see every analysis webhook set up for containers in one list?
      instructions:
      - text: List all analysis webhooks for the {platformType} platform.
        slots:
          platformType: path.platformType
      - text: Show me every container analysis webhook registered in Kubex.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/webhook/analysis/{platformType}/{platformSubType}/{analysisId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the webhook set on one analysis
      effect: read
      questions:
      - What webhook URI is a specific analysis currently delivering its results to?
      - Is there a webhook attached to my AWS cloud analysis right now?
      instructions:
      - text: Show the webhook configured for analysis {analysisId} on {platformType}/{platformSubType}.
        slots:
          analysisId: path.analysisId
          platformType: path.platformType
          platformSubType: path.platformSubType
      - text: Tell me where analysis {analysisId} under {platformType}/{platformSubType} sends results.
        slots:
          analysisId: path.analysisId
          platformType: path.platformType
          platformSubType: path.platformSubType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/webhook/analysis/{platformType}/{platformSubType}/{analysisId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change the webhook on an analysis
      effect: write
      questions:
      - Can I point an analysis's existing webhook to a new URL?
      - How do I change the bearer token Kubex uses when calling my analysis webhook?
      instructions:
      - text: Change the webhook for analysis {analysisId} on {platformType}/{platformSubType} to {uri}.
        slots:
          analysisId: path.analysisId
          platformType: path.platformType
          platformSubType: path.platformSubType
          uri: requestBody.uri
      - text: Update analysis {analysisId}'s webhook on {platformType}/{platformSubType} to use {authType} auth with {authValue}.
        slots:
          analysisId: path.analysisId
          platformType: path.platformType
          platformSubType: path.platformSubType
          authType: requestBody.authType
          authValue: requestBody.authValue
      method: generated
      generated: '2026-10-01'
- target: $.paths['/webhook/analysis/{platformType}/{platformSubType}/{analysisId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach a new webhook to an analysis
      effect: write
      questions:
      - How do I get analysis results pushed to my endpoint when an analysis has no webhook yet?
      - Can I add a webhook to an analysis that already has one?
      instructions:
      - text: Add a webhook at {uri} to analysis {analysisId} on {platformType}/{platformSubType}.
        slots:
          uri: requestBody.uri
          analysisId: path.analysisId
          platformType: path.platformType
          platformSubType: path.platformSubType
      - text: Attach a webhook {uri} with Basic auth {authValue} to analysis {analysisId} under {platformType}/{platformSubType}.
        slots:
          uri: requestBody.uri
          authValue: requestBody.authValue
          analysisId: path.analysisId
          platformType: path.platformType
          platformSubType: path.platformSubType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/webhook/analysis/{platformType}/{platformSubType}/{analysisId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove the webhook from an analysis
      effect: destructive
      questions:
      - How do I stop an analysis from posting results to my webhook?
      - Can I detach a webhook from an analysis without deleting the analysis itself?
      instructions:
      - text: Remove the webhook from analysis {analysisId} on {platformType}/{platformSubType}.
        slots:
          analysisId: path.analysisId
          platformType: path.platformType
          platformSubType: path.platformSubType
      - text: Stop analysis {analysisId} on {platformType}/{platformSubType} from calling its webhook.
        slots:
          analysisId: path.analysisId
          platformType: path.platformType
          platformSubType: path.platformSubType
      method: generated
      generated: '2026-10-01'