API coverage¶
Every writable (POST, PUT, PATCH, DELETE) path template in the pinned OpenAPI snapshot of each supported
OpenBao minor is classified exactly once in api-coverage/classification.yaml:
- typed: a kind of this operator configures the object behind the path.
- Endpoint only: configuration without a typed kind; use the
OpenBaoEndpointkind. unreviewed paths are Endpoint only paths that nobody has classified yet. - action: a one-off operation, not configuration (login, issue, sign, rotate, revoke, tidy, ...).
go test ./test/apicoverage/... fails when a writable path is unclassified or classified twice, when a
typed entry names a kind without a CRD in config/crd/bases, or when this file is stale.
The snapshots api-coverage/openapi-<minor>.json come from bao server -dev with every builtin auth
method and secrets engine mounted at its default path (kv v2 at secret/, kv v1 at kv/), fetched with
sys/internal/specs/openapi?generic_mount_paths=true so mount paths appear as {<type>_mount_path}. Add or
refresh a minor with hack/apicoverage/snapshot.sh <bao-binary> api-coverage/openapi-<minor>.json, classify
the new paths, then run go run ./hack/apicoverage. Kinds for engines that are external plugins in a
release (for example AWS, GCP, or LDAP on 2.7) are outside that release's snapshot.
Coverage per release¶
| OpenBao | writable paths | typed | Endpoint only | unreviewed | action | typed share of configuration |
|---|---|---|---|---|---|---|
| 2.6.5 | 377 | 120 (31.8%) | 8 (2.1%) | 0 (0.0%) | 249 (66.0%) | 93.8% |
| 2.7.2 | 352 | 106 (30.1%) | 9 (2.6%) | 0 (0.0%) | 237 (67.3%) | 92.2% |
Typed share of configuration is typed / (typed + Endpoint only + unreviewed): actions are not configuration and are left out. This is a classification of path templates, not a percentage of runtime tests passed.
For OpenBao 2.7.2, 92.2% means 106 of 115 configuration paths. Those same 106 typed paths are 30.1% of all 352 writable paths; the remaining 237 action paths are outside configuration scope.
Why the typed count changes between snapshots¶
The 2.7.2 snapshot omits 14 typed paths present in 2.6.5 and adds no typed paths: three Kerberos auth, three LDAP auth, two RADIUS auth, and six LDAP/OpenLDAP secrets-engine paths. These integrations require external plugins in the later server snapshot. Their CRDs remain in the plugin-gated catalogue; their absence from the builtin snapshot does not mean the operator removed those kinds. Snapshot coverage and live-tested compatibility are separate; see the compatibility reference.
Endpoint-only paths¶
Configuration paths without a typed kind. Manage them with the OpenBaoEndpoint kind; each is a candidate
for a typed kind.
| path | OpenBao | reason |
|---|---|---|
/cubbyhole/{path} |
2.6, 2.7 | token-scoped storage: data written there is visible only to the operator's own token |
/sys/external-keys/configs/{config} |
2.7 | needs a KMS plugin; bao server -dev does not load one |
/sys/external-keys/configs/{config}/keys/{key} |
2.7 | needs a KMS plugin; bao server -dev does not load one |
/sys/external-keys/configs/{config}/keys/{key}/grants/{mount} |
2.7 | needs a KMS plugin; bao server -dev does not load one |
/sys/loggers |
2.6, 2.7 | sets the level of every logger at once; Logger manages one named logger |
/sys/raw |
2.6, 2.7 | raw storage access, break-glass only; deliberately untyped |
/sys/raw/{path} |
2.6, 2.7 | raw storage access, break-glass only; deliberately untyped |
/{ldap_mount_path}/library/{name} |
2.6 | external plugin library set; not tested until the plugin is in CI |
/{openldap_mount_path}/library/{name} |
2.6 | external plugin library set; not tested until the plugin is in CI |
/{ssh_mount_path}/config/zeroaddress |
2.6, 2.7 | allowlist of roles that may use any source address; set it with OpenBaoEndpoint |
/{ssh_mount_path}/issuer/{issuer_ref} |
2.6, 2.7 | renames or deletes an issuer; SSHCA owns the default CA through config/ca |