Skip to main content

definitions_install

Typed specification

Generated by the pinned ess generate --kind docs from ess. Structural validation establishes consistency; behaviour, storage and cross-record predicates remain implementation obligations.

What connectors definitions install reads and writes. Index is a connectors-definitions release's published index.json as this build reads it; Lock pins one installed release for one connectors configuration; CacheEntry is the read-only copy of that release's files, keyed by the SHA-256 of its index.json.

connectors.definitions_install is one of connectors's bounded contexts. Back to the index.

Types​

Asset​

connectors.definitions_install.Asset is a record of two fields:

  • name — String
  • sha256 — connectors.definitions_install.HexDigest

CacheEntry​

connectors.definitions_install.CacheEntry is a record of two fields:

  • index_sha256 — connectors.definitions_install.HexDigest
  • index — connectors.definitions_install.Index

Feature​

connectors.definitions_install.Feature is one of embedded_text, query_fixed, query_folds and rate_limit_headers.

HexDigest​

connectors.definitions_install.HexDigest wraps String and is not interchangeable with one: the whole value of naming it separately is the crossings the model then refuses. Its characters are drawn from 0123456789abcdef.

Index​

connectors.definitions_install.Index is a record of six fields:

  • schema — connectors.definitions_install.IndexSchemaId
  • tag — String
  • commit — connectors.definitions_install.HexDigest
  • features — List<String>
  • asset — connectors.definitions_install.Asset
  • files — List<connectors.definitions_install.IndexFile>

IndexFile​

connectors.definitions_install.IndexFile is a record of three fields:

  • path — String
  • sha256 — connectors.definitions_install.HexDigest
  • size — Integer

IndexSchemaId​

connectors.definitions_install.IndexSchemaId is one of urn:beyond10x:connectors-definitions-index:1.

Lock​

connectors.definitions_install.Lock is a record of five fields:

  • format — connectors.definitions_install.LockFormat
  • source — String
  • tag — String
  • commit — connectors.definitions_install.HexDigest
  • index_sha256 — connectors.definitions_install.HexDigest

LockFormat​

connectors.definitions_install.LockFormat is one of connectors-definitions-lock/1.

Three of the types above are reached by nothing else in this system: connectors.definitions_install.CacheEntry, connectors.definitions_install.Feature and connectors.definitions_install.Lock. No entity, view, command, event, error or crossing names them, so it is either vocabulary something outside this specification uses or a leftover — and only a person can tell which.

Generated from connectors v1 · model digest e1e1672d0af4753cb8f2da6c0b22a7f6ae8ce9f7abc168f86169babdf1325787 · contract digest slice-sha256/2:32c0d8449b79899649f301bf2179579aed5e5996fb557eb19b31abd937bd872c. Do not edit this file; change the specification and regenerate it with ess generate.