codeforjapan / OPEN-EATS-JAPAN

This repo will be archived 🗄️ in the future
16 stars 1 forks source link

バージョニングを実施し、メタデータを付与したい #2

Open ryo-a opened 4 years ago

ryo-a commented 4 years ago

現在検討中のデータは初版であり、将来的には利用者が増加するにつれて様々な改良が加えられうると想定されます。

そうした場合、「内部的にはデータフォーマットのバージョン・形式が変わるなどしているが、データから即座に判断することができないため、データを読み取るアプリケーション側でのロジックが複雑になる」といった問題が生じることがあります。

例えば交通データのGTFS-JPでは、必須とされるフィールドがバージョンによって異なるといった差異が生じています。 参考: https://github.com/gtfs-jp/GTFS-JP-web/issues/25 これではvalidationをする際にも不便だと言えるでしょう。

GTFS-JPでの例を他山の石として、「このデータはOPEN EATS JAPAN ver xに基づいている」といったメタデータを付与できる構成にしたいです。

OPEN EATS JAPANは強い制約を設けるデータ形式というより、各飲食店や入力者などに記載内容を委ねる「ゆるい標準化」に近いと認識しています。内容の自由度・拡張性が高いからこそ、メタデータといった「土台」の部分はカッチリとしているべきだと考えています。