Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Palo Alto Networks Credentials API

9 actions 9 updates phrasing extends openapi/palo-alto-networks-credentials-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Palo Alto Networks's API. It is a proposal applied on top of the contract, not a document Palo Alto Networks publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 9

$.info
$.paths['/api/v34.03/credentials'].get
$.paths['/api/v34.03/credentials'].post
$.paths['/api/v34.03/credentials/{id}'].delete
$.paths['/api/v34.03/credentials/{id}/usages'].get
$.paths['/api/v34.04/credentials'].get
$.paths['/api/v34.04/credentials'].post
$.paths['/api/v34.04/credentials/{id}'].delete
$.paths['/api/v34.04/credentials/{id}/usages'].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 Palo Alto Networks Credentials API
  version: 1.0.0
extends: openapi/palo-alto-networks-credentials-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 8
- target: $.paths['/api/v34.03/credentials'].get
  update:
    x-apievangelist-phrasing:
      intent: List stored credentials (v34.03)
      effect: read
      questions:
      - How do I list all cloud credentials stored in the credentials store with v34.03?
      - Can the older API filter credentials by cloud or auto-import status?
      instructions:
      - text: List all credentials using API v34.03.
      - text: On v34.03, show credentials for cloud {cloud} that were auto-imported {autoImported}.
        slots:
          cloud: query.cloud
          autoImported: query.autoImported
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/credentials'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a credential (v34.03)
      effect: write
      questions:
      - How do I add a new cloud account credential through the v34.03 API?
      - Can I store an AWS role ARN credential with the older API version?
      instructions:
      - text: Add credential {_id} of type {type} using v34.03.
        slots:
          _id: requestBody._id
          type: requestBody.type
      - text: On 34.03, create credential {_id} using role ARN {roleArn}.
        slots:
          _id: requestBody._id
          roleArn: requestBody.roleArn
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/credentials/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a credential (v34.03)
      effect: destructive
      questions:
      - How do I remove a credential from the store with the v34.03 API?
      - Can I delete a stored credential by ID on the older version?
      instructions:
      - text: Delete credential {id} using v34.03.
        slots:
          id: path.id
      - text: Remove stored credential {id} via API 34.03.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/credentials/{id}/usages'].get
  update:
    x-apievangelist-phrasing:
      intent: See where a credential is used (v34.03)
      effect: read
      questions:
      - Which scans and integrations use a given credential, per the v34.03 API?
      - Can I check a credential's usages before deleting it on the older version?
      instructions:
      - text: Show usages of credential {id} on v34.03.
        slots:
          id: path.id
      - text: List what depends on credential {id} using 34.03.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/credentials'].get
  update:
    x-apievangelist-phrasing:
      intent: List stored credentials (v34.04)
      effect: read
      questions:
      - Which credentials are in my credentials store on the current v34.04 API?
      - Can I page and sort the credential list in version 34.04?
      instructions:
      - text: List credentials via version 34.04.
      - text: With v34.04, get credentials {ids} sorted by {sort}.
        slots:
          ids: query.ids
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/credentials'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a credential (v34.04)
      effect: write
      questions:
      - Where do I register a new cloud or registry credential on v34.04?
      - Can I add a credential with an API token on the current API version?
      instructions:
      - text: Create credential {_id} of type {type} with v34.04.
        slots:
          _id: requestBody._id
          type: requestBody.type
      - text: Using 34.04, add credential {_id} for account {accountID} with secret {secret}.
        slots:
          _id: requestBody._id
          accountID: requestBody.accountID
          secret: requestBody.secret
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/credentials/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a credential (v34.04)
      effect: destructive
      questions:
      - What's the v34.04 call to delete a credential I no longer need?
      - Does deleting a credential on 34.04 take just its ID?
      instructions:
      - text: Delete credential {id} on version 34.04.
        slots:
          id: path.id
      - text: Using v34.04, permanently remove credential {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/credentials/{id}/usages'].get
  update:
    x-apievangelist-phrasing:
      intent: See where a credential is used (v34.04)
      effect: read
      questions:
      - Where is a particular credential referenced, according to the v34.04 API?
      - Is a credential still in use anywhere on the current version?
      instructions:
      - text: List usages of credential {id} with v34.04.
        slots:
          id: path.id
      - text: On 34.04, show where credential {id} is referenced.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'