ores.marketdata.operations

/**
 * @brief The identity's remaining fields, such as ccy or curve_id.
 *
 * The other fields the type's schema row declares. A field the caller does not
 * state is left unconstrained, so the read narrows by what it is given.
 */

/** The declared coordinate fields in order. Empty when no shape is declared. */

/** "fresh" | "stale" | "unavailable" -- see
 * ores.analytics.quant::domain::rate_status.
 */

/** ISO-8601 UTC, empty when status is "unavailable". */

/** True when this pair has no direct quote and rate is computed as
 * 1/rate from the reverse pair -- only ever set when the request's own
 * `reciprocal` flag was true.
 */

/** %-change vs. the last value served for this exact pair (as displayed,
 * i.e. post-reciprocal) within this (tenant, party, crm_name) scope --
 * shared across every session polling that same CRM, not per-connection.
 * Unset for the first observation of a pair, or when status is
 * "unavailable".
 */

/** When true, a configured pair with no direct quote but whose reverse
 * pair *is* configured is backfilled with the reverse's computed
 * reciprocal (1/rate) -- see
 * ores.analytics.quant::service::rate_reciprocator. When the reverse
 * pair is itself also directly configured, its own direct rate is
 * served instead of a synthesised reciprocal.
 */

/**
 * @brief The value at each declared coordinate, index for index with the
 * response's coordinates.
 *
 * The empty string is a hole: the shape declares the coordinate and no point
 * holds a value for it at this instant. A short vector would be read as a
 * shorter object, which is the mistake the aligned shape exists to prevent.
 */

/** The object, as the typed identity the resolver already takes. */

/**
 * @brief The axis the component fixes, an oresmd field code such as
 * strike_label.
 *
 * Empty for an object with one coordinate axis, whose one component is the
 * whole object.
 */

/**
 * @brief The value the component fixes on that axis, such as ATM, in the
 * spelling the shape stores.
 */

/** The first market instant of the range, inclusive. */

/** The last market instant of the range, inclusive. */

/**
 * @brief Why the read was refused, when it was.
 *
 * A component the shape does not declare is refused here, naming the axis or
 * the value that is missing.
 */

/**
 * @brief The axis the component varies over, an oresmd field code such as
 * expiry.
 *
 * Empty when the response holds no instant.
 */

/**
 * @brief The declared values of the coordinate field, in the order the shape
 * stores them.
 *
 * Every instant's values are index for index with this.
 */

/** Oldest first, one entry per distinct market instant in the range. */

/**
 * @brief One label per declared axis, index for index with the response's
 * coordinate_fields.
 */

/**
 * @brief The change the node shows over the range.
 *
 * One of never_quoted, persistent, added, dropped or intermittent, which is
 * the first of those that holds. never_quoted is a node the shape declares and
 * no instant in the range carries, which is what tells it apart from a node the
 * object does not have: that node is not in the response at all.
 */

/**
 * @brief The value at each node, index for index with the response's nodes.
 *
 * The empty string is a hole: the shape declares the node and no point held a
 * value for it at this instant.
 */

/** The object, as the typed identity the resolver already takes. */

/** The first market instant of the range, inclusive, when instants is empty. */

/** The last market instant of the range, inclusive, when instants is empty. */

/**
 * @brief The instants the caller states, which replace the range when the
 * vector is not empty.
 *
 * Each one is read as the object stood at it, whether or not the object holds a
 * point at exactly that instant. A caller that wants the object at the month
 * ends states them; a caller that wants everything it holds between two
 * instants states the range and leaves this empty.
 */

/** Why the read was refused, when it was. */

/**
 * @brief The axis names, in the order the shape stores them.
 *
 * Every node's coordinates are index for index with this.
 */

/**
 * @brief The declared grid, with the last axis varying fastest.
 *
 * Every combination of the declared axis values is a node, whether or not any
 * instant carries it.
 */

/** Oldest first, one entry per distinct market instant read. */

/**
 * @brief One of quoted, derived or manual.
 *
 * A point with no annex row is quoted. The empty string marks a hole, which has
 * no source.
 */

/** Who set the point. Empty for a quoted point and for a hole. */

/** Why the point was set. Empty for a quoted point and for a hole. */

/** The free-text reason for the change. Empty when none was given. */

/** When the annex row was recorded. The epoch for a quoted point and for a hole. */

/** The recipe that built a derived point. Empty unless the point is derived. */

/** The recipe version the point was built under. Zero unless the point is derived. */

/** The as-of of the upstream data the derivation read. The epoch unless the point is derived. */

/** The object, as the typed identity the resolver already takes. */

/**
 * @brief Whether the response states where each value came from.
 *
 * The annex is read only when this is set, so a caller that does not ask pays
 * nothing for it. The provenance is the current annex row of each point shown, the
 * same generation the values come from, not the row as it stood at the instant.
 */

/** Why the read was refused, when it was. */

/**
 * @brief The instant the snapshot is as of, which is what an age is measured
 * from.
 *
 * Without it a reader measures an age from its own clock, so clock skew shows
 * up as staleness that is not in the curve.
 */

/** The axis names, in the order the shape stores them. */

/**
 * @brief The declared grid, with the last axis varying fastest.
 *
 * The status of a node is empty: one instant shows no change.
 */

/**
 * @brief The value at each node, index for index with nodes.
 *
 * The empty string is a hole: the shape declares the node and no point held a
 * value for it.
 */

/** When each point was recorded, index-for-index with observations: the
 * bitemporal valid_from of the row it was read from. Two ages are readable
 * from a point and they answer different questions: the snapshot instant
 * minus the point's instant is market staleness, the age of the market state
 * it belongs to; now minus its record time is record staleness, how long ago
 * the value arrived.
 */

/**
 * @brief Where each value came from, index for index with nodes.
 *
 * Empty when the request did not ask for provenance.
 */

/**
 * @brief The age of the snapshot's oldest point, in seconds.
 *
 * Market staleness, not record staleness: the age of the market state the
 * point belongs to, which is what decides whether a drawn curve is one market
 * read or a stitching of several. Zero for an empty snapshot.
 */

/**
 * @brief The spread between the oldest and the newest point, in seconds.
 *
 * The number that measures the mixing: points that share one instant have a
 * spread of zero however old that instant is, and a curve stitched across
 * market horizons does not. A point whose instant is after the snapshot
 * instant carries no age at all, and one exactly at it is age zero and counts.
 */

/**
 * @brief Whether the snapshot is mixed enough that a view must not draw it
 * silently.
 *
 * The threshold is stated by the evolution journey, not by this message: the
 * read reports the crossing, and the view decides what to show.
 */

/**
 * @brief When a person last published this series, or absent when nobody has.
 *
 * The values the snapshot serves are the latest observations, published or
 * not. This is what tells a reader which of the two it is looking at, and a
 * series no person published answers absent rather than a plausible instant.
 */

/**
 * @brief The account that published the set, or empty when nobody has.
 *
 * The decider and the publisher are two people: the approval records who
 * answered the request, and this records who applied the answer.
 */

/**
 * @brief The market instant the published set was bootstrapped against.
 *
 * The epoch when nobody has published the series. The snapshot's own instant
 * is now, and the values carry their own ages; this is the as-of the published
 * set was built at, which is what a delta against the live set is measured
 * from.
 */

/**
 * @brief The approval request that authorised the published set, or empty.
 *
 * The request a decider answered, so a reader sees which decision the set in
 * use stands on and can read its decisions, its reason and its state.
 */

/**
 * @brief Full text content of an ORE market.txt file.
 *
 * Supports both YYYYMMDD and YYYY-MM-DD date formats, and whitespace or
 * comma delimiters. Empty string means no market observations to import.
 */

/**
 * @brief Full text content of an ORE fixings.txt file.
 *
 * Same format rules as market_data_content. Empty string means no fixings
 * to import.
 */

/**
 * @brief Tag stamped on every imported market_observation's source field.
 *
 * Distinguishes where an observation came from (e.g. "ore.reference" for a
 * named ORE example vintage) so downstream consumers can query for a specific
 * import rather than an untagged mix. Empty string (the default) preserves
 * the pre-existing untagged behaviour.
 */

/**
 * @brief How a (date, key) pair repeated within market_data_content or
 * fixings_content is handled.
 *
 * false (default): the later occurrence wins (last-line-wins), each repeat is
 * reported in @c warnings, and the import proceeds -- it matches real ORE
 * example data, which does contain such repeats.
 *
 * true: same de-duplication, but each repeat is reported in @c errors
 * instead, and the affected content (market data and/or fixings, whichever
 * contained repeats) is not persisted -- a strict mode for callers that want
 * repeats treated as a hard failure.
 */

/**
 * @brief Non-fatal issues from de-duplicating repeated (date, key) pairs.
 *
 * One string per repeat, e.g. "market data line 12: duplicate key '...' --
 * superseded by line 34". Populated regardless of duplicates_are_errors;
 * which of warnings/errors they land in depends on it.
 */

/**
 * @brief Same shape as warnings, populated only when duplicates_are_errors
 * is true.
 *
 * A non-empty errors means the content with repeats (market data and/or
 * fixings) was not persisted.
 */

/** The per-kind breakdown of the three counts above, which aggregate across
 * every kind and are the summary clients print. Both are always populated.
 */

/**
 * @brief Where the market data body goes.
 */

/**
 * @brief Where the fixings body goes.
 *
 * The engine reads fixings from a file of their own, so the body goes to an
 * object of its own. An empty body is written too, because a run whose run
 * document names the file must find it.
 */

/**
 * @brief The valuation date, as an ISO 8601 date, or empty for the whole stored history.
 *
 * A date adds one line for each datum, dated at it, with the value the datum had at the
 * close of that day, and the history of the other dates stays. The ticks of a live feed are
 * in that line. They are not in the history.
 */

/**
 * @brief The oldest value, in days before the valuation date, that the line of that date
 * may carry forward. Empty means the service default.
 *
 * A datum whose latest value is older than this has no line of its own at the date, so the
 * run does not use a stale quote as a current one. Its history lines stay. The answer counts
 * these datums.
 */

/**
 * @brief Where the fixings body was written.
 */

/**
 * @brief The datums whose line at the valuation date carries a value from an earlier day.
 */

/**
 * @brief The datums left out of the valuation date because their latest value is older
 * than the limit.
 */

/**
 * @brief The owning party to narrow to, or empty for every party the caller
 * can see.
 */

/**
 * @brief How many series were projected by this call.
 *
 * A series whose stored row already matched the fresh projection is not
 * counted: only the rows this call wrote are.
 */

/**
 * @brief How many current series already carried the projection this call
 * would write.
 */

/**
 * @brief How many of the projected series carried a URI neither codec reads.
 *
 * Their rows are written with their kind and no field value, so the series is
 * findable and never mistaken for one whose identity was read. The count is
 * what says how many identities the database could not state.
 */

/** The object, as the typed identity the reads take. */

/** The node: one coordinate per declared axis, in the shape's order. */

/** The value to key, as a number written in text. */

/** The change reason code that says why the point is keyed. */

/** The free-text reason for the correction. */

/** The object, as the typed identity the reads take. */

/** The node: one coordinate per declared axis, in the shape's order. */

/**
 * @brief The valuation date, as an ISO 8601 date, or empty for the whole stored history.
 *
 * A date adds one line for each datum, dated at it, with the value the datum had at the
 * close of that day, and the history of the other dates stays. The ticks of a live feed are
 * in that line. They are not in the history.
 */

/**
 * @brief The oldest value, in days before the valuation date, that the line of that date
 * may carry forward. Empty means the service default.
 *
 * A datum whose latest value is older than this has no line of its own at the date, so the
 * run does not use a stale quote as a current one. Its history lines stay. The answer counts
 * these datums.
 */

/**
 * @brief The market.txt body: one DATE<TAB>KEY<TAB>VALUE line per
 * observation, empty when the tenant has no observations.
 */

/**
 * @brief The fixings.txt body: one DATE<TAB>INDEX<TAB>VALUE line per
 * fixing, empty when the tenant has no fixings.
 */

/**
 * @brief The datums whose line at the valuation date carries a value from an earlier day.
 */

/**
 * @brief The datums left out of the valuation date because their latest value is older
 * than the limit.
 */

/** The quote URI of the datum observed, under the strict contract. */

/** The observed value as decimal text, so it keeps the producer's digits. */

/** When the value was observed. */

/** The producer, unique within a tenant; its routes name the consumers. */