Tenable · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Vulnerability Management Asset Attributes API

10 actions 10 updates phrasing extends openapi/tenable-asset-attributes-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Tenable's API. It is a proposal applied on top of the contract, not a document Tenable publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 10

$.info
$.paths['/api/v3/assets/attributes'].get
$.paths['/api/v3/assets/attributes'].post
$.paths['/api/v3/assets/attributes/{attribute_id}'].put
$.paths['/api/v3/assets/attributes/{attribute_id}'].delete
$.paths['/api/v3/assets/{asset_id}/attributes'].get
$.paths['/api/v3/assets/{asset_id}/attributes'].put
$.paths['/api/v3/assets/{asset_id}/attributes'].delete
$.paths['/api/v3/assets/{asset_id}/attributes/{attribute_id}'].put
$.paths['/api/v3/assets/{asset_id}/attributes/{attribute_id}'].delete

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 Vulnerability Management Asset Attributes API
  version: 1.0.0
extends: openapi/tenable-asset-attributes-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: 9
- target: $.paths['/api/v3/assets/attributes'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom asset attributes
      effect: read
      questions:
      - What custom asset attributes are defined in my container?
      - How many custom attributes can a container have?
      instructions:
      - text: List all custom asset attributes in my container.
      - text: Show me the custom attribute definitions available for assets.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/assets/attributes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create custom asset attributes
      effect: write
      questions:
      - How do I define a new custom attribute like owner or cost center for assets?
      - Who is allowed to create custom asset attributes?
      instructions:
      - text: Create custom asset attributes {attributes}.
        slots:
          attributes: requestBody.attributes
      - text: Define a new custom attribute for my assets using {attributes}.
        slots:
          attributes: requestBody.attributes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/assets/attributes/{attribute_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a custom attribute's description
      effect: write
      questions:
      - Can I change the description of a custom asset attribute definition?
      - Which fields of an attribute definition are editable after creation?
      instructions:
      - text: Change the description of attribute {attribute_id} to {description}.
        slots:
          attribute_id: path.attribute_id
          description: requestBody.description
      - text: Update custom attribute definition {attribute_id}.
        slots:
          attribute_id: path.attribute_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/assets/attributes/{attribute_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom attribute definition
      effect: destructive
      questions:
      - Does deleting a custom attribute definition remove it from all assets?
      - Can I retire a custom attribute I no longer track?
      instructions:
      - text: Delete custom attribute definition {attribute_id} everywhere.
        slots:
          attribute_id: path.attribute_id
      - text: Remove attribute {attribute_id} from my container and from every asset.
        slots:
          attribute_id: path.attribute_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/assets/{asset_id}/attributes'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom attributes on an asset
      effect: read
      questions:
      - Which custom attribute values are set on a specific asset?
      - What owner or business-unit attributes does this asset carry?
      instructions:
      - text: List the custom attributes assigned to asset {asset_id}.
        slots:
          asset_id: path.asset_id
      - text: Show the custom attribute values on asset {asset_id}.
        slots:
          asset_id: path.asset_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/assets/{asset_id}/attributes'].put
  update:
    x-apievangelist-phrasing:
      intent: Assign several custom attributes to an asset
      effect: write
      questions:
      - Can I set several custom attribute values on an asset in one request?
      - What's the way to bulk set an asset's custom attributes?
      instructions:
      - text: Assign attributes {attributes} to asset {asset_id}.
        slots:
          attributes: requestBody.attributes
          asset_id: path.asset_id
      - text: Set multiple custom attribute values {attributes} on asset {asset_id}.
        slots:
          attributes: requestBody.attributes
          asset_id: path.asset_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/assets/{asset_id}/attributes'].delete
  update:
    x-apievangelist-phrasing:
      intent: Clear all custom attributes from an asset
      effect: destructive
      questions:
      - Can I wipe every custom attribute value from one asset at once?
      - Is there a way to reset an asset's custom attributes to empty?
      instructions:
      - text: Remove all custom attributes from asset {asset_id}.
        slots:
          asset_id: path.asset_id
      - text: Clear every custom attribute value on asset {asset_id}.
        slots:
          asset_id: path.asset_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/assets/{asset_id}/attributes/{attribute_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Set one custom attribute on an asset
      effect: write
      questions:
      - Can I set just one custom attribute value on an asset without touching the others?
      - How do I record a single owner value on one asset?
      instructions:
      - text: Set attribute {attribute_id} on asset {asset_id} to {value}.
        slots:
          attribute_id: path.attribute_id
          asset_id: path.asset_id
          value: requestBody.value
      - text: Assign only custom attribute {attribute_id} to asset {asset_id}.
        slots:
          attribute_id: path.attribute_id
          asset_id: path.asset_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/assets/{asset_id}/attributes/{attribute_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove one custom attribute from an asset
      effect: destructive
      questions:
      - Can I remove a single custom attribute from an asset and keep the rest?
      - Which call unsets one attribute value on one asset?
      instructions:
      - text: Remove attribute {attribute_id} from asset {asset_id}.
        slots:
          attribute_id: path.attribute_id
          asset_id: path.asset_id
      - text: Unset only custom attribute {attribute_id} on asset {asset_id}.
        slots:
          attribute_id: path.attribute_id
          asset_id: path.asset_id
      method: generated
      generated: '2026-10-01'