open5e / open5e-api

The api for open5e.com
Other
145 stars 91 forks source link

Document the primary key conventions #456

Open augustjohnson opened 1 month ago

augustjohnson commented 1 month ago

We need to include some documentation about primary keys, and adding data.

augustjohnson commented 1 month ago

primary key format:

= the pk of the document that this item is related to (must be only one). = the name of the object (must have a Name field) run through the django slugify method. = the related key for the parent object. For top level objects: (creatures, spells, feats, etc), the convention is: `_` For child objects (creature action, class feature, feat benefit), the convention is: `_` For child child objects (creature attack, class feature item), the convention is also: `_`