For the complete documentation index, see llms.txt.
Skip to main content

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.

InterfacePurposeCurrent contract
Public APIManage Services, artifacts, Configuration Plans, Expositions, Secrets, Gateway Groups, and API tokensPublic OpenAPI
Administration APIManage users, organizations, memberships, quotas, and service accountsAdmin OpenAPI
Authentication APIAuthenticate users and establish CLI or browser sessionsAuthentication OpenAPI

Command-line interfaces​

  • CLI reference provides the user-facing command index and bounded examples on this site.
  • CLI source is the current owner for registered commands and embedded help.
  • Admin CLI guide owns exhaustive administration workflows.

Use reshapr --help or reshapr <command> --help for the command set installed on your machine.

Kubernetes APIs​

Helm interfaces​

Consult each chart's README.md, COMMANDS.md, and values.yaml in the owner repository rather than relying on copied option tables.

Agent View