starlinglab / integrity-schema

Schemas for authenticated metadata used in the Starling Integrity framework.
MIT License
0 stars 2 forks source link

Document schemas used in Integrity Backend #12

Open benhylau opened 1 year ago

benhylau commented 1 year ago

Standardize and document schemas in: https://github.com/starlinglab/integrity-schema/tree/main/integrity-backend

Create a README.md that standardizes keys in each:

Whether each of these input types have specific keys inside of their extras and private bundles, and what is in extras vs. private:

We can start with one README.md at this folder level and think about README in each input type if necessary.

benhylau commented 1 year ago

The results of this need to be incorporated in this documentation.

benhylau commented 1 year ago

Once this is done, I'd like to reference the standardized schema in https://github.com/starlinglab/integrity-backend/pull/123/files (right now I am just referring to the examples which is non-ideal)

galargh commented 1 year ago

ETA: 2022-12-06

galargh commented 1 year ago

I put together the v0 for this in https://github.com/starlinglab/integrity-schema/pull/14.