momentry_core/deliverable_v1.1.0/modules/_template.md

{Module Name} — API Workspace Module

Use this template when adding or editing API endpoint documentation modules.

Module Metadata

Every module MUST start with:

<!-- module: <short_name> -->
<!-- description: One-line description of what this module covers -->
<!-- depends: <comma-separated list of dependency module names> -->

Endpoint Template

Each endpoint MUST use this structure:

METHOD /path/to/endpoint

Auth: Required / Optional / Public

Scope: file-level / identity-level / system-level

Request Parameters

Field	Type	Required	Default	Description
param1	string	Yes	—	Description

Example

# brief description of what this example demonstrates
curl -s -X METHOD "$API/path" \
  -H "X-API-Key: $KEY" \
  -H "Content-Type: application/json" \
  -d '{"param1": "value"}'

Response (200)

{ "success": true }

Field	Type	Description
success	boolean	Always true on 200

Error Codes

Code	HTTP	When
E0xx	4xx	Description

Rules

1. Each module file covers ONE topic group (e.g., 09_tmdb.md = all TMDb endpoints)
2. Use $API and $KEY in all curl examples
3. Use $FILE_UUID, $IDENTITY_UUID variables for UUID examples
4. Module filename = NN_topic.md (NN = execution order, 01-99)
5. depends metadata = which modules must be assembled before this one