fmea-api-mcp-server 1.0.0

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 (27) hide show
  1. package/README.md +87 -0
  2. package/dist/index.js +191 -0
  3. package/endpoints/v1/authentication.json +171 -0
  4. package/endpoints/v1/block-diagrams.json +214 -0
  5. package/endpoints/v1/divisions.json +118 -0
  6. package/endpoints/v1/failure-modes.json +301 -0
  7. package/endpoints/v1/files.json +33 -0
  8. package/endpoints/v1/fta.json +149 -0
  9. package/endpoints/v1/knowledge-base.json +359 -0
  10. package/endpoints/v1/projects.json +342 -0
  11. package/endpoints/v1/synonyms.json +230 -0
  12. package/endpoints/v1/terms.json +190 -0
  13. package/endpoints/v1/users.json +214 -0
  14. package/endpoints/v1/worksheets.json +61 -0
  15. package/endpoints/v2/api-keys.json +426 -0
  16. package/endpoints/v2/block-diagrams.json +371 -0
  17. package/endpoints/v2/divisions.json +34 -0
  18. package/endpoints/v2/documents.json +266 -0
  19. package/endpoints/v2/failure-modes.json +93 -0
  20. package/endpoints/v2/files.json +41 -0
  21. package/endpoints/v2/fourm.json +204 -0
  22. package/endpoints/v2/projects.json +271 -0
  23. package/endpoints/v2/system.json +61 -0
  24. package/endpoints/v2/templates.json +137 -0
  25. package/endpoints/v2/users.json +61 -0
  26. package/endpoints/v2/worksheets.json +530 -0
  27. package/package.json +25 -0
package/endpoints/v1/synonyms.json ADDED
@@ -0,0 +1,230 @@
1
+ {
2
+ "category": "Synonyms",
3
+ "version": "v1",
4
+ "description": "동의어 관리 관련 API",
5
+ "endpoints": [
6
+ {
7
+ "path": "/api/v1/synonyms/{synonymId}",
8
+ "method": "GET",
9
+ "operationId": "findById_5",
10
+ "summary": "Find synonym by ID",
11
+ "description": "Retrieve a specific synonym by its ID",
12
+ "tags": [],
13
+ "parameters": [
14
+ {
15
+ "name": "synonymId",
16
+ "in": "path",
17
+ "required": true,
18
+ "schema": {
19
+ "type": "integer",
20
+ "format": "int32"
21
+ }
22
+ }
23
+ ],
24
+ "responses": {
25
+ "default": {
26
+ "description": "default response",
27
+ "content": {
28
+ "application/json": {}
29
+ }
30
+ }
31
+ }
32
+ },
33
+ {
34
+ "path": "/api/v1/synonyms/{synonymId}",
35
+ "method": "PUT",
36
+ "operationId": "updateById_2",
37
+ "summary": "Update synonym by ID",
38
+ "description": "Update a specific synonym by its ID",
39
+ "tags": [],
40
+ "parameters": [
41
+ {
42
+ "name": "synonymId",
43
+ "in": "path",
44
+ "required": true,
45
+ "schema": {
46
+ "type": "integer",
47
+ "format": "int32"
48
+ }
49
+ }
50
+ ],
51
+ "requestBody": {
52
+ "content": {
53
+ "application/json": {
54
+ "schema": {
55
+ "type": "array",
56
+ "items": {
57
+ "$ref": "#/components/schemas/SynonymDTO"
58
+ }
59
+ }
60
+ }
61
+ }
62
+ },
63
+ "responses": {
64
+ "default": {
65
+ "description": "default response",
66
+ "content": {
67
+ "application/json": {}
68
+ }
69
+ }
70
+ }
71
+ },
72
+ {
73
+ "path": "/api/v1/synonyms/{synonymId}",
74
+ "method": "DELETE",
75
+ "operationId": "deleteById_2",
76
+ "summary": "Delete synonym by ID",
77
+ "description": "Delete a specific synonym by its ID",
78
+ "tags": [],
79
+ "parameters": [
80
+ {
81
+ "name": "synonymId",
82
+ "in": "path",
83
+ "required": true,
84
+ "schema": {
85
+ "type": "integer",
86
+ "format": "int32"
87
+ }
88
+ }
89
+ ],
90
+ "responses": {
91
+ "default": {
92
+ "description": "default response",
93
+ "content": {
94
+ "*/*": {}
95
+ }
96
+ }
97
+ }
98
+ },
99
+ {
100
+ "path": "/api/v1/synonyms/export",
101
+ "method": "GET",
102
+ "operationId": "exportData_1",
103
+ "summary": "Export synonyms",
104
+ "description": "Export synonyms data with optional search filter",
105
+ "tags": [],
106
+ "parameters": [
107
+ {
108
+ "name": "search",
109
+ "in": "query",
110
+ "schema": {
111
+ "type": "string"
112
+ }
113
+ }
114
+ ],
115
+ "responses": {
116
+ "default": {
117
+ "description": "default response",
118
+ "content": {
119
+ "application/json": {}
120
+ }
121
+ }
122
+ }
123
+ },
124
+ {
125
+ "path": "/api/v1/synonyms",
126
+ "method": "GET",
127
+ "operationId": "findAll_3",
128
+ "summary": "Find all synonyms",
129
+ "description": "Retrieve all synonyms",
130
+ "tags": [],
131
+ "parameters": [],
132
+ "responses": {
133
+ "default": {
134
+ "description": "default response",
135
+ "content": {
136
+ "application/json": {}
137
+ }
138
+ }
139
+ }
140
+ },
141
+ {
142
+ "path": "/api/v1/synonyms",
143
+ "method": "POST",
144
+ "operationId": "save_6",
145
+ "summary": "Save synonyms",
146
+ "description": "Create new synonyms",
147
+ "tags": [],
148
+ "parameters": [],
149
+ "requestBody": {
150
+ "content": {
151
+ "application/json": {
152
+ "schema": {
153
+ "type": "array",
154
+ "items": {
155
+ "$ref": "#/components/schemas/SynonymDTO"
156
+ }
157
+ }
158
+ }
159
+ }
160
+ },
161
+ "responses": {
162
+ "default": {
163
+ "description": "default response",
164
+ "content": {
165
+ "application/json": {}
166
+ }
167
+ }
168
+ }
169
+ },
170
+ {
171
+ "path": "/api/v1/synonyms/import",
172
+ "method": "POST",
173
+ "operationId": "importProject",
174
+ "summary": "Import synonyms",
175
+ "description": "Import synonyms from a file upload",
176
+ "tags": [],
177
+ "parameters": [],
178
+ "requestBody": {
179
+ "content": {
180
+ "multipart/form-data": {
181
+ "schema": {
182
+ "type": "object",
183
+ "properties": {
184
+ "file": {
185
+ "type": "object"
186
+ },
187
+ "rowStart": {
188
+ "type": "integer",
189
+ "format": "int32"
190
+ },
191
+ "columnStart": {
192
+ "type": "integer",
193
+ "format": "int32"
194
+ },
195
+ "columnEnd": {
196
+ "type": "integer",
197
+ "format": "int32"
198
+ }
199
+ }
200
+ }
201
+ }
202
+ }
203
+ },
204
+ "responses": {
205
+ "default": {
206
+ "description": "default response",
207
+ "content": {
208
+ "application/json": {}
209
+ }
210
+ }
211
+ }
212
+ }
213
+ ],
214
+ "components": {
215
+ "schemas": {
216
+ "SynonymDTO": {
217
+ "type": "object",
218
+ "properties": {
219
+ "serial": {
220
+ "type": "integer",
221
+ "format": "int32"
222
+ },
223
+ "value": {
224
+ "type": "string"
225
+ }
226
+ }
227
+ }
228
+ }
229
+ }
230
+ }
package/endpoints/v1/terms.json ADDED
@@ -0,0 +1,190 @@
1
+ {
2
+ "category": "Terms",
3
+ "version": "v1",
4
+ "description": "용어 관리 관련 API",
5
+ "endpoints": [
6
+ {
7
+ "path": "/api/v1/terms/{type}/{nodeId}",
8
+ "method": "GET",
9
+ "operationId": "findTreeByTypeCodeAndId",
10
+ "summary": "Find term tree by type and node ID",
11
+ "description": "Retrieves a term tree structure based on the type code and specific node ID",
12
+ "tags": [],
13
+ "parameters": [
14
+ {
15
+ "name": "type",
16
+ "in": "path",
17
+ "required": true,
18
+ "schema": {
19
+ "type": "string"
20
+ }
21
+ },
22
+ {
23
+ "name": "nodeId",
24
+ "in": "path",
25
+ "required": true,
26
+ "schema": {
27
+ "type": "string"
28
+ }
29
+ }
30
+ ],
31
+ "requestBody": null,
32
+ "responses": {
33
+ "default": {
34
+ "description": "default response",
35
+ "content": {
36
+ "application/json": {}
37
+ }
38
+ }
39
+ }
40
+ },
41
+ {
42
+ "path": "/api/v1/terms/{type}/{nodeId}",
43
+ "method": "PUT",
44
+ "operationId": "updateByTypeCodeAndId",
45
+ "summary": "Update term by type and node ID",
46
+ "description": "Updates a term based on the type code and specific node ID",
47
+ "tags": [],
48
+ "parameters": [
49
+ {
50
+ "name": "type",
51
+ "in": "path",
52
+ "required": true,
53
+ "schema": {
54
+ "type": "string"
55
+ }
56
+ },
57
+ {
58
+ "name": "nodeId",
59
+ "in": "path",
60
+ "required": true,
61
+ "schema": {
62
+ "type": "string"
63
+ }
64
+ }
65
+ ],
66
+ "requestBody": {
67
+ "content": {
68
+ "application/json": {
69
+ "schema": {
70
+ "$ref": "#/components/schemas/TermDTO"
71
+ }
72
+ }
73
+ }
74
+ },
75
+ "responses": {
76
+ "default": {
77
+ "description": "default response",
78
+ "content": {
79
+ "application/json": {}
80
+ }
81
+ }
82
+ }
83
+ },
84
+ {
85
+ "path": "/api/v1/terms/{type}/{nodeId}",
86
+ "method": "POST",
87
+ "operationId": "addChild",
88
+ "summary": "Add child term",
89
+ "description": "Adds a child term to the specified parent node identified by type and node ID",
90
+ "tags": [],
91
+ "parameters": [
92
+ {
93
+ "name": "type",
94
+ "in": "path",
95
+ "required": true,
96
+ "schema": {
97
+ "type": "string"
98
+ }
99
+ },
100
+ {
101
+ "name": "nodeId",
102
+ "in": "path",
103
+ "required": true,
104
+ "schema": {
105
+ "type": "string"
106
+ }
107
+ }
108
+ ],
109
+ "requestBody": {
110
+ "content": {
111
+ "application/json": {
112
+ "schema": {
113
+ "$ref": "#/components/schemas/TermDTO"
114
+ }
115
+ }
116
+ }
117
+ },
118
+ "responses": {
119
+ "default": {
120
+ "description": "default response",
121
+ "content": {
122
+ "application/json": {}
123
+ }
124
+ }
125
+ }
126
+ },
127
+ {
128
+ "path": "/api/v1/terms/{type}/{nodeId}",
129
+ "method": "DELETE",
130
+ "operationId": "deleteById_3",
131
+ "summary": "Delete term by type and node ID",
132
+ "description": "Deletes a term based on the type code and specific node ID",
133
+ "tags": [],
134
+ "parameters": [
135
+ {
136
+ "name": "type",
137
+ "in": "path",
138
+ "required": true,
139
+ "schema": {
140
+ "type": "string"
141
+ }
142
+ },
143
+ {
144
+ "name": "nodeId",
145
+ "in": "path",
146
+ "required": true,
147
+ "schema": {
148
+ "type": "string"
149
+ }
150
+ }
151
+ ],
152
+ "requestBody": null,
153
+ "responses": {
154
+ "default": {
155
+ "description": "default response",
156
+ "content": {
157
+ "*/*": {}
158
+ }
159
+ }
160
+ }
161
+ },
162
+ {
163
+ "path": "/api/v1/terms/{type}",
164
+ "method": "GET",
165
+ "operationId": "findTreeByTypeCode",
166
+ "summary": "Find term tree by type code",
167
+ "description": "Retrieves the complete term tree structure based on the type code",
168
+ "tags": [],
169
+ "parameters": [
170
+ {
171
+ "name": "type",
172
+ "in": "path",
173
+ "required": true,
174
+ "schema": {
175
+ "type": "string"
176
+ }
177
+ }
178
+ ],
179
+ "requestBody": null,
180
+ "responses": {
181
+ "default": {
182
+ "description": "default response",
183
+ "content": {
184
+ "application/json": {}
185
+ }
186
+ }
187
+ }
188
+ }
189
+ ]
190
+ }
package/endpoints/v1/users.json ADDED
@@ -0,0 +1,214 @@
1
+ {
2
+ "category": "User Management",
3
+ "version": "v1",
4
+ "description": "사용자 관리 관련 API",
5
+ "endpoints": [
6
+ {
7
+ "path": "/api/v1/admin/users/{userId}/activate",
8
+ "method": "PUT",
9
+ "operationId": "activateUser",
10
+ "summary": "Activate User",
11
+ "description": "Activate a user account",
12
+ "tags": ["User Management"],
13
+ "parameters": [
14
+ {
15
+ "name": "userId",
16
+ "in": "path",
17
+ "required": true,
18
+ "schema": {
19
+ "type": "string"
20
+ }
21
+ }
22
+ ],
23
+ "requestBody": null,
24
+ "responses": {
25
+ "default": {
26
+ "description": "default response",
27
+ "content": {
28
+ "*/*": {}
29
+ }
30
+ }
31
+ }
32
+ },
33
+ {
34
+ "path": "/api/v1/admin/users/register",
35
+ "method": "POST",
36
+ "operationId": "create",
37
+ "summary": "Register User",
38
+ "description": "Register a new user",
39
+ "tags": ["User Management"],
40
+ "parameters": [],
41
+ "requestBody": {
42
+ "content": {
43
+ "application/json": {
44
+ "schema": {
45
+ "$ref": "#/components/schemas/UserSaveDTO"
46
+ }
47
+ }
48
+ }
49
+ },
50
+ "responses": {
51
+ "default": {
52
+ "description": "default response",
53
+ "content": {
54
+ "application/json": {}
55
+ }
56
+ }
57
+ }
58
+ },
59
+ {
60
+ "path": "/api/v1/admin/users/{userId}/deactivate",
61
+ "method": "PUT",
62
+ "operationId": "deactivateUser",
63
+ "summary": "Deactivate User",
64
+ "description": "Deactivate a user account",
65
+ "tags": ["User Management"],
66
+ "parameters": [
67
+ {
68
+ "name": "userId",
69
+ "in": "path",
70
+ "required": true,
71
+ "schema": {
72
+ "type": "string"
73
+ }
74
+ }
75
+ ],
76
+ "requestBody": null,
77
+ "responses": {
78
+ "default": {
79
+ "description": "default response",
80
+ "content": {
81
+ "*/*": {}
82
+ }
83
+ }
84
+ }
85
+ },
86
+ {
87
+ "path": "/api/v1/admin/users/{userId}",
88
+ "method": "DELETE",
89
+ "operationId": "deleteUser",
90
+ "summary": "Delete User",
91
+ "description": "Delete a user account",
92
+ "tags": ["User Management"],
93
+ "parameters": [
94
+ {
95
+ "name": "userId",
96
+ "in": "path",
97
+ "required": true,
98
+ "schema": {
99
+ "type": "string"
100
+ }
101
+ }
102
+ ],
103
+ "requestBody": null,
104
+ "responses": {
105
+ "default": {
106
+ "description": "default response",
107
+ "content": {
108
+ "*/*": {}
109
+ }
110
+ }
111
+ }
112
+ },
113
+ {
114
+ "path": "/api/v1/admin/users/{id}",
115
+ "method": "GET",
116
+ "operationId": "findById",
117
+ "summary": "Find User by ID",
118
+ "description": "Retrieve a user by ID",
119
+ "tags": ["User Management"],
120
+ "parameters": [
121
+ {
122
+ "name": "id",
123
+ "in": "path",
124
+ "required": true,
125
+ "schema": {
126
+ "type": "string"
127
+ }
128
+ }
129
+ ],
130
+ "requestBody": null,
131
+ "responses": {
132
+ "default": {
133
+ "description": "default response",
134
+ "content": {
135
+ "application/json": {}
136
+ }
137
+ }
138
+ }
139
+ },
140
+ {
141
+ "path": "/api/v1/admin/users",
142
+ "method": "POST",
143
+ "operationId": "save",
144
+ "summary": "Save Users",
145
+ "description": "Save multiple users",
146
+ "tags": ["User Management"],
147
+ "parameters": [],
148
+ "requestBody": {
149
+ "content": {
150
+ "application/json": {
151
+ "schema": {
152
+ "type": "array",
153
+ "items": {
154
+ "$ref": "#/components/schemas/UserSaveDTO"
155
+ }
156
+ }
157
+ }
158
+ }
159
+ },
160
+ "responses": {
161
+ "default": {
162
+ "description": "default response",
163
+ "content": {
164
+ "*/*": {}
165
+ }
166
+ }
167
+ }
168
+ },
169
+ {
170
+ "path": "/api/v1/users/my",
171
+ "method": "GET",
172
+ "operationId": "findById_6",
173
+ "summary": "Get Current User",
174
+ "description": "Retrieve current user information",
175
+ "tags": ["User Management"],
176
+ "parameters": [],
177
+ "requestBody": null,
178
+ "responses": {
179
+ "default": {
180
+ "description": "default response",
181
+ "content": {
182
+ "application/json": {}
183
+ }
184
+ }
185
+ }
186
+ },
187
+ {
188
+ "path": "/api/v1/users",
189
+ "method": "PUT",
190
+ "operationId": "update_1",
191
+ "summary": "Update User",
192
+ "description": "Update user information",
193
+ "tags": ["User Management"],
194
+ "parameters": [],
195
+ "requestBody": {
196
+ "content": {
197
+ "application/json": {
198
+ "schema": {
199
+ "$ref": "#/components/schemas/UserUpdateDTO"
200
+ }
201
+ }
202
+ }
203
+ },
204
+ "responses": {
205
+ "default": {
206
+ "description": "default response",
207
+ "content": {
208
+ "application/json": {}
209
+ }
210
+ }
211
+ }
212
+ }
213
+ ]
214
+ }
package/endpoints/v1/worksheets.json ADDED
@@ -0,0 +1,61 @@
1
+ {
2
+ "category": "Worksheets",
3
+ "version": "v1",
4
+ "description": "워크시트 관련 API",
5
+ "endpoints": [
6
+ {
7
+ "path": "/api/v1/worksheet-templates",
8
+ "method": "GET",
9
+ "summary": "Find worksheet templates by FMEA type",
10
+ "description": "Retrieve worksheet templates filtered by FMEA type (Design, Process, Equipment, FA)",
11
+ "tags": [],
12
+ "parameters": [
13
+ {
14
+ "name": "fmeaType",
15
+ "in": "query",
16
+ "required": false,
17
+ "schema": {
18
+ "type": "string",
19
+ "pattern": "Design|Process|Equipment|FA"
20
+ }
21
+ }
22
+ ],
23
+ "operationId": "findByFmeaType",
24
+ "responses": {
25
+ "default": {
26
+ "description": "default response",
27
+ "content": {
28
+ "application/json": {}
29
+ }
30
+ }
31
+ }
32
+ },
33
+ {
34
+ "path": "/api/v1/worksheet-templates/{id}",
35
+ "method": "GET",
36
+ "summary": "Find worksheet template by ID",
37
+ "description": "Retrieve a specific worksheet template by its ID",
38
+ "tags": [],
39
+ "parameters": [
40
+ {
41
+ "name": "id",
42
+ "in": "path",
43
+ "required": true,
44
+ "schema": {
45
+ "type": "integer",
46
+ "format": "int32"
47
+ }
48
+ }
49
+ ],
50
+ "operationId": "findById_7",
51
+ "responses": {
52
+ "default": {
53
+ "description": "default response",
54
+ "content": {
55
+ "application/json": {}
56
+ }
57
+ }
58
+ }
59
+ }
60
+ ]
61
+ }