Insider · OpenAPI Overlay 1.0.0

API Evangelist enhancements for Insider One Gateway API (OAuth 2.0)

6 actions 6 updates update extends ../openapi/insider-gateway-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Insider's API. It is a proposal applied on top of the contract, not a document Insider publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-derived-fromx-derived-source-urlx-provider-publishes-openapix-rate-limit-referencex-authentication-profilex-error-catalogx-error-formatx-rfc9457

Targets 5

$.info
$.paths.*.*
$.components.securitySchemes.*
$.components.securitySchemes.OAuth2
$.paths['/api/wa/v2/transactional/settings'].post

OpenAPI Overlay

Raw ↑ 
overlay: 1.0.0
info:
  title: API Evangelist enhancements for Insider One Gateway API (OAuth 2.0)
  version: 1.0.0
extends: ../openapi/insider-gateway-openapi.yml
x-provenance:
  generated: '2026-08-13'
  method: generated
  source: openapi/insider-gateway-openapi.yml
  note: Captures API Evangelist annotations without mutating the derived specification.
actions:
- target: $.info
  description: Record that this document is an API Evangelist derivation of Insider One's own public Postman collection,
    not a provider-published OpenAPI.
  update:
    x-derived-from: postman/insider-one-apis.postman_collection.json
    x-derived-source-url: https://developers.insiderone.com/
    x-provider-publishes-openapi: false
- target: $.paths.*.*
  description: Attach the documented 429 throttling response to every operation, from the published per-endpoint
    rate-limit table.
  update:
    x-rate-limit-reference: https://academy.insiderone.com/docs/api-rate-limits-1
- target: $.components.securitySchemes.*
  description: Cross-link the authentication profile, since the API-key header name varies by Insider One host.
  update:
    x-authentication-profile: authentication/insider-authentication.yml
- target: $.info
  description: 'Cross-link the derived error catalog: Insider One documents errors globally, not per operation,
    and uses six different envelopes.'
  update:
    x-error-catalog: errors/insider-problem-types.yml
    x-error-format: vendor-json
    x-rfc9457: false
- target: $.components.securitySchemes.OAuth2
  description: Populate the OAuth 2.0 flows from the live RFC 8414 authorization-server metadata served at gw.useinsider.com.
  update:
    x-discovery: well-known/insider-gw-oauth-authorization-server.json
    x-scopes-artifact: scopes/insider-scopes.yml
- target: $.paths['/api/wa/v2/transactional/settings'].post
  description: Mark the webhook-registration operations and cross-link the webhook catalog.
  update:
    x-webhook-registration: true
    x-webhook-catalog: asyncapi/insider-whatsapp-webhooks.yml