Tenable · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Identity Exposure Preference API

3 actions 3 updates phrasing extends openapi/tenable-preference-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/preferences'].get

$.paths['/api/preferences'].patch

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 Preference API
  version: 1.0.0
extends: openapi/tenable-preference-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/preferences'].get
  update:
    x-apievangelist-phrasing:
      intent: View my preferences
      effect: read
      questions:
      - What language and default profile are set for my account?
      - Can I see my user preferences?
      instructions:
      - text: Show my preferences.
      - text: Get my language and preferred profile.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/preferences'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update my preferences
      effect: write
      questions:
      - How do I switch the interface language?
      - Can I change which profile opens by default?
      instructions:
      - text: Set my language to {language}.
        slots:
          language: requestBody.language
      - text: Make {preferredProfileId} my preferred profile.
        slots:
          preferredProfileId: requestBody.preferredProfileId
      method: generated
      generated: '2026-10-01'