The sidecar¶
Registration, settings, access, scope, figures, refusals and the delivery stream. This is its data dictionary at contract v24: one entry for every field of its messages a plugin meets, saying what the field is for, what a value means and does not mean, what empty means, who fills it, its bounds and the operations a write must carry it on. Each entry is anchored by its name, the name a refusal's path resolves to and a declaration names, which never changes.
Its messages are declared in meridian/plugin/v1/operations.proto, meridian/v1/plugins.proto, meridian/v1/sidecar.proto. A field's entry is the same whatever carries it: a typed operation's parameters take the entries of the message they are made from.
RegisterRequest¶
meridian.v1.RegisterRequest, a message.
schema_version¶
text · since v2 · stable
Says which contract version the plugin was built against.
- Means: v and a number; admitted when it lies between the sidecar's floor and its own version, refused otherwise naming both (W4.1)
- Does not mean: the plugin's own version, or anything that decides its access
- Empty: never empty: a plugin naming no version is refused
- Filled: as-reported, by
plugin - Required on:
SidecarRegisterfrom v2
interface¶
message InterfaceDeclaration · since v2 · stable
Declares the interface the plugin serves to people (W6.9).
- Means: its loopback port, title and pages
- Does not mean: who may see it, which access levels and grants decide
- Empty: unset when the plugin serves no interface to people
- Filled: as-reported, by
plugin
settings¶
repeated message SettingDeclaration · since v2 · stable
Declares the settings an admin of the plugin must or may give it (W4.7, W6.11).
- Means: each setting's name, type, label and whether it is required or secret
- Does not mean: the values, which the settings stream delivers
- Empty: empty when the plugin needs no setting
- Filled: as-reported, by
plugin
reads_external_accounts¶
boolean · since v2 · stable
Says the plugin names accounts by an external source's identifiers.
- Means: true when an admin of the plugin links its external accounts to the deployment's accounts (W6.4), and the sidecar translates on the way in (W2)
- Does not mean: a role: what the plugin may publish is its roles'
- Empty: false for a plugin that names no external account
- Filled: as-reported, by
plugin
declaration¶
message PluginDeclaration · since v11 · stable
Carries the version's declaration as the plugin's SDK built it from its code (W4.1, W8.1).
- Means: the same declaration its upload carried: its secret settings' names, what it does not carry, the storage it asks for; the sidecar reports it (W4.8)
- Does not mean: what the plugin supports, which its roles say; or anything that widens its access
- Empty: unset from a plugin before v11
- Filled: derived, by
plugin
tools¶
repeated message ToolDeclaration · since v12 · stable
Declares the plugin's tools on the deployment's MCP surface (W4.1, W6.20).
- Means: each derived by the plugin's SDK from a route it declares with one typed record of inputs, or declared to replace one; the sidecar admits each it can check and refuses the others by name, the plugin admitted
- Does not mean: a grant or a part of the plugin access is granted by: a call is never wider than its route's page at that level
- Empty: empty from a plugin before v12, and from one declaring no typed route: none of its routes is on the deployment's MCP surface
- Filled: derived, by
plugin - Bounds: at most 200 items; past it, answered at the bound
ToolDeclaration¶
meridian.v1.ToolDeclaration, a message.
name¶
text · since v12 · stable
Names the tool among the plugin's.
- Means: lower-case letters, digits, _ and -, unique among the plugin's tools; the surface names it {instance}__{name}, refused when that passes 64 characters
- Does not mean: the route's path, or a name an agent may call without its owner's prefix
- Empty: never empty
- Filled: derived, by
plugin - Bounds: 1 to 61 characters; past it, refused
title¶
text · since v12 · stable
Names the tool for a person on the consent page.
- Means: the words a person reads under the row of access that reaches it
- Does not mean: an identifier
- Empty: never empty
- Filled: derived, by
plugin - Bounds: 1 to 120 characters; past it, refused
description¶
text · since v12 · stable
Tells an agent what the tool does and answers.
- Means: the vendor's text, which the dashboard prefixes with the plugin's title and instance before an agent reads it
- Does not mean: an instruction the deployment follows: an agent following it still cannot exceed the person
- Empty: never empty
- Filled: derived, by
plugin - Bounds: 1 to 1024 characters; past it, refused
method¶
text · since v12 · stable
Says which method the tool's route takes.
- Means: the method a call is sent with, and the only one at which the sidecar admits a request naming the tool (W4.9)
- Does not mean: whether it reads or acts, which
readssays - Empty: never empty
- Filled: derived, by
plugin
| Value | Means |
|---|---|
GET |
a route that reads |
POST |
a route that changes something, or declares that it changes nothing |
PUT |
a route that replaces something |
PATCH |
a route that changes part of something |
DELETE |
a route that removes something |
path¶
text · since v12 · stable
Says where the tool's route is served.
- Means: a path on the plugin's own host, beginning with / and not under /.meridian; the only one at which the sidecar admits a request naming the tool
- Does not mean: a URL on the dashboard's host
- Empty: never empty
- Filled: derived, by
plugin - Bounds: 1 to 512 characters; past it, refused
levels¶
repeated enum AccessLevel · since v12 · stable
Says which levels the tool's route serves.
- Means: its route's levels; a call opens at the highest the person holds and the delegation covers, write before read before admin
- Does not mean: a role, or a grant
- Empty: never empty: a tool naming no level, or one outside the three, is refused at registration
- Filled: derived, by
plugin
| Value | Means |
|---|---|
ACCESS_LEVEL_UNSPECIFIED |
holds nothing; a tool naming it is refused at registration |
ACCESS_LEVEL_READ |
the route serves View: listed to a person holding read, through a delegation covering it |
ACCESS_LEVEL_WRITE |
the route serves Open: listed to a person holding write, through a delegation covering it |
ACCESS_LEVEL_ADMIN |
the route serves Manage: configuration only, no account's data |
roles¶
repeated text · since v15 · stable
Says which of the plugin's roles the tool serves.
- Means: roles from the deployment's fixed list that the plugin was launched with, a derived tool taking its route's; listed to a person holding one of its levels on one of these roles, and a call opens at the highest such level the delegation covers
- Does not mean: a grant: the sidecar admits what a call sends by the role whose generated grants include it, whatever the tool names
- Empty: empty on a plugin holding one role, where it serves that role, and on a plugin holding none; refused empty from a plugin built at v15 or later holding several
- Filled: derived, by
plugin - Bounds: at most 13 items; past it, refused
reads¶
boolean · since v12 · stable
Says whether the tool reads or acts.
- Means: true for a page, a GET route, or a route declaring that it changes nothing, answering typed data; false for a route that changes something
- Does not mean: what the sidecar admits, which the person's grants at the level decide
- Empty: false is an act
- Filled: derived, by
plugin
input_schema¶
text · since v12 · stable
Describes the route's one typed record of inputs.
- Means: JSON Schema text of an object, decimals as strings and dates as ISO 8601, whose properties are named by the data dictionary's path grammar, so a refusal's path names one argument and one cell of the page's form
- Does not mean: a schema the kernel validates: the plugin's SDK parses the arguments against the record it declared
- Empty: never empty: a route with no inputs declares an empty object
- Filled: derived, by
plugin - Bounds: 2 to 65536 characters; past it, refused
output_schema¶
text · since v12 · stable
Describes the typed answer a read returns.
- Means: JSON Schema text of the record the route's page renders
- Does not mean: HTML, or an answer's value
- Empty: empty for an act
- Filled: derived, by
plugin - Bounds: at most 65536 characters; past it, refused
checked_by¶
text · since v20 · preview
Names the read tool that checks an act without changing anything (W6.26).
- Means: one of the plugin's own read tools taking the same typed record of inputs, which the dashboard calls with the preparer's claims to check a prepared change as the plugin would
- Does not mean: a promise that the act will succeed when made: the stores' own refusals arrive only then; or anything on a read, where it is refused
- Empty: empty: the act cannot be prepared, and the admins may set agents only to may make or may not reach it
- Filled: derived, by
plugin - Bounds: at most 61 characters; past it, refused
accounts¶
repeated text · since v20 · preview
Names where in an act's input the accounts it touches are.
- Means: paths in the input schema by the dictionary's grammar (
account_id,positions[].account_id) whose values are the deployment's accounts, so a prepared change is shown to everyone who may make it on them - Does not mean: a grant or a scope: the sidecar still admits what the act sends by the person's write accounts
- Empty: empty when the act touches no account, or none its input names
- Filled: derived, by
plugin - Bounds: at most 8 items; past it, refused
made_on¶
text · since v20 · preview
Names the page where a person makes an act's change (W6.27).
- Means: the path of one of the plugin's declared pages, opened with the prepared change in the claims so the page starts its form from it
- Does not mean: a route the act is sent to: that stays the tool's method and path
- Empty: empty: the change is made in the dashboard's Inbox
- Filled: derived, by
plugin - Bounds: at most 512 characters; past it, refused
PluginDeclaration¶
meridian.v1.PluginDeclaration, a message.
secret_settings¶
repeated text · since v11 · stable
Names the secret settings the version will ask for, before it is launched (Q6).
- Means: each the name of a setting it declares secret at registration, so an admin knows what credentials it needs
- Does not mean: a value: never one, anywhere in the declaration
- Empty: empty when the plugin asks for no secret
- Filled: derived, by
plugin - Bounds: at most 64 items; past it, refused
not_carried¶
repeated message NotCarried · since v11 · stable
Names what the version receives from its source and does not carry (Q15).
- Means: the evidence that the common model may need to grow, by name only, reviewed with the version
- Does not mean: what the plugin fails to support: a part of its role it does not meet is a reason it is not verified, never declared
- Empty: empty when the plugin carries everything it receives, or declares nothing
- Filled: as-reported, by
plugin - Bounds: at most 500 items; past it, refused
storage¶
message StorageDeclaration · since v11 · stable
Asks for storage of the plugin's own for its raw records (decisions/028).
- Means: approved at launch with the roles; only on a version holding an edge role, refused otherwise
- Does not mean: storage another plugin may read: no plugin's storage is a channel to another
- Empty: unset asks for no storage
- Filled: as-reported, by
plugin
catalogue¶
message Catalogue · since v18 · preview
Declares the datasets a data plugin serves the lake (W8.1, W10.4).
- Means: its catalogue, approved at launch with its roles; only on a version holding data, refused otherwise
- Does not mean: a declaration of support: the canonical role is the requirement
- Empty: unset serves the lake no dataset
- Filled: as-reported, by
plugin
algorithms¶
repeated message AlgorithmDeclaration · since v22 · preview
Declares the algorithm identifiers the version's autonomous work may name (W4.1, W4.9).
- Means: each stable across versions, with a description; a call as a service account naming one this version does not declare is refused INVALID_ARGUMENT naming algorithm_id (W4.15)
- Does not mean: a grant: the service account's grants decide what it reaches
- Empty: empty declares none
- Filled: as-reported, by
plugin
Catalogue¶
meridian.v1.Catalogue, a message.
datasets¶
repeated message DatasetDeclaration · since v18 · preview
Lists the datasets a data plugin serves.
- Means: each dataset, its key once
- Does not mean: a licence: the deployment licenses each
- Empty: none: the catalogue serves nothing
- Filled: as-reported, by
data - Bounds: at most 32 items; past it, refused
DatasetDeclaration¶
meridian.v1.DatasetDeclaration, a message.
key¶
text · since v18 · preview
Names a dataset within its plugin.
- Means: 1 to 40 characters, lowercase letters, digits and underscores, beginning with a letter; the dataset's ID in a deployment is the instance, a colon, and this
- Does not mean: a vendor's product code
- Empty: never empty
- Filled: as-reported, by
data - Bounds: 1 to 40 characters; past it, refused
vendor¶
text · since v18 · preview
Says who originated the data.
- Means: the vendor, as the plugin names it: data, not vocabulary
- Does not mean: who distributes it
- Empty: never empty
- Filled: as-reported, by
data - Bounds: 1 to 64 characters; past it, refused
aggregator¶
text · since v18 · preview
Says who carries the data when an aggregator does.
- Means: the aggregator, as the plugin names it
- Does not mean: the vendor
- Empty: empty: reached directly
- Filled: as-reported, by
data - Bounds: at most 64 characters; past it, refused
data_types¶
repeated text · since v18 · preview
Says what a dataset holds.
- Means: the lake's data types it serves and the optional fields it fills, each by its dictionary entry: a type by its message (meridian.v1.Price), a field by its entry (meridian.v1.Bar.vwap)
- Does not mean: a capability: what a dataset fills is its content
- Empty: never empty
- Filled: as-reported, by
data - Bounds: 1 to 32 items; past it, refused
modes¶
repeated enum ObservationMode · since v18 · preview
Says how a dataset's rows can arrive.
- Means: pull, push or stream, each once, among which the deployment chooses
- Does not mean: how the plugin reaches its vendor
- Empty: never empty
- Filled: as-reported, by
data - Bounds: 1 to 3 items; past it, refused
| Value | Means |
|---|---|
OBSERVATION_MODE_UNSPECIFIED |
refused |
OBSERVATION_MODE_PULL |
fetched when a reader's read is wanted (W10.7) |
OBSERVATION_MODE_PUSH |
recorded on the source's own timetable, unasked |
OBSERVATION_MODE_STREAM |
kept current from the source's stream while a standing want stands |
cadence¶
integer · since v18 · preview
Says how often a dataset updates, and so when it is silent.
- Means: seconds between the source's updates; a dataset that recorded nothing for a subject within it is silent, and a default read falls through
- Does not mean: a schedule the plugin keeps
- Empty: 0: it updates only when asked
- Filled: as-reported, by
data - Unit: seconds
history¶
integer · since v18 · preview
Says how far back a dataset reaches.
- Means: days of history the source serves
- Does not mean: what the lake keeps, which its licence says
- Empty: 0: it states none
- Filled: as-reported, by
data - Unit: days
licence_default¶
message DatasetLicence · since v18 · preview
Carries the terms a vendor's standard terms impose.
- Means: keep or not, derived use, display, the default fields and whether the terms are one person's; the deployment's licence confirms or replaces it (W10.1)
- Does not mean: the deployment's licence, which is enforced; a claim that a deployment meets the vendor's terms
- Empty: unset: the vendor's terms say nothing the platform records
- Filled: as-reported, by
data
day_time_zone¶
text · since v18 · preview
Says the time zone a daily value's business date is in.
- Means: an IANA zone: Etc/UTC for a crypto venue's daily candle, America/New_York for a US close and FX's 17:00 roll; an invalid zone refuses the registration
- Does not mean: a holiday calendar
- Empty: empty: not a daily dataset
- Filled: as-reported, by
data - Bounds: at most 64 characters; past it, refused
day_end_minute¶
integer · since v18 · preview
Says when a dataset's business day ends.
- Means: minutes after local midnight the day ends, which says which candle or session counts as a business date and when it is final
- Does not mean: a market's trading hours
- Empty: 0: the day ends at local midnight
- Filled: as-reported, by
data - Unit: minutes after local midnight
- Bounds: from 0 to 1439; past it, refused
venue_id¶
identifier venue · since v18 · preview
Names the venue a dataset is.
- Means: the venue master's ID; a row naming no venue is the dataset's view
- Does not mean: a MIC, or the dataset's distributor
- Empty: empty: not one venue's, the consolidated view
- Filled: as-reported, by
data
calendar_id¶
text · since v22 · preview
Names the settlement calendar the dataset's business dates follow (W10.1).
- Means: its
CAL-ID, beside day_time_zone and day_end_minute; in v22 kept and applied to nothing, a daily value on a day it says is closed recorded as reported and not flagged until v23 (W10.4) - Does not mean: a venue's trading hours, or a rule applied to the rows
- Empty: empty names none, as before
- Filled: as-reported, by
data
DatasetLicence¶
meridian.v1.DatasetLicence, a message.
dataset¶
identifier dataset · since v18 · preview
Names the dataset licensed.
- Means: the dataset's ID in the deployment
- Does not mean: a vendor's product
- Empty: empty in a catalogue's default
- Filled: entered, by
dashboard
kept¶
boolean · since v18 · preview
Says whether the lake may keep the rows.
- Means: true, kept for retention_days; false, served to the waiting reader and recorded only as served (W10.7)
- Does not mean: whether a reader may see them
- Empty: false: served, not kept
- Filled: entered, by
dashboard
retention_days¶
integer · since v18 · preview
Says how long the lake keeps a row.
- Means: days from when a row was recorded; past it the lake removes the row and records the removal
- Does not mean: how long the plugin keeps its raw records
- Empty: 0: kept as long as the licence allows, no limit set
- Filled: entered, by
dashboard - Unit: days
- Bounds: from 0 to 36500; past it, refused
derived_use¶
boolean · since v18 · preview
Says whether data derived from the dataset may be made.
- Means: true where the terms allow a value computed from it to be kept or shown
- Does not mean: display of the data itself
- Empty: false: no derived data
- Filled: entered, by
dashboard
display¶
boolean · since v18 · preview
Says whether the data may be shown to people.
- Means: true where the terms allow display
- Does not mean: redistribution outside the deployment, which no licence here grants
- Empty: false: not shown
- Filled: entered, by
dashboard
default_fields¶
repeated text · since v18 · preview
Says the fields readable by default.
- Means: fields by their dictionary entries, which an entitlement naming no fields reads
- Does not mean: an entitlement
- Empty: none: every field
- Filled: entered, by
dashboard - Bounds: at most 64 items; past it, refused
personal_use¶
boolean · since v18 · preview
Says whether the terms are one person's.
- Means: true for a feed licensed to one person, such as a retail account holder's; the Data sources page warns when more than one person holds read on a plugin entitled to it
- Does not mean: enforcement per person, which comes later
- Empty: false
- Filled: entered, by
dashboard
updated_by¶
text · since v18 · preview
Names who set the licence.
- Means: the deployment-local subject the dashboard stamped
- Does not mean: an email address
- Empty: empty in a catalogue's default
- Filled: stamped, by
dashboard
updated_at_ns¶
moment · since v18 · preview
Says when it was set.
- Means: when the conductor recorded the change
- Does not mean: when the vendor's terms changed
- Empty: 0 in a catalogue's default
- Filled: decided, by
conductor - Unit: nanoseconds since the epoch
acting_through_delegation¶
text · since v18 · preview
Names the delegation a person acted through.
- Means: the delegation's ID
- Does not mean: an access token
- Empty: empty in a browser, and in a default
- Filled: stamped, by
dashboard
client_name¶
text · since v18 · preview
Names the client a person acted through.
- Means: the client's name
- Does not mean: a person
- Empty: empty in a browser, and in a default
- Filled: stamped, by
dashboard
note¶
text · since v18 · preview
Says why the licence was set.
- Means: the note kept with the change's record
- Does not mean: the vendor's terms
- Empty: empty where none was given at the page; never through /mcp
- Filled: entered, by
dashboard
prepared_call_id¶
text · since v20 · preview
Names the prepared change the change was made from (W6.27).
- Means: the
PC-ID the person's request carried, stamped beside the delegation, so the record says what prepared the change as well as who made it - Does not mean: who made it, who stays the person; or that an agent made it: a person did, from what was prepared
- Empty: empty where the change was not made from a prepared change, and on every change before v20
- Filled: stamped, by
dashboard
NotCarried¶
meridian.v1.NotCarried, a message.
role¶
text · since v11 · stable
Names the role the plugin receives the name in.
- Means: a role from the fixed list the version holds
- Does not mean: a component's name
- Empty: never empty
- Filled: as-reported, by
plugin - Bounds: 1 to 32 characters; past it, refused
scheme¶
text · since v11 · stable
Says whose vocabulary the name is in.
- Means: the plugin's scheme for its source's fields or code set, as on its values as reported
- Does not mean: an identifier scheme of the instrument store
- Empty: never empty
- Filled: as-reported, by
plugin - Bounds: 1 to 64 characters; past it, refused
name¶
text · since v11 · stable
Names a source's field, or a code of its code set, the plugin receives and does not carry.
- Means: the source's own name for it, as its documentation gives it
- Does not mean: a value, an account or an identifier: never one
- Empty: never empty
- Filled: as-reported, by
plugin - Bounds: 1 to 128 characters; past it, refused
reason¶
enum NotCarriedReason · since v11 · stable
Says why a name is not carried.
- Means: which of the two kinds of evidence it is
- Does not mean: a failure the plugin hides: a value it receives and cannot convert crosses as reported
- Empty: unspecified is refused
- Filled: as-reported, by
plugin
| Value | Means |
|---|---|
NOT_CARRIED_REASON_UNSPECIFIED |
not said; refused |
NOT_CARRIED_REASON_NO_CONTRACT_MEANING |
the contract has no meaning for it: a place the model may grow |
NOT_CARRIED_REASON_NOT_CONVERTED |
the contract has a meaning the plugin does not yet convert it to |
StorageDeclaration¶
meridian.v1.StorageDeclaration, a message.
retention_days¶
integer · since v11 · stable
Says how long the plugin keeps a raw record.
- Means: days from when the plugin received the record; the reach of a backfill, and what the deployment keeps the storage for; from v16 the window of a version declaring no kinds, past which its records are archived or kept, never deleted
- Does not mean: a regulator's period, which the firm sets; or a promise the deployment deletes anything
- Empty: never 0 on storage asked for
- Filled: as-reported, by
plugin - Unit: days
- Bounds: from 1 to 36500; past it, refused
Changes: v16, clarified: the default window of a version declaring no kinds of raw record; each declared kind's window says it otherwise.
record_kinds¶
repeated message RawRecordKind · since v16 · stable
Names each kind of raw record the version keeps (W4.1).
- Means: each kind's name, label, default window and whether it can be archived; its window and what is done past it are the plugin admin's settings, which the SDK declares from it
- Does not mean: the windows themselves, which are settings and change without a new version; or object storage against a database schema, the storage's own kinds (decisions/028)
- Empty: empty keeps the behaviour before v16: records kept for retention_days, then archived or kept, never deleted
- Filled: as-reported, by
plugin - Bounds: at most 16 items; past it, refused
RawRecordKind¶
meridian.v1.RawRecordKind, a message.
name¶
text · since v16 · stable
Names the kind in the plugin's code and settings.
- Means: lowercase letters, digits and underscores, beginning with a letter, once per declaration; its settings are
_window_days and _past_window, which no other setting may take - Does not mean: what a person reads, which label is
- Empty: never empty
- Filled: as-reported, by
plugin - Bounds: 1 to 40 characters; past it, refused
label¶
text · since v16 · stable
Names the kind for a person.
- Means: what the plugin's Summary and its settings form call it, such as Reported activity
- Does not mean: the key its settings take, which name is
- Empty: never empty
- Filled: as-reported, by
plugin - Bounds: 1 to 40 characters; past it, refused
window_days¶
integer · since v16 · stable
Gives the kind's default window.
- Means: days from when a record was received that it stays in the plugin's storage, until the plugin's admin sets another
- Does not mean: how long the record is kept: past the window it is archived, kept or deleted as the admin chose, never inside a hold
- Empty: never 0
- Filled: as-reported, by
plugin - Unit: days
- Bounds: from 1 to 36500; past it, refused
archivable¶
boolean · since v16 · stable
Says whether a unit of the kind can be moved to an archive.
- Means: true for records kept as received; false for state read and updated in place, such as a FIX session's
- Does not mean: that the deployment has an archive, which a deployment admin allows per instance
- Empty: false: the kind is never archived, and is kept past its window unless an admin chose deleted
- Filled: as-reported, by
plugin
InterfaceDeclaration¶
meridian.v1.InterfaceDeclaration, a message.
loopback_port¶
integer · since v2 · stable
Says where the plugin serves its interface.
- Means: the loopback port the sidecar forwards verified requests to; nothing else reaches it
- Does not mean: a port anybody outside the sidecar may reach
- Empty: never 0 on a declared interface
- Filled: as-reported, by
plugin - Unit: a TCP port number
title¶
text · since v2 · stable
Names the interface in the dashboard's navigation.
- Means: the words a person reads
- Does not mean: an identifier
- Empty: empty for the plugin's name
- Filled: as-reported, by
plugin
pages¶
repeated message PageDeclaration · since v5 · stable
Lists the plugin's pages, in the order shown (W4.1, W4.8).
- Means: each page's path, title and levels: the area shows under each button the pages whose levels include its level (W6.9)
- Does not mean: an access decision: the plugin refuses a page by the same declaration
- Empty: none at write or read: the plugin's area frames its / under Open and View
- Filled: as-reported, by
plugin
PageDeclaration¶
meridian.v1.PageDeclaration, a message.
path¶
text · since v2 · stable
Says where the page is served.
- Means: a path on the plugin's own host, beginning with /
- Does not mean: a URL on the dashboard's host
- Empty: never empty
- Filled: as-reported, by
plugin
title¶
text · since v2 · stable
Names the page's tab.
- Means: the words a person reads on the tab
- Does not mean: an identifier
- Empty: never empty
- Filled: as-reported, by
plugin
levels¶
repeated enum AccessLevel · since v5 · stable
Says which levels the page serves.
- Means: one or several: its tab shows under those buttons, and one path serving write and read adapts by the session's level
- Does not mean: a role
- Empty: never empty: a page naming no level, or one outside the three, is refused at registration, naming the page
- Filled: as-reported, by
plugin
| Value | Means |
|---|---|
ACCESS_LEVEL_UNSPECIFIED |
holds nothing; a page naming it is refused at registration |
ACCESS_LEVEL_READ |
what the plugin reads and may show the person, cut to the accounts they may read; the home's View |
ACCESS_LEVEL_WRITE |
what the plugin publishes and may do acting for the person on the accounts they may write, and everything read allows; the home's Open |
ACCESS_LEVEL_ADMIN |
configures the plugin: its settings, its pages at admin and its account links; reaches no account's data; the home's Manage |
roles¶
repeated text · since v15 · stable
Says which of the plugin's roles the page serves.
- Means: roles from the deployment's fixed list that the plugin was launched with; the page's tab shows under a button when, for one of these roles, the person's level within it is one of the page's levels, and a page serving several adapts per role
- Does not mean: what the sidecar admits, which the generated grants and the person's grant on the role holding each act decide; a page naming a role the plugin was not launched with is refused at registration
- Empty: empty on a plugin holding one role, where it serves that role, and on a plugin holding none; refused empty from a plugin built at v15 or later holding several, and read as every role from one built earlier
- Filled: as-reported, by
plugin - Bounds: at most 13 items; past it, refused
SettingDeclaration¶
meridian.v1.SettingDeclaration, a message.
name¶
text · since v2 · stable
Names the setting for the plugin's code.
- Means: the key its value is delivered under
- Does not mean: what a person reads, which label is
- Empty: never empty
- Filled: as-reported, by
plugin
type¶
enum SettingType · since v2 · stable
Says what kind of value the setting holds.
- Means: how the dashboard's form takes it and the SDK parses it
- Does not mean: how it is stored: every value travels as text
- Empty: unspecified is text
- Filled: as-reported, by
plugin
| Value | Means |
|---|---|
SETTING_TYPE_UNSPECIFIED |
not said; taken as text |
SETTING_TYPE_STRING |
text |
SETTING_TYPE_INTEGER |
a whole number |
SETTING_TYPE_BOOLEAN |
true or false |
SETTING_TYPE_CHOICE |
one of the declared choices, held as its value |
SETTING_TYPE_TABLE |
rows of the declared columns, held as JSON text: a list of rows, each keyed by column name, with each row's changed_by and changed_at |
Changes: v14, widened: a table: rows of typed columns, entered in the dashboard's Settings form as an editable table.
required¶
boolean · since v2 · stable
Says the plugin cannot proceed without the setting.
- Means: a plugin missing a required setting stays registered and reports itself not healthy, with that reason, until it arrives (W4.7)
- Does not mean: a field a write must carry
- Empty: false for a setting the plugin can do without
- Filled: as-reported, by
plugin
secret¶
boolean · since v2 · stable
Marks a setting written and never read back.
- Means: set or replaced through the dashboard, never read back, displayed, logged, reported or bundled
- Does not mean: encrypted in the plugin's process, which receives the value
- Empty: false for a setting that may be shown
- Filled: as-reported, by
plugin
description¶
text · since v2 · stable
Explains the setting to a person.
- Means: words shown beside the field
- Does not mean: anything parsed
- Empty: empty for none
- Filled: as-reported, by
plugin
label¶
text · since v2 · stable
Names the setting in the dashboard's form.
- Means: the words a person reads
- Does not mean: the key its value is delivered under
- Empty: empty for the name
- Filled: as-reported, by
plugin
default_value¶
text · since v2 · stable
Says what the plugin uses while no value is set.
- Means: written as the form would take it, shown greyed in the empty field
- Does not mean: a stored value; never declared for a secret
- Empty: empty for no default
- Filled: as-reported, by
plugin
unit¶
text · since v2 · stable
Says the unit a number is in.
- Means: words shown beside the field, as seconds or hours
- Does not mean: a conversion any component applies
- Empty: empty for a value without a unit
- Filled: as-reported, by
plugin
choices¶
repeated message SettingChoice · since v2 · stable
Lists a choice setting's options, in the order shown.
- Means: each option's value, label and description; a value not among them is refused
- Does not mean: values of any other type
- Empty: empty unless the type is a choice
- Filled: as-reported, by
plugin
applies_when¶
message SettingCondition · since v2 · stable
Makes the setting apply only under another's values.
- Means: shown, and required where it is required, only while the other setting holds one of the values named
- Does not mean: a validation of the other setting
- Empty: unset: the setting always applies
- Filled: as-reported, by
plugin
developer¶
boolean · since v2 · stable
Marks a setting for whoever develops the plugin.
- Means: shown only on a development deployment, never on one installed otherwise
- Does not mean: a secret
- Empty: false for a setting every deployment shows
- Filled: as-reported, by
plugin
columns¶
repeated message SettingColumn · since v14 · preview
Declares a table setting's columns, in the order shown.
- Means: each column's name, label, type, whether a row must fill it, and its choices; every cell is checked against its column
- Does not mean: the rows, which an admin of the plugin enters
- Empty: empty unless the type is a table
- Filled: as-reported, by
plugin
most_rows¶
integer · since v14 · preview
Bounds how many rows a table setting holds.
- Means: the most rows the form takes and the conductor stores
- Does not mean: how many rows a page shows at once
- Empty: 0 for no more than 500, the most any table holds
- Filled: as-reported, by
plugin - Unit: rows
- Bounds: from 0 to 500; past it, refused
roles¶
repeated text · since v15 · stable
Says which of the plugin's roles the setting serves.
- Means: roles from the deployment's fixed list that the plugin was launched with; shown to an admin of any of them, and set only by a person holding admin on every one
- Does not mean: who may read the value: a secret is never shown back to anybody, and a plugin reads every setting it declared whatever its roles
- Empty: empty on a plugin holding one role, where it serves that role, and on a plugin holding none; refused empty from a plugin built at v15 or later holding several
- Filled: as-reported, by
plugin - Bounds: at most 13 items; past it, refused
per_person¶
boolean · since v20 · preview
Says the setting is each person's own (W6.31).
- Means: each person with write on a role it serves sets their own value on the plugin's pages; the dashboard keeps it under them and hands it back in their claims (own_settings), never on the Settings form or by WatchSettings
- Does not mean: a secret, which is never per person; or anything another person can read
- Empty: false: an admin's setting, the same for everyone
- Filled: derived, by
plugin
SettingChoice¶
meridian.v1.SettingChoice, a message.
value¶
text · since v2 · stable
Says what the setting holds when the option is chosen.
- Means: the value delivered
- Does not mean: what the form shows
- Empty: never empty
- Filled: as-reported, by
plugin
label¶
text · since v2 · stable
Names the option in the form.
- Means: the words a person reads
- Does not mean: the value delivered
- Empty: empty for the value
- Filled: as-reported, by
plugin
description¶
text · since v2 · stable
Explains the option.
- Means: words shown beside it
- Does not mean: anything parsed
- Empty: empty for none
- Filled: as-reported, by
plugin
SettingColumn¶
meridian.v1.SettingColumn, a message.
name¶
text · since v14 · preview
Names a column for the plugin's code.
- Means: the key each row's cell is held under; never changed_by or changed_at, which the conductor stamps
- Does not mean: what a person reads, which label is
- Empty: never empty
- Filled: as-reported, by
plugin
label¶
text · since v14 · preview
Names the column for a person.
- Means: the column's heading in the form's table
- Does not mean: anything parsed
- Empty: empty shows the name
- Filled: as-reported, by
plugin
type¶
enum SettingColumnType · since v14 · preview
Says what kind of value a column's cells hold.
- Means: how the form takes a cell and the conductor checks it
- Does not mean: how it travels: every cell is text in the row's JSON
- Empty: unspecified is text
- Filled: as-reported, by
plugin
| Value | Means |
|---|---|
SETTING_COLUMN_TYPE_UNSPECIFIED |
not said; taken as text |
SETTING_COLUMN_TYPE_TEXT |
text |
SETTING_COLUMN_TYPE_INTEGER |
a whole number |
SETTING_COLUMN_TYPE_DECIMAL |
an exact decimal, written as text, at most 18 places |
SETTING_COLUMN_TYPE_DATE |
a date, YYYY-MM-DD |
SETTING_COLUMN_TYPE_CHOICE |
one of the column's choices, held as its value |
SETTING_COLUMN_TYPE_EXTERNAL_ACCOUNT |
an external account this plugin reported, by its identifier |
SETTING_COLUMN_TYPE_INSTRUMENT |
a deployment instrument record's ID, picked by search and checked to exist; never a symbol |
required¶
boolean · since v14 · preview
Says whether every row fills the column.
- Means: true: a row with the cell empty is refused, naming the cell
- Does not mean: whether the table needs any row, which the setting's own required says
- Empty: false: a row may leave the cell empty
- Filled: as-reported, by
plugin
description¶
text · since v14 · preview
Explains the column.
- Means: words shown beside its heading
- Does not mean: anything parsed
- Empty: empty for none
- Filled: as-reported, by
plugin
choices¶
repeated message SettingChoice · since v14 · preview
Lists a choice column's options, in the order shown.
- Means: each option's value, label and description; a cell not among them is refused
- Does not mean: values of any other column type
- Empty: empty unless the column is a choice
- Filled: as-reported, by
plugin
SettingCondition¶
meridian.v1.SettingCondition, a message.
setting¶
text · since v2 · stable
Names the setting a condition depends on.
- Means: another setting the same plugin declares, which comes before this one
- Does not mean: a setting of another plugin
- Empty: never empty on a condition
- Filled: as-reported, by
plugin
one_of¶
repeated text · since v2 · stable
Lists the values under which the setting applies.
- Means: values of the setting named
- Does not mean: values of this setting
- Empty: never empty on a condition
- Filled: as-reported, by
plugin
RegisterReply¶
meridian.v1.RegisterReply, a message.
admitted¶
boolean · since v2 · stable
Says whether the sidecar admitted the plugin.
- Means: true when its version is within the sidecar's range and its grants are loaded
- Does not mean: that it is healthy
- Empty: false is refused, refusal_reason saying why
- Filled: decided, by
sidecar
deployment_id¶
text · since v2 · stable
Names the deployment the plugin runs in.
- Means: the deployment's identifier, scoping everything the plugin does after
- Does not mean: a tenant of the central plane
- Empty: empty when not admitted
- Filled: decided, by
sidecar
instance_id¶
identifier instance · since v2 · stable
Tells the plugin who it was launched as.
- Means: the instance the sidecar serves, so the plugin can log what it is and stop at startup when that is not what it expected
- Does not mean: anything the plugin declared
- Empty: empty when not admitted
- Filled: decided, by
sidecar
roles¶
repeated text · since v2 · stable
Tells the plugin the roles it was launched as.
- Means: one or more of the fixed roles; its grants are the union of theirs, generated from the contract's rows naming them (decisions/020)
- Does not mean: roles the plugin asked for: it asks for none
- Empty: empty for a plugin admitted with no topics
- Filled: decided, by
sidecar
publish_grants¶
repeated text · since v2 · stable
Lists the topic patterns the plugin may publish on.
- Means: its roles' grants, returned so it can fail at startup rather than at its first refused operation
- Does not mean: a guarantee that a command is admitted: access by account is checked per command
- Empty: empty for none
- Filled: decided, by
sidecar
subscribe_grants¶
repeated text · since v2 · stable
Lists the topic patterns the plugin may hear.
- Means: its roles' grants
- Does not mean: the rows delivered, which its read scope also cuts
- Empty: empty for none
- Filled: decided, by
sidecar
refusal_reason¶
text · since v2 · stable
Says why the plugin was not admitted.
- Means: what is missing, in words an operator can act on: a grant, a version, or access control not yet loaded
- Does not mean: a code a plugin branches on
- Empty: empty when admitted
- Filled: decided, by
sidecar
HeartbeatRequest¶
meridian.v1.HeartbeatRequest, a message.
healthy¶
boolean · since v2 · stable
Says whether the plugin considers itself healthy.
- Means: the plugin's own report, half the picture: a plugin that stops sending heartbeats at all is what the sidecar notices
- Does not mean: a check the sidecar ran
- Empty: false is not healthy, detail saying why
- Filled: as-reported, by
plugin
detail¶
text · since v2 · stable
Says why the plugin is not healthy.
- Means: words for a person; diagnostic, nothing branches on it
- Does not mean: a code
- Empty: empty when healthy
- Filled: as-reported, by
plugin
figures¶
repeated message PluginFigure · since v6 · stable
Reports the plugin's figures as they stand, in the order to draw them.
- Means: at most 8; a heartbeat breaking any figure's bound is refused whole, INVALID_ARGUMENT, never cut
- Does not mean: an account's data: a figure is about the plugin's own work
- Empty: empty for none; each heartbeat replaces the last, and none clears them
- Filled: as-reported, by
plugin - Bounds: at most 8 items; past it, refused
not_carried_seen¶
repeated message NotCarriedSeen · since v11 · stable
Reports how often the plugin saw each name it does not carry (W4.5, Q15).
- Means: per name its declaration lists, the count since the plugin started; the sidecar reports it, and it stays in the deployment
- Does not mean: a value, an account or an identifier: a name and a count only
- Empty: empty for none seen, or from a plugin before v11; each heartbeat replaces the last
- Filled: as-reported, by
plugin - Bounds: at most 500 items; past it, refused
stored¶
repeated message StoredSpan · since v16 · stable
Reports what the plugin's storage holds of each kind of raw record, and the bytes each uses of its archive (W4.5).
- Means: one per declared kind at most, as the storage stands; the Summary draws it beside the archive's spans, and each kind's bytes against the archive's bound
- Does not mean: the archive's records and span, which the moves the conductor recorded say
- Empty: empty from a plugin declaring no kinds, or from a plugin before v16; each heartbeat replaces the last
- Filled: as-reported, by
plugin - Bounds: at most 16 items; past it, refused
NotCarriedSeen¶
meridian.v1.NotCarriedSeen, a message.
scheme¶
text · since v11 · stable
Says whose vocabulary the name is in.
- Means: as the declaration names it
- Does not mean: an identifier scheme
- Empty: never empty
- Filled: as-reported, by
plugin - Bounds: 1 to 64 characters; past it, refused
name¶
text · since v11 · stable
Names what was seen.
- Means: a name the declaration lists as not carried
- Does not mean: a value
- Empty: never empty
- Filled: as-reported, by
plugin - Bounds: 1 to 128 characters; past it, refused
count¶
integer · since v11 · stable
Says how often a name not carried was seen.
- Means: a count the plugin kept since it started
- Does not mean: a count across restarts, or across deployments: it never leaves the deployment
- Empty: 0 for a name not seen yet
- Filled: derived, by
plugin - Unit: times seen since the plugin started
StoredSpan¶
meridian.v1.StoredSpan, a message.
record_kind¶
text · since v16 · stable
Names the kind the span is of.
- Means: a kind the version's declaration names
- Does not mean: a unit or a record's key
- Empty: never empty
- Filled: as-reported, by
plugin - Bounds: 1 to 40 characters; past it, refused
record_count¶
integer · since v16 · stable
Says how many records of the kind are held.
- Means: a count the plugin keeps of its own records
- Does not mean: a count of units, or of bytes
- Empty: 0 when the storage holds none of the kind, and then no span
- Filled: derived, by
plugin - Unit: records
first_received_ns¶
moment · since v16 · stable
Says from when the held records reach.
- Means: when the earliest of them was received
- Does not mean: the date of what the record is about
- Empty: 0 when none is held
- Filled: derived, by
plugin - Unit: nanoseconds since the epoch
last_received_ns¶
moment · since v16 · stable
Says to when the held records reach.
- Means: when the latest of them was received
- Does not mean: when the plugin last read its vendor
- Empty: 0 when none is held
- Filled: derived, by
plugin - Unit: nanoseconds since the epoch
bytes¶
integer · since v16 · stable
Says how much of the instance's archive the kind uses, which its bound is counted against.
- Means: the bytes of the kind's units the plugin's index holds archived, a restored unit still counted, as the SDK sums them; the archive's bound is MERIDIAN_ARCHIVE_MOST_BYTES
- Does not mean: the bytes the plugin's storage uses, which the volume the deployment sizes bounds
- Empty: 0 where nothing of the kind is archived, or the instance has no archive; none in the conductor's spans of the archive (ReadMoves), which the plugin's report says
- Filled: derived, by
plugin - Unit: bytes
PluginFigure¶
meridian.v1.PluginFigure, a message.
label¶
text · since v6 · stable
Names a figure on the plugin's Summary tile, under Manage.
- Means: what the plugin counts or shows, in words a person reads; given once per list
- Does not mean: an identifier: a label is unique within one report, and two reports may use one label for different things
- Empty: never; a figure with no label is refused
- Filled: as-reported, by
plugin - Bounds: 1 to 40 characters; past it, refused
count¶
integer · since v6 · stable
Carries a figure that is a count.
- Means: a whole number, as a tile shows it
- Does not mean: an amount of money or a quantity of an instrument
- Empty: 0 is a count of none, when the figure is a count
- Filled: as-reported, by
plugin - Unit: whatever the label counts
decimal¶
Decimal · since v6 · stable
Carries a figure that is a number with places.
- Means: exact, refused outside its range, never rounded (decisions/023)
- Does not mean: an amount of money or a quantity of an instrument
- Empty: unset unless the figure is a decimal
- Filled: as-reported, by
plugin - Unit: whatever the label measures
- Bounds: 0 to 18 decimal places; at most 38 significant digits; past it, refused
text¶
text · since v6 · stable
Carries a figure that is words.
- Means: a short value a person reads on the tile
- Does not mean: an explanation, which why is
- Empty: unset unless the figure is a text
- Filled: as-reported, by
plugin - Bounds: at most 40 characters; past it, refused
at_ns¶
moment · since v6 · stable
Carries a figure that is a moment, as Last read.
- Means: when the thing the label names happened
- Does not mean: when the figure was true, which as_of_ns is
- Empty: unset unless the figure is a moment
- Filled: as-reported, by
plugin - Unit: nanoseconds since the epoch
state¶
enum FigureState · since v6 · stable
Says how the tile is drawn.
- Means: the plugin's judgement of its own figure
- Does not mean: the plugin's health, which the heartbeat says
- Empty: unspecified is no state; a number the enum does not define is refused
- Filled: as-reported, by
plugin
| Value | Means |
|---|---|
FIGURE_STATE_UNSPECIFIED |
no state, drawn plain |
FIGURE_STATE_OK |
as it should be |
FIGURE_STATE_WARN |
worth a look |
FIGURE_STATE_ERROR |
wrong, and needs a person |
why¶
text · since v6 · stable
Explains the figure in a note beside the tile.
- Means: words a person reads
- Does not mean: a code
- Empty: empty for none
- Filled: as-reported, by
plugin - Bounds: at most 200 characters; past it, refused
as_of_ns¶
moment · since v6 · stable
Says when the figure's value was true.
- Means: a moment earlier than the heartbeat, where the plugin knows one
- Does not mean: when the heartbeat was sent
- Empty: 0 when the value is true at the heartbeat's moment
- Filled: as-reported, by
plugin - Unit: nanoseconds since the epoch
LeaveRequest¶
meridian.v1.LeaveRequest, a message.
reason¶
text · since v2 · stable
Says why the plugin is stopping.
- Means: words that tell a planned stop from a failure, which the timeout path cannot
- Does not mean: a code
- Empty: empty for no reason given
- Filled: as-reported, by
plugin
SettingsDelivery¶
meridian.v1.SettingsDelivery, a message.
values¶
repeated message SettingValue · since v2 · stable
Delivers the plugin's settings as they stand.
- Means: every value an admin of the plugin set, sent at once and again on every change
- Does not mean: defaults, which the declaration holds
- Empty: empty when nothing is set
- Filled: decided, by
conductor
missing_required¶
repeated text · since v2 · stable
Names the required settings with no value yet.
- Means: each by its name
- Does not mean: settings that are optional
- Empty: empty when the plugin may proceed
- Filled: decided, by
sidecar
SettingValue¶
meridian.v1.SettingValue, a message.
name¶
text · since v2 · stable
Names the setting a value is for.
- Means: a name the plugin declared
- Does not mean: its label
- Empty: never empty
- Filled: decided, by
conductor
value¶
text · since v2 · stable
Carries a setting's value.
- Means: as text, whatever the declared type, parsed by the SDK against the declaration; a table's is JSON, a list of rows keyed by column name, each with changed_by and changed_at, which the conductor stamps on a row added or changed; a secret's value is delivered here and nowhere else
- Does not mean: a typed value on the wire
- Empty: never empty: a setting with no value is not delivered
- Filled: entered, by
dashboard
Changes: v14, clarified: a table setting's value is JSON rows, each stamped with who changed it and when.
CallerAssertion¶
meridian.v1.CallerAssertion, a message.
claims¶
bytes · since v2 · stable
Carries who the person is, as the dashboard signed it.
- Means: a serialised CallerClaims, so the signature covers exactly the bytes the sidecar checks
- Does not mean: anything a plugin may alter: it hands the same bytes back to act for the person
- Empty: never empty
- Filled: decided, by
dashboard
signature¶
bytes · since v2 · stable
Proves the dashboard signed the claims.
- Means: Ed25519 over the claims, by the dashboard's own key, which the sidecar verifies
- Does not mean: a signature a plugin checks: it verifies nothing
- Empty: never empty
- Filled: decided, by
dashboard
key_id¶
text · since v2 · stable
Names the key that signed, so it can be rotated.
- Means: the dashboard's key identifier
- Does not mean: the deployment's key, which only the conductor holds
- Empty: never empty
- Filled: decided, by
dashboard
CallerClaims¶
meridian.v1.CallerClaims, a message.
subject¶
text · since v2 · stable
Names the person, or from v21 the service account.
- Means: deployment-local: the directory's issuer and subject; for a service account its SA- ID, subject_kind saying so
- Does not mean: an email address
- Empty: never empty
- Filled: decided, by
dashboard
Changes: v21, clarified: a service account's SA- ID where subject_kind says SUBJECT_KIND_SERVICE_ACCOUNT.
display_name¶
text · since v2 · stable
Names the person for others to read.
- Means: the name the directory gave at sign-in
- Does not mean: an identifier
- Empty: empty where the directory gives none
- Filled: decided, by
dashboard
audience_instance_id¶
identifier instance · since v2 · stable
Names the plugin instance the assertion is for.
- Means: a sidecar refuses an assertion addressed to another instance
- Does not mean: the plugin that is asked to act
- Empty: never empty
- Filled: decided, by
dashboard
level¶
enum AccessLevel · since v5 · stable
Says the level the session was opened at.
- Means: one the person holds on this plugin (W6.9); the plugin serves a page only at a level it declares, and the sidecar admits what is sent for the person by it (W4.9)
- Does not mean: a role, or the person's level on one: from v15 each role's level within the session is in roles
- Empty: unspecified holds nothing
- Filled: decided, by
dashboard
| Value | Means |
|---|---|
ACCESS_LEVEL_UNSPECIFIED |
none: an assertion naming no level holds nothing |
ACCESS_LEVEL_READ |
opened by View: pages at read, and nothing sent acting for the person |
ACCESS_LEVEL_WRITE |
opened by Open: pages at write, and commands on accounts in the write set acting for the person |
ACCESS_LEVEL_ADMIN |
opened by Manage: pages at admin, the deployment's accounts read as identities and the link, and nothing else |
Changes: v15, clarified: a role's level within the session is in roles; this stays the button's.
read_account_ids¶
repeated identifier account · since v2 · stable
Lists the accounts the session may read.
- Means: every account the person may read through their read and write grants, cut to the level, the union over the session's roles; every write account is listed here too
- Does not mean: the plugin's read scope, which may be wider; or one role's accounts, which roles names by position here
- Empty: empty under admin, and for a person who may read no account through the plugin
- Filled: decided, by
dashboard
Changes: v15, clarified: the union over the session's roles, each role's entry in roles naming its accounts by position here.
write_account_ids¶
repeated identifier account · since v2 · stable
Lists the accounts the session may write.
- Means: the accounts the person's write grants name, under write, the union over the session's roles
- Does not mean: accounts the plugin may write as itself; or the accounts one role may write, which roles names
- Empty: empty under read and admin
- Filled: decided, by
dashboard
Changes: v15, clarified: the union over the session's roles; a command is admitted on an account in the write accounts of the role holding it.
issued_at_ns¶
moment · since v2 · stable
Records when the assertion was minted.
- Means: the dashboard's clock
- Does not mean: when the person signed in
- Empty: never 0
- Filled: decided, by
dashboard - Unit: nanoseconds since the epoch
expires_at_ns¶
moment · since v2 · stable
Says when the assertion stops being honoured.
- Means: at most 60 seconds after issue
- Does not mean: when the session ends
- Empty: never 0
- Filled: decided, by
dashboard - Unit: nanoseconds since the epoch
assertion_id¶
text · since v2 · stable
Makes the assertion unique, so it cannot be replayed.
- Means: minted per request; a sidecar refuses one it has seen within the last 60 seconds
- Does not mean: a session identifier
- Empty: never empty
- Filled: decided, by
dashboard
deployment_admin¶
boolean · since v2 · stable
Says the person is a deployment admin.
- Means: linking an external account at admin, the person may name a new account rather than an existing one (W6.4)
- Does not mean: access to a page or an account: a deployment admin holds on a plugin what their grants give
- Empty: false for anybody who is not a deployment admin
- Filled: decided, by
dashboard
delegation_id¶
text · since v9 · stable
Names the delegation the person acted through.
- Means: deployment-local and opaque: the person acted through a client, the dashboard resolving it to its client (W6.18, decisions/029); the sidecar stamps it on what it sends for them
- Does not mean: the actor, who stays the person
- Empty: empty for a person at the dashboard in a browser
- Filled: decided, by
dashboard
client_name¶
text · since v10 · stable
Names the client the person acted through.
- Means: the client's registered name, its own choice, for a plugin to show and record as it chooses
- Does not mean: a person or a plugin instance
- Empty: empty where delegation_id is
- Filled: decided, by
dashboard
tool_name¶
text · since v12 · stable
Names the tool a call through the deployment's MCP surface is for.
- Means: the plugin's own name for the tool, set only by the dashboard's /mcp: the sidecar admits the request only at that tool's method and path, and the SDK serves it without a browser's form token
- Does not mean: a sign of a delegation, which delegation_id is; a terminal's page fetch names a delegation and no tool
- Empty: empty for every request but a call through the deployment's MCP surface
- Filled: decided, by
dashboard
roles¶
repeated message RoleAccess · since v15 · stable
Carries the person's level and accounts on each of the plugin's roles within the session's button.
- Means: one entry per role of the plugin the person holds something on within the button: under Manage each role they administer at admin with no account, under Open each role they hold account access on at that level, under View each at read; the sidecar admits a command sent for them by their write on a role whose generated grants include it
- Does not mean: the roles the plugin holds, which its registration reply says; or a role the person holds nothing on, for which nothing is carried
- Empty: empty for a plugin holding no role, and from a dashboard before v15: a sidecar then reads the level and account sets as the one role's on a plugin holding one, and refuses a command sent for the person on a plugin holding several
- Filled: decided, by
dashboard - Bounds: at most 13 items; past it, refused
prepared_call_id¶
text · since v20 · preview
Names the prepared change a request was made or a page opened from (W6.27).
- Means: the
PC-ID, set only by the dashboard; the plugin reads the change with ReadPreparedCall and the sidecar stamps the ID on what the request sends - Does not mean: that the person may make it: they may, or the dashboard would not have opened it, but the sidecar still admits each command by their grants
- Empty: empty for every request not made from, or opened from, a prepared change
- Filled: decided, by
dashboard
own_settings¶
repeated message SettingValue · since v20 · preview
Hands the plugin the person's own values of its per-person settings (W6.31).
- Means: the values the dashboard keeps under the person for this instance, as a setting's are delivered, a table's as JSON rows
- Does not mean: anybody else's values, or a default: a setting the person never set is absent
- Empty: empty where the person set none, the plugin declares none, and under Manage
- Filled: decided, by
dashboard - Bounds: at most 64 items; past it, refused
second_pair_of_eyes¶
repeated text · since v20 · preview
Tells a plugin which of its acts need a second person, so its pages show it (W6.29).
- Means: the plugin's acts, by their tool names, whose second pair of eyes is on for this person now: a page draws Prepare in place of Save, and says a second person makes a change this person prepared
- Does not mean: the enforcement, which is the dashboard's whatever a page draws; or who may make the change
- Empty: empty where no act of the plugin has its second pair of eyes on for the person
- Filled: decided, by
dashboard - Bounds: at most 200 items; past it, refused
subject_kind¶
enum SubjectKind · since v21 · preview
Says whether the subject is a person or a service account.
- Means: set only by the dashboard; the sidecar stamps it on what is sent with the claims (acting_for_kind), so every store records which kind of user acted
- Does not mean: an agent: an agent acting for a person names a delegation, and the person stays the actor
- Empty: unspecified: the subject is a person
- Filled: decided, by
dashboard
| Value | Means |
|---|---|
SUBJECT_KIND_UNSPECIFIED |
a person, as every assertion before v21 |
SUBJECT_KIND_SERVICE_ACCOUNT |
a service account, for a call the dashboard admitted through the act's door (W4.15): never a page, a delegation or a client |
owner_subject¶
text · since v21 · preview
Names the person answerable for the service account the claims are for.
- Means: the deployment-local subject of the account's owner when the call was admitted (W6.32), stamped on the envelope and kept on the actor
- Does not mean: who acted, which is the service account; or anyone the plugin may act for
- Empty: empty for a person
- Filled: decided, by
dashboard
algorithm_id¶
text · since v22 · preview
Carries the algorithm identifier a service account's call named.
- Means: kept in the assertion the dashboard made for the call, so every command it makes carries it and none can name another; the sidecar checks it against the version's algorithms and stamps it on the envelope
- Does not mean: anything the plugin may change after the call is admitted
- Empty: empty for a person, and where the call named none
- Filled: decided, by
dashboard
connectivity_instance_ids¶
repeated identifier instance · since v22 · preview
Carries the connectivity plugin instances the user may route through for the calling ems.
- Means: computed by the dashboard at admission from the conductor's links (AccessRecords.connectivity_links) and the person's user groups, logins or the service account's identity; the calling plugin's sidecar checks a CreatePlacement's connectivity instance against it and stamps MessageMeta.connectivity_allowed (W4.9, W11.8)
- Does not mean: the user's groups, which it never discloses to the plugin
- Empty: empty in an assertion for any plugin but an ems, and for a user who may route through no connectivity plugin
- Filled: decided, by
dashboard
RoleAccess¶
meridian.v1.RoleAccess, a message.
role¶
text · since v15 · stable
Names the role this entry is for.
- Means: a role from the deployment's fixed list that the plugin was launched with
- Does not mean: a part the plugin names for itself: roles are the deployment's list
- Empty: never empty
- Filled: decided, by
dashboard
level¶
enum AccessLevel · since v15 · stable
Says the person's level on this role within the button, or a group's or a person's account access on it in the access table.
- Means: in the claims, the level within the session's button; in the access table, the account access held, read or write
- Does not mean: the session's button, which the claims' level says
- Empty: never unspecified
- Filled: decided, by
dashboard
| Value | Means |
|---|---|
ACCESS_LEVEL_UNSPECIFIED |
holds nothing; never carried |
ACCESS_LEVEL_READ |
reads what the plugin shows for this role, cut to the read accounts named |
ACCESS_LEVEL_WRITE |
also acts for the person in this role, on the write accounts named |
ACCESS_LEVEL_ADMIN |
administers this role's side of the plugin, reaching no account; in the claims under Manage only, never in the access table |
read_positions¶
repeated integer · since v15 · stable
Names the accounts this role reaches to read, without repeating them.
- Means: each a position in the carrying message's read_account_ids: the claims', a user group's or a person's; every write account of the role is among them
- Does not mean: an account identifier, or the plugin's read scope
- Empty: empty under admin, and where the role reaches no account to read
- Filled: decided, by
dashboard - Unit: positions, counted from 0, in the read accounts of the message carrying this entry
- Bounds: at most 10000 items; past it, refused
write_positions¶
repeated integer · since v15 · stable
Names the accounts this role reaches to write, without repeating them.
- Means: each a position in the carrying message's read_account_ids, since every write account is a read account; a command for the person in this role is admitted only on one of these
- Does not mean: a position in write_account_ids, or accounts the plugin may write as itself
- Empty: empty at read and admin, and where the role reaches no account to write
- Filled: decided, by
dashboard - Unit: positions, counted from 0, in the read accounts of the message carrying this entry
- Bounds: at most 10000 items; past it, refused
PluginAccessReply¶
meridian.v1.PluginAccessReply, a message.
user_groups¶
repeated message UserGroupAccess · since v2 · stable
Lists who may use the plugin, group by group.
- Means: each user group with the accounts it may read and write through this plugin
- Does not mean: an access decision: the sidecar checks each command itself
- Empty: empty when no group may use the plugin
- Filled: decided, by
conductor
people¶
repeated message PersonAccess · since v2 · stable
Lists the people who may use the plugin, for shaping an interface.
- Means: people who have signed in to the deployment, with the groups they were in at their last sign-in
- Does not mean: a directory: nobody who has not signed in is here
- Empty: empty before anybody has signed in
- Filled: decided, by
conductor
UserGroupAccess¶
meridian.v1.UserGroupAccess, a message.
user_group_id¶
text · since v2 · stable
Identifies the user group.
- Means: the deployment's identifier for it
- Does not mean: a directory's group
- Empty: never empty
- Filled: decided, by
conductor
name¶
text · since v2 · stable
Names the user group for a person.
- Means: the name a deployment admin gave it
- Does not mean: an identifier
- Empty: never empty
- Filled: decided, by
conductor
read_account_ids¶
repeated identifier account · since v2 · stable
Lists the accounts the group may read through the plugin.
- Means: every write account is listed here too
- Does not mean: accounts it may read through another plugin
- Empty: empty when the group may read nothing through the plugin
- Filled: decided, by
conductor
write_account_ids¶
repeated identifier account · since v2 · stable
Lists the accounts the group may write through the plugin.
- Means: accounts its write grants name
- Does not mean: accounts the plugin may write as itself
- Empty: empty when the group may write nothing through the plugin
- Filled: decided, by
conductor
roles¶
repeated message RoleAccess · since v15 · stable
Breaks the group's access to the plugin down by role.
- Means: one entry per role of this plugin the group holds account access on, at that level, its accounts as positions in the group's read accounts; only this plugin's roles
- Does not mean: admin, which the table does not list; or an access decision: the sidecar checks each command itself
- Empty: empty for a plugin holding no role, and before v15
- Filled: decided, by
conductor - Bounds: at most 13 items; past it, refused
PersonAccess¶
meridian.v1.PersonAccess, a message.
subject¶
text · since v2 · stable
Names the person.
- Means: the deployment-local subject of their sign-in
- Does not mean: an email address
- Empty: never empty
- Filled: decided, by
conductor
display_name¶
text · since v2 · stable
Names the person for others to read.
- Means: the name at their last sign-in
- Does not mean: an identifier
- Empty: empty where the directory gave none
- Filled: decided, by
conductor
user_group_ids¶
repeated text · since v2 · stable
Lists the groups the person was in.
- Means: at their last sign-in
- Does not mean: groups they are in now, which the next sign-in records
- Empty: empty for a person in no group
- Filled: decided, by
conductor
last_signed_in_at_ns¶
moment · since v2 · stable
Records when the person last signed in.
- Means: the deployment's clock then
- Does not mean: when they last used the plugin
- Empty: never 0
- Filled: decided, by
conductor - Unit: nanoseconds since the epoch
read_account_ids¶
repeated identifier account · since v2 · stable
Lists the accounts the person may read through the plugin.
- Means: through their groups' grants; every write account is listed here too
- Does not mean: what a session of theirs reaches, which its level cuts
- Empty: empty when the person may read nothing through the plugin
- Filled: decided, by
conductor
write_account_ids¶
repeated identifier account · since v2 · stable
Lists the accounts the person may write through the plugin.
- Means: through their groups' write grants
- Does not mean: what a session of theirs reaches
- Empty: empty when the person may write nothing through the plugin
- Filled: decided, by
conductor
roles¶
repeated message RoleAccess · since v15 · stable
Breaks the person's access to the plugin down by role.
- Means: one entry per role of this plugin the person holds account access on through their groups' grants, at that level, its accounts as positions in the person's read accounts; only this plugin's roles
- Does not mean: admin, which the table does not list; or what a session of theirs reaches, which its button cuts
- Empty: empty for a plugin holding no role, and before v15
- Filled: decided, by
conductor - Bounds: at most 13 items; past it, refused
AccountScopeDelivery¶
meridian.v1.AccountScopeDelivery, a message.
read_account_ids¶
repeated identifier account · since v2 · stable
Delivers everything anybody may read through the plugin.
- Means: derived from permissions and links, never declared; sent at once and on every change; the plugin reads it as itself and serves each person from it; from v22, for a connectivity plugin, the accounts its ems mapped venue account codes to on it (W11.22), empty while it is linked to none
- Does not mean: what one person may read
- Empty: empty is nothing: the plugin reads no account
- Filled: decided, by
conductor
Changes: v22, clarified: a connectivity plugin's scope is the accounts its ems mapped on it, not permissions or links of its own (W4.11, W11.21, W11.22).
write_account_ids¶
repeated identifier account · since v2 · stable
Delivers everything anybody may write through the plugin.
- Means: derived from permissions and links; a linked account is in both scopes while the link stands; from v22, for a connectivity plugin, the accounts its ems mapped on it
- Does not mean: what one person may write
- Empty: empty is nothing: the plugin writes no account
- Filled: decided, by
conductor
Changes: v22, clarified: a connectivity plugin's scope is the accounts its ems mapped on it (W4.11, W11.22).
links¶
repeated message LinkedExternalAccount · since v2 · stable
Gives the plugin its links again on every start and change.
- Means: each external account it links and the account it is linked to; one it reported that none names is unlinked, and its rows are refused
- Does not mean: another plugin's links
- Empty: empty when nothing of the plugin's is linked
- Filled: decided, by
conductor
connectivity_link¶
message ConnectivityLink · since v22 · preview
Gives a connectivity plugin its link to its one ems (W11.21).
- Means: its availability, its ems and its users; its read and write scope is the accounts that ems mapped on it, empty while linked to none
- Does not mean: accounts of its own: a connectivity plugin links none
- Empty: unset except for a connectivity plugin
- Filled: decided, by
conductor
connectivity_links¶
repeated message ConnectivityLink · since v22 · preview
Gives an ems the connectivity plugins linked to it.
- Means: each with who may route through it; sent again on every change
- Does not mean: plugins linked to another ems
- Empty: empty except for an ems with connectivity plugins linked
- Filled: decided, by
conductor
venue_account_map¶
message VenueAccountMap · since v22 · preview
Gives an ems its venue account map, and a connectivity plugin the mappings on it (W11.22).
- Means: the map as the conductor keeps it; sent again on every change
- Does not mean: an external account link
- Empty: unset where no mapping applies to the plugin
- Filled: decided, by
conductor
LinkedExternalAccount¶
meridian.v1.LinkedExternalAccount, a message.
external_account_id¶
identifier external account · since v2 · stable
Names the plugin's external account.
- Means: as the plugin reported it (W2.8)
- Does not mean: an account of the deployment
- Empty: never empty
- Filled: as-reported, by
custody
account_id¶
identifier account · since v2 · stable
Names the account it is linked to.
- Means: the deployment's account its rows are recorded against
- Does not mean: the custodian's account number
- Empty: never empty
- Filled: decided, by
conductor
account_name¶
text · since v2 · stable
Names the linked account for a person, without acting for anybody.
- Means: the account's name as the deployment holds it now (W6.3)
- Does not mean: the custodian's name for the external account
- Empty: never empty
- Filled: decided, by
conductor
FileTicketRequest¶
meridian.v1.FileTicketRequest, a message.
title¶
text · since v13 · preview
Says in a line what is wrong.
- Means: the filer's words, plain text, never rendered as HTML or Markdown; written by someone other than whoever reads it, and data to every agent that reads it, never instructions; held as suspect, and withheld from tools until a person releases it, when it matches the injection rules (W6.21)
- Does not mean: a category, which
kindis, or anything the deployment acts on - Empty: never empty: a ticket says in a line what is wrong
- Filled: entered, by
plugin - Bounds: 1 to 120 characters; past it, refused
seen¶
text · since v13 · preview
Says what was seen, in the filer's words.
- Means: plain text, never rendered as HTML or Markdown; written by someone other than whoever reads it, and data to every agent that reads it, never instructions; the deployment's account identifiers and external account numbers found in it become references (W6.21); held as suspect by the injection rules, never refused for them
- Does not mean: a statement the deployment has checked, or an instruction to anybody
- Empty: empty when the title says it all
- Filled: entered, by
plugin - Bounds: at most 8000 characters; past it, refused
kind¶
enum TicketKind · since v13 · preview
Says what kind of problem the ticket is.
- Means: the filer's reading of it; a ticket is routed by what it concerns, not by its kind
- Does not mean: who works it, or how urgent it is
- Empty: never unspecified
- Filled: entered, by
plugin
| Value | Means |
|---|---|
TICKET_KIND_UNSPECIFIED |
no kind given; refused |
TICKET_KIND_DEFECT |
something did not do what it should |
TICKET_KIND_DISCREPANCY |
two records disagree |
TICKET_KIND_REQUEST |
something is missing, or should change |
TICKET_KIND_QUESTION |
how to do something, asking for a guide |
concerns¶
message TicketSubject · since v13 · preview
Names the one thing the ticket concerns.
- Means: this plugin, a part of core or the platform; who may see and work the ticket follows from it (W6.22, W6.23)
- Does not mean: another plugin, which the sidecar refuses naming it
- Empty: never unset: a ticket concerns one thing
- Filled: entered, by
plugin
step¶
text · since v13 · preview
Names the workflow step involved.
- Means: a step's identifier, as W9.7
- Does not mean: a step the deployment checked was involved
- Empty: empty when no workflow step is involved, or the filer cannot say
- Filled: entered, by
plugin
operation¶
text · since v13 · preview
Names the operation involved.
- Means: a matrix row, a tool or a route pattern
- Does not mean: a call the deployment has looked up
- Empty: empty when no operation is involved, or the filer cannot say
- Filled: entered, by
plugin
reason¶
text · since v13 · preview
Names the refusal reason involved.
- Means: a refusal reason as the refusal named it
- Does not mean: the refusal's words, which may change
- Empty: empty when nothing was refused
- Filled: entered, by
plugin
paths¶
repeated text · since v13 · preview
Names the fields involved.
- Means: field paths by the dictionary's grammar, as a refusal names them
- Does not mean: values; a path names where, never what
- Empty: empty when no field is involved
- Filled: entered, by
plugin
references¶
repeated message TicketReference · since v13 · preview
Names the records the ticket is about, by value.
- Means: each record by its identifier; a ticket naming accounts is seen only by those who may read every one of them through what it concerns
- Does not mean: records the plugin may change, or a channel to anybody
- Empty: empty when the ticket is about no particular record
- Filled: entered, by
plugin - Bounds: at most 50 items; past it, refused
idempotency_key¶
text · since v13 · preview
Names the problem in the plugin's own terms, so a plugin restarted mid-run files nothing twice.
- Means: a filing whose key matches an open ticket from the same instance brings that ticket up to date and is answered unchanged; one matching a resolved or closed ticket files a new one
- Does not mean: a ticket's identifier, or a key any other instance's filings are matched against
- Empty: empty on a person's own filing at a page; never on a plugin's
- Filled: as-reported, by
plugin - Required on:
SidecarFileTicketfrom v13
TicketSubject¶
meridian.v1.TicketSubject, a message.
kind¶
text · since v13 · preview
Says what kind of thing the ticket concerns.
- Means: a plugin's ticket is seen and worked by that plugin's people; core's and the platform's by the deployment admin while they name no account
- Does not mean: who filed it
- Empty: never empty
- Filled: entered, by
plugin
| Value | Means |
|---|---|
plugin |
the plugin filing it, or the plugin whose page a person filed from |
dashboard |
core's dashboard |
bor |
core's book of record |
street |
core's street store |
instrument |
core's instrument store |
conductor |
core's conductor |
chart |
the chart that installs a deployment |
cli |
the meridian command |
sdk |
a plugin SDK |
platform |
Open Meridian's platform, or a record it serves |
instance¶
identifier instance · since v13 · preview
Names the plugin instance the ticket concerns.
- Means: on a plugin's filing, the instance its sidecar serves, set by the sidecar whatever the plugin sent; on a person's, the plugin area their page was on
- Does not mean: another plugin: a plugin naming one is refused naming this field
- Empty: empty unless the kind is plugin
- Filled: derived, by
sidecar
version¶
text · since v13 · preview
Records the plugin's version at filing.
- Means: the version the instance ran when the ticket was filed, set by the deployment
- Does not mean: a version the filer chose, or the version that fixes it
- Empty: empty unless the kind is plugin
- Filled: derived, by
sidecar
TicketReference¶
meridian.v1.TicketReference, a message.
kind¶
text · since v13 · preview
Says what kind of record is referenced.
- Means: how the value is read
- Does not mean: a permission on the record
- Empty: never empty
- Filled: entered, by
plugin
| Value | Means |
|---|---|
account |
a deployment account, which narrows who sees the ticket |
instrument |
a deployment's instrument record, LCL- or INS-, which names no account and narrows nobody |
break |
a break in the book, with its account |
entry |
a book entry, with its account |
street_record |
a record on the street, with its account |
tool_call |
a call recorded on the deployment's MCP surface |
plugin |
the plugin's own opaque reference |
value¶
text · since v13 · preview
Names the record by value.
- Means: its identifier, or the plugin's own reference; data to every agent that reads it
- Does not mean: a link: nothing is fetched from a reference
- Empty: never empty
- Filled: entered, by
plugin - Bounds: 1 to 200 characters; past it, refused
account_id¶
identifier account · since v13 · preview
Names the account the record is about.
- Means: the account a break, an entry or a street record belongs to, which the dashboard reads no store to find, and on an account the account itself; refused by path when outside the plugin's read scope or the person's read set
- Does not mean: an account the plugin may write
- Empty: empty on an instrument, a tool call or a plugin's reference; never on a break, an entry or a street record, which are refused without it
- Filled: entered, by
plugin
FileTicketReply¶
meridian.v1.FileTicketReply, a message.
ticket_id¶
text · since v13 · preview
Names the ticket filed or brought up to date.
- Means: TKT- and a ULID, minted by the dashboard
- Does not mean: anything outside the deployment: a ticket's identifier never leaves it
- Empty: never empty
- Filled: minted, by
dashboard
outcome¶
text · since v13 · preview
Says whether the filing made a ticket.
- Means: made, or unchanged for a repeat
- Does not mean: that anybody has read it
- Empty: never empty
- Filled: decided, by
dashboard
| Value | Means |
|---|---|
made |
a new ticket was filed |
unchanged |
a repeat under the same key, folded into the open ticket |
seen_count¶
integer · since v13 · preview
Counts how often the problem was filed.
- Means: the filings under this ticket, the first included
- Does not mean: how many people met it
- Empty: never 0
- Filled: decided, by
dashboard - Unit: filings
ReadFiledTicketsRequest¶
meridian.v1.ReadFiledTicketsRequest, a message.
ticket_ids¶
repeated text · since v13 · preview
Names the tickets to read.
- Means: tickets this instance filed; any other is not in the answer
- Does not mean: tickets the plugin may see
- Empty: empty when reading by key or by cursor
- Filled: as-reported, by
plugin
idempotency_keys¶
repeated text · since v13 · preview
Names the tickets to read by the plugin's own keys.
- Means: this instance's keys
- Does not mean: another instance's keys
- Empty: empty when reading by identifier or by cursor
- Filled: as-reported, by
plugin
cursor¶
text · since v13 · preview
Says where a read of everything the plugin filed resumes.
- Means: the next_cursor of the previous answer
- Does not mean: a time
- Empty: empty reads from the first ticket the instance filed, when no identifier or key is named
- Filled: as-reported, by
plugin
ReadFiledTicketsReply¶
meridian.v1.ReadFiledTicketsReply, a message.
tickets¶
repeated message FiledTicket · since v13 · preview
Answers what became of the tickets asked for.
- Means: only tickets this instance filed
- Does not mean: every ticket about the plugin
- Empty: empty when the instance filed none of those asked for
- Filled: decided, by
dashboard
next_cursor¶
text · since v13 · preview
Says where the next read starts.
- Means: an opaque position the dashboard reads back
- Does not mean: a ticket's identifier
- Empty: empty when there is nothing further
- Filled: decided, by
dashboard
FiledTicket¶
meridian.v1.FiledTicket, a message.
ticket_id¶
text · since v13 · preview
Names the ticket.
- Means: TKT- and a ULID
- Does not mean: anything outside the deployment
- Empty: never empty
- Filled: minted, by
dashboard
idempotency_key¶
text · since v13 · preview
Names the ticket by the plugin's own key.
- Means: the key it was filed under
- Does not mean: a key matched against another instance's
- Empty: never empty for a plugin's filing
- Filled: as-reported, by
plugin
state¶
enum TicketState · since v13 · preview
Says where the ticket stands.
- Means: set only by a person's act at the ticket's page (W6.23); nothing resolves or closes a ticket by itself
- Does not mean: who owns it, or when it is due, which a plugin is not answered
- Empty: never unspecified
- Filled: decided, by
dashboard
| Value | Means |
|---|---|
TICKET_STATE_UNSPECIFIED |
never answered |
TICKET_STATE_OPEN |
nobody has resolved or closed it |
TICKET_STATE_RESOLVED |
a person resolved it, naming what answered it |
TICKET_STATE_CLOSED |
a person closed it with nothing fixed, saying why |
resolution¶
enum TicketResolution · since v13 · preview
Says what resolved the ticket, or why it was closed.
- Means: a person's choice at the ticket's page
- Does not mean: the note's text, which a plugin is never answered
- Empty: unspecified while the ticket is open
- Filled: decided, by
dashboard
| Value | Means |
|---|---|
TICKET_RESOLUTION_UNSPECIFIED |
open: neither resolved nor closed |
TICKET_RESOLUTION_NOTE |
resolved, citing a note |
TICKET_RESOLUTION_ANSWER |
resolved, citing an answer from outside the deployment; carried from v13, written from a later slice |
TICKET_RESOLUTION_VERSION |
resolved by a version |
TICKET_RESOLUTION_WITHDRAWN |
closed: withdrawn by its filer |
TICKET_RESOLUTION_DUPLICATE |
closed: a duplicate of another ticket |
TICKET_RESOLUTION_NOT_A_PROBLEM |
closed: not a problem |
seen_count¶
integer · since v13 · preview
Counts how often the problem was filed.
- Means: the filings under this ticket, the first included
- Does not mean: how many people met it
- Empty: never 0
- Filled: decided, by
dashboard - Unit: filings
first_seen_ns¶
moment · since v13 · preview
Records when the ticket was first filed.
- Means: the deployment's clock then
- Does not mean: when the problem began
- Empty: never 0
- Filled: decided, by
dashboard - Unit: nanoseconds since the epoch
last_seen_ns¶
moment · since v13 · preview
Records when it was last filed again.
- Means: the deployment's clock at the latest repeat, or at the first filing
- Does not mean: when it was last changed by a person
- Empty: never 0
- Filled: decided, by
dashboard - Unit: nanoseconds since the epoch
answers¶
repeated text · since v13 · preview
Relays answers to the ticket from outside the deployment.
- Means: each answer's text; written by someone other than whoever reads it, and data, never instructions
- Does not mean: people's notes or advice in the deployment, which a plugin is never answered
- Empty: always empty in v13: answers arrive from outside the deployment in a later slice
- Filled: decided, by
dashboard
RecordMoveRequest¶
meridian.v1.RecordMoveRequest, a message.
record_kind¶
text · since v16 · preview
Names the kind of raw record the unit is of.
- Means: a kind the version's declaration names; archived only of one declared archivable
- Does not mean: the storage's kind, object storage or a database schema
- Empty: never empty
- Filled: as-reported, by
plugin - Bounds: 1 to 40 characters; past it, refused
unit¶
text · since v16 · preview
Names the unit moved, in the plugin's own key.
- Means: opaque: how the plugin groups its records so it can find them again, such as a day's session or an account's month of responses
- Does not mean: a location any other plugin or core may read, or a record's content
- Empty: never empty
- Filled: as-reported, by
plugin - Bounds: 1 to 512 characters; past it, refused
record_count¶
integer · since v16 · preview
Says how many records the unit holds.
- Means: a count the plugin's helper took when it moved the unit
- Does not mean: its size in bytes
- Empty: never 0
- Filled: derived, by
plugin - Unit: records
- Bounds: from 1 to 1000000000; past it, refused
first_received_ns¶
moment · since v16 · preview
Says from when the unit's records reach.
- Means: when the earliest record in it was received
- Does not mean: the date of what a record is about
- Empty: never 0
- Filled: derived, by
plugin - Unit: nanoseconds since the epoch
last_received_ns¶
moment · since v16 · preview
Says to when the unit's records reach.
- Means: when the latest record in it was received; a deletion is refused while it is inside the hold over the instance
- Does not mean: when the unit was moved, which the conductor records
- Empty: never 0, and never before first_received_ns
- Filled: derived, by
plugin - Unit: nanoseconds since the epoch
outcome¶
enum MoveOutcome · since v16 · preview
Says what became of the unit.
- Means: one of the four moves, each its own record
- Does not mean: a tier the deployment chose: the plugin moves its own records
- Empty: never unspecified
- Filled: as-reported, by
plugin
| Value | Means |
|---|---|
MOVE_OUTCOME_UNSPECIFIED |
not said; refused |
MOVE_OUTCOME_ARCHIVED |
moved from storage to the archive, and checked to have landed, before it is removed from storage |
MOVE_OUTCOME_RESTORED |
copied back from the archive to the restore area in storage, for a person with write who asked |
MOVE_OUTCOME_RETURNED |
removed from the restore area after the restore period; the archive still holds it |
MOVE_OUTCOME_DELETED |
deleted, from storage past its window or from the archive by an admin; reported before it is done, and refused inside a hold |
rule¶
text · since v16 · preview
Names the window that moved the unit.
- Means: the window setting and its value, such as activity_window_days 2555
- Does not mean: a person: the person a move is done for is read from their assertion, never written by the plugin
- Empty: empty for a move done acting for a person, who is the assertion's
- Filled: derived, by
plugin - Bounds: at most 200 characters; past it, refused
Refusal¶
meridian.v1.Refusal, a message.
reason¶
enum RefusalReason · since v2 · stable
Tells refusals a plugin must tell apart, where one status covers them.
- Means: sent in the status's trailing metadata meridian-refusal-bin, encoded; a plugin acts on the reason, never on the words, which may change
- Does not mean: the status, which says what the caller should do
- Empty: unspecified where the status says all there is
- Filled: decided, by
sidecar
| Value | Means |
|---|---|
REFUSAL_REASON_UNSPECIFIED |
no reason beyond the status |
REFUSAL_REASON_EXTERNAL_ACCOUNT_NOT_LINKED |
beside FAILED_PRECONDITION: the operation named an external account nobody has linked (W2, W6.4); nothing recorded, and once a link is made the next statement records it |
REFUSAL_REASON_ACTOR_REQUIRED |
a command other than a finding sent with no user — a person, or from v21 a service account: an opening balance, handling, a resolution or an attribute is a user's act |
REFUSAL_REASON_REASON_REQUIRED |
a justified act sent without its reason or explanation |
REFUSAL_REASON_OPENING_BALANCE_RECORDED |
a second opening balance while one stands (W9.1) |
REFUSAL_REASON_NO_OPENING_BALANCE |
a break, figures or an entry for an account with no opening balance |
REFUSAL_REASON_BEFORE_OPENING_BALANCE |
an entry moving a position effective on or before the opening balance's date |
REFUSAL_REASON_LOTS_UNBALANCED |
an opening position whose lots do not sum to its quantity, or an entry leaving a position's open lots so |
REFUSAL_REASON_BREAK_STATE |
a command the break's state does not allow |
REFUSAL_REASON_LATER_ENTRIES_STAND |
a reversal of an opening balance while a later entry moving the account's positions stands |
REFUSAL_REASON_IDEMPOTENCY_CONFLICT |
an idempotency key the account's book holds for a different command: nothing applied |
REFUSAL_REASON_INCOMPLETE |
beside ABORTED: an entry missing a field the book requires (W9.1, W9.7); nothing applied, and each missing field named in fields by its path |
REFUSAL_REASON_IDENTIFIER_HELD |
the instrument store refusing one record of a completion at the dashboard: an identifier another record carries; per record, never a plugin's |
REFUSAL_REASON_RECORD_CHANGED |
a record changed since the version a completion or a merge named: read it again; per record, never a plugin's |
REFUSAL_REASON_REFERENCE_UNAVAILABLE |
beside UNAVAILABLE, to be tried again: the book could not check a command because the instrument store did not answer in time; nothing recorded |
REFUSAL_REASON_WITHIN_HOLD |
beside FAILED_PRECONDITION: a deletion of a unit whose last record was received inside the hold over the instance; nothing recorded, and the unit is kept |
REFUSAL_REASON_ACCOUNT_NOT_LINKABLE |
beside FAILED_PRECONDITION: a link naming an existing account the deployment admin has not granted the plugin's instance; nothing linked; from v22 also an ems's venue account mapping naming such an account (W11.22) |
REFUSAL_REASON_ALLOCATION_UNBALANCED |
beside ABORTED: a release whose allocation instruction does not sum to the ordered quantity (W11.6; principle 1); nothing changed |
REFUSAL_REASON_APPROVAL_REQUIRED |
beside ABORTED: a release of an order whose approval required stands unapproved (W11.6) |
REFUSAL_REASON_CHECK_BLOCKS |
beside ABORTED: a release while a check's block stands without an override (W11.6) |
REFUSAL_REASON_CLAIMED |
beside ABORTED: a placement, a claim or a change by other than the claimant of a claimed order (W11.3, W11.7 to W11.9), and from v23 an accept onto it (W11.23); a cancel by anyone who may write the account is admitted past a claim, and so is a connectivity plugin's report of a cancel it sent under a stop |
REFUSAL_REASON_ORDER_STATE |
beside ABORTED: a command the order's or the placement's state does not allow, by the transition table (decisions/035): a placement or a child order under an order not released, a quantity change that is not the proposer's or an alignment, an acknowledgement of does not tie out, a use of an expired locate |
REFUSAL_REASON_IDENTIFIER_IN_USE |
beside ABORTED: a new record reusing an identifier already in use (W11.1) |
REFUSAL_REASON_CONNECTIVITY_NOT_ALLOWED |
beside ABORTED: a placement naming a connectivity plugin not linked to the placing ems, or not made available to the user the command acts for (W11.8), refused and recorded, an entry heard by the ems and compliance; or an ems's venue account mapping at a connectivity plugin not linked to it (W11.22) |
REFUSAL_REASON_CONNECTIVITY_LINKED |
beside ABORTED: a link of a connectivity plugin already linked to another ems (W11.21): each is linked to exactly one |
REFUSAL_REASON_QUANTITY_EXCEEDS_ORDER |
beside ABORTED: an accept of venue-originated fills whose quantity, added to what the order has filled already, is past its ordered quantity (W11.23): the trader accepts to a new order instead, or portfolio upsizes first; nothing changed |
REFUSAL_REASON_EXECUTION_STATE |
beside ABORTED: an accept or a DK of an execution not unmatched — answered already — or of one a bust or a correction supersedes, by the transition table's e3 to e6 (W11.23, W11.24); nothing changed |
REFUSAL_REASON_EXECUTIONS_DIFFER |
beside ABORTED: an accept of fills of more than one account, instrument, side, connectivity plugin or trade date, or of a fill whose side is the order's opposite (W11.23); nothing changed |
REFUSAL_REASON_BOOKING_UNBALANCED |
beside ABORTED: a booking or a correction whose allocations do not tie out exactly to the executions booked, in quantity, gross and each fee kind (W11.27, W11.29); nothing changed |
REFUSAL_REASON_ACCOUNT_NOT_INSTRUCTED |
beside ABORTED: a booking or a correction allocating to an account neither the order's allocation instruction names nor marked an error account (W11.27, W11.29); nothing changed |
REFUSAL_REASON_LOCAL_RECORD_NOT_ALLOWED |
beside ABORTED: a proposal, or an accept of venue-originated fills, naming an instrument whose record is provisional, a local record, while the deployment's setting allows_local_record_orders is off (W11's invariant, W11.1, W11.23); nothing changed, a fill staying unmatched. FIX's OrdRejReason (103) 1, Unknown symbol |
Changes: v21, clarified: REFUSAL_REASON_ACTOR_REQUIRED: a service account answers for a justified act as a person does (W9.1, W9.7); v22, clarified: REFUSAL_REASON_ACCOUNT_NOT_LINKABLE: also an ems's venue account mapping naming an account not granted its instance (W11.22); v23, clarified: REFUSAL_REASON_CLAIMED: also an accept of venue-originated fills onto an order another claims (W11.23; approved 2026-10-13).
fields¶
repeated text · since v9 · stable
Names each field a command left out, so a plugin shows a person what to complete without reading words.
- Means: each by its path in the command: field names joined by dots, an item by [n], and x for a field x_id stepping into the record it names (positions[0].lots[1].terms.cost, positions[0].instrument.asset_class)
- Does not mean: an entry's name, which the SDK resolves a path to
- Empty: empty on every refusal but REFUSAL_REASON_INCOMPLETE and a per-record refusal of the instrument store
- Filled: decided, by
bor
Published¶
meridian.plugin.v1.Published, a message.
message_id¶
identifier message · since v2 · stable
Answers an event a plugin published.
- Means: the message's identifier on the bus
- Does not mean: a receipt that anyone heard it
- Empty: never empty
- Filled: minted, by
sidecar
ReceiveRequest¶
meridian.plugin.v1.ReceiveRequest, a message.
rows¶
repeated text · since v7 · stable
Names the rows a plugin asks to hear.
- Means: rows by their matrix names; a row no role it holds hears is refused, PERMISSION_DENIED, naming it
- Does not mean: topics
- Empty: empty for every row the plugin's roles hear
- Filled: as-reported, by
plugin
subjects¶
repeated text · since v18 · preview
Names the subjects a plugin wants of the conflated rows.
- Means: entity IDs; the sidecar delivers only the conflated rows, and from v19 the unconflated ones, about them
- Does not mean: rows to hear, which rows names
- Empty: none: no conflated row is delivered
- Filled: as-reported, by
plugin - Bounds: at most 500 items; past it, refused
Changes: v19, clarified: narrows the unconflated rows too: the lake's trades (W4.3).
Delivery¶
meridian.plugin.v1.Delivery, a message.
meta¶
message DeliveryMeta · since v7 · stable
Says what is known of a delivery beside its message.
- Means: the envelope's identifiers and time, the row, and the record's journal and cause
- Does not mean: the message itself
- Empty: never unset
- Filled: decided, by
sidecar
lost¶
message Lost · since v7 · stable
Marks the place where deliveries were dropped.
- Means: the sidecar's queue for the plugin was full, or the bus's drop count for its subscription rose
- Does not mean: a delivery of a row
- Empty: unset unless the sidecar dropped deliveries at this point
- Filled: decided, by
sidecar
statement_recorded¶
message StatementRecordedEvent · since v7 · stable
Delivers a completed statement (W2.5).
- Means: the street's record of it, within the plugin's read scope
- Does not mean: a statement still open
- Empty: unset unless the delivery is a completed statement
- Filled: decided, by
street
custodial_position_updated¶
message CustodialPositionUpdatedEvent · since v7 · stable
Delivers a custodial position that changed (W2.6).
- Means: the position's whole new state, within the plugin's read scope
- Does not mean: the book's position
- Empty: unset unless the delivery is a custodial position that changed
- Filled: decided, by
street
position_changed¶
message PositionChangedEvent · since v8 · stable
Delivers a book position that changed (W9.8).
- Means: the position's whole new state, within the plugin's read scope
- Does not mean: the custodian's position
- Empty: unset unless the delivery is a book position that changed
- Filled: decided, by
bor
break_changed¶
message BreakChangedEvent · since v8 · stable
Delivers a break that changed (W9.8).
- Means: the break's whole new state, within the plugin's read scope
- Does not mean: a difference the book has not recorded
- Empty: unset unless the delivery is a break that changed
- Filled: decided, by
bor
account_figures_recorded¶
message AccountFiguresRecordedEvent · since v8 · stable
Delivers an account's figures the book recorded (W9.8).
- Means: the figures for a business date, within the plugin's read scope
- Does not mean: figures the book derived
- Empty: unset unless the delivery is figures the book recorded
- Filled: decided, by
bor
account_attribute_changed¶
message AccountAttributeChangedEvent · since v8 · stable
Delivers an account's attributes that changed (W9.8).
- Means: the attributes' whole new state, within the plugin's read scope
- Does not mean: the account's record at the conductor
- Empty: unset unless the delivery is an account's attributes that changed
- Filled: decided, by
bor
activity_recorded¶
message ActivityRecordedEvent · since v14 · preview
Delivers an activity the street recorded (W2.12).
- Means: the activity's whole record, within the plugin's read scope
- Does not mean: a position or a lot: the street derives none from it
- Empty: unset unless the delivery is an activity the street recorded
- Filled: decided, by
street
sync_status_recorded¶
message SyncStatusRecordedEvent · since v14 · preview
Delivers a sync status the street recorded (W2.13).
- Means: the sync status's whole record, within the plugin's read scope: never one for an unlinked external account
- Does not mean: a holding or a statement
- Empty: unset unless the delivery is a sync status the street recorded
- Filled: decided, by
street
activity_re_resolved¶
message ActivityReResolvedEvent · since v15 · preview
Delivers a re-resolution of an activity the street recorded (W2.16).
- Means: the re-resolution's whole record, within the plugin's read scope
- Does not mean: a change to the activity as first recorded, which stays as it was
- Empty: unset unless the delivery is a re-resolution the street recorded
- Filled: decided, by
street
prices_recorded¶
message PricesRecordedEvent · since v18 · preview
Delivers a price the lake recorded (W10.5).
- Means: a price the lake recorded, latest value first per key under load
- Does not mean: a record with a journal: a lake row carries its sequence in its own envelope
- Empty: unset unless the delivery is a price the lake recorded
- Filled: decided, by
lake
bars_recorded¶
message BarsRecordedEvent · since v18 · preview
Delivers a bar the lake recorded (W10.5).
- Means: a bar the lake recorded, latest value first per key under load
- Does not mean: a record with a journal: a lake row carries its sequence in its own envelope
- Empty: unset unless the delivery is a bar the lake recorded
- Filled: decided, by
lake
trades_recorded¶
message TradesRecordedEvent · since v19 · preview
Delivers a trade the lake recorded (W10.5).
- Means: a trade the lake recorded, every one, never dropped for a later one; after a loss marker the plugin reads the trades after the watermark it last saw
- Does not mean: a record with a journal: a lake row carries its sequence in its own envelope
- Empty: unset unless the delivery is a trade the lake recorded
- Filled: decided, by
lake
quotes_recorded¶
message QuotesRecordedEvent · since v19 · preview
Delivers a quote the lake recorded (W10.5).
- Means: a quote the lake recorded, latest value first per key under load
- Does not mean: a record with a journal: a lake row carries its sequence in its own envelope
- Empty: unset unless the delivery is a quote the lake recorded
- Filled: decided, by
lake
outcomes_recorded¶
message OutcomesRecordedEvent · since v23 · preview
Delivers an event contract's outcome the lake recorded (W10.5; contract v23).
- Means: an outcome the lake recorded, every version, never dropped for a later one; after a loss marker the plugin reads the outcomes after the watermark it last saw
- Does not mean: a record with a journal: a lake row carries its sequence in its own envelope
- Empty: unset unless the delivery is an outcome the lake recorded
- Filled: decided, by
lake
observations_wanted¶
message ObservationsWantedEvent · since v18 · preview
Delivers a want of the plugin's dataset (W10.7).
- Means: a want of the plugin's dataset, latest value first per key under load
- Does not mean: a record with a journal: a lake row carries its sequence in its own envelope
- Empty: unset unless the delivery is a want of the plugin's dataset
- Filled: decided, by
lake
want_withdrawn¶
message WantWithdrawnEvent · since v18 · preview
Delivers a want withdrawn (W10.7).
- Means: a want withdrawn, latest value first per key under load
- Does not mean: a record with a journal: a lake row carries its sequence in its own envelope
- Empty: unset unless the delivery is a want withdrawn
- Filled: decided, by
lake
order_updated¶
message OrderUpdatedEvent · since v22 · preview
Delivers an order that changed (W11.13).
- Means: the order's whole new state with what changed, within the plugin's read scope
- Does not mean: a placement or an execution, each its own arm
- Empty: unset unless the delivery is an order that changed
- Filled: decided, by
bor
placement_updated¶
message PlacementUpdatedEvent · since v22 · preview
Delivers a placement that changed (W11.13).
- Means: the placement's whole new state, within the plugin's read scope; to a connectivity plugin only at the instance the placement names (matrix/directed.tsv)
- Does not mean: an order's state
- Empty: unset unless the delivery is a placement that changed
- Filled: decided, by
bor
execution_recorded¶
message ExecutionRecordedEvent · since v22 · preview
Delivers an execution the book recorded (W11.13).
- Means: the execution's whole record, a superseding one included, within the plugin's read scope
- Does not mean: a booking, which BookingUpdated delivers from v24
- Empty: unset unless the delivery is an execution the book recorded
- Filled: decided, by
bor
Changes: v24, clarified: a booking is delivered by BookingUpdated from v24 (W11.30).
unplaced_fact_recorded¶
message UnplacedFactRecordedEvent · since v22 · preview
Delivers an unplaced fact the book kept or placed (W11.13).
- Means: the fact's whole record, within the plugin's read scope; one naming no account reaches no plugin
- Does not mean: a refusal: a venue's fact is never refused for its state
- Empty: unset unless the delivery is an unplaced fact the book kept or placed
- Filled: decided, by
bor
trading_instruction_changed¶
message TradingInstructionChangedEvent · since v22 · preview
Delivers a trading instruction that changed (W11.16).
- Means: the instruction's whole new state, a group's with the persons it covers, to every subscriber: an instruction names a target, not an account's data
- Does not mean: a book decision: an instruction feeds none
- Empty: unset unless the delivery is a trading instruction that changed
- Filled: decided, by
bor
locate_updated¶
message LocateUpdatedEvent · since v22 · preview
Delivers a locate that changed (W11.18).
- Means: the locate's whole new state with its uses, within the plugin's read scope
- Does not mean: a prime's lists
- Empty: unset unless the delivery is a locate that changed
- Filled: decided, by
bor
report_venue_catalogue¶
message VenueCatalogueEvent · since v22 · preview
Delivers a venue catalogue a connectivity plugin published (W11.20).
- Means: the catalogue for one venue account code, latest first per connectivity plugin and code under load
- Does not mean: a record with a journal: the catalogue is read again by ReadVenueCatalogue
- Empty: unset unless the delivery is a venue catalogue a connectivity plugin published
- Filled: decided, by
connectivity
booking_updated¶
message BookingUpdatedEvent · since v24 · preview
Delivers a booking that changed (W11.30).
- Means: the booking's whole new state with its entry, within the plugin's read scope
- Does not mean: an execution or an order, each its own arm
- Empty: unset unless the delivery is a booking that changed
- Filled: decided, by
bor
alert_changed¶
message AlertChangedEvent · since v24 · preview
Delivers an alert that changed (W11.35).
- Means: the alert's whole new state, within the plugin's read scope
- Does not mean: a booking, its own arm
- Empty: unset unless the delivery is an alert raised, acknowledged or cleared
- Filled: decided, by
bor
replace_merged_instrument¶
message InstrumentReplacedEvent · since v24 · preview
Delivers an instrument replaced (W3.8), sequenced reference data (approved 2026-10-14).
- Means: the replaced record, the record it became, why and its sequence, heard by every role whatever its scope and caught up by ListReplacements after the last sequence seen (W3.22)
- Does not mean: a record of the book, caught up by watermark
- Empty: unset unless the delivery is an instrument replaced
- Filled: decided, by
instrument
DeliveryMeta¶
meridian.plugin.v1.DeliveryMeta, a message.
message_id¶
identifier message · since v7 · stable
Identifies the delivered message.
- Means: its identifier on the bus, from its envelope
- Does not mean: the record's identifier
- Empty: empty on a Lost
- Filled: decided, by
sidecar
correlation_id¶
identifier message · since v7 · stable
Ties the delivery to the work it was part of.
- Means: from its envelope
- Does not mean: the message's own identifier
- Empty: empty where the message carried none
- Filled: decided, by
sidecar
causation_id¶
identifier message · since v7 · stable
Names the message that caused the delivered one.
- Means: from its envelope
- Does not mean: the delivered message
- Empty: empty where the message carried none
- Filled: decided, by
sidecar
published_at_ns¶
moment · since v7 · stable
Records when the delivered message was published.
- Means: from its envelope
- Does not mean: when the change committed, which the cause says
- Empty: 0 on a Lost
- Filled: decided, by
sidecar - Unit: nanoseconds since the epoch
row¶
text · since v7 · stable
Names the row delivered.
- Means: its matrix name, as ReceiveRequest names it
- Does not mean: a topic
- Empty: empty on a Lost
- Filled: decided, by
sidecar
journal¶
message JournalRef · since v7 · stable
Says where the delivered change sits in its store's record.
- Means: copied from the record's journal
- Does not mean: a position in the stream
- Empty: unset on a Lost
- Filled: decided, by
sidecar
cause¶
message ChangeCause · since v7 · stable
Says who caused the delivered change.
- Means: copied from the record's cause
- Does not mean: who published the event
- Empty: unset on a Lost
- Filled: decided, by
sidecar
own¶
boolean · since v7 · stable
Says the plugin caused the delivered change itself.
- Means: the cause's instance is this plugin's
- Does not mean: that the plugin's person caused it
- Empty: false for a change another instance caused
- Filled: decided, by
sidecar
Lost¶
meridian.plugin.v1.Lost, a message.
dropped¶
integer · since v7 · stable
Says how many deliveries were dropped.
- Means: the count, where the sidecar knows it
- Does not mean: how many changes the plugin must read: it reads its store since its watermark
- Empty: 0 when the sidecar knows only that some were dropped
- Filled: decided, by
sidecar - Unit: deliveries
rows¶
repeated text · since v7 · stable
Names the rows the dropped deliveries were of.
- Means: rows by their matrix names
- Does not mean: topics
- Empty: empty when the sidecar cannot say, which is every row
- Filled: decided, by
sidecar
RecordPricesParams¶
meridian.plugin.v1.RecordPricesParams, a message.
acting_for¶
message CallerAssertion · since v18 · preview
Names the person RecordPrices is sent for.
- Means: the assertion the plugin was handed for them, the same bytes, never altered; a data plugin records as itself
- Does not mean: the plugin's own identity, which the sidecar knows
- Empty: unset, the plugin acts as itself
- Filled: as-reported, by
plugin
RecordBarsParams¶
meridian.plugin.v1.RecordBarsParams, a message.
acting_for¶
message CallerAssertion · since v18 · preview
Names the person RecordBars is sent for.
- Means: the assertion the plugin was handed for them, the same bytes, never altered; a data plugin records as itself
- Does not mean: the plugin's own identity, which the sidecar knows
- Empty: unset, the plugin acts as itself
- Filled: as-reported, by
plugin
RecordTradesParams¶
meridian.plugin.v1.RecordTradesParams, a message.
acting_for¶
message CallerAssertion · since v19 · preview
Names the person RecordTrades is sent for.
- Means: the assertion the plugin was handed for them, the same bytes, never altered; a data plugin records as itself
- Does not mean: the plugin's own identity, which the sidecar knows
- Empty: unset, the plugin acts as itself
- Filled: as-reported, by
plugin
RecordQuotesParams¶
meridian.plugin.v1.RecordQuotesParams, a message.
acting_for¶
message CallerAssertion · since v19 · preview
Names the person RecordQuotes is sent for.
- Means: the assertion the plugin was handed for them, the same bytes, never altered; a data plugin records as itself
- Does not mean: the plugin's own identity, which the sidecar knows
- Empty: unset, the plugin acts as itself
- Filled: as-reported, by
plugin
RecordOutcomesParams¶
meridian.plugin.v1.RecordOutcomesParams, a message.
acting_for¶
message CallerAssertion · since v23 · preview
Names the person RecordOutcomes is sent for.
- Means: the assertion the plugin was handed for them, the same bytes, never altered; a data plugin records as itself
- Does not mean: the plugin's own identity, which the sidecar knows
- Empty: unset, the plugin acts as itself
- Filled: as-reported, by
plugin
DeclineWantParams¶
meridian.plugin.v1.DeclineWantParams, a message.
acting_for¶
message CallerAssertion · since v18 · preview
Names the person DeclineWant is sent for.
- Means: the assertion the plugin was handed for them, the same bytes, never altered; a data plugin records as itself
- Does not mean: the plugin's own identity, which the sidecar knows
- Empty: unset, the plugin acts as itself
- Filled: as-reported, by
plugin
RecordHoldingsStatementParams¶
meridian.plugin.v1.RecordHoldingsStatementParams, a message.
acting_for¶
message CallerAssertion · since v2 · stable
Names the person RecordHoldingsStatement is sent for.
- Means: the assertion the plugin was handed for them, the same bytes, never altered; set, the sidecar admits the command only in a session at write, when the person may write the account it names, and stamps them on it (W4.9)
- Does not mean: the plugin's own identity, which the sidecar knows
- Empty: unset, the plugin acts as itself
- Filled: as-reported, by
plugin
RecordHoldingParams¶
meridian.plugin.v1.RecordHoldingParams, a message.
acting_for¶
message CallerAssertion · since v2 · stable
Names the person RecordHolding is sent for.
- Means: the assertion the plugin was handed for them, the same bytes, never altered; set, the sidecar admits the command only in a session at write, when the person may write the account it names, and stamps them on it (W4.9)
- Does not mean: the plugin's own identity, which the sidecar knows
- Empty: unset, the plugin acts as itself
- Filled: as-reported, by
plugin
RecordActivityParams¶
meridian.plugin.v1.RecordActivityParams, a message.
acting_for¶
message CallerAssertion · since v14 · preview
Names the person RecordActivity is sent for.
- Means: the assertion the plugin was handed for them, the same bytes, never altered; set, the sidecar admits the command only in a session at write, when the person may write the account it names, and stamps them on it (W4.9)
- Does not mean: the plugin's own identity, which the sidecar knows
- Empty: unset, the plugin acts as itself
- Filled: as-reported, by
plugin
ReResolveActivityParams¶
meridian.plugin.v1.ReResolveActivityParams, a message.
acting_for¶
message CallerAssertion · since v15 · preview
Names the person ReResolveActivity is sent for.
- Means: the assertion the plugin was handed for them, the same bytes, never altered; set, the sidecar admits the command only in a session at write, when the person may write the account it names, and stamps them on it (W4.9)
- Does not mean: the plugin's own identity, which the sidecar knows
- Empty: unset, the plugin acts as itself
- Filled: as-reported, by
plugin
LinkExternalAccountParams¶
meridian.plugin.v1.LinkExternalAccountParams, a message.
acting_for¶
message CallerAssertion · since v2 · stable
Names the person LinkExternalAccount is sent for.
- Means: the assertion the plugin was handed for them, the same bytes, never altered; admitted only in a session at admin, opened by Manage (W4.9, W6.4)
- Does not mean: the plugin's own identity, which the sidecar knows
- Empty: never unset: the sidecar refuses a change to the deployment's configuration sent for no one
- Filled: as-reported, by
plugin - Required on:
LinkExternalAccountfrom v2
ReadAccountsForLinkingParams¶
meridian.plugin.v1.ReadAccountsForLinkingParams, a message.
acting_for¶
message CallerAssertion · since v2 · stable
Names the person ReadAccountsForLinking is sent for.
- Means: the assertion the plugin was handed for them, the same bytes, never altered; answered only in a session at admin, opened by Manage, and stamped with the person (W4.9, W6.4)
- Does not mean: the plugin's own identity, which the sidecar knows
- Empty: never unset: the sidecar refuses a read of the deployment's configuration sent for no one
- Filled: as-reported, by
plugin - Required on:
ReadAccountsForLinkingfrom v2
RecordOpeningBalanceParams¶
meridian.plugin.v1.RecordOpeningBalanceParams, a message.
acting_for¶
message CallerAssertion · since v8 · stable
Names the person RecordOpeningBalance is sent for.
- Means: the assertion the plugin was handed for them, the same bytes, never altered; the sidecar admits it only in a session at write, when the person may write the account it names, and stamps them on it (W4.9)
- Does not mean: the plugin's own identity, which the sidecar knows
- Empty: never unset: the act is a user's, a person's or from v21 a service account's, and the book refuses it sent for no one (REFUSAL_REASON_ACTOR_REQUIRED)
- Filled: as-reported, by
plugin - Required on:
RecordOpeningBalancefrom v8
RecordBreakParams¶
meridian.plugin.v1.RecordBreakParams, a message.
acting_for¶
message CallerAssertion · since v8 · stable
Names the person RecordBreak is sent for.
- Means: the assertion the plugin was handed for them, the same bytes, never altered; set, the sidecar admits it only in a session at write, when the person may write the account it names, and stamps them on it (W4.9)
- Does not mean: the plugin's own identity, which the sidecar knows
- Empty: unset, the plugin sends the finding as itself, which a finding may be
- Filled: as-reported, by
plugin
RecordAccountFiguresParams¶
meridian.plugin.v1.RecordAccountFiguresParams, a message.
acting_for¶
message CallerAssertion · since v8 · stable
Names the person RecordAccountFigures is sent for.
- Means: the assertion the plugin was handed for them, the same bytes, never altered; set, the sidecar admits it only in a session at write, when the person may write the account it names, and stamps them on it (W4.9)
- Does not mean: the plugin's own identity, which the sidecar knows
- Empty: unset, the plugin sends the finding as itself, which a finding may be
- Filled: as-reported, by
plugin
RecordEncumbrancesParams¶
meridian.plugin.v1.RecordEncumbrancesParams, a message.
acting_for¶
message CallerAssertion · since v8 · stable
Names the person RecordEncumbrances is sent for.
- Means: the assertion the plugin was handed for them, the same bytes, never altered; set, the sidecar admits it only in a session at write, when the person may write the account it names, and stamps them on it (W4.9)
- Does not mean: the plugin's own identity, which the sidecar knows
- Empty: unset, the plugin sends the finding as itself, which a finding may be
- Filled: as-reported, by
plugin
HandleBreakParams¶
meridian.plugin.v1.HandleBreakParams, a message.
acting_for¶
message CallerAssertion · since v8 · stable
Names the person HandleBreak is sent for.
- Means: the assertion the plugin was handed for them, the same bytes, never altered; the sidecar admits it only in a session at write, when the person may write the account it names, and stamps them on it (W4.9)
- Does not mean: the plugin's own identity, which the sidecar knows
- Empty: never unset: the act is a user's, a person's or from v21 a service account's, and the book refuses it sent for no one (REFUSAL_REASON_ACTOR_REQUIRED)
- Filled: as-reported, by
plugin - Required on:
HandleBreakfrom v8
ResolveBreakParams¶
meridian.plugin.v1.ResolveBreakParams, a message.
acting_for¶
message CallerAssertion · since v8 · stable
Names the person ResolveBreak is sent for.
- Means: the assertion the plugin was handed for them, the same bytes, never altered; the sidecar admits it only in a session at write, when the person may write the account it names, and stamps them on it (W4.9)
- Does not mean: the plugin's own identity, which the sidecar knows
- Empty: never unset: the act is a user's, a person's or from v21 a service account's, and the book refuses it sent for no one (REFUSAL_REASON_ACTOR_REQUIRED)
- Filled: as-reported, by
plugin - Required on:
ResolveBreakfrom v8
CloseBreaksAsClearedParams¶
meridian.plugin.v1.CloseBreaksAsClearedParams, a message.
acting_for¶
message CallerAssertion · since v8 · stable
Names the person CloseBreaksAsCleared is sent for.
- Means: the assertion the plugin was handed for them, the same bytes, never altered; the sidecar admits it only in a session at write, when the person may write the account it names, and stamps them on it (W4.9)
- Does not mean: the plugin's own identity, which the sidecar knows
- Empty: never unset: the act is a user's, a person's or from v21 a service account's, and the book refuses it sent for no one (REFUSAL_REASON_ACTOR_REQUIRED)
- Filled: as-reported, by
plugin - Required on:
CloseBreaksAsClearedfrom v8
RecordOrderParams¶
meridian.plugin.v1.RecordOrderParams, a message.
acting_for¶
message CallerAssertion · since v22 · preview
Names the person RecordOrder is sent for.
- Means: the assertion the plugin was handed for them, the same bytes, never altered; admitted only in a session at write when the person may write the account, and stamped on it (W4.9)
- Does not mean: the plugin's own identity, which the sidecar knows
- Empty: never unset: a recorded order is a user's act, the oms's for a person or its service account, and the book refuses it sent for no one (REFUSAL_REASON_ACTOR_REQUIRED)
- Filled: as-reported, by
plugin - Required on:
RecordOrderfrom v22
ReportPlacementParams¶
meridian.plugin.v1.ReportPlacementParams, a message.
acting_for¶
message CallerAssertion · since v22 · preview
Names the person ReportPlacement is sent for.
- Means: the assertion the plugin was handed for them, the same bytes, never altered; set, a person's entry where the role makes one, admitted only in a session at write when the person may write the account, and stamped on it (W4.9)
- Does not mean: the plugin's own identity, which the sidecar knows
- Empty: unset, the plugin reports a venue's fact as itself, which a fact report may be (W11's invariants)
- Filled: as-reported, by
plugin
ReportExecutionParams¶
meridian.plugin.v1.ReportExecutionParams, a message.
acting_for¶
message CallerAssertion · since v22 · preview
Names the person ReportExecution is sent for.
- Means: the assertion the plugin was handed for them, the same bytes, never altered; set, the oms's or the ems's entry for a person, admitted only in a session at write when the person may write the account, and stamped on it (W4.9)
- Does not mean: the plugin's own identity, which the sidecar knows
- Empty: unset, the plugin reports a venue's fact as itself, which a fact report may be (W11's invariants)
- Filled: as-reported, by
plugin
ReportChargeParams¶
meridian.plugin.v1.ReportChargeParams, a message.
acting_for¶
message CallerAssertion · since v22 · preview
Names the person ReportCharge is sent for.
- Means: the assertion the plugin was handed for them, the same bytes, never altered; set, a person's entry where the role makes one, admitted only in a session at write when the person may write the account, and stamped on it (W4.9)
- Does not mean: the plugin's own identity, which the sidecar knows
- Empty: unset, the plugin reports a venue's fact as itself, which a fact report may be (W11's invariants)
- Filled: as-reported, by
plugin
RecordLocateParams¶
meridian.plugin.v1.RecordLocateParams, a message.
acting_for¶
message CallerAssertion · since v22 · preview
Names the person RecordLocate is sent for.
- Means: the assertion the plugin was handed for them, the same bytes, never altered; set, a person's entry where the role makes one, admitted only in a session at write when the person may write the account, and stamped on it (W4.9)
- Does not mean: the plugin's own identity, which the sidecar knows
- Empty: unset, the plugin reports a venue's fact as itself, which a fact report may be (W11's invariants)
- Filled: as-reported, by
plugin
ProposeOrderParams¶
meridian.plugin.v1.ProposeOrderParams, a message.
acting_for¶
message CallerAssertion · since v22 · preview
Names the person ProposeOrder is sent for.
- Means: the assertion the plugin was handed for them, the same bytes, never altered; the sidecar admits it only in a session at write, when the person may write the account it names or the record it names is in their write access, and stamps them on it (W4.9)
- Does not mean: the plugin's own identity, which the sidecar knows
- Empty: never unset: a command other than a fact report needs a user, a person or a service account, and the book refuses it sent for no one (REFUSAL_REASON_ACTOR_REQUIRED)
- Filled: as-reported, by
plugin - Required on:
ProposeOrderfrom v22
RequestOrderChangeParams¶
meridian.plugin.v1.RequestOrderChangeParams, a message.
acting_for¶
message CallerAssertion · since v22 · preview
Names the person RequestOrderChange is sent for.
- Means: the assertion the plugin was handed for them, the same bytes, never altered; the sidecar admits it only in a session at write, when the person may write the account it names or the record it names is in their write access, and stamps them on it (W4.9)
- Does not mean: the plugin's own identity, which the sidecar knows
- Empty: never unset: a command other than a fact report needs a user, a person or a service account, and the book refuses it sent for no one (REFUSAL_REASON_ACTOR_REQUIRED)
- Filled: as-reported, by
plugin - Required on:
RequestOrderChangefrom v22
RecordCheckParams¶
meridian.plugin.v1.RecordCheckParams, a message.
acting_for¶
message CallerAssertion · since v22 · preview
Names the person RecordCheck is sent for.
- Means: the assertion the plugin was handed for them, the same bytes, never altered; the sidecar admits it only in a session at write, when the person may write the account it names or the record it names is in their write access, and stamps them on it (W4.9)
- Does not mean: the plugin's own identity, which the sidecar knows
- Empty: never unset: a command other than a fact report needs a user, a person or a service account, and the book refuses it sent for no one (REFUSAL_REASON_ACTOR_REQUIRED)
- Filled: as-reported, by
plugin - Required on:
RecordCheckfrom v22
DecideApprovalParams¶
meridian.plugin.v1.DecideApprovalParams, a message.
acting_for¶
message CallerAssertion · since v22 · preview
Names the person DecideApproval is sent for.
- Means: the assertion the plugin was handed for them, the same bytes, never altered; the sidecar admits it only in a session at write, when the person may write the account it names or the record it names is in their write access, and stamps them on it (W4.9)
- Does not mean: the plugin's own identity, which the sidecar knows
- Empty: never unset: a command other than a fact report needs a user, a person or a service account, and the book refuses it sent for no one (REFUSAL_REASON_ACTOR_REQUIRED)
- Filled: as-reported, by
plugin - Required on:
DecideApprovalfrom v22
ReleaseOrderParams¶
meridian.plugin.v1.ReleaseOrderParams, a message.
acting_for¶
message CallerAssertion · since v22 · preview
Names the person ReleaseOrder is sent for.
- Means: the assertion the plugin was handed for them, the same bytes, never altered; the sidecar admits it only in a session at write, when the person may write the account it names or the record it names is in their write access, and stamps them on it (W4.9)
- Does not mean: the plugin's own identity, which the sidecar knows
- Empty: never unset: a command other than a fact report needs a user, a person or a service account, and the book refuses it sent for no one (REFUSAL_REASON_ACTOR_REQUIRED)
- Filled: as-reported, by
plugin - Required on:
ReleaseOrderfrom v22
SetWorkingConditionParams¶
meridian.plugin.v1.SetWorkingConditionParams, a message.
acting_for¶
message CallerAssertion · since v22 · preview
Names the person SetWorkingCondition is sent for.
- Means: the assertion the plugin was handed for them, the same bytes, never altered; the sidecar admits it only in a session at write, when the person may write the account it names or the record it names is in their write access, and stamps them on it (W4.9)
- Does not mean: the plugin's own identity, which the sidecar knows
- Empty: never unset: a command other than a fact report needs a user, a person or a service account, and the book refuses it sent for no one (REFUSAL_REASON_ACTOR_REQUIRED)
- Filled: as-reported, by
plugin - Required on:
SetWorkingConditionfrom v22
CreatePlacementParams¶
meridian.plugin.v1.CreatePlacementParams, a message.
acting_for¶
message CallerAssertion · since v22 · preview
Names the person CreatePlacement is sent for.
- Means: the assertion the plugin was handed for them, the same bytes, never altered; the sidecar admits it only in a session at write, when the person may write the account it names or the record it names is in their write access, and stamps them on it (W4.9)
- Does not mean: the plugin's own identity, which the sidecar knows
- Empty: never unset: a command other than a fact report needs a user, a person or a service account, and the book refuses it sent for no one (REFUSAL_REASON_ACTOR_REQUIRED)
- Filled: as-reported, by
plugin - Required on:
CreatePlacementfrom v22
RequestPlacementChangeParams¶
meridian.plugin.v1.RequestPlacementChangeParams, a message.
acting_for¶
message CallerAssertion · since v22 · preview
Names the person RequestPlacementChange is sent for.
- Means: the assertion the plugin was handed for them, the same bytes, never altered; the sidecar admits it only in a session at write, when the person may write the account it names or the record it names is in their write access, and stamps them on it (W4.9)
- Does not mean: the plugin's own identity, which the sidecar knows
- Empty: never unset: a command other than a fact report needs a user, a person or a service account, and the book refuses it sent for no one (REFUSAL_REASON_ACTOR_REQUIRED)
- Filled: as-reported, by
plugin - Required on:
RequestPlacementChangefrom v22
AcknowledgeFlagParams¶
meridian.plugin.v1.AcknowledgeFlagParams, a message.
acting_for¶
message CallerAssertion · since v22 · preview
Names the person AcknowledgeFlag is sent for.
- Means: the assertion the plugin was handed for them, the same bytes, never altered; the sidecar admits it only in a session at write, when the person may write the account it names or the record it names is in their write access, and stamps them on it (W4.9)
- Does not mean: the plugin's own identity, which the sidecar knows
- Empty: never unset: a command other than a fact report needs a user, a person or a service account, and the book refuses it sent for no one (REFUSAL_REASON_ACTOR_REQUIRED)
- Filled: as-reported, by
plugin - Required on:
AcknowledgeFlagfrom v22
RecordLocateUseParams¶
meridian.plugin.v1.RecordLocateUseParams, a message.
acting_for¶
message CallerAssertion · since v22 · preview
Names the person RecordLocateUse is sent for.
- Means: the assertion the plugin was handed for them, the same bytes, never altered; the sidecar admits it only in a session at write, when the person may write the account it names or the record it names is in their write access, and stamps them on it (W4.9)
- Does not mean: the plugin's own identity, which the sidecar knows
- Empty: never unset: a command other than a fact report needs a user, a person or a service account, and the book refuses it sent for no one (REFUSAL_REASON_ACTOR_REQUIRED)
- Filled: as-reported, by
plugin - Required on:
RecordLocateUsefrom v22
MapVenueAccountParams¶
meridian.plugin.v1.MapVenueAccountParams, a message.
acting_for¶
message CallerAssertion · since v22 · preview
Names the person MapVenueAccount is sent for.
- Means: the assertion the plugin was handed for them, the same bytes, never altered; admitted only in a session at admin, on the ems's page (W4.9, W11.22)
- Does not mean: the plugin's own identity, which the sidecar knows
- Empty: never unset: the sidecar refuses a change to the deployment's configuration sent for no one
- Filled: as-reported, by
plugin - Required on:
MapVenueAccountfrom v22
ReadVenueCatalogueParams¶
meridian.plugin.v1.ReadVenueCatalogueParams, a message.
acting_for¶
message CallerAssertion · since v22 · preview
Names the person ReadVenueCatalogue is sent for.
- Means: the assertion the plugin was handed for them, the same bytes, never altered; answered only in a session at admin, and stamped with the person (W4.9), as every platform.config read is
- Does not mean: the plugin's own identity, which the sidecar knows
- Empty: never unset: a read of the deployment's configuration (platform.config) is answered only for a person, in a session at admin
- Filled: as-reported, by
plugin - Required on:
ReadVenueCataloguefrom v22
AcceptExecutionParams¶
meridian.plugin.v1.AcceptExecutionParams, a message.
acting_for¶
message CallerAssertion · since v23 · preview
Names the person AcceptExecution is sent for.
- Means: the assertion the plugin was handed for them, the same bytes, never altered; the sidecar admits it only in a session at write, when the executions it names are in their write access, and stamps them on it (W4.9)
- Does not mean: the plugin's own identity, which the sidecar knows
- Empty: never unset: an accept needs a user, a person or the ems's service account, and the book refuses it sent for no one (REFUSAL_REASON_ACTOR_REQUIRED)
- Filled: as-reported, by
plugin - Required on:
AcceptExecutionfrom v23
DontKnowExecutionParams¶
meridian.plugin.v1.DontKnowExecutionParams, a message.
acting_for¶
message CallerAssertion · since v23 · preview
Names the person DontKnowExecution is sent for.
- Means: the assertion the plugin was handed for them, the same bytes, never altered; the sidecar admits it only in a session at write, when the executions it names are in their write access, and stamps them on it (W4.9)
- Does not mean: the plugin's own identity, which the sidecar knows
- Empty: never unset: a DK needs a user, a person or the ems's service account, and the book refuses it sent for no one (REFUSAL_REASON_ACTOR_REQUIRED)
- Filled: as-reported, by
plugin - Required on:
DontKnowExecutionfrom v23
ReportValueDateRollParams¶
meridian.plugin.v1.ReportValueDateRollParams, a message.
acting_for¶
message CallerAssertion · since v23 · preview
Names the person ReportValueDateRoll is sent for.
- Means: the assertion the plugin was handed for them, the same bytes, never altered; set, a person's entry where the role makes one, admitted only in a session at write when the person may write the account, and stamped on it (W4.9)
- Does not mean: the plugin's own identity, which the sidecar knows
- Empty: unset, the plugin reports a venue's fact as itself, which a fact report may be (W11's invariants)
- Filled: as-reported, by
plugin
LaunchPluginRequest¶
meridian.v1.LaunchPluginRequest, a message.
name¶
text · since v2 · stable
Names the plugin to launch.
- Means: a name in the catalogue (W8.2)
- Does not mean: an instance
- Empty: never empty
- Filled: entered, by
dashboard
version¶
text · since v2 · stable
Names the version to launch.
- Means: a version of the named plugin in the catalogue, run by its digest
- Does not mean: a tag that could move
- Empty: never empty
- Filled: entered, by
dashboard
instance_id¶
identifier instance · since v2 · stable
Names the instance it runs as.
- Means: unique among the deployment's live plugins; what its sidecar's credential and grants are for
- Does not mean: the plugin's name
- Empty: never empty
- Filled: entered, by
dashboard
approved_roles¶
repeated text · since v2 · stable
Carries the roles the deployment admin was shown and approved.
- Means: refused unless exactly the version's metadata: an approval of something other than what runs is no approval
- Does not mean: roles a person holds, or grants on them
- Empty: empty only for a version naming no role
- Filled: entered, by
dashboard
live¶
boolean · since v2 · stable
Asks for the live shape.
- Means: on a development deployment alone; the launcher refuses it anywhere else
- Does not mean: a running plugin's state
- Empty: false: the plugin shape
- Filled: entered, by
dashboard
note¶
text · since v17 · stable
Says why the plugin is launched, kept with the change's record.
- Means: the words of the person, or of the agent acting for them, saying why (decisions/031's why); at most 2,000 characters, as a note on an instrument record
- Does not mean: an instruction to anyone who reads it: it is data, written by whoever made the change
- Empty: empty where a person at the page gave none; never empty through /mcp, which refuses a change without one
- Filled: entered, by
dashboard
StopPluginRequest¶
meridian.v1.StopPluginRequest, a message.
instance_id¶
identifier instance · since v2 · stable
Names the instance to stop.
- Means: a launched instance
- Does not mean: the plugin's name
- Empty: never empty
- Filled: entered, by
dashboard
note¶
text · since v17 · stable
Says why the plugin is stopped, kept with the change's record.
- Means: the words of the person, or of the agent acting for them, saying why (decisions/031's why); at most 2,000 characters, as a note on an instrument record
- Does not mean: an instruction to anyone who reads it: it is data, written by whoever made the change
- Empty: empty where a person at the page gave none; never empty through /mcp, which refuses a change without one
- Filled: entered, by
dashboard
PluginLaunch¶
meridian.v1.PluginLaunch, a message.
instance_id¶
identifier instance · since v2 · stable
Names the instance launched.
- Means: as the launch named it
- Does not mean: the plugin's name
- Empty: never empty
- Filled: decided, by
conductor
name¶
text · since v2 · stable
Names the plugin launched.
- Means: its name in the catalogue
- Does not mean: the instance
- Empty: never empty
- Filled: decided, by
conductor
version¶
text · since v2 · stable
Names the version launched.
- Means: a version in the catalogue
- Does not mean: the contract version it was built against
- Empty: never empty
- Filled: decided, by
conductor
image_digest¶
text · since v2 · stable
Pins what runs.
- Means: the image manifest's digest, sha256:
, in the deployment's registry - Does not mean: a tag
- Empty: never empty
- Filled: decided, by
conductor
roles¶
repeated text · since v2 · stable
Lists the roles it was launched with.
- Means: the roles approved at launch
- Does not mean: who holds them
- Empty: empty for a plugin holding no role
- Filled: decided, by
conductor
launched_by¶
text · since v2 · stable
Names who launched it.
- Means: the deployment-local subject of the deployment admin the dashboard stamped
- Does not mean: an agent: an agent acts for the person, named by the delegation beside them
- Empty: never empty
- Filled: stamped, by
dashboard
launched_at_ns¶
moment · since v2 · stable
Says when it was launched.
- Means: the time the conductor recorded the launch
- Does not mean: when it registered
- Empty: never 0
- Filled: decided, by
conductor - Unit: nanoseconds since the epoch
state¶
enum PluginLaunchState · since v2 · stable
Says what became of the launch.
- Means: launched, stopped, or failed with why
- Does not mean: its health, which its sidecar's reports say
- Empty: never unspecified
- Filled: decided, by
conductor
| Value | Means |
|---|---|
PLUGIN_LAUNCH_STATE_UNSPECIFIED |
not said |
PLUGIN_LAUNCH_STATE_LAUNCHED |
recorded, and the launcher asked |
PLUGIN_LAUNCH_STATE_STOPPED |
stopped by an administrator; the instance may be launched again |
PLUGIN_LAUNCH_STATE_FAILED |
the launcher refused or failed, failure saying why |
stopped_by¶
text · since v2 · stable
Names who stopped it.
- Means: the deployment-local subject of the deployment admin the dashboard stamped
- Does not mean: an agent
- Empty: empty while not stopped
- Filled: stamped, by
dashboard
stopped_at_ns¶
moment · since v2 · stable
Says when it was stopped.
- Means: the time the conductor recorded the stop
- Does not mean: when its workload went
- Empty: 0 while not stopped
- Filled: decided, by
conductor - Unit: nanoseconds since the epoch
failure¶
text · since v2 · stable
Says why a launch failed.
- Means: the launcher's or the conductor's words
- Does not mean: a refusal at the request, which records no launch
- Empty: empty unless it failed
- Filled: decided, by
conductor
live¶
boolean · since v2 · stable
Says it was launched in the live shape.
- Means: as the launch asked, on a development deployment
- Does not mean: whether it is running
- Empty: false: the plugin shape
- Filled: decided, by
conductor
acting_through_delegation¶
text · since v17 · stable
Names the delegation the person who launched it acted through, beside them.
- Means: the delegation's identifier as the dashboard stamped it on the envelope: the CLI's, or an agent's through /mcp (W6.20)
- Does not mean: an actor of its own: the person is the actor, the delegation provenance
- Empty: empty where the change was made in a browser, through no delegation, and on every record before v17, each of which was
- Filled: stamped, by
dashboard
client_name¶
text · since v17 · stable
Names the client the person who launched it acted through, so the record reads "by the person, through that client" without a second read.
- Means: the client's registered name, as stamped beside the delegation
- Does not mean: a person's name, or anything that decides access
- Empty: empty whenever acting_through_delegation is
- Filled: stamped, by
dashboard
stopped_through_delegation¶
text · since v17 · stable
Names the delegation the person who stopped it acted through, beside stopped_by.
- Means: the delegation's identifier as the dashboard stamped it
- Does not mean: an actor of its own
- Empty: empty while not stopped, for a stop made in a browser, and on every stop before v17, each of which has a gap record saying it went unrecorded
- Filled: stamped, by
dashboard
stopped_client_name¶
text · since v17 · stable
Names the client the person who stopped it acted through.
- Means: the client's registered name, as stamped
- Does not mean: a person's name
- Empty: empty whenever stopped_through_delegation is
- Filled: stamped, by
dashboard
note¶
text · since v17 · stable
Says why it was launched, beside who launched it.
- Means: the words of the person, or of the agent acting for them, saying why (decisions/031's why), as kept with the change; at most 2,000 characters; the launch's, not its stop's
- Does not mean: an instruction to anyone who reads it: it is data, written by whoever made the change
- Empty: empty where none was given, and on every launch before v17
- Filled: entered, by
dashboard
stopped_note¶
text · since v17 · stable
Says why it was stopped, beside who stopped it.
- Means: the words of the person, or of the agent acting for them, saying why (decisions/031's why), as kept with the stop; at most 2,000 characters; the stop's, not the launch's
- Does not mean: an instruction to anyone who reads it: it is data, written by whoever made the change
- Empty: empty while not stopped, where none was given, and on every stop before v17
- Filled: entered, by
dashboard
AllowArchiveRequest¶
meridian.v1.AllowArchiveRequest, a message.
instance_id¶
identifier instance · since v16 · stable
Names the edge instance allowed an archive.
- Means: a launched instance holding an edge role
- Does not mean: a bucket or a path
- Empty: never empty
- Filled: entered, by
dashboard
most_bytes¶
integer · since v16 · stable
Bounds the archive.
- Means: the most bytes the instance's archive may hold
- Does not mean: what it holds now
- Empty: 0 for no bound
- Filled: entered, by
dashboard - Unit: bytes
note¶
text · since v17 · stable
Says why the archive is allowed or its bound changed, kept with the change's record.
- Means: the words of the person, or of the agent acting for them, saying why (decisions/031's why); at most 2,000 characters, as a note on an instrument record
- Does not mean: an instruction to anyone who reads it: it is data, written by whoever made the change
- Empty: empty where a person at the page gave none; never empty through /mcp, which refuses a change without one
- Filled: entered, by
dashboard
WithdrawArchiveRequest¶
meridian.v1.WithdrawArchiveRequest, a message.
instance_id¶
identifier instance · since v16 · stable
Names the instance whose archive is withdrawn.
- Means: an instance allowed one
- Does not mean: a deletion of what it holds, which is kept
- Empty: never empty
- Filled: entered, by
dashboard
note¶
text · since v17 · stable
Says why the archive is withdrawn, kept with the change's record.
- Means: the words of the person, or of the agent acting for them, saying why (decisions/031's why); at most 2,000 characters, as a note on an instrument record
- Does not mean: an instruction to anyone who reads it: it is data, written by whoever made the change
- Empty: empty where a person at the page gave none; never empty through /mcp, which refuses a change without one
- Filled: entered, by
dashboard
PluginArchive¶
meridian.v1.PluginArchive, a message.
instance_id¶
identifier instance · since v16 · stable
Names the instance.
- Means: as allowed
- Does not mean: a bucket or a path
- Empty: never empty
- Filled: decided, by
conductor
allowed¶
boolean · since v16 · stable
Says whether the instance has an archive now.
- Means: allowed by a deployment admin and not withdrawn
- Does not mean: whether it holds anything
- Empty: false once withdrawn
- Filled: decided, by
conductor
most_bytes¶
integer · since v16 · stable
Says the archive's bound.
- Means: the most bytes it may hold
- Does not mean: what it holds now, which the plugin's report says
- Empty: 0 for no bound
- Filled: decided, by
conductor - Unit: bytes
updated_by¶
text · since v16 · stable
Names who last allowed, changed or withdrew it.
- Means: the deployment-local subject of the deployment admin the dashboard stamped
- Does not mean: an agent
- Empty: never empty
- Filled: stamped, by
dashboard
updated_at_ns¶
moment · since v16 · stable
Says when.
- Means: the time of its latest change, its own record
- Does not mean: when it was made
- Empty: never 0
- Filled: decided, by
conductor - Unit: nanoseconds since the epoch
acting_through_delegation¶
text · since v17 · stable
Names the delegation the person who last allowed, changed or withdrew it acted through, beside them.
- Means: the delegation's identifier as the dashboard stamped it on the envelope: the CLI's, or an agent's through /mcp (W6.20)
- Does not mean: an actor of its own: the person is the actor, the delegation provenance
- Empty: empty where the change was made in a browser, through no delegation, and on every record before v17, each of which was
- Filled: stamped, by
dashboard
client_name¶
text · since v17 · stable
Names the client the person who last allowed, changed or withdrew it acted through, so the record reads "by the person, through that client" without a second read.
- Means: the client's registered name, as stamped beside the delegation
- Does not mean: a person's name, or anything that decides access
- Empty: empty whenever acting_through_delegation is
- Filled: stamped, by
dashboard
note¶
text · since v17 · stable
Says why the archive was last allowed, changed or withdrawn, beside who did it.
- Means: the words of the person, or of the agent acting for them, saying why (decisions/031's why), as kept with the change; at most 2,000 characters
- Does not mean: an instruction to anyone who reads it: it is data, written by whoever made the change
- Empty: empty where none was given: a person at the page may give none, and every change before v17 carried none
- Filled: entered, by
dashboard
ReadPreparedCallRequest¶
meridian.v1.ReadPreparedCallRequest, a message.
prepared_call_id¶
text · since v20 · preview
Names the prepared change a page was opened from.
- Means:
PC-and a ULID, as the claims carried it - Does not mean: a change the plugin may look up freely: one not shown to the person is answered as not found
- Empty: never empty: the ID the claims named
- Filled: as-reported, by
plugin
ReadPreparedCallReply¶
meridian.v1.ReadPreparedCallReply, a message.
prepared_call¶
message PreparedCall · since v20 · preview
Answers the prepared change.
- Means: the change as the dashboard keeps it, for the person whose page it is
- Does not mean: a record the plugin keeps: it keeps nothing
- Empty: unset when not found: no such change, another instance's, not shown to the person, or one they may not make now, never which
- Filled: decided, by
dashboard
PreparedCall¶
meridian.v1.PreparedCall, a message.
prepared_call_id¶
text · since v20 · preview
Identifies a prepared change.
- Means:
PC-and a ULID, minted by the dashboard when the change passed its check - Does not mean: a change made: nothing changed when it was prepared
- Empty: never empty
- Filled: minted, by
dashboard
tool_name¶
text · since v20 · preview
Names the act prepared.
- Means: the plugin's own name for the act's tool
- Does not mean: a tool the plugin may call: the person makes it
- Empty: never empty
- Filled: decided, by
dashboard
arguments_json¶
text · since v20 · preview
Carries the act's arguments as prepared.
- Means: a JSON object, the tool's typed record of inputs, which the page starts its form from
- Does not mean: what will be made: the person may change it first
- Empty: never empty: at least {}
- Filled: entered, by
dashboard - Bounds: 2 to 1048576 characters; past it, refused
prepared_by_subject¶
text · since v20 · preview
Names who prepared it.
- Means: the deployment-local subject of the person who prepared it, themselves or through a client
- Does not mean: who will make it, who is never the preparer's agent
- Empty: never empty
- Filled: stamped, by
dashboard
prepared_by_display_name¶
text · since v20 · preview
Names who prepared it, for a person to read.
- Means: their display name at their last sign-in
- Does not mean: an identity to act on
- Empty: empty where the directory gave none
- Filled: stamped, by
dashboard
prepared_through_client¶
text · since v20 · preview
Names the client it was prepared through.
- Means: the client's registered name, its own choice, shown as "prepared by"
- Does not mean: a person or a plugin instance
- Empty: empty for a person who prepared it at a page
- Filled: stamped, by
dashboard
reason¶
text · since v20 · preview
Says why it was prepared.
- Means: the preparer's words, plain text, at most 4,000 characters
- Does not mean: an instruction to anyone who reads it: another's words, shown as text
- Empty: empty where none was given at a page; never through /mcp
- Filled: entered, by
dashboard - Bounds: at most 4000 characters; past it, refused
state¶
enum PreparedCallState · since v20 · preview
Says what became of it.
- Means: its state now (W6.27, W6.28)
- Does not mean: a promise it will stay so: a pending one may be settled by anyone it is shown to
- Empty: never unspecified
- Filled: decided, by
dashboard
| Value | Means |
|---|---|
PREPARED_CALL_STATE_UNSPECIFIED |
never sent |
PREPARED_CALL_STATE_PREPARED |
waiting |
PREPARED_CALL_STATE_SHARED |
waiting, shared with everyone who may make it |
PREPARED_CALL_STATE_MADE |
made as prepared |
PREPARED_CALL_STATE_CHANGED |
made after the person changed it |
PREPARED_CALL_STATE_DISCARDED |
discarded |
PREPARED_CALL_STATE_WITHDRAWN |
withdrawn by whoever prepared it |
PREPARED_CALL_STATE_LAPSED |
lapsed, never made |
prepared_at_ns¶
moment · since v20 · preview
Says when it was prepared.
- Means: when it passed its check and was kept
- Does not mean: when it was made
- Empty: never 0
- Filled: stamped, by
dashboard
SetOwnSettingsRequest¶
meridian.v1.SetOwnSettingsRequest, a message.
values¶
repeated message SettingValue · since v20 · preview
Carries the person's own values to save (W6.31).
- Means: each a setting the plugin declares per_person, its value as a setting's is written; an empty value clears it; those not named keep theirs
- Does not mean: values for anybody but the person the assertion names
- Empty: never empty: at least one setting
- Filled: entered, by
plugin - Bounds: 1 to 64 items; past it, refused
SetOwnSettingsReply¶
meridian.v1.SetOwnSettingsReply, a message.
values¶
repeated message SettingValue · since v20 · preview
Answers the person's own values as they stand.
- Means: every per-person value the dashboard keeps under them for this instance, which their next request's claims carry
- Does not mean: anyone else's
- Empty: empty where the person now holds none
- Filled: decided, by
dashboard - Bounds: at most 64 items; past it, refused
CallAsServiceAccountRequest¶
meridian.v1.CallAsServiceAccountRequest, a message.
role¶
text · since v21 · preview
Names the role whose service account the call is made as.
- Means: a role the instance was launched with; the dashboard admits the call as the service account that role's admin chose (W6.33)
- Does not mean: a role the plugin grants itself: the generated grants and the account's grant decide what it reaches
- Empty: never empty
- Filled: as-reported, by
plugin
tool_name¶
text · since v21 · preview
Names the act called.
- Means: the plugin's own name for one of its declared acts on the role, as its tool is named; never a read or a core tool
- Does not mean: a route the plugin may call with any arguments: the dashboard admits it, and the sidecar admits what the route sends
- Empty: never empty
- Filled: as-reported, by
plugin - Bounds: 1 to 61 characters; past it, refused
arguments_json¶
text · since v21 · preview
Carries the act's arguments.
- Means: a JSON object, the tool's typed record of inputs, sent to the act's route when made and kept as the prepared change's when prepared
- Does not mean: a record of anything done: nothing is done until the answer says made
- Empty: never empty: at least {}
- Filled: as-reported, by
plugin - Bounds: 2 to 1048576 characters; past it, refused
reason¶
text · since v21 · preview
Says why the autonomous work calls the act.
- Means: the plugin's words, plain text, kept as the prepared change's reason when prepared
- Does not mean: the act's own reason field, which the act's arguments carry where the act takes one; or an instruction to anyone who reads it
- Empty: never empty
- Filled: as-reported, by
plugin - Bounds: 1 to 4000 characters; past it, refused
algorithm_id¶
text · since v22 · preview
Names the algorithm the autonomous work runs.
- Means: one of the identifiers the version declares; checked and stamped by the sidecar on every command the act sends, and copied by the book to each entry's ServiceAccountActor; one not declared is refused INVALID_ARGUMENT naming algorithm_id
- Does not mean: the act's own arguments
- Empty: empty names none
- Filled: as-reported, by
plugin
CallAsServiceAccountReply¶
meridian.v1.CallAsServiceAccountReply, a message.
outcome¶
text · since v21 · preview
Says what became of the call.
- Means: made or prepared, by the levels, the gate and the account's setting that applied (W6.29)
- Does not mean: that the act succeeded in its store, which the act's own answer says
- Empty: never empty: a refusal is the call's status, naming the field
- Filled: decided, by
dashboard
| Value | Means |
|---|---|
made |
the act was made as the service account; the act's own answer is beside it |
prepared |
the act was prepared for the people who may make it; prepared_call_id names it |
prepared_call_id¶
text · since v21 · preview
Names the prepared change the call became.
- Means:
PC-and a ULID; its preparer is the service account, and a person makes it - Does not mean: a change the plugin or the service account may make: neither does
- Empty: empty unless the outcome is prepared
- Filled: decided, by
dashboard
answer_json¶
text · since v21 · preview
Carries the act's own answer.
- Means: the route's typed JSON answer, as a tool's call is answered (W6.20)
- Does not mean: a record kept by the dashboard: the act's store keeps the record
- Empty: empty unless the outcome is made
- Filled: decided, by
dashboard - Bounds: at most 1048576 characters; past it, refused
AlgorithmDeclaration¶
meridian.v1.AlgorithmDeclaration, a message.
algorithm_id¶
text · since v22 · preview
Names one algorithm the version declares.
- Means: stable across versions and reinstalls: what
reportingmaps to a regime's decision-maker and executor - Does not mean: a version of the plugin, or a person
- Empty: never empty
- Filled: as-reported, by
plugin
description¶
text · since v22 · preview
Says what the algorithm is, for a person reading the plugin's page.
- Means: plain text
- Does not mean: an instruction to anyone who reads it
- Empty: never empty
- Filled: as-reported, by
plugin - Bounds: 1 to 1024 characters; past it, refused
DateBasis¶
meridian.v1.DateBasis, a message.
rule¶
message DateRuleRef · since v22 · preview
Names the rule a date was computed by (W3.20).
- Means: the rule's kind, subject and version
- Does not mean: the calendars
- Empty: unset for a date worked out on calendars alone: a roll, a business-day check
- Filled: derived, by
instrument
calendars¶
repeated message CalendarRef · since v22 · preview
Names each calendar a date was computed on.
- Means: each with its version, so the same inputs and versions always give the same date
- Does not mean: the calendars held now
- Empty: never empty on a computed date
- Filled: derived, by
instrument
DateRuleRef¶
meridian.v1.DateRuleRef, a message.
kind¶
enum DateRuleKind · since v22 · preview
Says the rule's kind.
- Means: settlement or spot
- Does not mean: a calendar's kind
- Empty: never unspecified
- Filled: derived, by
instrument
| Value | Means |
|---|---|
DATE_RULE_KIND_UNSPECIFIED |
not said |
DATE_RULE_KIND_SETTLEMENT |
a market's settlement-date rule, for a country and an asset class |
DATE_RULE_KIND_SPOT |
a currency pair's spot-date rule, its tenor-date rule on it |
subject¶
text · since v22 · preview
Names what the rule is for.
- Means: as the platform names it:
US/equity, a country and an asset class;EUR/USD, a pair - Does not mean: an ID: a rule has none of its own (Q11)
- Empty: never empty
- Filled: derived, by
instrument
version¶
integer · since v22 · preview
Names the rule's version.
- Means: assigned by the platform; a date before a version is answered by the one before
- Does not mean: the date it takes effect
- Empty: never 0
- Filled: derived, by
instrument - Unit: versions of the rule
CalendarRef¶
meridian.v1.CalendarRef, a message.
calendar_id¶
text · since v22 · preview
Names a calendar.
- Means:
CAL-and the platform's ID, never reused - Does not mean: a currency code or an FpML business centre
- Empty: never empty
- Filled: derived, by
instrument
version¶
integer · since v22 · preview
Names the calendar's version.
- Means: monotonic, assigned by the platform, starting at 1
- Does not mean: a count of days
- Empty: never 0
- Filled: derived, by
instrument - Unit: versions of the record
ConnectivityLink¶
meridian.v1.ConnectivityLink, a message.
connectivity_instance_id¶
identifier instance · since v22 · preview
Names the connectivity plugin instance.
- Means: an instance holding connectivity
- Does not mean: the ems
- Empty: never empty
- Filled: decided, by
conductor
available¶
boolean · since v22 · preview
Says whether a deployment admin made it available.
- Means: true while available to link
- Does not mean: a link
- Empty: false: not available, as every one is by default
- Filled: entered, by
dashboard
ems_instance_id¶
identifier instance · since v22 · preview
Names the one ems it is linked to.
- Means: linked by the ems plugin's admin; each connectivity plugin to exactly one
- Does not mean: every ems that may read it
- Empty: empty while unlinked
- Filled: entered, by
dashboard
users¶
repeated message ConnectivityUser · since v22 · preview
Says who may route through it.
- Means: made available by the ems's admin; a placement for any other user is refused REFUSAL_REASON_CONNECTIVITY_NOT_ALLOWED
- Does not mean: a grant of a role
- Empty: empty: nobody may route through it
- Filled: entered, by
dashboard
ConnectivityUser¶
meridian.v1.ConnectivityUser, a message.
subject¶
text · since v22 · preview
Names a person.
- Means: the deployment-local subject
- Does not mean: an email address
- Empty: empty unless a person
- Filled: entered, by
dashboard
service_account_id¶
text · since v22 · preview
Names a service account.
- Means: its
SA-ID - Does not mean: a plugin
- Empty: empty unless a service account
- Filled: entered, by
dashboard
user_group_id¶
text · since v22 · preview
Names a user group.
- Means: the group, whose persons may route
- Does not mean: an access group
- Empty: empty unless a user group
- Filled: entered, by
dashboard
VenueAccountMap¶
meridian.v1.VenueAccountMap, a message.
ems_instance_id¶
identifier instance · since v22 · preview
Names the ems whose map it is.
- Means: the ems that sets the venue's account field at its connectivity plugins
- Does not mean: a connectivity plugin
- Empty: never empty
- Filled: decided, by
conductor
mappings¶
repeated message VenueAccountMapping · since v22 · preview
Lists the ems's mappings.
- Means: each account's code at one connectivity plugin; what the sidecar stamps a venue fact's account by
- Does not mean: external account links
- Empty: empty while nothing is mapped
- Filled: decided, by
conductor
VenueAccountMapping¶
meridian.v1.VenueAccountMapping, a message.
connectivity_instance_id¶
identifier instance · since v22 · preview
Names the connectivity plugin the code is at.
- Means: one linked to the ems
- Does not mean: a venue
- Empty: never empty
- Filled: entered, by
ems
venue_account_code¶
text · since v22 · preview
Carries the code the account trades under.
- Means: once per plugin
- Does not mean: an account ID
- Empty: never empty
- Filled: entered, by
ems
account_id¶
identifier account · since v22 · preview
Names the book account.
- Means: an account the deployment admin granted the ems's instance (W6.30)
- Does not mean: an external account
- Empty: never empty
- Filled: entered, by
ems
SetAllocationInstructionParams¶
meridian.plugin.v1.SetAllocationInstructionParams, a message.
acting_for¶
message CallerAssertion · since v24 · preview
Names the person SetAllocationInstruction is sent for.
- Means: the assertion the plugin was handed for them, the same bytes, never altered; the sidecar admits it only in a session at write, when the person may write the account it names or the record it names is in their write access, and stamps them on it (W4.9)
- Does not mean: the plugin's own identity, which the sidecar knows
- Empty: never unset: a command other than a fact report needs a user, a person or a service account, and the book refuses it sent for no one (REFUSAL_REASON_ACTOR_REQUIRED)
- Filled: as-reported, by
plugin - Required on:
SetAllocationInstructionfrom v24
BookOrderParams¶
meridian.plugin.v1.BookOrderParams, a message.
acting_for¶
message CallerAssertion · since v24 · preview
Names the person BookOrder is sent for.
- Means: the assertion the plugin was handed for them, the same bytes, never altered; the sidecar admits it only in a session at write, when the person may write the account it names or the record it names is in their write access, and stamps them on it (W4.9)
- Does not mean: the plugin's own identity, which the sidecar knows
- Empty: never unset: a command other than a fact report needs a user, a person or a service account, and the book refuses it sent for no one (REFUSAL_REASON_ACTOR_REQUIRED)
- Filled: as-reported, by
plugin - Required on:
BookOrderfrom v24
HandOffBookingParams¶
meridian.plugin.v1.HandOffBookingParams, a message.
acting_for¶
message CallerAssertion · since v24 · preview
Names the person HandOffBooking is sent for.
- Means: the assertion the plugin was handed for them, the same bytes, never altered; the sidecar admits it only in a session at write, when the person may write the account it names or the record it names is in their write access, and stamps them on it (W4.9)
- Does not mean: the plugin's own identity, which the sidecar knows
- Empty: never unset: a command other than a fact report needs a user, a person or a service account, and the book refuses it sent for no one (REFUSAL_REASON_ACTOR_REQUIRED)
- Filled: as-reported, by
plugin - Required on:
HandOffBookingfrom v24
CorrectBookingParams¶
meridian.plugin.v1.CorrectBookingParams, a message.
acting_for¶
message CallerAssertion · since v24 · preview
Names the person CorrectBooking is sent for.
- Means: the assertion the plugin was handed for them, the same bytes, never altered; the sidecar admits it only in a session at write, when the person may write the account it names or the record it names is in their write access, and stamps them on it (W4.9)
- Does not mean: the plugin's own identity, which the sidecar knows
- Empty: never unset: a command other than a fact report needs a user, a person or a service account, and the book refuses it sent for no one (REFUSAL_REASON_ACTOR_REQUIRED)
- Filled: as-reported, by
plugin - Required on:
CorrectBookingfrom v24
RecordSleeveCrossParams¶
meridian.plugin.v1.RecordSleeveCrossParams, a message.
acting_for¶
message CallerAssertion · since v24 · preview
Names the person RecordSleeveCross is sent for.
- Means: the assertion the plugin was handed for them, the same bytes, never altered; the sidecar admits it only in a session at write, when the person may write the account it names or the record it names is in their write access, and stamps them on it (W4.9)
- Does not mean: the plugin's own identity, which the sidecar knows
- Empty: never unset: a command other than a fact report needs a user, a person or a service account, and the book refuses it sent for no one (REFUSAL_REASON_ACTOR_REQUIRED)
- Filled: as-reported, by
plugin - Required on:
RecordSleeveCrossfrom v24
AcknowledgeAlertParams¶
meridian.plugin.v1.AcknowledgeAlertParams, a message.
acting_for¶
message CallerAssertion · since v24 · preview
Names the person AcknowledgeAlert is sent for.
- Means: the assertion the plugin was handed for them, the same bytes, never altered; the sidecar admits it only in a session at write, when the person may write the account it names or the record it names is in their write access, and stamps them on it (W4.9)
- Does not mean: the plugin's own identity, which the sidecar knows
- Empty: never unset: a command other than a fact report needs a user, a person or a service account, and the book refuses it sent for no one (REFUSAL_REASON_ACTOR_REQUIRED)
- Filled: as-reported, by
plugin - Required on:
AcknowledgeAlertfrom v24
RaiseAlertParams¶
meridian.plugin.v1.RaiseAlertParams, a message.
acting_for¶
message CallerAssertion · since v24 · preview
Names the person RaiseAlert is sent for.
- Means: the assertion the plugin was handed for them, the same bytes, never altered; set, the sidecar admits it only in a session at write, when the person may write the account or the record it names, and stamps them on it (W4.9)
- Does not mean: the plugin's own identity, which the sidecar knows
- Empty: unset, compliance raises its own alert as itself, a finding as RecordBreak's is (W11.34)
- Filled: as-reported, by
plugin
ReportGiveUpParams¶
meridian.plugin.v1.ReportGiveUpParams, a message.
acting_for¶
message CallerAssertion · since v24 · preview
Names the person ReportGiveUp is sent for.
- Means: the assertion the plugin was handed for them, the same bytes, never altered; set, the sidecar admits it only in a session at write, when the person may write the account or the record it names, and stamps them on it (W4.9)
- Does not mean: the plugin's own identity, which the sidecar knows
- Empty: unset, the plugin reports a prime's answer as itself, which a fact report may be (W11.32)
- Filled: as-reported, by
plugin
OfferTemplateFieldsParams¶
meridian.plugin.v1.OfferTemplateFieldsParams, a message.
acting_for¶
message CallerAssertion · since v24 · preview
Names the person OfferTemplateFields is sent for.
- Means: the assertion the plugin was handed for them, the same bytes, never altered; set, the sidecar admits it only in a session at write, when the person may write the account or the record it names, and stamps them on it (W4.9)
- Does not mean: the plugin's own identity, which the sidecar knows
- Empty: unset, the reference plugin offers its fields as itself, the offers' source (W3.23)
- Filled: as-reported, by
plugin
Operation limits¶
A bound a plugin can meet on an operation rather than on a field.
SidecarReceive.limit¶
integer · since v7 · stable
Bounds what the sidecar holds for a plugin that reads slowly.
- Means: at most 1,024 deliveries wait; past it the sidecar drops what it cannot hold and marks the place with a Lost, which the plugin reads its store to catch up from
- Does not mean: a page of a read, or a promise of delivery: delivery is at most once
- Empty: not a field: the bound on the stream
- Filled: decided, by
sidecar - Unit: deliveries queued for the plugin
- Bounds: from 0 to 1024; past it, answered at the bound
Generated from boundaries/fields.json in meridian-schema at a6a0af7, contract v24.