API Evangelist conversational phrasing for Salesforce Credential API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Salesforce Credential API
  version: 1.0.0
extends: openapi/salesforce-credential-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: 10
- target: $.paths['/data/v64.0/named-credentials/credential'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a principal's stored credential
      effect: read
      questions:
      - Where can I check what credential is stored for a named principal?
      - Which principal types can I look up a credential for, like per-user?
      instructions:
      - text: Get the credential for principal {principalName} on external credential {externalCredential}.
        slots:
          principalName: query.principalName
          externalCredential: query.externalCredential
      - text: Show the {principalType} credential {principalName} under {externalCredential}.
        slots:
          principalType: query.principalType
          principalName: query.principalName
          externalCredential: query.externalCredential
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/named-credentials/credential'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a principal's stored credential
      effect: write
      questions:
      - Can I rotate the stored secret for an external credential principal?
      - What do I send to change a principal's stored credentials?
      instructions:
      - text: Update the credentials for principal {principalName} on {externalCredential} to {credentials}.
        slots:
          principalName: requestBody.principalName
          externalCredential: requestBody.externalCredential
          credentials: requestBody.credentials
      - text: Replace the stored {principalType} credential {principalName} using {authenticationProtocol}.
        slots:
          principalType: requestBody.principalType
          principalName: requestBody.principalName
          authenticationProtocol: requestBody.authenticationProtocol
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/named-credentials/credential'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a principal's stored credential
      effect: destructive
      questions:
      - Can I remove the stored credential for a principal?
      - How do I clear a per-user principal's saved credential?
      instructions:
      - text: Delete the credential for principal {principalName} on {externalCredential}.
        slots:
          principalName: requestBody.principalName
          externalCredential: requestBody.externalCredential
      - text: Remove the {principalType} credential {principalName} from {externalCredential}.
        slots:
          principalType: requestBody.principalType
          principalName: requestBody.principalName
          externalCredential: requestBody.externalCredential
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/named-credentials/external-credentials/{DEVELOPER_NAME}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an external credential
      effect: write
      questions:
      - Can I change the authentication protocol of an existing external credential?
      - Is it possible to edit the principals or headers on an external credential?
      instructions:
      - text: Update external credential {DEVELOPER_NAME} to use {authenticationProtocol}.
        slots:
          DEVELOPER_NAME: path.DEVELOPER_NAME
          authenticationProtocol: requestBody.authenticationProtocol
      - text: Rename external credential {DEVELOPER_NAME} to the label {masterLabel}.
        slots:
          DEVELOPER_NAME: path.DEVELOPER_NAME
          masterLabel: requestBody.masterLabel
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/named-credentials/external-credentials/{DEVELOPER_NAME}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an external credential
      effect: destructive
      questions:
      - How do I delete an external credential by developer name?
      - Can I remove an external credential that's no longer used?
      instructions:
      - text: Delete external credential {DEVELOPER_NAME}.
        slots:
          DEVELOPER_NAME: path.DEVELOPER_NAME
      - text: Remove the external credential called {DEVELOPER_NAME}.
        slots:
          DEVELOPER_NAME: path.DEVELOPER_NAME
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/named-credentials/named-credential-setup/{DEVELOPER_NAME}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a named credential by developer name
      effect: read
      questions:
      - Where can I see a named credential's callout URL by its developer name?
      - What settings does a given named credential have?
      instructions:
      - text: Get named credential {DEVELOPER_NAME}.
        slots:
          DEVELOPER_NAME: path.DEVELOPER_NAME
      - text: Show the setup of the named credential called {DEVELOPER_NAME}.
        slots:
          DEVELOPER_NAME: path.DEVELOPER_NAME
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/named-credentials/named-credential-setup/{DEVELOPER_NAME}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a named credential's setup
      effect: write
      questions:
      - Can I change the callout URL on a named credential?
      - Is it possible to swap the external credentials a named credential uses?
      instructions:
      - text: Point named credential {DEVELOPER_NAME} at {calloutUrl}.
        slots:
          DEVELOPER_NAME: path.DEVELOPER_NAME
          calloutUrl: requestBody.calloutUrl
      - text: Update named credential {DEVELOPER_NAME} to use external credentials {externalCredentials}.
        slots:
          DEVELOPER_NAME: path.DEVELOPER_NAME
          externalCredentials: requestBody.externalCredentials
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/tooling/sobjects/NamedCredential/{NAMED_CREDENTIAL_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a NamedCredential Tooling record
      effect: read
      questions:
      - Can I read a NamedCredential record by its ID through the Tooling API?
      - What metadata does the Tooling API return for a named credential ID?
      instructions:
      - text: Get Tooling API named credential {NAMED_CREDENTIAL_ID}.
        slots:
          NAMED_CREDENTIAL_ID: path.NAMED_CREDENTIAL_ID
      - text: Fetch the NamedCredential tooling record {NAMED_CREDENTIAL_ID}.
        slots:
          NAMED_CREDENTIAL_ID: path.NAMED_CREDENTIAL_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/tooling/sobjects/NamedCredential/{NAMED_CREDENTIAL_ID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a NamedCredential Tooling record
      effect: destructive
      questions:
      - How do I delete a named credential by record ID with the Tooling API?
      - Can the Tooling API remove a NamedCredential record?
      instructions:
      - text: Delete Tooling API named credential {NAMED_CREDENTIAL_ID}.
        slots:
          NAMED_CREDENTIAL_ID: path.NAMED_CREDENTIAL_ID
      - text: Remove the NamedCredential tooling record {NAMED_CREDENTIAL_ID}.
        slots:
          NAMED_CREDENTIAL_ID: path.NAMED_CREDENTIAL_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/tooling/sobjects/NamedCredential/{NAMED_CREDENTIAL_ID}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch a NamedCredential Tooling record
      effect: write
      questions:
      - Can I patch a named credential's metadata by record ID via the Tooling API?
      - What fields do I send to update a NamedCredential tooling record?
      instructions:
      - text: Update Tooling API named credential {NAMED_CREDENTIAL_ID} with metadata {Metadata}.
        slots:
          NAMED_CREDENTIAL_ID: path.NAMED_CREDENTIAL_ID
          Metadata: requestBody.Metadata
      - text: Patch NamedCredential {NAMED_CREDENTIAL_ID} setting full name {FullName}.
        slots:
          NAMED_CREDENTIAL_ID: path.NAMED_CREDENTIAL_ID
          FullName: requestBody.FullName
      method: generated
      generated: '2026-09-26'