fmea-api-mcp-server 1.1.45 → 1.1.47

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.
@@ -220,7 +220,7 @@
220
220
  "method": "GET",
221
221
  "operationId": "get_3",
222
222
  "summary": "Get project details",
223
- "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.",
223
+ "description": "Returns the full project details for the given project ID. Throws 404 if the project does not exist.",
224
224
  "tags": [
225
225
  "Project"
226
226
  ],
@@ -579,7 +579,7 @@
579
579
  "method": "GET",
580
580
  "operationId": "getSummary",
581
581
  "summary": "Get project summary",
582
- "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.",
582
+ "description": "Returns a lightweight summary of a project including key metrics. Throws 404 if the project does not exist.",
583
583
  "tags": [
584
584
  "Project"
585
585
  ],
@@ -705,15 +705,6 @@
705
705
  "schema": {
706
706
  "type": "string"
707
707
  }
708
- },
709
- {
710
- "name": "useSynonym",
711
- "in": "query",
712
- "description": "Whether to expand q with synonym dictionary terms (default: true)",
713
- "schema": {
714
- "type": "boolean",
715
- "default": true
716
- }
717
708
  }
718
709
  ],
719
710
  "responses": {
@@ -791,7 +782,7 @@
791
782
  "method": "GET",
792
783
  "operationId": "getJoinRequestsByProjectId",
793
784
  "summary": "List project join requests",
794
- "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.",
785
+ "description": "Returns all pending and processed join requests for a project. Requires at least MEMBER role in the project.",
795
786
  "tags": [
796
787
  "Project"
797
788
  ],
@@ -952,7 +943,7 @@
952
943
  "method": "POST",
953
944
  "operationId": "createJoinRequest",
954
945
  "summary": "Create a project join request",
955
- "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.",
946
+ "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.",
956
947
  "tags": [
957
948
  "Project"
958
949
  ],
@@ -995,7 +986,7 @@
995
986
  "method": "PUT",
996
987
  "operationId": "updateJoinRequests",
997
988
  "summary": "Approve or reject project join requests in batch",
998
- "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.",
989
+ "description": "Processes multiple join requests in a single call by approving or rejecting them. Requires at least MEMBER role in the project.",
999
990
  "tags": [
1000
991
  "Project"
1001
992
  ],
@@ -1052,7 +1043,7 @@
1052
1043
  "method": "PUT",
1053
1044
  "operationId": "updateJoinRequest",
1054
1045
  "summary": "Approve or reject a project join request",
1055
- "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.",
1046
+ "description": "Processes a single join request by approving or rejecting it. Requires at least MEMBER role in the project.",
1056
1047
  "tags": [
1057
1048
  "Project"
1058
1049
  ],
@@ -1116,6 +1107,7 @@
1116
1107
  {
1117
1108
  "name": "projectId",
1118
1109
  "in": "path",
1110
+ "description": "Project ID whose high items to list",
1119
1111
  "required": true,
1120
1112
  "schema": {
1121
1113
  "type": "string"
@@ -1124,7 +1116,7 @@
1124
1116
  {
1125
1117
  "name": "q",
1126
1118
  "in": "query",
1127
- "description": "Unified keyword for high-item titles",
1119
+ "description": "Keyword filter for high-item titles (optional)",
1128
1120
  "schema": {
1129
1121
  "type": "string"
1130
1122
  }
@@ -1174,7 +1166,7 @@
1174
1166
  "method": "PATCH",
1175
1167
  "operationId": "patchProject",
1176
1168
  "summary": "Partially update project details",
1177
- "description": "",
1169
+ "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.",
1178
1170
  "tags": [
1179
1171
  "Project"
1180
1172
  ],
@@ -1372,11 +1364,14 @@
1372
1364
  "operationId": "refreshWorksheetSnapshot",
1373
1365
  "summary": "Refresh worksheet dashboard snapshots",
1374
1366
  "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.",
1375
- "tags": [],
1367
+ "tags": [
1368
+ "Admin - Dashboard"
1369
+ ],
1376
1370
  "parameters": [
1377
1371
  {
1378
1372
  "name": "divisionId",
1379
1373
  "in": "query",
1374
+ "description": "Division ID to refresh; if omitted, all cached divisions are refreshed",
1380
1375
  "schema": {
1381
1376
  "type": "integer",
1382
1377
  "format": "int32"
@@ -136,11 +136,11 @@
136
136
  "blockType": {
137
137
  "type": "string",
138
138
  "enum": [
139
- "Function",
140
- "Structure",
141
- "FunctionStructure",
142
- "StructureFunction",
143
- "Process"
139
+ "FMM_FUNCTION",
140
+ "FMM_STRUCTURE",
141
+ "FMM_FUNCTION_STRUCTURE",
142
+ "FMM_STRUCTURE_FUNCTION",
143
+ "FMM_PROCESS"
144
144
  ]
145
145
  },
146
146
  "blockNodeId": {
@@ -152,10 +152,7 @@
152
152
  "fmmDiagramType": {
153
153
  "type": "string",
154
154
  "enum": [
155
- "UNUSED",
156
- "NOT_SELECTED",
157
- "TYPE_A",
158
- "TYPE_C"
155
+ "UNUSED"
159
156
  ]
160
157
  },
161
158
  "complete": {
@@ -6,14 +6,17 @@
6
6
  {
7
7
  "path": "/api/v2/open/metrics/{apType}/constants",
8
8
  "method": "GET",
9
- "summary": "Get metric constants",
10
- "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.",
11
- "tags": [],
9
+ "summary": "Get metric constants for an AP type",
10
+ "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.",
11
+ "tags": [
12
+ "Metrics"
13
+ ],
12
14
  "operationId": "getMetricConstants",
13
15
  "parameters": [
14
16
  {
15
17
  "name": "apType",
16
18
  "in": "path",
19
+ "description": "Action priority type: aiag or msr (case-insensitive)",
17
20
  "required": true,
18
21
  "schema": {
19
22
  "type": "string"
@@ -33,14 +36,17 @@
33
36
  {
34
37
  "path": "/api/v2/system/context-version",
35
38
  "method": "GET",
36
- "summary": "Get Context Version",
37
- "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).",
38
- "tags": [],
39
+ "summary": "Get version info for a deployed web application context",
40
+ "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.",
41
+ "tags": [
42
+ "System"
43
+ ],
39
44
  "operationId": "checkContext",
40
45
  "parameters": [
41
46
  {
42
47
  "name": "contextPath",
43
48
  "in": "query",
49
+ "description": "Tomcat webapp sub-path to read the VERSION file from (e.g. 'fmea-frontend'). Leading slashes are stripped.",
44
50
  "schema": {
45
51
  "type": "string"
46
52
  }
@@ -59,9 +65,11 @@
59
65
  {
60
66
  "path": "/api/v2/system/health",
61
67
  "method": "GET",
62
- "summary": "System Health",
63
- "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).",
64
- "tags": [],
68
+ "summary": "Health check",
69
+ "description": "Returns the current server status and UTC timestamp. Always returns HTTP 200 with status='UP' when the application is running. No authentication required.",
70
+ "tags": [
71
+ "System"
72
+ ],
65
73
  "operationId": "health",
66
74
  "parameters": [],
67
75
  "requestBody": null,
@@ -118,16 +126,10 @@
118
126
  "projectPeriod": {
119
127
  "type": "object",
120
128
  "properties": {
121
- "createLimitEnabled": {
122
- "type": "boolean"
123
- },
124
- "createLimitDays": {
129
+ "createMaxDurationDays": {
125
130
  "type": "integer"
126
131
  },
127
- "modifyLimitEnabled": {
128
- "type": "boolean"
129
- },
130
- "modifyLimitDays": {
132
+ "modifyMaxDurationDays": {
131
133
  "type": "integer"
132
134
  }
133
135
  }
@@ -345,17 +347,11 @@
345
347
  "projectPeriod": {
346
348
  "type": "object",
347
349
  "properties": {
348
- "createLimitEnabled": {
349
- "type": "boolean"
350
- },
351
- "createLimitDays": {
350
+ "createMaxDurationDays": {
352
351
  "type": "integer",
353
352
  "format": "int32"
354
353
  },
355
- "modifyLimitEnabled": {
356
- "type": "boolean"
357
- },
358
- "modifyLimitDays": {
354
+ "modifyMaxDurationDays": {
359
355
  "type": "integer",
360
356
  "format": "int32"
361
357
  }
@@ -566,16 +562,233 @@
566
562
  "projectPeriod": {
567
563
  "type": "object",
568
564
  "properties": {
569
- "createLimitEnabled": {
565
+ "createMaxDurationDays": {
566
+ "type": "integer"
567
+ },
568
+ "modifyMaxDurationDays": {
569
+ "type": "integer"
570
+ }
571
+ }
572
+ },
573
+ "fmCheckprint": {
574
+ "type": "object",
575
+ "properties": {
576
+ "enabled": {
577
+ "type": "boolean"
578
+ },
579
+ "designEnabled": {
580
+ "type": "boolean"
581
+ },
582
+ "processEnabled": {
583
+ "type": "boolean"
584
+ },
585
+ "equipmentEnabled": {
586
+ "type": "boolean"
587
+ }
588
+ }
589
+ },
590
+ "fmmDisplay": {
591
+ "type": "object",
592
+ "properties": {
593
+ "showCreationInfo": {
594
+ "type": "boolean"
595
+ },
596
+ "highlightNewFailureModes": {
597
+ "type": "boolean"
598
+ },
599
+ "useBfmmType": {
600
+ "type": "boolean"
601
+ }
602
+ }
603
+ },
604
+ "security": {
605
+ "type": "object",
606
+ "properties": {
607
+ "forcePasswordChangeOnFirstLogin": {
608
+ "type": "boolean"
609
+ },
610
+ "enforcePasswordComplexity": {
611
+ "type": "boolean"
612
+ },
613
+ "restrictCommonSequences": {
614
+ "type": "boolean"
615
+ },
616
+ "preventPasswordReuse": {
617
+ "type": "boolean"
618
+ },
619
+ "enforcePasswordExpiration": {
620
+ "type": "boolean"
621
+ },
622
+ "passwordExpirationDays": {
623
+ "type": "integer"
624
+ },
625
+ "maxLoginFailures": {
626
+ "type": "integer"
627
+ }
628
+ }
629
+ },
630
+ "mail": {
631
+ "type": "object",
632
+ "properties": {
633
+ "enabled": {
570
634
  "type": "boolean"
571
635
  },
572
- "createLimitDays": {
636
+ "host": {
637
+ "type": "string"
638
+ },
639
+ "port": {
640
+ "type": "string"
641
+ },
642
+ "username": {
643
+ "type": "string"
644
+ },
645
+ "password": {
646
+ "type": "string"
647
+ },
648
+ "senderAddress": {
649
+ "type": "string"
650
+ },
651
+ "rpnThreshold": {
573
652
  "type": "integer"
653
+ }
654
+ }
655
+ },
656
+ "serverUrl": {
657
+ "type": "object",
658
+ "properties": {
659
+ "protocol": {
660
+ "type": "string"
574
661
  },
575
- "modifyLimitEnabled": {
662
+ "host": {
663
+ "type": "string"
664
+ }
665
+ }
666
+ },
667
+ "projectManagement": {
668
+ "type": "object",
669
+ "properties": {
670
+ "defaultApprovalOnCompletion": {
576
671
  "type": "boolean"
577
672
  },
578
- "modifyLimitDays": {
673
+ "restrictEditAfterApproval": {
674
+ "type": "boolean"
675
+ }
676
+ }
677
+ },
678
+ "validationApproval": {
679
+ "type": "object",
680
+ "properties": {
681
+ "enabled": {
682
+ "type": "boolean"
683
+ },
684
+ "checkEmptyRecommendedAction": {
685
+ "type": "boolean"
686
+ },
687
+ "checkEmptyDetectionAction": {
688
+ "type": "boolean"
689
+ },
690
+ "notifyFollowUpAssignees": {
691
+ "type": "boolean"
692
+ },
693
+ "checkRpnThreshold": {
694
+ "type": "boolean"
695
+ },
696
+ "checkUnresolvedHighItems": {
697
+ "type": "boolean"
698
+ }
699
+ }
700
+ },
701
+ "revisionEditing": {
702
+ "type": "object",
703
+ "properties": {
704
+ "enabled": {
705
+ "type": "boolean"
706
+ },
707
+ "allowRevisionNumberEdit": {
708
+ "type": "boolean"
709
+ },
710
+ "allowRevisionDateEdit": {
711
+ "type": "boolean"
712
+ },
713
+ "allowRevisionReasonEdit": {
714
+ "type": "boolean"
715
+ }
716
+ }
717
+ },
718
+ "reviewer": {
719
+ "type": "object",
720
+ "properties": {
721
+ "checkReviewerEnabled": {
722
+ "type": "boolean"
723
+ }
724
+ }
725
+ },
726
+ "blankText": {
727
+ "type": "object",
728
+ "properties": {
729
+ "texts": {
730
+ "type": "array",
731
+ "items": {
732
+ "type": "string"
733
+ }
734
+ }
735
+ }
736
+ }
737
+ }
738
+ }
739
+ }
740
+ }
741
+ }
742
+ }
743
+ },
744
+ {
745
+ "path": "/api/v2/system/settings/public",
746
+ "method": "GET",
747
+ "operationId": "getPublicSettings",
748
+ "summary": "Get public system settings",
749
+ "description": "Returns system settings visible to all users. Excludes sensitive groups: security, mail, serverUrl.",
750
+ "tags": [
751
+ "System Settings"
752
+ ],
753
+ "parameters": [],
754
+ "requestBody": null,
755
+ "responses": {
756
+ "default": {
757
+ "description": "default response",
758
+ "content": {
759
+ "application/json": {
760
+ "schema": {
761
+ "type": "object",
762
+ "properties": {
763
+ "company": {
764
+ "type": "object",
765
+ "properties": {
766
+ "name": {
767
+ "type": "string"
768
+ }
769
+ }
770
+ },
771
+ "scoring": {
772
+ "type": "object",
773
+ "properties": {
774
+ "enabled": {
775
+ "type": "boolean"
776
+ },
777
+ "threshold": {
778
+ "type": "integer"
779
+ },
780
+ "alwaysEnabled": {
781
+ "type": "boolean"
782
+ }
783
+ }
784
+ },
785
+ "projectPeriod": {
786
+ "type": "object",
787
+ "properties": {
788
+ "createMaxDurationDays": {
789
+ "type": "integer"
790
+ },
791
+ "modifyMaxDurationDays": {
579
792
  "type": "integer"
580
793
  }
581
794
  }
@@ -9,7 +9,9 @@
9
9
  "operationId": "getAll_1",
10
10
  "summary": "Get all action statuses",
11
11
  "description": "Returns all action status items. Used for populating action status dropdowns in worksheets.",
12
- "tags": [],
12
+ "tags": [
13
+ "Template"
14
+ ],
13
15
  "parameters": [],
14
16
  "responses": {
15
17
  "default": {
@@ -41,7 +43,9 @@
41
43
  "operationId": "create_7",
42
44
  "summary": "Create action status",
43
45
  "description": "Creates a new action status. Returns 201 with Location header. Requires ADMIN role. Throws 409 if title already exists.",
44
- "tags": [],
46
+ "tags": [
47
+ "Template"
48
+ ],
45
49
  "parameters": [],
46
50
  "requestBody": {
47
51
  "content": {
@@ -77,7 +81,9 @@
77
81
  "operationId": "getById_1",
78
82
  "summary": "Get action status by ID",
79
83
  "description": "Returns a single action status by ID. Returns 404 if not found.",
80
- "tags": [],
84
+ "tags": [
85
+ "Template"
86
+ ],
81
87
  "parameters": [
82
88
  {
83
89
  "name": "id",
@@ -116,7 +122,9 @@
116
122
  "operationId": "update_6",
117
123
  "summary": "Update action status",
118
124
  "description": "Updates an existing action status title. Returns updated DTO. Requires ADMIN role. Throws 404 if not found, 409 if title conflicts.",
119
- "tags": [],
125
+ "tags": [
126
+ "Template"
127
+ ],
120
128
  "parameters": [
121
129
  {
122
130
  "name": "id",
@@ -162,7 +170,9 @@
162
170
  "operationId": "delete_6",
163
171
  "summary": "Delete action status",
164
172
  "description": "Deletes an action status by ID. Returns 204 No Content. Requires ADMIN role. Throws 404 if not found.",
165
- "tags": [],
173
+ "tags": [
174
+ "Template"
175
+ ],
166
176
  "parameters": [
167
177
  {
168
178
  "name": "id",
@@ -32,9 +32,9 @@
32
32
  "queryMode": {
33
33
  "type": "string",
34
34
  "enum": [
35
- "referenceNode",
36
- "anchorPattern",
37
- "contextCompletion"
35
+ "REFERENCE_NODE",
36
+ "ANCHOR_PATTERN",
37
+ "CONTEXT_COMPLETION"
38
38
  ]
39
39
  },
40
40
  "query": {
@@ -21,15 +21,6 @@
21
21
  "type": "string"
22
22
  }
23
23
  },
24
- {
25
- "name": "useSynonym",
26
- "in": "query",
27
- "description": "Whether to expand q with synonym dictionary terms (default: true)",
28
- "schema": {
29
- "type": "boolean",
30
- "default": true
31
- }
32
- },
33
24
  {
34
25
  "name": "dept",
35
26
  "in": "query",
@@ -9,11 +9,14 @@
9
9
  "operationId": "get_7",
10
10
  "summary": "Get worksheet template",
11
11
  "description": "Returns a worksheet template. When search is provided, template headers are keyword-filtered.",
12
- "tags": [],
12
+ "tags": [
13
+ "Worksheet Templates"
14
+ ],
13
15
  "parameters": [
14
16
  {
15
17
  "name": "id",
16
18
  "in": "path",
19
+ "description": "Worksheet template ID",
17
20
  "required": true,
18
21
  "schema": {
19
22
  "type": "integer",
@@ -158,7 +161,9 @@
158
161
  "operationId": "list_13",
159
162
  "summary": "List worksheet templates",
160
163
  "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.",
161
- "tags": [],
164
+ "tags": [
165
+ "Worksheet Templates"
166
+ ],
162
167
  "parameters": [
163
168
  {
164
169
  "name": "fmeaType",