Skip to content

Commit 4070379

Browse files
selfcare-github-botmanuraf
selfcare-github-bot
and
manuraf
authored
[Update OpenAPI] Merge openapi prod using openapi-merge-cli (#387)
Co-authored-by: manuraf <[email protected]>
1 parent e532192 commit 4070379

File tree

4 files changed

+175
-5
lines changed

4 files changed

+175
-5
lines changed

‎infra/apim_v2/api/ms_internal_api/v1/openapi.prod.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,8 @@
236236
"tags": [
237237
"User"
238238
],
239-
"summary": "Update user status with optional filter for institution, product, role and productRole",
239+
"summary": "Update a user's product status with optional filters",
240+
"description": "Update user status with optional filter for institution, product, role and productRole",
240241
"operationId": "updateUserStatusUsingPUT",
241242
"parameters": [
242243
{

‎infra/apim_v2/api/selfcare_support_service/v1/openapi.prod.json

+4-2
Original file line numberDiff line numberDiff line change
@@ -274,7 +274,8 @@
274274
"tags": [
275275
"Institution"
276276
],
277-
"summary": "The API retrieves user's info including details of roles on products",
277+
"summary": "Retrieve user's information including product role details",
278+
"description": "Fetches detailed information about users associated with a specific institution, including their roles on various products. This endpoint is useful for administrators to obtain comprehensive user-role mappings within an institution.",
278279
"operationId": "getInstitutionUsersUsingGET",
279280
"parameters": [
280281
{
@@ -355,7 +356,8 @@
355356
"tags": [
356357
"User"
357358
],
358-
"summary": "Retrieves user given userId and optional ProductId",
359+
"summary": "Retrieve user information by userId and optional ProductId",
360+
"description": "Retrieves user given userId and optional ProductId",
359361
"operationId": "getUserInfoUsingGET",
360362
"parameters": [
361363
{

‎infra/apim_v2/api_pnpg/external_api_for_pnpg/v2/openapi.prod.json

+165
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,99 @@
8686
]
8787
}
8888
},
89+
"/users/{id}": {
90+
"get": {
91+
"tags": [
92+
"User"
93+
],
94+
"summary": "Retrieve user information by userId and optional ProductId",
95+
"description": "Retrieves user given userId and optional ProductId",
96+
"operationId": "getUserInfoUsingGET",
97+
"parameters": [
98+
{
99+
"name": "id",
100+
"in": "path",
101+
"required": true,
102+
"schema": {
103+
"type": "string"
104+
}
105+
},
106+
{
107+
"name": "institutionId",
108+
"in": "query",
109+
"schema": {
110+
"type": "string"
111+
}
112+
},
113+
{
114+
"name": "productId",
115+
"in": "query",
116+
"schema": {
117+
"type": "string"
118+
}
119+
}
120+
],
121+
"responses": {
122+
"200": {
123+
"description": "OK",
124+
"content": {
125+
"application/json": {
126+
"schema": {
127+
"$ref": "#/components/schemas/UserResponse"
128+
}
129+
}
130+
}
131+
},
132+
"400": {
133+
"description": "Bad Request",
134+
"content": {
135+
"application/problem+json": {
136+
"schema": {
137+
"$ref": "#/components/schemas/Problem1"
138+
}
139+
}
140+
}
141+
},
142+
"401": {
143+
"description": "Not Authorized",
144+
"content": {
145+
"application/problem+json": {
146+
"schema": {
147+
"$ref": "#/components/schemas/Problem1"
148+
}
149+
}
150+
}
151+
},
152+
"403": {
153+
"description": "Forbidden",
154+
"content": {
155+
"application/problem+json": {
156+
"schema": {
157+
"$ref": "#/components/schemas/Problem1"
158+
}
159+
}
160+
}
161+
},
162+
"404": {
163+
"description": "Not Found",
164+
"content": {
165+
"application/problem+json": {
166+
"schema": {
167+
"$ref": "#/components/schemas/Problem1"
168+
}
169+
}
170+
}
171+
}
172+
},
173+
"security": [
174+
{
175+
"bearerAuth": [
176+
"global"
177+
]
178+
}
179+
]
180+
}
181+
},
89182
"/institutions": {
90183
"get": {
91184
"tags": [
@@ -1016,6 +1109,78 @@
10161109
}
10171110
}
10181111
},
1112+
"UserResponse": {
1113+
"required": [
1114+
"id",
1115+
"name",
1116+
"surname"
1117+
],
1118+
"type": "object",
1119+
"properties": {
1120+
"id": {
1121+
"minLength": 1,
1122+
"type": "string"
1123+
},
1124+
"taxCode": {
1125+
"type": "string"
1126+
},
1127+
"name": {
1128+
"pattern": "\\S",
1129+
"type": "string"
1130+
},
1131+
"surname": {
1132+
"pattern": "\\S",
1133+
"type": "string"
1134+
},
1135+
"email": {
1136+
"type": "string"
1137+
},
1138+
"workContacts": {
1139+
"type": "object",
1140+
"additionalProperties": {
1141+
"type": "string"
1142+
}
1143+
}
1144+
}
1145+
},
1146+
"Problem1": {
1147+
"type": "object",
1148+
"properties": {
1149+
"detail": {
1150+
"type": "string"
1151+
},
1152+
"instance": {
1153+
"type": "string"
1154+
},
1155+
"invalidParams": {
1156+
"type": "array",
1157+
"items": {
1158+
"$ref": "#/components/schemas/InvalidParam1"
1159+
}
1160+
},
1161+
"status": {
1162+
"format": "int32",
1163+
"type": "integer"
1164+
},
1165+
"title": {
1166+
"type": "string"
1167+
},
1168+
"type": {
1169+
"type": "string"
1170+
}
1171+
}
1172+
},
1173+
"InvalidParam1": {
1174+
"type": "object",
1175+
"properties": {
1176+
"name": {
1177+
"type": "string"
1178+
},
1179+
"reason": {
1180+
"type": "string"
1181+
}
1182+
}
1183+
},
10191184
"InstitutionResource": {
10201185
"title": "InstitutionResource",
10211186
"required": [

‎infra/apim_v2/api_pnpg/pnpg_support_service/v1/openapi.prod.json

+4-2
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,8 @@
121121
"tags": [
122122
"Institution"
123123
],
124-
"summary": "The API retrieves user's info including details of roles on products",
124+
"summary": "Retrieve user's information including product role details",
125+
"description": "Fetches detailed information about users associated with a specific institution, including their roles on various products. This endpoint is useful for administrators to obtain comprehensive user-role mappings within an institution.",
125126
"operationId": "getInstitutionUsersUsingGET",
126127
"parameters": [
127128
{
@@ -202,7 +203,8 @@
202203
"tags": [
203204
"User"
204205
],
205-
"summary": "Retrieves user given userId and optional ProductId",
206+
"summary": "Retrieve user information by userId and optional ProductId",
207+
"description": "Retrieves user given userId and optional ProductId",
206208
"operationId": "getUserInfoUsingGET",
207209
"parameters": [
208210
{

0 commit comments

Comments
 (0)