# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Nylas Connector credentials API
  version: 1.0.0
extends: openapi/nylas-connector-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: 5
- target: $.paths['/v3/connectors/{provider}/creds'].get
  update:
    x-apievangelist-phrasing:
      intent: List credentials on a provider connector
      effect: read
      questions:
      - Which credentials are stored for a given provider connector?
      - Can I sort a connector's credentials?
      instructions:
      - text: List credentials for the {provider} connector.
        slots:
          provider: path.provider
      - text: Show {limit} {provider} credentials sorted by {sort_by}.
        slots:
          limit: query.limit
          provider: path.provider
          sort_by: query.sort_by
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/connectors/{provider}/creds'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a credential to a provider connector
      effect: write
      questions:
      - How do I manually add a credential record to a connector?
      - Can a connector hold more than one credential?
      instructions:
      - text: Create a credential on the {provider} connector.
        slots:
          provider: path.provider
      - text: Add a new manual credential record for {provider}.
        slots:
          provider: path.provider
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/connectors/{provider}/creds/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve one connector credential
      effect: read
      questions:
      - How can I look up a specific credential on a connector?
      - What's stored in a single connector credential record?
      instructions:
      - text: Get credential {id} on the {provider} connector.
        slots:
          id: path.id
          provider: path.provider
      - text: Show {provider} credential {id}.
        slots:
          provider: path.provider
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/connectors/{provider}/creds/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a non-default connector credential
      effect: destructive
      questions:
      - Can I delete the active credential on a connector?
      - What happens to grants using a credential when it's deleted?
      instructions:
      - text: Delete credential {id} from the {provider} connector.
        slots:
          id: path.id
          provider: path.provider
      - text: Remove unused {provider} credential {id}.
        slots:
          provider: path.provider
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/connectors/{provider}/creds/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a connector credential
      effect: write
      questions:
      - How do I rename a credential on a connector?
      - Can I replace the secret data stored in an existing credential?
      instructions:
      - text: Rename {provider} credential {id} to {name}.
        slots:
          provider: path.provider
          id: path.id
          name: requestBody.name
      - text: Replace the data of credential {id} on {provider} with {credential_data}.
        slots:
          id: path.id
          provider: path.provider
          credential_data: requestBody.credential_data
      method: generated
      generated: '2026-09-26'