Skip to content

Support per-side review metadata on alignment records #353

Description

@jonathanrobie

The spec currently defines meta on an alignment record as covering the link as a whole. A common review tool use case requires flagging potential discrepancies between the source and target sides — for example, where a source token's status and a target token's status appear inconsistent.

This is correctly modeled as a property of the link, not of either token in isolation: the source and target systems remain authoritative for their own data, but the alignment record is the right place to record a reviewer's assessment of the relationship between them.

Since meta is already extensible, no structural change is needed. We believe per-side metadata within meta was part of the original design intent, but there are currently no examples in the spec illustrating it. We propose adding examples using source and target keys:

{
  "source": ["n40001001001"],
  "target": ["40001001001"],
  "meta": {
    "origin": "manual",
    "status": "created",
    "source": { "flag": "unverified" },
    "target": { "flag": "possible-omission" }
  }
}

A review tool that does not assume source or target status is always correct can write its findings here without modifying either referenced system.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions