API Surfaces

This section is the canonical index for Marqo API surfaces across teams.

Scope

• library is the discovery and context layer.
• Service repos remain the source of truth for contracts and endpoint details.

Surfaces

Surface	Canonical docs (source repo publish)	Owner team	Notes
Ecom	TODO	TODO	Customer ecommerce workflows and integration paths
Classic	TODO	TODO	Core/control-plane aligned API surface
Dataplane	TODO	TODO	Data-plane operational and query-facing endpoints
Admin	TODO	TODO	Admin and operational API workflows

Usage

• Start here to choose the right API surface for a use case.
• Follow links to Swagger UI or Stoplight Elements pages for full contracts.
• Use local surface pages for cross-team context:
• auth model
• golden request/response workflows
• migration notes and common pitfalls

Required updates

When an API contract changes in a service repo:

1. Update and publish the source-of-truth OpenAPI docs in that repo.
2. Update this registry link and any impacted auth.md or common-workflows.md pages.
3. Open a library PR if cross-team behavior or guidance changed.