# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Nylas Authentication APIs API
  version: 1.0.0
extends: openapi/nylas-authentication-apis-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/connect/auth'].get
  update:
    x-apievangelist-phrasing:
      intent: Start a hosted OAuth authorization
      effect: read
      questions:
      - How do I send a user to Nylas to connect their email account?
      - Can I prefill the user's email address on the hosted login page?
      - Does hosted auth support PKCE code challenges?
      instructions:
      - text: Start hosted OAuth for client {client_id} redirecting to {redirect_uri} with response type {response_type}.
        slots:
          client_id: query.client_id
          redirect_uri: query.redirect_uri
          response_type: query.response_type
      - text: Build a hosted login URL for {client_id} back to {redirect_uri}, response {response_type}, prefilled with {login_hint}.
        slots:
          client_id: query.client_id
          redirect_uri: query.redirect_uri
          response_type: query.response_type
          login_hint: query.login_hint
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/connect/token'].post
  update:
    x-apievangelist-phrasing:
      intent: Exchange an OAuth code or refresh token
      effect: write
      questions:
      - How do I trade the authorization code from hosted auth for an access token?
      - Can I use a refresh token to get a new access token?
      instructions:
      - text: Exchange the authorization code from hosted OAuth for tokens.
      - text: Refresh my access token using the refresh token grant.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/connect/revoke'].post
  update:
    x-apievangelist-phrasing:
      intent: Revoke an OAuth access token
      effect: destructive
      questions:
      - Does revoking an access token also revoke the user's grant?
      - How do I invalidate a leaked access token?
      instructions:
      - text: Revoke access token {token}.
        slots:
          token: query.token
      - text: Invalidate OAuth token {token} right away.
        slots:
          token: query.token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/connect/tokeninfo'].get
  update:
    x-apievangelist-phrasing:
      intent: Inspect an OAuth token
      effect: read
      questions:
      - What grant and scopes does a given access token belong to?
      - Can I decode an ID token to see who it was issued for?
      instructions:
      - text: Show info for access token {access_token}.
        slots:
          access_token: query.access_token
      - text: Inspect ID token {id_token}.
        slots:
          id_token: query.id_token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/connect/custom'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a grant with your own OAuth tokens
      effect: write
      questions:
      - Can I create a grant from a refresh token I already obtained myself?
      - How do I migrate existing users without sending them through hosted auth again?
      instructions:
      - text: Create a grant using my own OAuth refresh token.
      - text: Register a grant through Bring Your Own Authentication.
      method: generated
      generated: '2026-09-26'