# 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 Credentials API
  version: 1.0.0
extends: openapi/tenable-credentials-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: 7
- target: $.paths['/credentials'].get
  update:
    x-apievangelist-phrasing:
      intent: List managed credentials
      effect: read
      questions:
      - Which managed credentials can I use in my scans?
      - Does the managed credentials list include credentials stored inside a scan or policy?
      instructions:
      - text: List the managed credentials I can use.
      - text: List managed credentials owned by {referrer_owner_uuid}.
        slots:
          referrer_owner_uuid: query.referrer_owner_uuid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/credentials'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a managed credential
      effect: write
      questions:
      - How do I store an SSH or Windows login once and reuse it across scans?
      - Can I share a managed credential with other users when I create it?
      instructions:
      - text: Create managed credential {name} of type {type} with settings {settings}.
        slots:
          name: requestBody.name
          type: requestBody.type
          settings: requestBody.settings
      - text: Create managed credential {name} of type {type} using {settings} and share it with {permissions}.
        slots:
          name: requestBody.name
          type: requestBody.type
          settings: requestBody.settings
          permissions: requestBody.permissions
      method: generated
      generated: '2026-10-01'
- target: $.paths['/credentials/{uuid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a managed credential's details
      effect: read
      questions:
      - What settings and sharing does a specific managed credential have?
      - Can I view one managed credential by UUID?
      instructions:
      - text: Get the details of managed credential {uuid}.
        slots:
          uuid: path.uuid
      - text: Show who can use managed credential {uuid}.
        slots:
          uuid: path.uuid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/credentials/{uuid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a managed credential
      effect: write
      questions:
      - Can I rotate the password inside an existing managed credential?
      - Is it possible to change a managed credential's type after creating it?
      instructions:
      - text: Update the settings of managed credential {uuid} to {settings}.
        slots:
          uuid: path.uuid
          settings: requestBody.settings
      - text: Rename managed credential {uuid} to {name}.
        slots:
          uuid: path.uuid
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/credentials/{uuid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a managed credential
      effect: destructive
      questions:
      - What happens to scans using a managed credential when I delete it?
      - Can I remove a managed credential that's no longer valid?
      instructions:
      - text: Delete managed credential {uuid}.
        slots:
          uuid: path.uuid
      - text: Remove managed credential {uuid} and detach it from every scan.
        slots:
          uuid: path.uuid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/credentials/types'].get
  update:
    x-apievangelist-phrasing:
      intent: List supported credential types
      effect: read
      questions:
      - What kinds of managed credentials are supported for scanning?
      - Which settings fields does each credential type require?
      instructions:
      - text: List all managed credential types.
      - text: Show me the supported credential types and their configuration fields.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/credentials/files'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a file for a managed credential
      effect: write
      questions:
      - How do I upload an SSH private key file for a credential?
      - Which file type must I declare when uploading a credential file?
      instructions:
      - text: Upload credential file {Filedata} as file type {fileType}.
        slots:
          Filedata: requestBody.Filedata
          fileType: query.fileType
      - text: Upload a {fileType} file for use in a managed credential.
        slots:
          fileType: query.fileType
      method: generated
      generated: '2026-10-01'