docs: service docstrings

Issue: #13
2026-05-28 14:41:11 +01:00 · 2026-05-28 14:41:11 +01:00 · d852bda091
commit d852bda091
parent 71f26a4c9b
9 changed files with 24 additions and 47 deletions
--- a/src/service/schemas.py
+++ b/src/service/schemas.py
@ -1,9 +1,10 @@
 """
-Pydantic models for the service module
+Pydantic models for service 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 "ServiceGetServiceResponse"
 """
 from pydantic import ConfigDict