Creating documentation

2026-01-20 14:06:31 -06:00
parent faa9a5e9d5
commit d003f67273
9 changed files with 155 additions and 9 deletions
@@ -0,0 +1,23 @@
+# CharacterApi document shapes
+
+This service expects JSON request bodies for character creation and stores
+character documents in MongoDB.
+
+Inbound JSON documents
+- CreateCharacterRequest (`POST /api/characters`)
+  ```json
+  {
+    "name": "string"
+  }
+  ```
+
+Stored documents (MongoDB)
+- Character
+  ```json
+  {
+    "id": "string (ObjectId)",
+    "ownerUserId": "string",
+    "name": "string",
+    "createdUtc": "string (ISO-8601 datetime)"
+  }
+  ```
@@ -0,0 +1,9 @@
+# CharacterApi
+
+## Document shapes
+See `DOCUMENTS.md` for request payloads and stored document shapes.
+
+## Endpoints
+- `POST /api/characters` Create a character.
+- `GET /api/characters` List characters for the current user.
+- `DELETE /api/characters/{id}` Delete a character owned by the current user.