# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Microsoft Azure O Auth Tokens API
  version: 1.0.0
extends: openapi/microsoft-azure-oauth-tokens-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: 4
- target: $.paths['/oauth/tokens'].get
  update:
    x-apievangelist-phrasing:
      intent: List OAuth tokens for parties
      effect: read
      questions:
      - Which OAuth tokens are stored for a party in my Data Manager for Agriculture instance?
      - Can I list only the tokens that are still valid for a given OAuth provider?
      instructions:
      - text: List OAuth tokens for party {partyIds}.
        slots:
          partyIds: query.partyIds
      - text: Show tokens from provider {authProviderIds} where valid is {isValid}.
        slots:
          authProviderIds: query.authProviderIds
          isValid: query.isValid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/oauth/tokens/:connect'].post
  update:
    x-apievangelist-phrasing:
      intent: Get an OAuth connection link for a party
      effect: read
      questions:
      - How do I get the link a farmer clicks to connect their account through OAuth?
      - Can I pass state that comes back on the redirect after the OAuth connect flow?
      instructions:
      - text: Get an OAuth connect link for party {partyId} with provider {oAuthProviderId}, redirecting to {userRedirectLink}.
        slots:
          partyId: requestBody.partyId
          oAuthProviderId: requestBody.oAuthProviderId
          userRedirectLink: requestBody.userRedirectLink
      - text: Generate a connection link for {partyId} via {oAuthProviderId} returning to {userRedirectLink} with state {userRedirectState}.
        slots:
          partyId: requestBody.partyId
          oAuthProviderId: requestBody.oAuthProviderId
          userRedirectLink: requestBody.userRedirectLink
          userRedirectState: requestBody.userRedirectState
      method: generated
      generated: '2026-10-01'
- target: $.paths['/oauth/tokens/remove/{jobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an OAuth token removal job
      effect: read
      questions:
      - Has my OAuth token removal job finished?
      - What's the status of a cascade delete job for a token?
      instructions:
      - text: Get the OAuth token removal job {jobId}.
        slots:
          jobId: path.jobId
      - text: Check progress of token delete job {jobId}.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/oauth/tokens/remove/{jobId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Start a job to remove a party's OAuth token
      effect: destructive
      questions:
      - How do I revoke and remove a party's OAuth token for a provider?
      - Can I delete a stored OAuth token along with its dependent data?
      instructions:
      - text: Start removal job {jobId} for party {partyId}'s token from provider {oauthProviderId}.
        slots:
          jobId: path.jobId
          partyId: query.partyId
          oauthProviderId: query.oauthProviderId
      - text: Remove the {oauthProviderId} OAuth token of {partyId} as job {jobId}.
        slots:
          oauthProviderId: query.oauthProviderId
          partyId: query.partyId
          jobId: path.jobId
      method: generated
      generated: '2026-10-01'