Skip to main content
GET
Read a contract version

Autorizações

Authorization
string
header
obrigatório

JWT issued by the identity provider. A producer calls with a service credential issued for the tenant it sends facts for; a reader calls with a user token or a service credential. The tenant is always taken from the token, never from the request path, query or body.

Parâmetros de caminho

producer
string
obrigatório

Producer service that owns the fact type.

Exemplo:

"checkout-api"

namespace
string
obrigatório

Namespace of the fact type.

Exemplo:

"acme.checkout"

type
string
obrigatório

Fact type name.

Exemplo:

"checkout.order_placed"

schemaVersion
string
obrigatório

Semantic version of the contract (major.minor.patch).

Exemplo:

"1.0.0"

Resposta

The contract version as registered, with its content hash and its status (ACTIVE or DEPRECATED).

createdAt
string<date-time>
obrigatório

When this version was registered. RFC 3339, UTC.

hash
string
obrigatório

Content hash verified at registration (the prefix sha256: plus 64 hex characters); the authoritative integrity value of this version.

namespace
string
obrigatório

Namespace of the fact type, bound to the producer that registered in it first.

Exemplo:

"acme.checkout"

producer
string
obrigatório

Producer service that owns the fact type.

Exemplo:

"checkout-api"

references
object[] | null
obrigatório

References facts of this type carry, each with the scope and sensitivity its reference type had at registration.

schema
any
obrigatório

Payload schema as stored: member order, whitespace and number spelling may differ from what was sent, so check integrity with hash, never by rehashing this.

schemaVersion
string
obrigatório

Semantic version of this contract (major.minor.patch).

Exemplo:

"1.0.0"

status
enum<string>
obrigatório

Lifecycle status: a DEPRECATED version refuses new facts and never returns to ACTIVE. Allowed values: ACTIVE, DEPRECATED.

Opções disponíveis:
ACTIVE,
DEPRECATED
team
string
obrigatório

Owning team or squad, as registered; informational and audited, never an identity.

Exemplo:

"checkout-squad"

type
string
obrigatório

Fact type name, chosen by the producer.

Exemplo:

"checkout.order_placed"

compatibilityPolicy
enum<string>

How a new version is checked against the earlier versions of its major. Allowed values: TRANSITIVE.

Opções disponíveis:
TRANSITIVE