Product Interfaces
Use this hub to find the canonical contract or implementation for each reShapr interface. The linked owner repositories carry exhaustive and frequently changing details; this site provides orientation and bounded examples.
Stability conventions​
- Current contract links point to the owner's default branch and evolve with the product.
- Release-specific usage should point to a Git tag or release matching the version used by an executable guide.
- Generated contracts remain owned by their source repository and should not be copied into this site.
Control plane APIs​
The reshapr repository owns the control plane contracts.
| Interface | Purpose | Current contract |
|---|---|---|
| Public API | Manage Services, artifacts, Configuration Plans, Expositions, Secrets, Gateway Groups, and API tokens | Public OpenAPI |
| Administration API | Manage users, organizations, memberships, quotas, and service accounts | Admin OpenAPI, organization guide, and quota guide |
| Authentication API | Authenticate users and establish CLI or browser sessions | Authentication OpenAPI |
Since the contract metadata update, all three current contracts declare API version 1.1 (info.version) and use the OpenAPI 3.0.2 format. The public contract still has the historical -v0.1 filename suffix; that suffix does not identify its declared API version. Release-specific guides retain the filenames and metadata present at their release tags rather than applying these default-branch renames retroactively.
MCP interface​
- MCP Compatibility explains session-based and stateless negotiation, state, response dialects, and elicitation.
- MCP Support Matrix records the exact versions and server methods verified for reShapr
1.1.0. - MCP implementation is the current owner for Gateway protocol behavior.
- Official MCP specification owns the protocol beyond reShapr's implementation boundary.
Command-line interfaces​
- CLI reference provides the user-facing command index and bounded examples on this site.
- Artifact import guide applies the Web UI and CLI to OpenAPI, GraphQL, and Protobuf sources.
- CLI source is the current owner for registered commands and embedded help.
- Admin CLI guide owns exhaustive administration workflows.
- Organization and membership guide covers organization creation, ownership, and user access.
- Organization quota guide applies the Web UI, CLI, and administration API to one bounded governance task.
Use reshapr --help or reshapr <command> --help for the command set installed on your machine.
Kubernetes APIs​
- Kubernetes APIs and Controllers orients readers across the operator, admission webhook, and eight custom resources.
- Controllers documentation owns installation and per-resource references.
- Generated CRD schemas are the current Kubernetes contracts.
Helm interfaces​
- Helm Charts Overview helps readers choose among the four reShapr charts.
- Helm charts repository owns chart documentation, commands, and values.
- Helm releases provide immutable versions for executable deployment procedures.
Consult each chart's README.md, COMMANDS.md, and values.yaml in the owner repository rather than relying on copied option tables.