互換性

このドキュメントで公開しているスキーマは、集計の前提として使えるように整備しています。 ただし、Codatum の機能が増えるにつれてイベントの定義も増えていきます。 そのため定義の変更は、すでに組まれた集計への影響を抑える形で行います。

取り込む側での前提

新しいイベント、enum の新しい値、新しいフィールドは、予告なく追加されることがあります。 取り込む側では、未知のイベントコード・enum 値・フィールドを無視して動作するように実装してください。

あわせて、次の点には依存しないでください。

• フィールドの並び順
• 任意フィールドのキーの有無（値がない場合、キーごと省略されることがあります）
• イベント1件が届く回数（同じイベントが重複して届いた場合は、event.uid で判別できます）

イベントのステータス

各イベントはステータスを持ち、仕様がどの程度確定しているかを表します。

ステータス	定義	集計での扱い
準備中	仕様検討中で、ログには出力されません	取り込めません
プレビュー	仕様が未確定で、予告なく変更される可能性があります	集計の前提にはできません
安定	仕様が確定しています	集計の前提にできます
非推奨	廃止予定で、将来的にログには出力されなくなります	移行の準備が必要です
廃止済	廃止済で、ログには出力されません	出力されません

ステータスは「準備中 → プレビュー → 安定 → 非推奨 → 廃止済」の順に進みます。

定義の変更方針

安定 のイベントに対する変更は、要素を足す方向で行います。

• フィールドや enum 値の追加は、既存の集計を壊さないため、予告なく行うことがあります
• 名前・型・意味の変更は行いません。意味を変える必要が生じた場合は、新しい名前で追加し、 従来のものを 非推奨 にします

プレビュー のイベントは、この方針の対象外です。

フィールドの削除や名前の変更を含めて、予告なく変更されることがあります。

なお、セキュリティや法令上の理由など、やむを得ない場合には、上記によらない変更をすることがあります。