overlay: 1.0.0
info:
  title: API Evangelist enhancements — Sendoso scim API
  version: 1.0.0
extends: ../openapi/sendoso-scim-api-openapi.yml
x-generated: '2026-08-13'
x-method: generated
x-source: >-
  API Evangelist enrichment pipeline. Captures the cross-cutting runtime semantics that
  Sendoso documents in prose but that do not live in any spec, so they can be re-applied
  after the OpenAPI is regenerated from the docs.
actions:
  - target: $.info
    description: Stamp provenance and the operational facts an agent needs before calling.
    update:
      x-provenance:
        generated-from: documentation
        source: https://developer.sendoso.com/llms.txt
        generated-on: '2026-08-13'
        publisher-of-spec: API Evangelist
        publisher-of-api: Sendoso
        note: >-
          Sendoso publishes no OpenAPI. This document is generated from Sendoso's own
          reference pages; every operation carries an externalDocs URL back to the page it
          came from.
      x-idempotency:
        supported: false
        statement: >-
          Sendoso does not handle duplicate payloads. Any order sent to Sendoso is processed
          immediately. POST operations are NOT safe to retry.
        source: https://developer.sendoso.com/rest-api/overview/faq
      x-rate-limits:
        source: rate-limits/sendoso-rate-limits.yml
        core: 10 requests/second per application client
        marketplace: 100 requests/minute per user
        exhaustion_status: 429
        headers: [X-Rate-Limit-Reset]
      x-error-format:
        rfc9457: false
        envelope: '{success: boolean, message: string}'
        stable_codes: false
        source: errors/sendoso-problem-types.yml
      x-agent-surfaces:
        mcp: https://app.sendoso.com/mcp
        agent_card: https://developer.sendoso.com/.well-known/agent-card.json
        agent_skill: https://developer.sendoso.com/.well-known/agent-skills/sendoso/skill.md
        llms_txt: https://developer.sendoso.com/llms.txt
      x-lifecycle:
        status_page: none
        changelog: none
        deprecation_policy: none
        source: lifecycle/sendoso-lifecycle.yml
  - target: $.info
    description: Record the entitlement gate and the join-by-name hazard.
    update:
      x-entitlement: >-
        SCIM user management is an Enterprise-tier feature on Sendoso's plan comparison. It
        also requires a separate OAuth client id and secret from the Core API.
      x-join-hazard: >-
        ScimUser.division matches a Core API team group by NAME, not id. Renaming a team group
        in the Sendoso application breaks provisioning silently.
      x-documented-gap: >-
        Sendoso's reference nav declares "Get Single User" at GET /api/scim/v2/Users — the
        same path and method as the list operation, with a request BODY. That is a
        documentation defect; no single-user GET path is published, so none is described in
        the spec.