README
¶
opod-sdk
The typed contract between an opod leader (opod-io/opod-core, Apache-2.0) and whatever manages it — the opod control plane today, anything else tomorrow. Apache-2.0, stdlib only, no business logic.
| Package | What |
|---|---|
adminapi |
The JSON shapes a leader serves on /admin/v1, /loadz and in the mounted auth / policy snapshot files, plus the frozen route list and feature names. The leader marshals these types itself, so a field here is a field on the wire. |
catalog |
The model catalog: one YAML per model, embedded (catalog.FS, Names(), Read()) and its schema (Entry). The leader and the control plane both read this one set; parsing stays with the importer's YAML library (this module stays stdlib-only). Schema in catalog/README.md. |
Planned here next: connect/ (the client snippet templates opod connect and the console share).
Rules: additive only within a contract version (adminapi.ContractVersion); json tags are the wire; nothing here imports anything but the standard library.
import "github.com/opod-io/opod-sdk/adminapi"
Directories
¶
| Path | Synopsis |
|---|---|
|
Package adminapi is the typed decoupling contract between an opod leader and whatever manages it (the control plane today, anything else tomorrow): the JSON shapes served on /admin/v1, /loadz and the mounted auth/policy snapshot files.
|
Package adminapi is the typed decoupling contract between an opod leader and whatever manages it (the control plane today, anything else tomorrow): the JSON shapes served on /admin/v1, /loadz and the mounted auth/policy snapshot files. |
|
Package catalog is the model catalog opod ships: one YAML per model (the files beside this package, embedded) and the schema they follow.
|
Package catalog is the model catalog opod ships: one YAML per model (the files beside this package, embedded) and the schema they follow. |
Click to show internal directories.
Click to hide internal directories.