Tenable · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Tenable Platform & Settings Recast Rules API

7 actions 7 updates phrasing extends openapi/tenable-recast-rules-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 7

$.info
$.paths['/v1/recast/rules'].post
$.paths['/v1/recast/rules/search'].post
$.paths['/v1/recast/rules/{rule_id}'].get
$.paths['/v1/recast/rules/{rule_id}'].put
$.paths['/v1/recast/rules/{rule_id}'].delete
$.paths['/v1/recast/rules/filters'].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 Tenable Platform & Settings Recast Rules API
  version: 1.0.0
extends: openapi/tenable-recast-rules-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['/v1/recast/rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a recast or accept rule
      effect: write
      questions:
      - How do I recast the severity of a vulnerability across matching findings?
      - Can I accept a risk with a rule that expires on a set date?
      instructions:
      - text: Create a recast rule for {resource_type} findings matching {filter} with action {rule_value}.
        slots:
          resource_type: requestBody.resource_type
          filter: requestBody.filter
          rule_value: requestBody.rule_value
      - text: Create accept rule {rule_name} on {resource_type} findings matching {filter}, action {rule_value}, expiring {expires_at}.
        slots:
          rule_name: requestBody.rule_name
          resource_type: requestBody.resource_type
          filter: requestBody.filter
          rule_value: requestBody.rule_value
          expires_at: requestBody.expires_at
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/recast/rules/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search recast and accept rules
      effect: read
      questions:
      - Which recast or accept rules apply to web app findings?
      - Can I find existing rules matching a filter and page through them?
      instructions:
      - text: Search recast rules for resource type {resource_type}.
        slots:
          resource_type: requestBody.resource_type
      - text: Find recast rules matching {filter}, sorted by {sort}, limit {limit}.
        slots:
          filter: requestBody.filter
          sort: requestBody.sort
          limit: requestBody.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/recast/rules/{rule_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a recast rule's details
      effect: read
      questions:
      - What filter and action does a specific recast rule use?
      - When does a particular accept rule expire?
      instructions:
      - text: Show recast rule {rule_id}.
        slots:
          rule_id: path.rule_id
      - text: Get the filter and expiry of rule {rule_id}.
        slots:
          rule_id: path.rule_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/recast/rules/{rule_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a recast or accept rule
      effect: write
      questions:
      - How do I change the filter or expiry of an existing recast rule?
      - Can I disable a recast rule without deleting it?
      instructions:
      - text: Update rule {rule_id} for {resource_type} findings to match {filter} with action {rule_value}.
        slots:
          rule_id: path.rule_id
          resource_type: requestBody.resource_type
          filter: requestBody.filter
          rule_value: requestBody.rule_value
      - text: Extend rule {rule_id} to expire {expires_at} ({resource_type}, filter {filter}, action {rule_value}).
        slots:
          rule_id: path.rule_id
          expires_at: requestBody.expires_at
          resource_type: requestBody.resource_type
          filter: requestBody.filter
          rule_value: requestBody.rule_value
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/recast/rules/{rule_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a recast or accept rule
      effect: destructive
      questions:
      - How do I delete a recast rule so findings go back to their original severity?
      - Can I remove an accept rule permanently?
      instructions:
      - text: Delete recast rule {rule_id}.
        slots:
          rule_id: path.rule_id
      - text: Remove the accept rule {rule_id}.
        slots:
          rule_id: path.rule_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/recast/rules/filters'].get
  update:
    x-apievangelist-phrasing:
      intent: List properties for filtering recast rules
      effect: read
      questions:
      - Which properties and operators can I use to filter recast rules?
      - What value types do the recast rule filters accept?
      instructions:
      - text: List the filter properties for recast rules.
      - text: Show the operators supported when filtering recast rules.
      method: generated
      generated: '2026-10-01'