Tenable · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Identity Exposure Checker option API

3 actions 3 updates phrasing extends openapi/tenable-checker-option-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 3

$.info

$.paths['/api/profiles/{profileId}/checkers/{checkerId}/checker-options'].get

$.paths['/api/profiles/{profileId}/checkers/{checkerId}/checker-options'].post

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 Identity Exposure Checker option API
  version: 1.0.0
extends: openapi/tenable-checker-option-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: 2
- target: $.paths['/api/profiles/{profileId}/checkers/{checkerId}/checker-options'].get
  update:
    x-apievangelist-phrasing:
      intent: List a checker's options
      effect: read
      questions:
      - What thresholds are configured for an indicator of exposure in my profile?
      - Can I view staged checker options that aren't committed yet?
      instructions:
      - text: List options of checker {checkerId} in profile {profileId}.
        slots:
          checkerId: path.checkerId
          profileId: path.profileId
      - text: Show staged={staged} options for checker {checkerId} in profile {profileId}.
        slots:
          staged: query.staged
          checkerId: path.checkerId
          profileId: path.profileId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/profiles/{profileId}/checkers/{checkerId}/checker-options'].post
  update:
    x-apievangelist-phrasing:
      intent: Set options on a checker
      effect: write
      questions:
      - How do I change an indicator of exposure's thresholds for a profile?
      - Can I customize a checker's settings per profile?
      instructions:
      - text: Create options for checker {checkerId} in profile {profileId}.
        slots:
          checkerId: path.checkerId
          profileId: path.profileId
      - text: Stage new threshold values on checker {checkerId} for profile {profileId}.
        slots:
          checkerId: path.checkerId
          profileId: path.profileId
      method: generated
      generated: '2026-10-01'