fmea-api-mcp-server 1.1.46 → 1.1.48

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.
Files changed (32) hide show
  1. package/data/endpoint-lookup.json +1 -1
  2. package/data/search-index.oxy +1 -1
  3. package/dist/index.js +1 -1
  4. package/dist/synonyms.js +3 -2
  5. package/endpoints/v2/additional-info/core.json +30 -6
  6. package/endpoints/v2/api-keys/core.json +86 -33
  7. package/endpoints/v2/block-diagrams/core.json +6 -3
  8. package/endpoints/v2/condition-library/core.json +62 -301
  9. package/endpoints/v2/condition-library-excel/core.json +1 -4
  10. package/endpoints/v2/divisions/core.json +0 -9
  11. package/endpoints/v2/documents/core.json +49 -21
  12. package/endpoints/v2/evaluation/core.json +158 -34
  13. package/endpoints/v2/excel/core.json +18 -9
  14. package/endpoints/v2/failure-modes/core.json +5 -5
  15. package/endpoints/v2/files/core.json +5 -3
  16. package/endpoints/v2/fourm/core.json +65 -49
  17. package/endpoints/v2/high-items/core.json +1 -0
  18. package/endpoints/v2/projects/core.json +69 -26
  19. package/endpoints/v2/recommendation-items/core.json +16 -3
  20. package/endpoints/v2/search/core.json +125 -33
  21. package/endpoints/v2/system/core.json +22 -10
  22. package/endpoints/v2/system-definition/core.json +9 -3
  23. package/endpoints/v2/system-definition-excel/core.json +1 -1
  24. package/endpoints/v2/templates/core.json +15 -5
  25. package/endpoints/v2/tree-search/core.json +4 -4
  26. package/endpoints/v2/users/core.json +0 -9
  27. package/endpoints/v2/worksheet-templates/core.json +17 -4
  28. package/endpoints/v2/worksheets/core.json +33 -15
  29. package/endpoints/v2/worksheets/excel.json +35 -15
  30. package/endpoints/v2/worksheets/management.json +28 -10
  31. package/endpoints/v2/worksheets/templates.json +4 -1
  32. package/package.json +1 -1
package/endpoints/v2/evaluation/core.json CHANGED
@@ -16,10 +16,18 @@
16
16
  {
17
17
  "name": "fmeaType",
18
18
  "in": "path",
19
- "description": "FMEA type: Design|Process|Equipment|FA|FTA",
19
+ "description": "FMEA type",
20
20
  "required": true,
21
21
  "schema": {
22
- "type": "string"
22
+ "type": "string",
23
+ "enum": [
24
+ "DESIGN",
25
+ "PROCESS",
26
+ "EQUIPMENT",
27
+ "FA",
28
+ "FTA",
29
+ "CPLAN"
30
+ ]
23
31
  }
24
32
  },
25
33
  {
@@ -55,10 +63,18 @@
55
63
  {
56
64
  "name": "fmeaType",
57
65
  "in": "path",
58
- "description": "FMEA type: Design|Process|Equipment|FA|FTA",
66
+ "description": "FMEA type",
59
67
  "required": true,
60
68
  "schema": {
61
- "type": "string"
69
+ "type": "string",
70
+ "enum": [
71
+ "DESIGN",
72
+ "PROCESS",
73
+ "EQUIPMENT",
74
+ "FA",
75
+ "FTA",
76
+ "CPLAN"
77
+ ]
62
78
  }
63
79
  },
64
80
  {
@@ -73,10 +89,15 @@
73
89
  {
74
90
  "name": "category",
75
91
  "in": "path",
76
- "description": "Rating category: severity|occurrence|detection",
92
+ "description": "Rating category",
77
93
  "required": true,
78
94
  "schema": {
79
- "type": "string"
95
+ "type": "string",
96
+ "enum": [
97
+ "SEVERITY",
98
+ "OCCURRENCE",
99
+ "DETECTION"
100
+ ]
80
101
  }
81
102
  },
82
103
  {
@@ -167,10 +188,18 @@
167
188
  {
168
189
  "name": "fmeaType",
169
190
  "in": "path",
170
- "description": "FMEA type: Design|Process|Equipment|FA|FTA",
191
+ "description": "FMEA type",
171
192
  "required": true,
172
193
  "schema": {
173
- "type": "string"
194
+ "type": "string",
195
+ "enum": [
196
+ "DESIGN",
197
+ "PROCESS",
198
+ "EQUIPMENT",
199
+ "FA",
200
+ "FTA",
201
+ "CPLAN"
202
+ ]
174
203
  }
175
204
  }
176
205
  ],
@@ -221,10 +250,18 @@
221
250
  {
222
251
  "name": "fmeaType",
223
252
  "in": "path",
224
- "description": "FMEA type: Design|Process|Equipment|FA|FTA",
253
+ "description": "FMEA type",
225
254
  "required": true,
226
255
  "schema": {
227
- "type": "string"
256
+ "type": "string",
257
+ "enum": [
258
+ "DESIGN",
259
+ "PROCESS",
260
+ "EQUIPMENT",
261
+ "FA",
262
+ "FTA",
263
+ "CPLAN"
264
+ ]
228
265
  }
229
266
  },
230
267
  {
@@ -326,10 +363,18 @@
326
363
  {
327
364
  "name": "fmeaType",
328
365
  "in": "path",
329
- "description": "FMEA type: Design|Process|Equipment|FA|FTA",
366
+ "description": "FMEA type",
330
367
  "required": true,
331
368
  "schema": {
332
- "type": "string"
369
+ "type": "string",
370
+ "enum": [
371
+ "DESIGN",
372
+ "PROCESS",
373
+ "EQUIPMENT",
374
+ "FA",
375
+ "FTA",
376
+ "CPLAN"
377
+ ]
333
378
  }
334
379
  },
335
380
  {
@@ -389,10 +434,18 @@
389
434
  {
390
435
  "name": "fmeaType",
391
436
  "in": "path",
392
- "description": "FMEA type: Design|Process|Equipment|FA|FTA",
437
+ "description": "FMEA type",
393
438
  "required": true,
394
439
  "schema": {
395
- "type": "string"
440
+ "type": "string",
441
+ "enum": [
442
+ "DESIGN",
443
+ "PROCESS",
444
+ "EQUIPMENT",
445
+ "FA",
446
+ "FTA",
447
+ "CPLAN"
448
+ ]
396
449
  }
397
450
  },
398
451
  {
@@ -407,10 +460,15 @@
407
460
  {
408
461
  "name": "category",
409
462
  "in": "path",
410
- "description": "Rating category: severity|occurrence|detection",
463
+ "description": "Rating category",
411
464
  "required": true,
412
465
  "schema": {
413
- "type": "string"
466
+ "type": "string",
467
+ "enum": [
468
+ "SEVERITY",
469
+ "OCCURRENCE",
470
+ "DETECTION"
471
+ ]
414
472
  }
415
473
  }
416
474
  ],
@@ -458,10 +516,18 @@
458
516
  {
459
517
  "name": "fmeaType",
460
518
  "in": "path",
461
- "description": "FMEA type: Design|Process|Equipment|FA|FTA",
519
+ "description": "FMEA type",
462
520
  "required": true,
463
521
  "schema": {
464
- "type": "string"
522
+ "type": "string",
523
+ "enum": [
524
+ "DESIGN",
525
+ "PROCESS",
526
+ "EQUIPMENT",
527
+ "FA",
528
+ "FTA",
529
+ "CPLAN"
530
+ ]
465
531
  }
466
532
  }
467
533
  ],
@@ -512,10 +578,18 @@
512
578
  {
513
579
  "name": "fmeaType",
514
580
  "in": "path",
515
- "description": "FMEA type: Design|Process|Equipment|FA|FTA",
581
+ "description": "FMEA type",
516
582
  "required": true,
517
583
  "schema": {
518
- "type": "string"
584
+ "type": "string",
585
+ "enum": [
586
+ "DESIGN",
587
+ "PROCESS",
588
+ "EQUIPMENT",
589
+ "FA",
590
+ "FTA",
591
+ "CPLAN"
592
+ ]
519
593
  }
520
594
  }
521
595
  ],
@@ -583,10 +657,18 @@
583
657
  {
584
658
  "name": "fmeaType",
585
659
  "in": "path",
586
- "description": "FMEA type: Design|Process|Equipment|FA|FTA",
660
+ "description": "FMEA type",
587
661
  "required": true,
588
662
  "schema": {
589
- "type": "string"
663
+ "type": "string",
664
+ "enum": [
665
+ "DESIGN",
666
+ "PROCESS",
667
+ "EQUIPMENT",
668
+ "FA",
669
+ "FTA",
670
+ "CPLAN"
671
+ ]
590
672
  }
591
673
  },
592
674
  {
@@ -601,10 +683,15 @@
601
683
  {
602
684
  "name": "category",
603
685
  "in": "path",
604
- "description": "Rating category: severity|occurrence|detection",
686
+ "description": "Rating category",
605
687
  "required": true,
606
688
  "schema": {
607
- "type": "string"
689
+ "type": "string",
690
+ "enum": [
691
+ "SEVERITY",
692
+ "OCCURRENCE",
693
+ "DETECTION"
694
+ ]
608
695
  }
609
696
  }
610
697
  ],
@@ -669,10 +756,18 @@
669
756
  {
670
757
  "name": "fmeaType",
671
758
  "in": "path",
672
- "description": "FMEA type: Design|Process|Equipment|FA|FTA",
759
+ "description": "FMEA type",
673
760
  "required": true,
674
761
  "schema": {
675
- "type": "string"
762
+ "type": "string",
763
+ "enum": [
764
+ "DESIGN",
765
+ "PROCESS",
766
+ "EQUIPMENT",
767
+ "FA",
768
+ "FTA",
769
+ "CPLAN"
770
+ ]
676
771
  }
677
772
  },
678
773
  {
@@ -708,10 +803,18 @@
708
803
  {
709
804
  "name": "fmeaType",
710
805
  "in": "path",
711
- "description": "FMEA type: Design|Process|Equipment|FA|FTA",
806
+ "description": "FMEA type",
712
807
  "required": true,
713
808
  "schema": {
714
- "type": "string"
809
+ "type": "string",
810
+ "enum": [
811
+ "DESIGN",
812
+ "PROCESS",
813
+ "EQUIPMENT",
814
+ "FA",
815
+ "FTA",
816
+ "CPLAN"
817
+ ]
715
818
  }
716
819
  },
717
820
  {
@@ -788,10 +891,18 @@
788
891
  {
789
892
  "name": "fmeaType",
790
893
  "in": "path",
791
- "description": "FMEA type: Design|Process|Equipment|FA|FTA",
894
+ "description": "FMEA type",
792
895
  "required": true,
793
896
  "schema": {
794
- "type": "string"
897
+ "type": "string",
898
+ "enum": [
899
+ "DESIGN",
900
+ "PROCESS",
901
+ "EQUIPMENT",
902
+ "FA",
903
+ "FTA",
904
+ "CPLAN"
905
+ ]
795
906
  }
796
907
  },
797
908
  {
@@ -883,10 +994,18 @@
883
994
  {
884
995
  "name": "fmeaType",
885
996
  "in": "path",
886
- "description": "FMEA type: Design|Process|Equipment|FA|FTA",
997
+ "description": "FMEA type",
887
998
  "required": true,
888
999
  "schema": {
889
- "type": "string"
1000
+ "type": "string",
1001
+ "enum": [
1002
+ "DESIGN",
1003
+ "PROCESS",
1004
+ "EQUIPMENT",
1005
+ "FA",
1006
+ "FTA",
1007
+ "CPLAN"
1008
+ ]
890
1009
  }
891
1010
  },
892
1011
  {
@@ -901,10 +1020,15 @@
901
1020
  {
902
1021
  "name": "category",
903
1022
  "in": "path",
904
- "description": "Rating category: severity|occurrence|detection",
1023
+ "description": "Rating category",
905
1024
  "required": true,
906
1025
  "schema": {
907
- "type": "string"
1026
+ "type": "string",
1027
+ "enum": [
1028
+ "SEVERITY",
1029
+ "OCCURRENCE",
1030
+ "DETECTION"
1031
+ ]
908
1032
  }
909
1033
  },
910
1034
  {
package/endpoints/v2/excel/core.json CHANGED
@@ -6,10 +6,10 @@
6
6
  {
7
7
  "path": "/api/v2/excel/{uuid}",
8
8
  "method": "GET",
9
- "summary": "Parse all sheets in Excel file",
10
- "description": "Extracts and returns ALL worksheets from an uploaded Excel file (.xlsx, .xls). Use this endpoint when you need complete workbook data including multiple sheets. The endpoint parses every tab/worksheet in the Excel file and returns them as a structured list with sheet metadata, row data, and cell values. This is ideal for bulk data extraction, complete workbook analysis, or when the sheet structure is unknown beforehand. Returns a list of POISheet objects containing sheet names, indices, and grid data. Requires valid file UUID from prior upload.",
9
+ "summary": "Parse all sheets from an uploaded Excel file",
10
+ "description": "Parses all sheets from a previously uploaded Excel file and returns them as a list of POISheet objects. Requires a prior file upload via POST /api/v2/files. The uuid is the file identifier returned by the upload endpoint. startRowNumber specifies which row to begin parsing (1-based). reindexFromZero resets row indices to start from 0.",
11
11
  "tags": [
12
- "excel"
12
+ "Excel"
13
13
  ],
14
14
  "operationId": "parseAll",
15
15
  "x-dependency-warning": "REQUIRES PRIOR FILE UPLOAD via [POST /api/v2/files]. The {uuid} parameter is the file ID returned by the upload endpoint.",
@@ -17,6 +17,7 @@
17
17
  {
18
18
  "name": "uuid",
19
19
  "in": "path",
20
+ "description": "UUID of the uploaded Excel file (returned by POST /api/v2/files)",
20
21
  "required": true,
21
22
  "schema": {
22
23
  "type": "string"
@@ -25,6 +26,7 @@
25
26
  {
26
27
  "name": "startRowNumber",
27
28
  "in": "query",
29
+ "description": "Row number to start parsing from (1-based, optional)",
28
30
  "schema": {
29
31
  "type": "integer",
30
32
  "format": "int32"
@@ -33,6 +35,7 @@
33
35
  {
34
36
  "name": "reindexFromZero",
35
37
  "in": "query",
38
+ "description": "Whether to reindex row numbers to start from 0 (default: true)",
36
39
  "schema": {
37
40
  "type": "boolean",
38
41
  "default": true
@@ -58,10 +61,10 @@
58
61
  {
59
62
  "path": "/api/v2/excel/{uuid}/sheets/{sheetIndex}",
60
63
  "method": "GET",
61
- "summary": "Parse specific sheet in Excel file",
62
- "description": "Extracts and returns a SINGLE worksheet from an uploaded Excel file by its zero-based index. Use this endpoint for targeted data retrieval when you know which specific tab/worksheet you need. More efficient than parsing all sheets when working with large workbooks or when only specific sheet data is required. The endpoint returns a POISheet object containing the sheet name, index, and complete grid data with cell values. Ideal for incremental processing, specific tab extraction, or reducing payload size. Sheet index starts at 0 (first sheet). Requires valid file UUID from prior upload.",
64
+ "summary": "Parse a specific sheet from an uploaded Excel file",
65
+ "description": "Parses a single sheet from a previously uploaded Excel file by its index. Requires a prior file upload via POST /api/v2/files. The uuid is the file identifier returned by the upload endpoint. startRowNumber specifies which row to begin parsing (1-based). reindexFromZero resets row indices to start from 0.",
63
66
  "tags": [
64
- "excel"
67
+ "Excel"
65
68
  ],
66
69
  "operationId": "parseSheet",
67
70
  "x-dependency-warning": "REQUIRES PRIOR FILE UPLOAD via [POST /api/v2/files]. The {uuid} parameter is the file ID returned by the upload endpoint.",
@@ -69,6 +72,7 @@
69
72
  {
70
73
  "name": "uuid",
71
74
  "in": "path",
75
+ "description": "UUID of the uploaded Excel file (returned by POST /api/v2/files)",
72
76
  "required": true,
73
77
  "schema": {
74
78
  "type": "string"
@@ -77,6 +81,7 @@
77
81
  {
78
82
  "name": "sheetIndex",
79
83
  "in": "path",
84
+ "description": "Zero-based index of the sheet to parse",
80
85
  "required": true,
81
86
  "schema": {
82
87
  "type": "integer",
@@ -86,6 +91,7 @@
86
91
  {
87
92
  "name": "startRowNumber",
88
93
  "in": "query",
94
+ "description": "Row number to start parsing from (1-based, optional)",
89
95
  "schema": {
90
96
  "type": "integer",
91
97
  "format": "int32"
@@ -94,6 +100,7 @@
94
100
  {
95
101
  "name": "reindexFromZero",
96
102
  "in": "query",
103
+ "description": "Whether to reindex row numbers to start from 0 (default: true)",
97
104
  "schema": {
98
105
  "type": "boolean",
99
106
  "default": true
@@ -116,9 +123,11 @@
116
123
  {
117
124
  "path": "/api/v2/excel/generate",
118
125
  "method": "POST",
119
- "summary": "Generate Excel File",
120
- "description": "Generates a downloadable Excel (.xlsx) file programmatically based on user-provided column definitions and grid data payloads. Use this endpoint to dynamically construct custom spreadsheet reports, export tabular analysis results, or create structured Excel files from raw JSON arrays. Ideal for custom FMEA reporting, bulk data compilation, and on-the-fly spreadsheet generation. (Create Excel / Export to XLSX / Build Spreadsheet / Generate Report).",
121
- "tags": [],
126
+ "summary": "Generate an Excel file from spreadsheet data",
127
+ "description": "Converts myspreadsheet worksheet data to an Excel (.xlsx) file. Returns a download URI (FileDownloadResponseDTO) for the generated file. Download the file using the returned URI via GET /api/v1/files/{uuid}.",
128
+ "tags": [
129
+ "Excel"
130
+ ],
122
131
  "operationId": "generate",
123
132
  "parameters": [],
124
133
  "requestBody": {
package/endpoints/v2/failure-modes/core.json CHANGED
@@ -210,11 +210,11 @@
210
210
  "fmmBlockDiagramType": {
211
211
  "type": "string",
212
212
  "enum": [
213
- "Function",
214
- "Structure",
215
- "FunctionStructure",
216
- "StructureFunction",
217
- "Process"
213
+ "FMM_FUNCTION",
214
+ "FMM_STRUCTURE",
215
+ "FMM_FUNCTION_STRUCTURE",
216
+ "FMM_STRUCTURE_FUNCTION",
217
+ "FMM_PROCESS"
218
218
  ]
219
219
  },
220
220
  "fmeaType": {
package/endpoints/v2/files/core.json CHANGED
@@ -7,9 +7,11 @@
7
7
  "path": "/api/v2/files",
8
8
  "method": "POST",
9
9
  "operationId": "upload",
10
- "summary": "Upload files",
11
- "description": "Initiates file upload by accepting one or more files via multipart/form-data and storing them in a temporary system folder. Returns a list of upload information objects, each containing a unique UUID identifier, original filename, and file size. The returned UUID serves as a temporary file reference that must be used in subsequent processing endpoints (e.g., Excel import, document attachment, data analysis workflows). This is the mandatory first step for any operation requiring file input. Supports batch upload of multiple files in a single request. Alternative terms: file transmission, document submission, attachment upload, bulk file transfer.",
12
- "tags": [],
10
+ "summary": "Upload one or more files",
11
+ "description": "Accepts a multipart/form-data request with one or more files in the 'files' field. Stores each file and returns a list of upload results including the assigned UUID per file. The UUID is used as a reference in subsequent import operations (e.g., POST /api/v2/projects/{projectId}/worksheet-excel/{uuid}).",
12
+ "tags": [
13
+ "Files"
14
+ ],
13
15
  "parameters": [],
14
16
  "requestBody": {
15
17
  "content": {