Remote · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Remote 2.0 OAuth API

3 actions 3 updates phrasing extends openapi/remote-com-oauth-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Remote's API. It is a proposal applied on top of the contract, not a document Remote publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/oauth/authorize'].get
$.paths['/oauth2/token'].post

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 Remote 2.0 OAuth API
  version: 1.0.0
extends: openapi/remote-com-oauth-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: 2
- target: $.paths['/oauth/authorize'].get
  update:
    x-apievangelist-phrasing:
      intent: Send a company admin to grant access
      effect: read
      questions:
      - How does a company admin authorize my partner app to access their Remote account?
      - Where do I redirect users to start the OAuth authorization code flow?
      instructions:
      - text: Build the authorize URL for client {client_id} with response type {response_type} returning to {redirect_uri}.
        slots:
          client_id: query.client_id
          response_type: query.response_type
          redirect_uri: query.redirect_uri
      - text: Start authorization for client {client_id} to {redirect_uri} with response type {response_type} and scope {scope}.
        slots:
          client_id: query.client_id
          redirect_uri: query.redirect_uri
          response_type: query.response_type
          scope: query.scope
      method: generated
      generated: '2026-09-26'
- target: $.paths['/oauth2/token'].post
  update:
    x-apievangelist-phrasing:
      intent: Exchange a code or refresh token for an access token
      effect: write
      questions:
      - How do I turn an authorization code into a company-scoped access token?
      - Can I refresh an expired access token?
      - Which grant types does the token endpoint accept?
      instructions:
      - text: Exchange authorization code {code} for client {client_id} using grant type {grant_type}.
        slots:
          code: requestBody.code
          client_id: requestBody.client_id
          grant_type: requestBody.grant_type
      - text: Refresh the token {refresh_token} for client {client_id} with grant type {grant_type}.
        slots:
          refresh_token: requestBody.refresh_token
          client_id: requestBody.client_id
          grant_type: requestBody.grant_type
      method: generated
      generated: '2026-09-26'