fmea-api-mcp-server 1.1.46 → 1.1.48

package/endpoints/v2/fourm/core.json

@@ -7,13 +7,16 @@
       "path": "/api/v2/fourm",
       "method": "GET",
       "operationId": "list_8",
-      "summary": "List 4M analysis items",
-      "description": "Retrieves all 4M (Man, Machine, Material, Environment) analysis items with optional filtering. Supports querying by project ID (projectId) and single or double tags (tag, secondTag) for targeted searches. Use this endpoint to browse, filter, or search for existing 4M analysis records within a project context. Returns a comprehensive list of analysis entries that can be further processed or displayed.",
-      "tags": [],
+      "summary": "List 4M records",
+      "description": "Returns 4M cause records for a given project. Optionally filtered by function node ID (tag) and a secondary node ID (secondTag). Returns all records when no filter is specified.",
+      "tags": [
+        "4M"
+      ],
       "parameters": [
         {
           "name": "projectId",
           "in": "query",
+          "description": "Project ID to filter records",
           "schema": {
             "type": "string"
           }
@@ -21,6 +24,7 @@
         {
           "name": "tag",
           "in": "query",
+          "description": "Function node ID filter (tag)",
           "schema": {
             "type": "string"
           }
@@ -28,6 +32,7 @@
         {
           "name": "secondTag",
           "in": "query",
+          "description": "Secondary node ID filter (secondTag)",
           "schema": {
             "type": "string"
           }
@@ -50,19 +55,19 @@
                     "projectId": {
                       "type": "string"
                     },
-                    "tag": {
+                    "functionNodeId": {
                       "type": "string"
                     },
-                    "secondTag": {
+                    "secondNodeId": {
                       "type": "string"
                     },
                     "category": {
                       "type": "string",
                       "enum": [
-                        "Man",
-                        "Machine",
-                        "Material",
-                        "Environment"
+                        "MAN",
+                        "MACHINE",
+                        "MATERIAL",
+                        "ENVIRONMENT"
                       ]
                     },
                     "workElement": {
@@ -83,9 +88,11 @@
       "path": "/api/v2/fourm",
       "method": "POST",
       "operationId": "create_4",
-      "summary": "Create 4M analysis item",
-      "description": "Creates a new 4M (Man, Machine, Material, Environment) analysis item in the system. Accepts analysis data including categorization by the four M dimensions (Man/Personnel, Machine/Equipment, Material/Resources, Environment/Conditions). Use this endpoint to initiate a new 4M analysis, register factors for quality or risk assessment, or document production variables. Returns the complete created object with system-generated ID.",
-      "tags": [],
+      "summary": "Create a 4M record",
+      "description": "Creates a new 4M cause record with the provided fields. Returns the created record as a FourMDTO.",
+      "tags": [
+        "4M"
+      ],
       "parameters": [],
       "requestBody": {
         "content": {
@@ -96,19 +103,19 @@
                 "projectId": {
                   "type": "string"
                 },
-                "tag": {
+                "functionNodeId": {
                   "type": "string"
                 },
-                "secondTag": {
+                "secondNodeId": {
                   "type": "string"
                 },
                 "category": {
                   "type": "string",
                   "enum": [
-                    "Man",
-                    "Machine",
-                    "Material",
-                    "Environment"
+                    "MAN",
+                    "MACHINE",
+                    "MATERIAL",
+                    "ENVIRONMENT"
                   ]
                 },
                 "workElement": {
@@ -136,19 +143,19 @@
                   "projectId": {
                     "type": "string"
                   },
-                  "tag": {
+                  "functionNodeId": {
                     "type": "string"
                   },
-                  "secondTag": {
+                  "secondNodeId": {
                     "type": "string"
                   },
                   "category": {
                     "type": "string",
                     "enum": [
-                      "Man",
-                      "Machine",
-                      "Material",
-                      "Environment"
+                      "MAN",
+                      "MACHINE",
+                      "MATERIAL",
+                      "ENVIRONMENT"
                     ]
                   },
                   "workElement": {
@@ -168,13 +175,16 @@
       "path": "/api/v2/fourm/{id}",
       "method": "GET",
       "operationId": "get_2",
-      "summary": "Get 4M analysis item by ID",
-      "description": "Retrieves a specific 4M analysis item by its unique identifier (id). Use this endpoint to fetch full details of an existing analysis record for viewing, editing preparation, or detailed examination. Returns complete object including all four M dimensions (Man, Machine, Material, Environment) and associated metadata. Ideal for drill-down operations, detailed inspection, or populating edit forms.",
-      "tags": [],
+      "summary": "Get a 4M record by ID",
+      "description": "Returns a single 4M cause record by its numeric ID. Throws 404 if the record does not exist.",
+      "tags": [
+        "4M"
+      ],
       "parameters": [
         {
           "name": "id",
           "in": "path",
+          "description": "4M record ID",
           "required": true,
           "schema": {
             "type": "integer",
@@ -197,19 +207,19 @@
                   "projectId": {
                     "type": "string"
                   },
-                  "tag": {
+                  "functionNodeId": {
                     "type": "string"
                   },
-                  "secondTag": {
+                  "secondNodeId": {
                     "type": "string"
                   },
                   "category": {
                     "type": "string",
                     "enum": [
-                      "Man",
-                      "Machine",
-                      "Material",
-                      "Environment"
+                      "MAN",
+                      "MACHINE",
+                      "MATERIAL",
+                      "ENVIRONMENT"
                     ]
                   },
                   "workElement": {
@@ -229,13 +239,16 @@
       "path": "/api/v2/fourm/{id}",
       "method": "PUT",
       "operationId": "update_3",
-      "summary": "Update 4M analysis item",
-      "description": "Modifies an existing 4M analysis item identified by its ID. Accepts partial or complete updates to the analysis data including changes to categorization, descriptions, or any of the four M dimensions (Man, Machine, Material, Environment). Use this endpoint to correct, enhance, or evolve analysis records over time. Returns the updated object reflecting all changes applied.",
-      "tags": [],
+      "summary": "Update a 4M record",
+      "description": "Updates an existing 4M cause record by its numeric ID. Returns the updated record as a FourMDTO.",
+      "tags": [
+        "4M"
+      ],
       "parameters": [
         {
           "name": "id",
           "in": "path",
+          "description": "4M record ID to update",
           "required": true,
           "schema": {
             "type": "integer",
@@ -252,10 +265,10 @@
                 "category": {
                   "type": "string",
                   "enum": [
-                    "Man",
-                    "Machine",
-                    "Material",
-                    "Environment"
+                    "MAN",
+                    "MACHINE",
+                    "MATERIAL",
+                    "ENVIRONMENT"
                   ]
                 },
                 "workElement": {
@@ -283,19 +296,19 @@
                   "projectId": {
                     "type": "string"
                   },
-                  "tag": {
+                  "functionNodeId": {
                     "type": "string"
                   },
-                  "secondTag": {
+                  "secondNodeId": {
                     "type": "string"
                   },
                   "category": {
                     "type": "string",
                     "enum": [
-                      "Man",
-                      "Machine",
-                      "Material",
-                      "Environment"
+                      "MAN",
+                      "MACHINE",
+                      "MATERIAL",
+                      "ENVIRONMENT"
                     ]
                   },
                   "workElement": {
@@ -315,13 +328,16 @@
       "path": "/api/v2/fourm/{id}",
       "method": "DELETE",
       "operationId": "delete_3",
-      "summary": "Delete 4M analysis item",
-      "description": "Permanently removes a 4M analysis item from the system using its unique identifier. This operation is irreversible and will eliminate all associated data including the four M dimension classifications (Man, Machine, Material, Environment). Use with caution for removing obsolete or incorrect analysis records. Returns no content upon successful deletion (204 status).",
-      "tags": [],
+      "summary": "Delete a 4M record",
+      "description": "Deletes a 4M cause record by its numeric ID. Returns HTTP 204 No Content on success.",
+      "tags": [
+        "4M"
+      ],
       "parameters": [
         {
           "name": "id",
           "in": "path",
+          "description": "4M record ID to delete",
           "required": true,
           "schema": {
             "type": "integer",

package/endpoints/v2/high-items/core.json

@@ -16,6 +16,7 @@
         {
           "name": "projectId",
           "in": "path",
+          "description": "Project ID whose high items to update",
           "required": true,
           "schema": {
             "type": "string"

package/endpoints/v2/projects/core.json

@@ -16,9 +16,15 @@
         {
           "name": "scope",
           "in": "query",
-          "description": "Scope: my (default), division, all (admin only)",
+          "description": "Search scope (default: my)",
           "schema": {
-            "type": "string"
+            "type": "string",
+            "enum": [
+              "MY",
+              "DIVISION",
+              "ALL"
+            ],
+            "default": "my"
           }
         },
         {
@@ -67,9 +73,17 @@
         {
           "name": "fmeaType",
           "in": "query",
-          "description": "FMEA type filter (DESIGN, PROCESS, EQUIPMENT, FA, FTA, CPLAN)",
+          "description": "FMEA type filter",
           "schema": {
-            "type": "string"
+            "type": "string",
+            "enum": [
+              "DESIGN",
+              "PROCESS",
+              "EQUIPMENT",
+              "FA",
+              "FTA",
+              "CPLAN"
+            ]
           }
         },
         {
@@ -77,7 +91,20 @@
           "in": "query",
           "description": "Project status filter",
           "schema": {
-            "type": "string"
+            "type": "string",
+            "enum": [
+              "IN_PROGRESS",
+              "REFUSED",
+              "SELF_COMPLETED",
+              "REVIEW",
+              "APPROVE",
+              "SCORE",
+              "COMPLETED",
+              "ASK_MODIFY_REVIEW",
+              "ASK_MODIFY_APPROVE",
+              "DELAY",
+              "NA"
+            ]
           }
         },
         {
@@ -220,7 +247,7 @@
       "method": "GET",
       "operationId": "get_3",
       "summary": "Get project details",
-      "description": "Fetches complete project information including metadata, configuration, and current status. Use this endpoint to retrieve detailed project data for viewing, editing, or auditing purposes. Supports retrieving any project the authenticated user has access to.",
+      "description": "Returns the full project details for the given project ID. Throws 404 if the project does not exist.",
       "tags": [
         "Project"
       ],
@@ -425,9 +452,17 @@
         {
           "name": "fmeaType",
           "in": "query",
-          "description": "FMEA type filter (DESIGN, PROCESS, EQUIPMENT, FA, FTA, CPLAN)",
+          "description": "FMEA type filter",
           "schema": {
-            "type": "string"
+            "type": "string",
+            "enum": [
+              "DESIGN",
+              "PROCESS",
+              "EQUIPMENT",
+              "FA",
+              "FTA",
+              "CPLAN"
+            ]
           }
         },
         {
@@ -435,7 +470,20 @@
           "in": "query",
           "description": "Project status filter",
           "schema": {
-            "type": "string"
+            "type": "string",
+            "enum": [
+              "IN_PROGRESS",
+              "REFUSED",
+              "SELF_COMPLETED",
+              "REVIEW",
+              "APPROVE",
+              "SCORE",
+              "COMPLETED",
+              "ASK_MODIFY_REVIEW",
+              "ASK_MODIFY_APPROVE",
+              "DELAY",
+              "NA"
+            ]
           }
         },
         {
@@ -579,7 +627,7 @@
       "method": "GET",
       "operationId": "getSummary",
       "summary": "Get project summary",
-      "description": "Fetches a condensed overview of project information including key metrics, status, and essential metadata. Use this for quick project previews, dashboard widgets, or when full project details are not required. Optimized for performance with minimal data transfer.",
+      "description": "Returns a lightweight summary of a project including key metrics. Throws 404 if the project does not exist.",
       "tags": [
         "Project"
       ],
@@ -705,15 +753,6 @@
           "schema": {
             "type": "string"
           }
-        },
-        {
-          "name": "useSynonym",
-          "in": "query",
-          "description": "Whether to expand q with synonym dictionary terms (default: true)",
-          "schema": {
-            "type": "boolean",
-            "default": true
-          }
         }
       ],
       "responses": {
@@ -791,7 +830,7 @@
       "method": "GET",
       "operationId": "getJoinRequestsByProjectId",
       "summary": "List project join requests",
-      "description": "Fetches all pending join requests for a specific project. Use this endpoint to review, approve, or reject users requesting access to the project. Requires project member role. Returns request details including requester information, request status, and timestamps for workflow management.",
+      "description": "Returns all pending and processed join requests for a project. Requires at least MEMBER role in the project.",
       "tags": [
         "Project"
       ],
@@ -952,7 +991,7 @@
       "method": "POST",
       "operationId": "createJoinRequest",
       "summary": "Create a project join request",
-      "description": "Submits a new request to join a project. Use this endpoint when a user wants to request access to a restricted project. The request will be reviewed by existing project members who can approve or reject it. Requires no existing project membership. Returns the created request ID for tracking.",
+      "description": "Creates a join request for the authenticated user to join the specified project. Requires the user to not already be a member (NONE role). Returns the created request ID and a Location header.",
       "tags": [
         "Project"
       ],
@@ -995,7 +1034,7 @@
       "method": "PUT",
       "operationId": "updateJoinRequests",
       "summary": "Approve or reject project join requests in batch",
-      "description": "Batch updates multiple join requests simultaneously to approve or reject project access requests. Use this endpoint for efficient workflow management when processing multiple pending requests at once. Requires project member role. Accepts a list of request IDs with their approval status and optional messages.",
+      "description": "Processes multiple join requests in a single call by approving or rejecting them. Requires at least MEMBER role in the project.",
       "tags": [
         "Project"
       ],
@@ -1052,7 +1091,7 @@
       "method": "PUT",
       "operationId": "updateJoinRequest",
       "summary": "Approve or reject a project join request",
-      "description": "Updates a specific join request to approve or reject a user's project access request. Use this endpoint for individual request processing when you need to review and respond to one request at a time. Requires project member role. Supports approval with optional response messages or rejection with reasons.",
+      "description": "Processes a single join request by approving or rejecting it. Requires at least MEMBER role in the project.",
       "tags": [
         "Project"
       ],
@@ -1116,6 +1155,7 @@
         {
           "name": "projectId",
           "in": "path",
+          "description": "Project ID whose high items to list",
           "required": true,
           "schema": {
             "type": "string"
@@ -1124,7 +1164,7 @@
         {
           "name": "q",
           "in": "query",
-          "description": "Unified keyword for high-item titles",
+          "description": "Keyword filter for high-item titles (optional)",
           "schema": {
             "type": "string"
           }
@@ -1174,7 +1214,7 @@
       "method": "PATCH",
       "operationId": "patchProject",
       "summary": "Partially update project details",
-      "description": "",
+      "description": "Applies partial updates to a project using the PATCH method. Only provided fields are updated; omitted fields remain unchanged. Returns the updated project details.",
       "tags": [
         "Project"
       ],
@@ -1372,11 +1412,14 @@
       "operationId": "refreshWorksheetSnapshot",
       "summary": "Refresh worksheet dashboard snapshots",
       "description": "Manually refreshes worksheet dashboard snapshots. If divisionId is specified, only that division is refreshed; otherwise all cached divisions are refreshed sequentially. Divisions already being refreshed are skipped. Executes synchronously and returns the result after completion.",
-      "tags": [],
+      "tags": [
+        "Admin - Dashboard"
+      ],
       "parameters": [
         {
           "name": "divisionId",
           "in": "query",
+          "description": "Division ID to refresh; if omitted, all cached divisions are refreshed",
           "schema": {
             "type": "integer",
             "format": "int32"

package/endpoints/v2/recommendation-items/core.json

@@ -24,9 +24,17 @@
         {
           "name": "status",
           "in": "query",
-          "description": "Recommended action status filter (NotCompleted|In-Progress|Delay|Completed|All)",
+          "description": "Recommended action status filter",
           "schema": {
-            "type": "string"
+            "type": "string",
+            "enum": [
+              "NOT_COMPLETED",
+              "IN_PROGRESS",
+              "DELAY",
+              "COMPLETED",
+              "ALL"
+            ],
+            "default": "All"
           }
         },
         {
@@ -49,9 +57,14 @@
         {
           "name": "scope",
           "in": "query",
-          "description": "Search scope: 'my' (default, user's projects), 'division' (requires divisionId), 'all' (all projects)",
+          "description": "Search scope (default: my)",
           "schema": {
             "type": "string",
+            "enum": [
+              "MY",
+              "DIVISION",
+              "ALL"
+            ],
             "default": "my"
           }
         },