open5e/open5e-api

Document the primary key conventions

Closed this issue · 4 comments

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

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:
<document key>_<slugified name>
For child objects (creature action, class feature, feat benefit), the convention is:
<parent>_<slugified name>
For child child objects (creature attack, class feature item), the convention is also:
<parent>_<slugified name>

Documentation should continue, but the actual items have been converted.

Related to #405

Closed with #405