For the complete documentation index, see llms.txt. This page is also available as Markdown.

Partner API

Status: deferred, not built out. locust/api/partner-api/ is scaffolded (ingest-pipeline/, search/ placeholder locustfiles) but has no working request bodies or scenarios yet — see ../staff-api/test-scenarios.md §2 ("Out of scope").

What this will eventually cover

  • DCI search (/sync/search, /dci/registry) — standards-compliant partner search against the same registers staff-api reads. Endpoint class: Register-Search (see ../staff-api/test-scenarios.md for the classification scheme this doc should reuse once built out).

  • Consent/signature posture materially affects partner-api latency more than staff-api's — every DCI search costs a Partner Management key fetch plus a Consent Manager /validate round-trip when global.consentEnforcementEnabled/global.partnerSignatureValidationEnabled are on (the chart default). See ../environment-topology.md and ../staff-api/test-scenarios.md §8 "Prep" step 2 — the same posture decision applies here.

  • /partner/ingest_data (async ingestion → Celery) is not partner-api's synchronous-API concern — that's ../celery/test-scenarios.md.

Reports

Once built, this tier gets its own raw-report.md (generated by a partner-api equivalent of scripts/create_raw_report.py) and final-report.md, structured the same way as ../staff-api/ — not shared files, since partner-api's volume-tier/pod-scale/step matrix and SLOs will differ from staff-api's.

Last updated

Was this helpful?