Saltar al contenido principal
GET
Obtener el contrato de escritura de una clave

Autorizaciones

Authorization
string
header
requerido

A bearer JWT issued by the platform's Access Manager (plugin-auth / lib-auth). Authorization is deny-all by default: the application must be configured with an authorizer, and when authentication is enabled it enforces per-namespace role-based access control on top of a valid, platform-scoped (non-tenant) identity. Machine callers obtain a token via the Access Manager client-credentials flow.

Parámetros de ruta

namespace
string
requerido

The Systemplane namespace. Rails and plugins use runtime_config, tenant_policy, or operational_registry; some applications register a single application-named namespace instead.

Ejemplo:

"runtime_config"

key
string
requerido

The registered key within the namespace. Keys are flat, dot-delimited identifiers; a key may itself contain / segments.

Ejemplo:

"tenancy.ispb_organization_bindings"

Respuesta

The key's write contract.

The full write contract for one registered key.

catalogVersion
string
requerido

The catalog schema version.

Ejemplo:

"systemplane.catalog.v1"

service
string
requerido

The application that serves this catalog.

Ejemplo:

"matcher"

namespace
string
requerido

The namespace the key belongs to.

Ejemplo:

"tenant_policy"

key
string
requerido

The registered key.

Ejemplo:

"tenancy.ispb_organization_bindings"

kind
string
requerido

The value kind the key accepts.

Ejemplo:

"object"

tenantScoped
boolean
requerido

Whether the key's value is resolved per tenant.

Ejemplo:

false

runtimeClass
string
requerido

When a change takes effect.

Ejemplo:

"read_live"

redaction
string
requerido

The redaction policy applied to the value on read.

Ejemplo:

"mask"

hasValidator
boolean
requerido

Whether the key has a server-side write validator.

Ejemplo:

true

description
string
requerido

A human-readable description of the key.

Ejemplo:

"Tenant-scoped JSON object keyed by ISPB"

detailUrl
string
requerido

The relative URL of this detail resource.

Ejemplo:

"/system/-/catalog/tenant_policy/tenancy.ispb_organization_bindings"

schema
object
requerido

The JSON schema the value is validated against.

write
object
requerido

The write descriptor for a key — the request you send to change it.

defaultValue
any

The key's default value. Untyped — matches the key's kind.

rules
string[]

Human-readable semantic validation rules beyond the JSON schema. Omitted when there are none.

Ejemplo:
examples
object[]

Valid example values for the key. Omitted when there are none.

Maximum array length: 10