Mailosaur · OpenAPI Overlay 1.0.0

API Evangelist enhancements for Mailosaur Analysis Messages API

4 actions 4 updates update extends openapi/mailosaur-messages-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-providerx-apievangelist-artifactsx-api-versioningx-error-responses-declaredx-observed-challengex-observed-401-bodyx-error-catalogx-idempotent-retry-safe

Targets 3

$.info

$.components.securitySchemes.basicAuth

$.paths.*.*

OpenAPI Overlay

overlay: 1.0.0
info:
  title: API Evangelist enhancements for Mailosaur Analysis Messages API
  version: 1.0.0
extends: openapi/mailosaur-messages-api-openapi.yml
x-generated: '2026-08-14'
x-method: generated
x-source: openapi/mailosaur-messages-api-openapi.yml + repo artifacts (conventions/, errors/, authentication/, lifecycle/, data-model/)
actions:
  - target: $.info
    description: Bind this contract to the API Evangelist artifacts derived from it.
    update:
      x-apievangelist-provider: mailosaur
      x-apievangelist-artifacts:
        conventions: conventions/mailosaur-conventions.yml
        errors: errors/mailosaur-problem-types.yml
        authentication: authentication/mailosaur-authentication.yml
        lifecycle: lifecycle/mailosaur-lifecycle.yml
        data_model: data-model/mailosaur-data-model.yml
        rate_limits: rate-limits/mailosaur-rate-limits.yml
        skills: skills/_index.yml
  - target: $.info
    description: >-
      Record the two facts the original contract does not state: the API is
      unversioned, and it declares no error responses.
    update:
      x-api-versioning: unversioned
      x-error-responses-declared: false
  - target: $.components.securitySchemes.basicAuth
    description: >-
      PROBED 2026-08-14 — an unauthenticated request to
      https://mailosaur.com/api/servers answers 401 with
      'www-authenticate: Bearer' and an empty body, contradicting the
      documented Basic scheme that actually works.
    update:
      x-observed-challenge: Bearer
      x-observed-401-body: empty
  - target: $.paths.*.*
    description: >-
      No operation in this document declares a 4xx or 5xx response. The real
      error contract is catalogued in errors/mailosaur-problem-types.yml:
      400 returns a {type,message,parameters,model} envelope; 401 and 404
      return no body.
    update:
      x-error-catalog: errors/mailosaur-problem-types.yml
      x-idempotent-retry-safe: false