Skip to content

Commit

Permalink
add README for schemas
Browse files Browse the repository at this point in the history
  • Loading branch information
Sup2point0 committed May 15, 2024
1 parent cb52592 commit a06c4f5
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions resources/schemas/README.md
Original file line number Diff line number Diff line change
@@ -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/).


<br>


## 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. |

0 comments on commit a06c4f5

Please sign in to comment.