Splitwise · OpenAPI Overlay 1.0.0

API Evangelist enrichment overlay for the Splitwise API

3 actions 3 updates update extends ../openapi/splitwise-openapi.json

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelistx-response-contractx-pagination

Targets 3

$.info

$.paths./get_expenses.get

OpenAPI Overlay

overlay: 1.0.0
info:
  title: API Evangelist enrichment overlay for the Splitwise API
  version: 1.0.0
x-meta:
  generated: '2026-07-21'
  method: generated
  source: >-
    Generated by the API Evangelist enrichment pipeline over
    openapi/splitwise-openapi.json. Captures our cross-cutting annotations
    without mutating the original spec.
extends: ../openapi/splitwise-openapi.json
actions:
- target: $.info
  description: Add API Evangelist provenance and documentation links.
  update:
    x-apievangelist:
      provider: splitwise
      docs: https://dev.splitwise.com/
      register_app: https://secure.splitwise.com/apps
      status_page: https://status.splitwise.com/
- target: $
  description: Note the success/error envelope contract for every operation.
  update:
    x-response-contract:
      note: >-
        A 200 OK does not by itself indicate success. Inspect the response body
        `success` and/or `errors` fields. Errors use {error} (401) or
        {errors.base[]} (400/403/404); not RFC 9457.
      detail: ../errors/splitwise-problem-types.yml
- target: $.paths./get_expenses.get
  description: Document limit/offset pagination convention.
  update:
    x-pagination:
      style: limit/offset
      limit_default: 20
      offset_default: 0
      detail: ../conventions/splitwise-conventions.yml