fmea-api-mcp-server 1.1.46 → 1.1.48

package/endpoints/v2/search/core.json

@@ -24,9 +24,15 @@
         {
           "name": "scope",
           "in": "query",
-          "description": "Search scope: 'my' (default), 'division', 'all'",
+          "description": "Search scope (default: my)",
           "schema": {
-            "type": "string"
+            "type": "string",
+            "enum": [
+              "MY",
+              "DIVISION",
+              "ALL"
+            ],
+            "default": "my"
           }
         },
         {
@@ -48,17 +54,38 @@
         {
           "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"
+            ]
           }
         },
         {
           "name": "status",
           "in": "query",
-          "description": "Project status filter: In-Progress|Completed|Review|etc.",
+          "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"
+            ]
           }
         },
         {
@@ -136,11 +163,11 @@
                         "blockType": {
                           "type": "string",
                           "enum": [
-                            "Function",
-                            "Structure",
-                            "FunctionStructure",
-                            "StructureFunction",
-                            "Process"
+                            "FMM_FUNCTION",
+                            "FMM_STRUCTURE",
+                            "FMM_FUNCTION_STRUCTURE",
+                            "FMM_STRUCTURE_FUNCTION",
+                            "FMM_PROCESS"
                           ]
                         },
                         "blockNodeId": {
@@ -152,10 +179,7 @@
                         "fmmDiagramType": {
                           "type": "string",
                           "enum": [
-                            "UNUSED",
-                            "NOT_SELECTED",
-                            "TYPE_A",
-                            "TYPE_C"
+                            "UNUSED"
                           ]
                         },
                         "complete": {
@@ -263,9 +287,15 @@
         {
           "name": "scope",
           "in": "query",
-          "description": "Search scope: 'my' (default), 'division', 'all'",
+          "description": "Search scope (default: my)",
           "schema": {
-            "type": "string"
+            "type": "string",
+            "enum": [
+              "MY",
+              "DIVISION",
+              "ALL"
+            ],
+            "default": "my"
           }
         },
         {
@@ -287,25 +317,51 @@
         {
           "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"
+            ]
           }
         },
         {
           "name": "status",
           "in": "query",
-          "description": "Project status filter: In-Progress|Completed|Review",
+          "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"
+            ]
           }
         },
         {
           "name": "tag",
           "in": "query",
-          "description": "Project tag filter: NORMAL|MASTER|REFERENCE",
+          "description": "Project tag filter",
           "schema": {
-            "type": "string"
+            "type": "string",
+            "enum": [
+              "NORMAL",
+              "MASTER",
+              "REFERENCE"
+            ]
           }
         },
         {
@@ -383,9 +439,13 @@
         {
           "name": "groupBy",
           "in": "query",
-          "description": "Group by: 'division' or 'item'. When specified, returns grouped response without paging.",
+          "description": "Group by field. When specified, returns grouped response without paging.",
           "schema": {
-            "type": "string"
+            "type": "string",
+            "enum": [
+              "DIVISION",
+              "ITEM"
+            ]
           }
         },
         {
@@ -607,9 +667,15 @@
         {
           "name": "scope",
           "in": "query",
-          "description": "Search scope: 'my' (default), 'division', 'all'",
+          "description": "Search scope (default: my)",
           "schema": {
-            "type": "string"
+            "type": "string",
+            "enum": [
+              "MY",
+              "DIVISION",
+              "ALL"
+            ],
+            "default": "my"
           }
         },
         {
@@ -631,25 +697,51 @@
         {
           "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"
+            ]
           }
         },
         {
           "name": "status",
           "in": "query",
-          "description": "Project status filter: In-Progress|Completed|Review",
+          "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"
+            ]
           }
         },
         {
           "name": "tag",
           "in": "query",
-          "description": "Project tag filter: NORMAL|MASTER|REFERENCE",
+          "description": "Project tag filter",
           "schema": {
-            "type": "string"
+            "type": "string",
+            "enum": [
+              "NORMAL",
+              "MASTER",
+              "REFERENCE"
+            ]
           }
         },
         {

package/endpoints/v2/system/core.json

@@ -6,17 +6,24 @@
     {
       "path": "/api/v2/open/metrics/{apType}/constants",
       "method": "GET",
-      "summary": "Get metric constants",
-      "description": "Retrieves metric scoring constants (Severity, Occurrence, Detection, Action Priorities) for the specified Analysis Type. Supports two FMEA methodologies: 'aiag' (AIAG/VDA standard) and 'msr' (Machinery Safety Regulation). Use this endpoint to fetch valid rating scales and calculation parameters required for risk assessment analysis. Commonly used when initializing FMEA worksheets, validating metric values, or configuring dropdown options. The {apType} parameter is case-insensitive but must match supported types. Returns 400 error if type is invalid.",
-      "tags": [],
+      "summary": "Get metric constants for an AP type",
+      "description": "Returns severity, occurrence, and detection metric constants for the given action priority type (AIAG or MSR). Used to populate evaluation criteria dropdowns and compute RPN values. This endpoint is open and does not require authentication.",
+      "tags": [
+        "Metrics"
+      ],
       "operationId": "getMetricConstants",
       "parameters": [
         {
           "name": "apType",
           "in": "path",
+          "description": "Action priority type",
           "required": true,
           "schema": {
-            "type": "string"
+            "type": "string",
+            "enum": [
+              "AIAG",
+              "MSR"
+            ]
           }
         }
       ],
@@ -33,14 +40,17 @@
     {
       "path": "/api/v2/system/context-version",
       "method": "GET",
-      "summary": "Get Context Version",
-      "description": "Fetches the current application version, deployment semantic tag, and build metadata associated with the specific API context path. Historically replaces legacy health-check endpoints. Use this modern endpoint to verify proper API deployment, check version compatibility before complex operations, or display software version in the UI footer. (Check Version / Get Release Tag / Context Information / API Revision).",
-      "tags": [],
+      "summary": "Get version info for a deployed web application context",
+      "description": "Reads the VERSION file from the given Tomcat webapp sub-path and returns the version string and build date. Returns 400 if contextPath is missing, 404 if the VERSION file does not exist or is unreadable.",
+      "tags": [
+        "System"
+      ],
       "operationId": "checkContext",
       "parameters": [
         {
           "name": "contextPath",
           "in": "query",
+          "description": "Tomcat webapp sub-path to read the VERSION file from (e.g. 'fmea-frontend'). Leading slashes are stripped.",
           "schema": {
             "type": "string"
           }
@@ -59,9 +69,11 @@
     {
       "path": "/api/v2/system/health",
       "method": "GET",
-      "summary": "System Health",
-      "description": "Performs a lightweight diagnostic check and retrieves the basic operational health status of the FMEA system. Use this endpoint for load balancer pinging, uptime monitoring services (e.g., Datadog, Pingdom), or ensuring backend connectivity before user authentication. Returns a simple success payload if the core services and database connections are operational. (Health Check / System Status / Ping API / Service Heartbeat).",
-      "tags": [],
+      "summary": "Health check",
+      "description": "Returns the current server status and UTC timestamp. Always returns HTTP 200 with status='UP' when the application is running. No authentication required.",
+      "tags": [
+        "System"
+      ],
       "operationId": "health",
       "parameters": [],
       "requestBody": null,

package/endpoints/v2/system-definition/core.json

@@ -25,15 +25,21 @@
         {
           "name": "scope",
           "in": "query",
-          "description": "Condition scope (owned|candidate|all). If omitted, defaults to all.",
+          "description": "Condition scope filter. If omitted, defaults to all.",
           "schema": {
-            "type": "string"
+            "type": "string",
+            "enum": [
+              "OWNED",
+              "CANDIDATE",
+              "ALL"
+            ],
+            "default": "all"
           }
         },
         {
           "name": "type",
           "in": "query",
-          "description": "Condition type (stress|design|process). If omitted, returns all types.",
+          "description": "Condition type filter. If omitted, returns all types.",
           "schema": {
             "type": "string",
             "enum": [

package/endpoints/v2/system-definition-excel/core.json

@@ -25,7 +25,7 @@
         {
           "name": "type",
           "in": "query",
-          "description": "Condition type (stress|design|process)",
+          "description": "Condition type",
           "required": true,
           "schema": {
             "type": "string",

package/endpoints/v2/templates/core.json

@@ -9,7 +9,9 @@
       "operationId": "getAll_1",
       "summary": "Get all action statuses",
       "description": "Returns all action status items. Used for populating action status dropdowns in worksheets.",
-      "tags": [],
+      "tags": [
+        "Template"
+      ],
       "parameters": [],
       "responses": {
         "default": {
@@ -41,7 +43,9 @@
       "operationId": "create_7",
       "summary": "Create action status",
       "description": "Creates a new action status. Returns 201 with Location header. Requires ADMIN role. Throws 409 if title already exists.",
-      "tags": [],
+      "tags": [
+        "Template"
+      ],
       "parameters": [],
       "requestBody": {
         "content": {
@@ -77,7 +81,9 @@
       "operationId": "getById_1",
       "summary": "Get action status by ID",
       "description": "Returns a single action status by ID. Returns 404 if not found.",
-      "tags": [],
+      "tags": [
+        "Template"
+      ],
       "parameters": [
         {
           "name": "id",
@@ -116,7 +122,9 @@
       "operationId": "update_6",
       "summary": "Update action status",
       "description": "Updates an existing action status title. Returns updated DTO. Requires ADMIN role. Throws 404 if not found, 409 if title conflicts.",
-      "tags": [],
+      "tags": [
+        "Template"
+      ],
       "parameters": [
         {
           "name": "id",
@@ -162,7 +170,9 @@
       "operationId": "delete_6",
       "summary": "Delete action status",
       "description": "Deletes an action status by ID. Returns 204 No Content. Requires ADMIN role. Throws 404 if not found.",
-      "tags": [],
+      "tags": [
+        "Template"
+      ],
       "parameters": [
         {
           "name": "id",

package/endpoints/v2/tree-search/core.json

@@ -32,9 +32,9 @@
                 "queryMode": {
                   "type": "string",
                   "enum": [
-                    "referenceNode",
-                    "anchorPattern",
-                    "contextCompletion"
+                    "REFERENCE_NODE",
+                    "ANCHOR_PATTERN",
+                    "CONTEXT_COMPLETION"
                   ]
                 },
                 "query": {
@@ -270,7 +270,7 @@
       "method": "POST",
       "operationId": "rebuild",
       "summary": "Rebuild tree search index",
-      "description": "Triggers an asynchronous full rebuild (reindex) of the Lucene tree search index for the specified domain. Use this to reindex or regenerate the search index data. Requires ADMIN privileges. Returns 202 if rebuild started, 409 if already in progress.",
+      "description": "Triggers an asynchronous full rebuild of the Lucene tree search index for the specified domain. Requires ADMIN privileges. Returns 202 if rebuild started, 409 if already in progress.",
       "tags": [
         "Tree Search"
       ],

package/endpoints/v2/users/core.json

@@ -21,15 +21,6 @@
             "type": "string"
           }
         },
-        {
-          "name": "useSynonym",
-          "in": "query",
-          "description": "Whether to expand q with synonym dictionary terms (default: true)",
-          "schema": {
-            "type": "boolean",
-            "default": true
-          }
-        },
         {
           "name": "dept",
           "in": "query",

package/endpoints/v2/worksheet-templates/core.json

@@ -9,11 +9,14 @@
       "operationId": "get_7",
       "summary": "Get worksheet template",
       "description": "Returns a worksheet template. When search is provided, template headers are keyword-filtered.",
-      "tags": [],
+      "tags": [
+        "Worksheet Templates"
+      ],
       "parameters": [
         {
           "name": "id",
           "in": "path",
+          "description": "Worksheet template ID",
           "required": true,
           "schema": {
             "type": "integer",
@@ -158,14 +161,24 @@
       "operationId": "list_13",
       "summary": "List worksheet templates",
       "description": "Returns worksheet templates filtered by FMEA type. When fmeaType is omitted, returns all templates for Design, Process, Equipment, and FA types, ordered by type and template order.",
-      "tags": [],
+      "tags": [
+        "Worksheet Templates"
+      ],
       "parameters": [
         {
           "name": "fmeaType",
           "in": "query",
-          "description": "FMEA type filter (Design|Process|Equipment|FA). Omit for all types.",
+          "description": "FMEA type filter. Omit for all types.",
           "schema": {
-            "type": "string"
+            "type": "string",
+            "enum": [
+              "DESIGN",
+              "PROCESS",
+              "EQUIPMENT",
+              "FA",
+              "FTA",
+              "CPLAN"
+            ]
           }
         }
       ],

package/endpoints/v2/worksheets/core.json

@@ -6,13 +6,16 @@
     {
       "path": "/api/v2/projects/{projectId}/worksheets",
       "method": "GET",
-      "summary": "Get worksheet summaries",
-      "description": "Retrieves a list of all worksheet summaries within a project. This endpoint provides a high-level overview (summary/directory) of available worksheets, excluding detailed content. Use this to browse, list, or enumerate worksheets before fetching specific worksheet details. The response contains basic metadata such as report numbers and titles. Ideal for dashboard views, worksheet selection interfaces, or getting a quick inventory of all worksheets in a project. No authentication required for read access.",
-      "tags": [],
+      "summary": "List worksheet summaries for a project",
+      "description": "Returns summary information for all worksheets belonging to the given project. Each summary includes the report number, title, and status. Requires NORMAL user level.",
+      "tags": [
+        "Worksheet"
+      ],
       "parameters": [
         {
           "name": "projectId",
           "in": "path",
+          "description": "Project ID to list worksheets for",
           "required": true,
           "schema": {
             "type": "string"
@@ -118,13 +121,16 @@
     {
       "path": "/api/v2/projects/{projectId}/worksheets",
       "method": "POST",
-      "summary": "Create worksheet",
-      "description": "Creates a new worksheet within the specified project. Use this endpoint to initialize a blank worksheet, set up a new analysis document, or establish a fresh worksheet structure. The request accepts worksheet creation parameters via WorksheetCreationDTO. Upon successful creation, returns the report number (reportNoSimple) of the newly created worksheet. Requires NORMAL user level and PROJECT MEMBER role. This is the initiating action for any worksheet-based workflow. Common use cases include: starting a new FMEA analysis, creating additional worksheets for different subsystems, or generating worksheet templates.",
-      "tags": [],
+      "summary": "Create a new worksheet in a project",
+      "description": "Creates a new worksheet under the given project using the provided creation DTO. Returns HTTP 201 Created with a Location header pointing to the new worksheet. Requires NORMAL user level and project MEMBER role.",
+      "tags": [
+        "Worksheet"
+      ],
       "parameters": [
         {
           "name": "projectId",
           "in": "path",
+          "description": "Project ID to create the worksheet under",
           "required": true,
           "schema": {
             "type": "string"
@@ -177,13 +183,16 @@
     {
       "path": "/api/v2/projects/{projectId}/worksheets/{reportNoSimple}",
       "method": "GET",
-      "summary": "Get worksheet by report number",
-      "description": "Fetches the complete details of a specific worksheet identified by its report number. The reportNoSimple parameter accepts formats like '3' or '3-1' (handling sub-worksheets via ReportNoSetDTO). Returns the full worksheet data including all rows, columns, headers, and cell values. Use this endpoint after listing summaries to retrieve detailed content for editing or analysis. Requires NORMAL user level. Common scenarios include: loading a worksheet for editing, viewing worksheet content, exporting worksheet data, or fetching worksheet structure for UI rendering. This is the primary read operation for full worksheet content.",
-      "tags": [],
+      "summary": "Get worksheet detail by report number",
+      "description": "Returns the full worksheet detail for the given report number within a project. Report number format: 'N' for primary only (e.g. '3'), or 'N-M' for primary-secondary (e.g. '3-1'). The '#' prefix is optional and will be stripped. Requires NORMAL user level.",
+      "tags": [
+        "Worksheet"
+      ],
       "parameters": [
         {
           "name": "projectId",
           "in": "path",
+          "description": "Project ID the worksheet belongs to",
           "required": true,
           "schema": {
             "type": "string"
@@ -192,6 +201,7 @@
         {
           "name": "reportNoSimple",
           "in": "path",
+          "description": "Report number: 'N' (primary) or 'N-M' (primary-secondary), e.g. '3-1'",
           "required": true,
           "schema": {
             "type": "string"
@@ -270,13 +280,16 @@
     {
       "path": "/api/v2/projects/{projectId}/worksheets/{reportNoSimple}",
       "method": "PUT",
-      "summary": "Update worksheet",
-      "description": "Updates and saves changes to an existing worksheet identified by its report number. Accepts WorksheetSaveDTO containing modified worksheet data including cell values, structure changes, and metadata updates. The reportNoSimple parameter supports both simple numbers ('3') and sub-worksheet notation ('3-1'). All changes are persisted to the database. Requires NORMAL user level and PROJECT MEMBER role with write permissions. Common use cases: saving worksheet edits, updating cell values, modifying worksheet structure, applying bulk changes, or synchronizing client-side modifications. This is the primary write operation for worksheets and should be called after any user modifications to persist data.",
-      "tags": [],
+      "summary": "Save worksheet data by report number",
+      "description": "Saves (updates) the worksheet content for the given report number. Accepts a WorksheetSaveDTO containing row data and column values. Requires NORMAL user level and project MEMBER role.",
+      "tags": [
+        "Worksheet"
+      ],
       "parameters": [
         {
           "name": "projectId",
           "in": "path",
+          "description": "Project ID the worksheet belongs to",
           "required": true,
           "schema": {
             "type": "string"
@@ -285,6 +298,7 @@
         {
           "name": "reportNoSimple",
           "in": "path",
+          "description": "Report number: 'N' (primary) or 'N-M' (primary-secondary), e.g. '3-1'",
           "required": true,
           "schema": {
             "type": "string"
@@ -419,13 +433,16 @@
     {
       "path": "/api/v2/projects/{projectId}/worksheets/{reportNoSimple}",
       "method": "DELETE",
-      "summary": "Delete worksheet",
-      "description": "Permanently removes a worksheet from the project using its report number identifier. The reportNoSimple parameter accepts formats like '3' or '3-1' for sub-worksheets. This operation is irreversible and will delete all worksheet data including rows, columns, cell values, and associated metadata. Requires NORMAL user level and PROJECT MEMBER role. Use with caution as deleted worksheets cannot be recovered without database restore. Common scenarios: removing obsolete worksheets, cleaning up test data, deleting unused analysis documents, or managing worksheet lifecycle. Consider archiving instead of deleting if the worksheet might be needed for future reference.",
-      "tags": [],
+      "summary": "Delete worksheet by report number",
+      "description": "Deletes the worksheet identified by the report number within the project. Returns HTTP 200 on success. Requires NORMAL user level and project MEMBER role.",
+      "tags": [
+        "Worksheet"
+      ],
       "parameters": [
         {
           "name": "projectId",
           "in": "path",
+          "description": "Project ID the worksheet belongs to",
           "required": true,
           "schema": {
             "type": "string"
@@ -434,6 +451,7 @@
         {
           "name": "reportNoSimple",
           "in": "path",
+          "description": "Report number: 'N' (primary) or 'N-M' (primary-secondary), e.g. '3-1'",
           "required": true,
           "schema": {
             "type": "string"