From a06c4f5f071ba4a16a00df6e7b684ca4c516dd6f Mon Sep 17 00:00:00 2001 From: "Sup#2.0" <102817779+Sup2point0@users.noreply.github.com> Date: Wed, 15 May 2024 12:31:10 +0000 Subject: [PATCH] add README for schemas --- resources/schemas/README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 resources/schemas/README.md diff --git a/resources/schemas/README.md b/resources/schemas/README.md new file mode 100644 index 0000000..e277a59 --- /dev/null +++ b/resources/schemas/README.md @@ -0,0 +1,16 @@ +# Victory Card Schemas + +These schemas define how *Victory!* cards should be represented in JSON for interaction with the [cards database API](../../create/). + + +
+ + +## Casing + +Particular casing styles are used for different attributes. + +| key nature | case | instance | notes | +| :--------- | :--- | :------- | :---- | +| in-game properties | `Single` | `Power` `Materials` | Capitalised for visual distinction from other JSON Schema keys. | +| enum values | `KEBAB-CAPS` | `CYBERNETIC` `UPGRADE` | Fully capitalised for consistency while retaining visual distinction from other values. |