docs: org docstrings

issue: #13
2026-05-28 14:23:36 +01:00 · 2026-05-28 14:23:36 +01:00 · 33e78d4a9b
commit 33e78d4a9b
parent 82c2b13a7f
9 changed files with 37 additions and 50 deletions
--- a/src/organisation/schemas.py
+++ b/src/organisation/schemas.py
@ -1,9 +1,10 @@
 """
 Pydantic models for organisation module

-Models:
- - List: Description
- - Models: Description
+Models follow the nomenclature of:
+- Sub-models: "<Resource><Opt:>Schema"
+- Mixins: "<Attribute>Mixin"
+- Models: "<Module><Method><Resource><Opt:Resource><Direction>" ie "OrgPostOrgRequest"
 """
 from typing import Optional