Tenable · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Identity Exposure Application setting API

3 actions 3 updates phrasing extends openapi/tenable-application-setting-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/application-settings'].get
$.paths['/api/application-settings'].patch

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 Identity Exposure Application setting API
  version: 1.0.0
extends: openapi/tenable-application-setting-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/application-settings'].get
  update:
    x-apievangelist-phrasing:
      intent: View application settings
      effect: read
      questions:
      - What SMTP server and activity log retention are configured?
      - Can I see the global application settings for Identity Exposure?
      instructions:
      - text: Show the application settings.
      - text: Get the current SMTP, telemetry and activity log settings.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/application-settings'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change application settings
      effect: write
      questions:
      - How do I point Identity Exposure at a different SMTP server?
      - Can I change how many months activity logs are kept?
      - Is it possible to turn telemetry off for the whole application?
      instructions:
      - text: Set the SMTP server to {smtpServerAddress} on port {smtpServerPort}.
        slots:
          smtpServerAddress: requestBody.smtpServerAddress
          smtpServerPort: requestBody.smtpServerPort
      - text: Keep activity logs for {activityLogsRetentionDurationInMonth} months.
        slots:
          activityLogsRetentionDurationInMonth: requestBody.activityLogsRetentionDurationInMonth
      - text: Set telemetry enabled to {telemetryEnabled} and the email sender to {emailSender}.
        slots:
          telemetryEnabled: requestBody.telemetryEnabled
          emailSender: requestBody.emailSender
      method: generated
      generated: '2026-10-01'