IntegrationOS · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for One OAuth Authorizations API

5 actions 5 updates phrasing extends openapi/integration-os-oauth-authorizations-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for IntegrationOS's API. It is a proposal applied on top of the contract, not a document IntegrationOS publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/v1/oauth-authorizations'].get

$.paths['/v1/oauth-authorizations/{client_id}'].get

$.paths['/v1/oauth-authorizations/{client_id}'].delete

$.paths['/v1/oauth-authorizations/{client_id}'].patch

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for One OAuth Authorizations API
  version: 1.0.0
extends: openapi/integration-os-oauth-authorizations-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['/v1/oauth-authorizations'].get
  update:
    x-apievangelist-phrasing:
      intent: List the OAuth apps I have authorized
      effect: read
      questions:
      - Which third-party OAuth apps have I granted access to my account?
      - Can I page through every OAuth client I've authorized?
      instructions:
      - text: List the OAuth apps I've authorized.
      - text: Show page {page} of my OAuth authorizations, {limit} per page.
        slots:
          page: query.page
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/oauth-authorizations/{client_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: View my authorization for one OAuth app
      effect: read
      questions:
      - What access did I grant to a specific OAuth client?
      - Can I check which access rules apply to one app I've authorized?
      instructions:
      - text: Show my authorization for OAuth client {client_id}.
        slots:
          client_id: path.client_id
      - text: Look up the access rules I granted to app {client_id}.
        slots:
          client_id: path.client_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/oauth-authorizations/{client_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke an OAuth app's access to my account
      effect: destructive
      questions:
      - How do I remove an OAuth app's access to my account?
      - Can I disconnect a third-party app I authorized earlier?
      instructions:
      - text: Revoke my authorization for OAuth client {client_id}.
        slots:
          client_id: path.client_id
      - text: Disconnect app {client_id} from my account entirely.
        slots:
          client_id: path.client_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/oauth-authorizations/{client_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change the access an authorized app has
      effect: write
      questions:
      - Can I narrow what an already-authorized OAuth app is allowed to reach?
      - How do I change the access rules on an app I authorized without revoking it?
      instructions:
      - text: Update the access rules for authorized app {client_id} to {accessRules}.
        slots:
          client_id: path.client_id
          accessRules: requestBody.accessRules
      - text: 'Restrict OAuth client {client_id} to these access rules: {accessRules}.'
        slots:
          client_id: path.client_id
          accessRules: requestBody.accessRules
      method: generated
      generated: '2026-10-01'