Northbeam · OpenAPI Overlay 1.0.0

API Evangelist enhancements for Northbeam Orders API v1 (Deprecated)

4 actions 4 updates update extends openapi/northbeam-orders-v1-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-slugx-apievangelist-tagsx-apievangelist-notex-apievangelist-spec-sourcex-apievangelist-artifactsx-apievangelist-idempotencyx-apievangelist-lifecycle

Targets 1

$.info

OpenAPI Overlay

overlay: 1.0.0
info:
  title: API Evangelist enhancements for Northbeam Orders API v1 (Deprecated)
  version: 1.0.0
extends: openapi/northbeam-orders-v1-openapi.yml
x-generated: '2026-08-13'
x-method: generated
x-source: apis.yml + repo artifacts
actions:
- target: $.info
  update:
    x-apievangelist-slug: northbeam
    x-apievangelist-tags:
    - Orders
    - Attribution
    - Deprecated
    x-apievangelist-note: 'Superseded by Orders v2. Northbeam marks this deprecated only in info.title — no operation carries deprecated: true, no Sunset header and no removal date are published.'
    x-apievangelist-spec-source: https://dash.readme.com/api/v1/api-registry/ (ReadMe registry @northbeam-customer-sucess/v2.2)
- target: $.info
  update:
    x-apievangelist-artifacts:
      authentication: authentication/northbeam-authentication.yml
      conventions: conventions/northbeam-conventions.yml
      errors: errors/northbeam-problem-types.yml
      lifecycle: lifecycle/northbeam-lifecycle.yml
      rate_limits: rate-limits/northbeam-rate-limits.yml
      sandbox: sandbox/northbeam-sandbox.yml
      data_model: data-model/northbeam-data-model.yml
      conformance: conformance/northbeam-conformance.yml
      mcp: mcp/northbeam-mcp.yml
- target: $.info
  update:
    x-apievangelist-idempotency:
      mechanism: natural-key upsert
      key: order_id
      header: null
      note: POST /orders is an upsert on order_id, so replays are safe. PATCH /orders is NOT — it requires every order_id to already exist and fails the entire batch otherwise.
- target: $.info
  update:
    x-apievangelist-lifecycle:
      status: deprecated
      successor: https://api.northbeam.io/v2
      sunset_date: null
      evidence: info.title is "API - Orders - V1 (Deprecated)"