fmea-api-mcp-server 1.1.2 → 1.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/endpoints/README.md +19 -1
- package/package.json +1 -1
package/endpoints/README.md
CHANGED
|
@@ -18,6 +18,16 @@ endpoints/
|
|
|
18
18
|
└── ...
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
+
### Classification Rules
|
|
22
|
+
|
|
23
|
+
To prevent ambiguity, follow these classification principles:
|
|
24
|
+
|
|
25
|
+
- **Domain Specific**: If an endpoint operates *within the context* of a specific resource (e.g., "Export THIS resource's sub-data"), place it under that resource's directory.
|
|
26
|
+
- Example: `/api/v2/main-resources/{id}/sub-feature` -> `endpoints/v2/main-resources/sub-feature.json`
|
|
27
|
+
|
|
28
|
+
- **Global / Utility**: If an endpoint is a generic utility or operates independently of other resources (e.g., "Process ANY file"), create a dedicated top-level resource directory.
|
|
29
|
+
- Example: `/api/v2/standalone-feature` -> `endpoints/v2/standalone-feature/core.json`
|
|
30
|
+
|
|
21
31
|
### Rules
|
|
22
32
|
|
|
23
33
|
1. **Directory Required**: Every resource (e.g., `projects`, `users`) MUST be a directory, even if it only contains one file.
|
|
@@ -27,7 +37,15 @@ endpoints/
|
|
|
27
37
|
- `category`: String (Resource category name)
|
|
28
38
|
- `version`: String ("v1" or "v2")
|
|
29
39
|
- `description`: String (Resource description)
|
|
30
|
-
- `endpoints`: Array of endpoint objects.
|
|
40
|
+
- `endpoints`: Array of endpoint objects. Each object MUST contain:
|
|
41
|
+
- `path`: String (URI path)
|
|
42
|
+
- `method`: String (HTTP method)
|
|
43
|
+
- `summary`: String (Short summary)
|
|
44
|
+
- `description`: String (Detailed description)
|
|
45
|
+
- `tags`: Array of Strings
|
|
46
|
+
- `operationId`: String (Unique identifier)
|
|
47
|
+
- `parameters`: Array (Optional parameters)
|
|
48
|
+
- `responses`: Object (Response definitions)
|
|
31
49
|
|
|
32
50
|
### Example
|
|
33
51
|
|