Mirage · OpenAPI Overlay 1.0.0

API Evangelist enhancements for Mirage Video API

3 actions 3 updates update extends openapi/mirage-openapi-original.json

Authorship not recorded No authorship marker is recorded for this file. It is not presented as the provider's.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-providerx-apievangelist-backed-byx-apievangelist-authx-apievangelist-async-modelApiKeyAuth

Targets 3

$.info

$.servers

$.components.securitySchemes

OpenAPI Overlay

overlay: 1.0.0
info:
  title: API Evangelist enhancements for Mirage Video API
  version: 1.0.0
extends: openapi/mirage-openapi-original.json
actions:
- target: $.info
  update:
    x-apievangelist-provider: mirage
    x-apievangelist-backed-by: general-catalyst
    x-apievangelist-auth: x-api-key header (see authentication/mirage-authentication.yml)
    x-apievangelist-async-model: submit-and-poll
- target: $.servers
  update:
  - url: https://api.mirage.app
    description: Production (added by API Evangelist; the source spec declares no servers[]).
- target: $.components.securitySchemes
  update:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API key issued from the dashboard. The source spec omits securitySchemes;
        this documents the auth the API reference requires.