diff --git a/docs/api/traceability-foss-backend.json b/docs/api/traceability-foss-backend.json index adf8621301..fe750a2092 100644 --- a/docs/api/traceability-foss-backend.json +++ b/docs/api/traceability-foss-backend.json @@ -31,12 +31,12 @@ "description": "The endpoint returns all policies .", "operationId": "policy", "responses": { - "415": { - "description": "Unsupported media type", + "200": { + "description": "Returns the policies", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/IrsPolicyResponse" } } } @@ -51,12 +51,12 @@ } } }, - "200": { - "description": "Returns the policies", + "404": { + "description": "Not found.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/IrsPolicyResponse" + "$ref": "#/components/schemas/ErrorResponse" } } } @@ -71,8 +71,8 @@ } } }, - "404": { - "description": "Not found.", + "401": { + "description": "Authorization failed.", "content": { "application/json": { "schema": { @@ -81,8 +81,8 @@ } } }, - "400": { - "description": "Bad request.", + "403": { + "description": "Forbidden.", "content": { "application/json": { "schema": { @@ -91,8 +91,8 @@ } } }, - "403": { - "description": "Forbidden.", + "415": { + "description": "Unsupported media type", "content": { "application/json": { "schema": { @@ -101,8 +101,8 @@ } } }, - "401": { - "description": "Authorization failed.", + "400": { + "description": "Bad request.", "content": { "application/json": { "schema": { @@ -138,13 +138,11 @@ "required": true }, "responses": { - "415": { - "description": "Unsupported media type", + "200": { + "description": "Update successful", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } + } } }, @@ -158,8 +156,8 @@ } } }, - "429": { - "description": "Too many requests.", + "404": { + "description": "Not found.", "content": { "application/json": { "schema": { @@ -168,8 +166,8 @@ } } }, - "404": { - "description": "Not found.", + "429": { + "description": "Too many requests.", "content": { "application/json": { "schema": { @@ -178,8 +176,8 @@ } } }, - "400": { - "description": "Bad request.", + "401": { + "description": "Authorization failed.", "content": { "application/json": { "schema": { @@ -198,16 +196,18 @@ } } }, - "200": { - "description": "Update successful", + "415": { + "description": "Unsupported media type", "content": { "application/json": { - + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } }, - "401": { - "description": "Authorization failed.", + "400": { + "description": "Bad request.", "content": { "application/json": { "schema": { @@ -243,8 +243,8 @@ "required": true }, "responses": { - "415": { - "description": "Unsupported media type", + "500": { + "description": "Internal server error.", "content": { "application/json": { "schema": { @@ -253,8 +253,8 @@ } } }, - "500": { - "description": "Internal server error.", + "404": { + "description": "Not found.", "content": { "application/json": { "schema": { @@ -263,18 +263,18 @@ } } }, - "200": { - "description": "Returns the policies", + "429": { + "description": "Too many requests.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreatePolicyResponse" + "$ref": "#/components/schemas/ErrorResponse" } } } }, - "429": { - "description": "Too many requests.", + "401": { + "description": "Authorization failed.", "content": { "application/json": { "schema": { @@ -283,8 +283,8 @@ } } }, - "404": { - "description": "Not found.", + "403": { + "description": "Forbidden.", "content": { "application/json": { "schema": { @@ -293,8 +293,8 @@ } } }, - "400": { - "description": "Bad request.", + "415": { + "description": "Unsupported media type", "content": { "application/json": { "schema": { @@ -303,18 +303,18 @@ } } }, - "403": { - "description": "Forbidden.", + "200": { + "description": "Returns the policies", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/CreatePolicyResponse" } } } }, - "401": { - "description": "Authorization failed.", + "400": { + "description": "Bad request.", "content": { "application/json": { "schema": { @@ -363,8 +363,8 @@ "required": true }, "responses": { - "415": { - "description": "Unsupported media type", + "500": { + "description": "Internal server error.", "content": { "application/json": { "schema": { @@ -373,8 +373,8 @@ } } }, - "500": { - "description": "Internal server error.", + "404": { + "description": "Not found.", "content": { "application/json": { "schema": { @@ -396,8 +396,8 @@ } } }, - "404": { - "description": "Not found.", + "401": { + "description": "Authorization failed.", "content": { "application/json": { "schema": { @@ -406,8 +406,8 @@ } } }, - "400": { - "description": "Bad request.", + "403": { + "description": "Forbidden.", "content": { "application/json": { "schema": { @@ -416,8 +416,8 @@ } } }, - "403": { - "description": "Forbidden.", + "415": { + "description": "Unsupported media type", "content": { "application/json": { "schema": { @@ -426,8 +426,8 @@ } } }, - "401": { - "description": "Authorization failed.", + "400": { + "description": "Bad request.", "content": { "application/json": { "schema": { @@ -455,12 +455,17 @@ "description": "The endpoint returns a result of BPN EDC URL mappings.", "operationId": "getBpnEdcs", "responses": { - "415": { - "description": "Unsupported media type", + "200": { + "description": "Returns the paged result found", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "maxItems": 2147483647, + "minItems": 0, + "type": "array", + "items": { + "$ref": "#/components/schemas/BpnEdcMappingResponse" + } } } } @@ -475,17 +480,12 @@ } } }, - "200": { - "description": "Returns the paged result found", + "404": { + "description": "Not found.", "content": { "application/json": { "schema": { - "maxItems": 2147483647, - "minItems": 0, - "type": "array", - "items": { - "$ref": "#/components/schemas/BpnEdcMappingResponse" - } + "$ref": "#/components/schemas/ErrorResponse" } } } @@ -500,8 +500,8 @@ } } }, - "404": { - "description": "Not found.", + "401": { + "description": "Authorization failed.", "content": { "application/json": { "schema": { @@ -510,8 +510,8 @@ } } }, - "400": { - "description": "Bad request.", + "403": { + "description": "Forbidden.", "content": { "application/json": { "schema": { @@ -520,8 +520,8 @@ } } }, - "403": { - "description": "Forbidden.", + "415": { + "description": "Unsupported media type", "content": { "application/json": { "schema": { @@ -530,8 +530,8 @@ } } }, - "401": { - "description": "Authorization failed.", + "400": { + "description": "Bad request.", "content": { "application/json": { "schema": { @@ -572,12 +572,17 @@ "required": true }, "responses": { - "415": { - "description": "Unsupported media type", + "200": { + "description": "Returns the paged result found for BpnEdcMapping", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "maxItems": 2147483647, + "minItems": 0, + "type": "array", + "items": { + "$ref": "#/components/schemas/BpnEdcMappingResponse" + } } } } @@ -592,8 +597,8 @@ } } }, - "429": { - "description": "Too many requests.", + "404": { + "description": "Not found.", "content": { "application/json": { "schema": { @@ -602,8 +607,8 @@ } } }, - "404": { - "description": "Not found.", + "429": { + "description": "Too many requests.", "content": { "application/json": { "schema": { @@ -612,8 +617,8 @@ } } }, - "400": { - "description": "Bad request.", + "401": { + "description": "Authorization failed.", "content": { "application/json": { "schema": { @@ -632,23 +637,18 @@ } } }, - "200": { - "description": "Returns the paged result found for BpnEdcMapping", + "415": { + "description": "Unsupported media type", "content": { "application/json": { "schema": { - "maxItems": 2147483647, - "minItems": 0, - "type": "array", - "items": { - "$ref": "#/components/schemas/BpnEdcMappingResponse" - } + "$ref": "#/components/schemas/ErrorResponse" } } } }, - "401": { - "description": "Authorization failed.", + "400": { + "description": "Bad request.", "content": { "application/json": { "schema": { @@ -689,12 +689,17 @@ "required": true }, "responses": { - "415": { - "description": "Unsupported media type", + "200": { + "description": "Returns the paged result found for BpnEdcMapping", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "maxItems": 2147483647, + "minItems": 0, + "type": "array", + "items": { + "$ref": "#/components/schemas/BpnEdcMappingResponse" + } } } } @@ -709,8 +714,8 @@ } } }, - "429": { - "description": "Too many requests.", + "404": { + "description": "Not found.", "content": { "application/json": { "schema": { @@ -719,8 +724,8 @@ } } }, - "404": { - "description": "Not found.", + "429": { + "description": "Too many requests.", "content": { "application/json": { "schema": { @@ -729,8 +734,8 @@ } } }, - "400": { - "description": "Bad request.", + "401": { + "description": "Authorization failed.", "content": { "application/json": { "schema": { @@ -749,23 +754,18 @@ } } }, - "200": { - "description": "Returns the paged result found for BpnEdcMapping", + "415": { + "description": "Unsupported media type", "content": { "application/json": { "schema": { - "maxItems": 2147483647, - "minItems": 0, - "type": "array", - "items": { - "$ref": "#/components/schemas/BpnEdcMappingResponse" - } + "$ref": "#/components/schemas/ErrorResponse" } } } }, - "401": { - "description": "Authorization failed.", + "400": { + "description": "Bad request.", "content": { "application/json": { "schema": { @@ -803,8 +803,8 @@ } ], "responses": { - "415": { - "description": "Unsupported media type", + "500": { + "description": "Internal server error.", "content": { "application/json": { "schema": { @@ -813,8 +813,8 @@ } } }, - "500": { - "description": "Internal server error.", + "404": { + "description": "Not found.", "content": { "application/json": { "schema": { @@ -823,18 +823,18 @@ } } }, - "429": { - "description": "Too many requests.", + "200": { + "description": "Returns submodel payload", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "type": "string" } } } }, - "404": { - "description": "Not found.", + "429": { + "description": "Too many requests.", "content": { "application/json": { "schema": { @@ -843,8 +843,8 @@ } } }, - "400": { - "description": "Bad request.", + "401": { + "description": "Authorization failed.", "content": { "application/json": { "schema": { @@ -853,18 +853,18 @@ } } }, - "200": { - "description": "Returns submodel payload", + "403": { + "description": "Forbidden.", "content": { "application/json": { "schema": { - "type": "string" + "$ref": "#/components/schemas/ErrorResponse" } } } }, - "403": { - "description": "Forbidden.", + "415": { + "description": "Unsupported media type", "content": { "application/json": { "schema": { @@ -873,8 +873,8 @@ } } }, - "401": { - "description": "Authorization failed.", + "400": { + "description": "Bad request.", "content": { "application/json": { "schema": { @@ -920,8 +920,8 @@ "required": true }, "responses": { - "415": { - "description": "Unsupported media type", + "500": { + "description": "Internal server error.", "content": { "application/json": { "schema": { @@ -930,8 +930,11 @@ } } }, - "500": { - "description": "Internal server error.", + "200": { + "description": "Ok." + }, + "404": { + "description": "Not found.", "content": { "application/json": { "schema": { @@ -940,9 +943,6 @@ } } }, - "200": { - "description": "Ok." - }, "429": { "description": "Too many requests.", "content": { @@ -953,8 +953,11 @@ } } }, - "404": { - "description": "Not found.", + "204": { + "description": "No Content." + }, + "401": { + "description": "Authorization failed.", "content": { "application/json": { "schema": { @@ -963,8 +966,8 @@ } } }, - "400": { - "description": "Bad request.", + "403": { + "description": "Forbidden.", "content": { "application/json": { "schema": { @@ -973,11 +976,8 @@ } } }, - "204": { - "description": "No Content." - }, - "403": { - "description": "Forbidden.", + "415": { + "description": "Unsupported media type", "content": { "application/json": { "schema": { @@ -986,8 +986,8 @@ } } }, - "401": { - "description": "Authorization failed.", + "400": { + "description": "Bad request.", "content": { "application/json": { "schema": { @@ -1025,8 +1025,8 @@ "required": true }, "responses": { - "415": { - "description": "Unsupported media type", + "500": { + "description": "Internal server error.", "content": { "application/json": { "schema": { @@ -1035,8 +1035,8 @@ } } }, - "500": { - "description": "Internal server error.", + "404": { + "description": "Not found.", "content": { "application/json": { "schema": { @@ -1055,8 +1055,8 @@ } } }, - "404": { - "description": "Not found.", + "401": { + "description": "Authorization failed.", "content": { "application/json": { "schema": { @@ -1065,8 +1065,8 @@ } } }, - "400": { - "description": "Bad request.", + "403": { + "description": "Forbidden.", "content": { "application/json": { "schema": { @@ -1075,8 +1075,8 @@ } } }, - "403": { - "description": "Forbidden.", + "415": { + "description": "Unsupported media type", "content": { "application/json": { "schema": { @@ -1095,8 +1095,8 @@ } } }, - "401": { - "description": "Authorization failed.", + "400": { + "description": "Bad request.", "content": { "application/json": { "schema": { @@ -1145,8 +1145,8 @@ "required": true }, "responses": { - "415": { - "description": "Unsupported media type", + "500": { + "description": "Internal server error.", "content": { "application/json": { "schema": { @@ -1155,8 +1155,8 @@ } } }, - "500": { - "description": "Internal server error.", + "404": { + "description": "Not found.", "content": { "application/json": { "schema": { @@ -1178,8 +1178,8 @@ } } }, - "404": { - "description": "Not found.", + "401": { + "description": "Authorization failed.", "content": { "application/json": { "schema": { @@ -1188,8 +1188,8 @@ } } }, - "400": { - "description": "Bad request.", + "403": { + "description": "Forbidden.", "content": { "application/json": { "schema": { @@ -1198,8 +1198,8 @@ } } }, - "403": { - "description": "Forbidden.", + "415": { + "description": "Unsupported media type", "content": { "application/json": { "schema": { @@ -1208,8 +1208,8 @@ } } }, - "401": { - "description": "Authorization failed.", + "400": { + "description": "Bad request.", "content": { "application/json": { "schema": { @@ -1258,8 +1258,8 @@ "required": true }, "responses": { - "415": { - "description": "Unsupported media type", + "500": { + "description": "Internal server error.", "content": { "application/json": { "schema": { @@ -1268,8 +1268,11 @@ } } }, - "500": { - "description": "Internal server error.", + "200": { + "description": "Ok." + }, + "404": { + "description": "Not found.", "content": { "application/json": { "schema": { @@ -1278,9 +1281,6 @@ } } }, - "200": { - "description": "Ok." - }, "204": { "description": "No content." }, @@ -1294,8 +1294,8 @@ } } }, - "404": { - "description": "Not found.", + "401": { + "description": "Authorization failed.", "content": { "application/json": { "schema": { @@ -1304,8 +1304,8 @@ } } }, - "400": { - "description": "Bad request.", + "403": { + "description": "Forbidden.", "content": { "application/json": { "schema": { @@ -1314,8 +1314,8 @@ } } }, - "403": { - "description": "Forbidden.", + "415": { + "description": "Unsupported media type", "content": { "application/json": { "schema": { @@ -1324,8 +1324,8 @@ } } }, - "401": { - "description": "Authorization failed.", + "400": { + "description": "Bad request.", "content": { "application/json": { "schema": { @@ -1364,8 +1364,8 @@ } ], "responses": { - "415": { - "description": "Unsupported media type", + "500": { + "description": "Internal server error.", "content": { "application/json": { "schema": { @@ -1374,8 +1374,11 @@ } } }, - "500": { - "description": "Internal server error.", + "200": { + "description": "Ok." + }, + "404": { + "description": "Not found.", "content": { "application/json": { "schema": { @@ -1384,8 +1387,8 @@ } } }, - "200": { - "description": "Ok." + "204": { + "description": "No content." }, "429": { "description": "Too many requests.", @@ -1397,11 +1400,8 @@ } } }, - "204": { - "description": "No content." - }, - "404": { - "description": "Not found.", + "401": { + "description": "Authorization failed.", "content": { "application/json": { "schema": { @@ -1410,8 +1410,8 @@ } } }, - "400": { - "description": "Bad request.", + "403": { + "description": "Forbidden.", "content": { "application/json": { "schema": { @@ -1420,8 +1420,8 @@ } } }, - "403": { - "description": "Forbidden.", + "415": { + "description": "Unsupported media type", "content": { "application/json": { "schema": { @@ -1430,8 +1430,8 @@ } } }, - "401": { - "description": "Authorization failed.", + "400": { + "description": "Bad request.", "content": { "application/json": { "schema": { @@ -1470,8 +1470,8 @@ } ], "responses": { - "415": { - "description": "Unsupported media type", + "500": { + "description": "Internal server error.", "content": { "application/json": { "schema": { @@ -1480,8 +1480,11 @@ } } }, - "500": { - "description": "Internal server error.", + "200": { + "description": "Ok." + }, + "404": { + "description": "Not found.", "content": { "application/json": { "schema": { @@ -1490,8 +1493,8 @@ } } }, - "200": { - "description": "Ok." + "204": { + "description": "No content." }, "429": { "description": "Too many requests.", @@ -1503,11 +1506,8 @@ } } }, - "204": { - "description": "No content." - }, - "404": { - "description": "Not found.", + "401": { + "description": "Authorization failed.", "content": { "application/json": { "schema": { @@ -1516,8 +1516,8 @@ } } }, - "400": { - "description": "Bad request.", + "403": { + "description": "Forbidden.", "content": { "application/json": { "schema": { @@ -1526,8 +1526,8 @@ } } }, - "403": { - "description": "Forbidden.", + "415": { + "description": "Unsupported media type", "content": { "application/json": { "schema": { @@ -1536,8 +1536,8 @@ } } }, - "401": { - "description": "Authorization failed.", + "400": { + "description": "Bad request.", "content": { "application/json": { "schema": { @@ -1556,27 +1556,27 @@ ] } }, - "/notifications/filter": { + "/notifications/searchable-values": { "post": { "tags": [ "Notifications" ], - "summary": "Filter notifications defined by the request body", - "description": "The endpoint returns notifications as paged result.", - "operationId": "filterNotifications", + "summary": "searchable-values", + "description": "The endpoint returns searchable values for given fieldName.", + "operationId": "searchable-values", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PageableFilterRequest" + "$ref": "#/components/schemas/SearchableNotificationsRequest" } } }, "required": true }, "responses": { - "415": { - "description": "Unsupported media type", + "500": { + "description": "Internal server error.", "content": { "application/json": { "schema": { @@ -1585,8 +1585,8 @@ } } }, - "500": { - "description": "Internal server error.", + "404": { + "description": "Not found.", "content": { "application/json": { "schema": { @@ -1596,55 +1596,169 @@ } }, "200": { - "description": "Returns the paged result found for Notifications", + "description": "Returns searchable values for given fieldName.", "content": { "application/json": { "schema": { "maxItems": 2147483647, + "minItems": 0, "type": "array", - "description": "Notifications", "items": { - "type": "object", - "properties": { - "id": { - "maximum": 255, - "minimum": 0, - "maxLength": 255, - "type": "integer", - "format": "int64", - "example": 66 - }, - "title": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "Title" - }, - "status": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "CREATED", - "enum": [ - "CREATED", - "SENT", - "RECEIVED", - "ACKNOWLEDGED", - "ACCEPTED", - "DECLINED", - "CANCELED", - "CLOSED" - ] - }, - "description": { - "maxLength": 1000, - "minLength": 0, - "type": "string", - "example": "DescriptionText" - }, - "createdBy": { - "maxLength": 255, - "minLength": 0, + "type": "string" + } + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] + } + }, + "/notifications/filter": { + "post": { + "tags": [ + "Notifications" + ], + "summary": "Filter notifications defined by the request body", + "description": "The endpoint returns notifications as paged result.", + "operationId": "filterNotifications", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PageableFilterRequest" + } + } + }, + "required": true + }, + "responses": { + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Returns the paged result found for Notifications", + "content": { + "application/json": { + "schema": { + "maxItems": 2147483647, + "type": "array", + "description": "Notifications", + "items": { + "type": "object", + "properties": { + "id": { + "maximum": 255, + "minimum": 0, + "maxLength": 255, + "type": "integer", + "format": "int64", + "example": 66 + }, + "title": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Title" + }, + "status": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "CREATED", + "enum": [ + "CREATED", + "SENT", + "RECEIVED", + "ACKNOWLEDGED", + "ACCEPTED", + "DECLINED", + "CANCELED", + "CLOSED" + ] + }, + "description": { + "maxLength": 1000, + "minLength": 0, + "type": "string", + "example": "DescriptionText" + }, + "createdBy": { + "maxLength": 255, + "minLength": 0, "type": "string", "example": "BPNL00000003AYRE" }, @@ -1752,8 +1866,8 @@ } } }, - "404": { - "description": "Not found.", + "401": { + "description": "Authorization failed.", "content": { "application/json": { "schema": { @@ -1762,8 +1876,8 @@ } } }, - "400": { - "description": "Bad request.", + "403": { + "description": "Forbidden.", "content": { "application/json": { "schema": { @@ -1772,8 +1886,8 @@ } } }, - "403": { - "description": "Forbidden.", + "415": { + "description": "Unsupported media type", "content": { "application/json": { "schema": { @@ -1782,8 +1896,8 @@ } } }, - "401": { - "description": "Authorization failed.", + "400": { + "description": "Bad request.", "content": { "application/json": { "schema": { @@ -1821,8 +1935,8 @@ "required": true }, "responses": { - "415": { - "description": "Unsupported media type", + "500": { + "description": "Internal server error.", "content": { "application/json": { "schema": { @@ -1831,8 +1945,8 @@ } } }, - "500": { - "description": "Internal server error.", + "404": { + "description": "Not found.", "content": { "application/json": { "schema": { @@ -1851,8 +1965,8 @@ } } }, - "404": { - "description": "Not found.", + "401": { + "description": "Authorization failed.", "content": { "application/json": { "schema": { @@ -1861,8 +1975,8 @@ } } }, - "400": { - "description": "Bad request.", + "403": { + "description": "Forbidden.", "content": { "application/json": { "schema": { @@ -1871,8 +1985,8 @@ } } }, - "403": { - "description": "Forbidden.", + "415": { + "description": "Unsupported media type", "content": { "application/json": { "schema": { @@ -1891,8 +2005,8 @@ } } }, - "401": { - "description": "Authorization failed.", + "400": { + "description": "Bad request.", "content": { "application/json": { "schema": { @@ -1930,95 +2044,95 @@ "required": true }, "responses": { - "429": { - "description": "Too many requests.", + "401": { + "description": "Authorization failed.", "content": { "application/json": { "schema": { "type": "string", "example": { - "message": "Too many requests." + "message": "Authorization failed." } } } } }, - "500": { - "description": "Internal server error.", + "404": { + "description": "Not found.", "content": { "application/json": { "schema": { "type": "string", "example": { - "message": "Internal server error." + "message": "Not found." } } } } }, - "404": { - "description": "Not found.", + "415": { + "description": "Unsupported media type.", "content": { "application/json": { "schema": { "type": "string", "example": { - "message": "Not found." + "message": "Unsupported media type." } } } } }, - "200": { - "description": "Ok.", + "403": { + "description": "Forbidden.", "content": { "application/json": { "schema": { - "maxItems": 2147483647, - "minItems": 0, - "type": "array", - "description": "PageResults", - "items": { - "$ref": "#/components/schemas/PageResultContractResponse" + "type": "string", + "example": { + "message": "Forbidden." } } } } }, - "401": { - "description": "Authorization failed.", + "429": { + "description": "Too many requests.", "content": { "application/json": { "schema": { "type": "string", "example": { - "message": "Authorization failed." + "message": "Too many requests." } } } } }, - "403": { - "description": "Forbidden.", + "200": { + "description": "Ok.", "content": { "application/json": { "schema": { - "type": "string", - "example": { - "message": "Forbidden." + "maxItems": 2147483647, + "minItems": 0, + "type": "array", + "description": "PageResults", + "items": { + "$ref": "#/components/schemas/PageResultContractResponse" } } } } }, - "415": { - "description": "Unsupported media type.", + "500": { + "description": "Internal server error.", "content": { "application/json": { "schema": { "type": "string", "example": { - "message": "Unsupported media type." + "message": "Internal server error." } } } @@ -2078,16 +2192,11 @@ "required": true }, "responses": { - "204": { - "description": "No Content." - }, - "415": { - "description": "Unsupported media type", + "200": { + "description": "OK.", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } + } } }, @@ -2101,8 +2210,8 @@ } } }, - "429": { - "description": "Too many requests.", + "404": { + "description": "Not found.", "content": { "application/json": { "schema": { @@ -2111,8 +2220,11 @@ } } }, - "404": { - "description": "Not found.", + "204": { + "description": "No Content." + }, + "429": { + "description": "Too many requests.", "content": { "application/json": { "schema": { @@ -2121,8 +2233,8 @@ } } }, - "400": { - "description": "Bad request.", + "401": { + "description": "Authorization failed.", "content": { "application/json": { "schema": { @@ -2141,16 +2253,18 @@ } } }, - "200": { - "description": "OK.", + "415": { + "description": "Unsupported media type", "content": { "application/json": { - + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } }, - "401": { - "description": "Authorization failed.", + "400": { + "description": "Bad request.", "content": { "application/json": { "schema": { @@ -2196,19 +2310,6 @@ } }, "responses": { - "204": { - "description": "No Content." - }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, "500": { "description": "Internal server error.", "content": { @@ -2219,8 +2320,8 @@ } } }, - "429": { - "description": "Too many requests.", + "404": { + "description": "Not found.", "content": { "application/json": { "schema": { @@ -2239,8 +2340,11 @@ } } }, - "404": { - "description": "Not found.", + "204": { + "description": "No Content." + }, + "429": { + "description": "Too many requests.", "content": { "application/json": { "schema": { @@ -2249,8 +2353,8 @@ } } }, - "400": { - "description": "Bad request.", + "401": { + "description": "Authorization failed.", "content": { "application/json": { "schema": { @@ -2269,8 +2373,18 @@ } } }, - "401": { - "description": "Authorization failed.", + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", "content": { "application/json": { "schema": { @@ -2308,8 +2422,8 @@ "required": true }, "responses": { - "415": { - "description": "Unsupported media type", + "500": { + "description": "Internal server error.", "content": { "application/json": { "schema": { @@ -2318,8 +2432,8 @@ } } }, - "500": { - "description": "Internal server error.", + "404": { + "description": "Not found.", "content": { "application/json": { "schema": { @@ -2338,8 +2452,8 @@ } } }, - "404": { - "description": "Not found.", + "401": { + "description": "Authorization failed.", "content": { "application/json": { "schema": { @@ -2348,8 +2462,8 @@ } } }, - "400": { - "description": "Bad request.", + "403": { + "description": "Forbidden.", "content": { "application/json": { "schema": { @@ -2358,8 +2472,8 @@ } } }, - "403": { - "description": "Forbidden.", + "415": { + "description": "Unsupported media type", "content": { "application/json": { "schema": { @@ -2371,8 +2485,8 @@ "201": { "description": "Created." }, - "401": { - "description": "Authorization failed.", + "400": { + "description": "Bad request.", "content": { "application/json": { "schema": { @@ -2399,7 +2513,7 @@ ], "summary": "Get searchable values for a fieldName", "description": "The endpoint returns searchable values for given fieldName.", - "operationId": "searchable-values", + "operationId": "searchable-values_1", "requestBody": { "content": { "application/json": { @@ -2411,8 +2525,8 @@ "required": true }, "responses": { - "415": { - "description": "Unsupported media type", + "500": { + "description": "Internal server error.", "content": { "application/json": { "schema": { @@ -2421,8 +2535,8 @@ } } }, - "500": { - "description": "Internal server error.", + "404": { + "description": "Not found.", "content": { "application/json": { "schema": { @@ -2431,18 +2545,23 @@ } } }, - "429": { - "description": "Too many requests.", + "200": { + "description": "Returns searchable values for given fieldName.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "maxItems": 2147483647, + "minItems": 0, + "type": "array", + "items": { + "type": "string" + } } } } }, - "404": { - "description": "Not found.", + "429": { + "description": "Too many requests.", "content": { "application/json": { "schema": { @@ -2451,8 +2570,8 @@ } } }, - "400": { - "description": "Bad request.", + "401": { + "description": "Authorization failed.", "content": { "application/json": { "schema": { @@ -2471,23 +2590,18 @@ } } }, - "200": { - "description": "Returns searchable values for given fieldName.", + "415": { + "description": "Unsupported media type", "content": { "application/json": { "schema": { - "maxItems": 2147483647, - "minItems": 0, - "type": "array", - "items": { - "type": "string" - } + "$ref": "#/components/schemas/ErrorResponse" } } } }, - "401": { - "description": "Authorization failed.", + "400": { + "description": "Bad request.", "content": { "application/json": { "schema": { @@ -2518,23 +2632,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetDetailInformationRequest" - } - } - }, - "required": true - }, - "responses": { - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } + "$ref": "#/components/schemas/GetDetailInformationRequest" } } }, + "required": true + }, + "responses": { "500": { "description": "Internal server error.", "content": { @@ -2545,8 +2649,8 @@ } } }, - "429": { - "description": "Too many requests.", + "404": { + "description": "Not found.", "content": { "application/json": { "schema": { @@ -2747,8 +2851,8 @@ } } }, - "404": { - "description": "Not found.", + "429": { + "description": "Too many requests.", "content": { "application/json": { "schema": { @@ -2757,8 +2861,8 @@ } } }, - "400": { - "description": "Bad request.", + "401": { + "description": "Authorization failed.", "content": { "application/json": { "schema": { @@ -2777,8 +2881,18 @@ } } }, - "401": { - "description": "Authorization failed.", + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", "content": { "application/json": { "schema": { @@ -2816,8 +2930,8 @@ "required": true }, "responses": { - "415": { - "description": "Unsupported media type", + "500": { + "description": "Internal server error.", "content": { "application/json": { "schema": { @@ -2826,8 +2940,8 @@ } } }, - "500": { - "description": "Internal server error.", + "404": { + "description": "Not found.", "content": { "application/json": { "schema": { @@ -2846,8 +2960,8 @@ } } }, - "404": { - "description": "Not found.", + "401": { + "description": "Authorization failed.", "content": { "application/json": { "schema": { @@ -2856,8 +2970,8 @@ } } }, - "400": { - "description": "Bad request.", + "403": { + "description": "Forbidden.", "content": { "application/json": { "schema": { @@ -2866,8 +2980,8 @@ } } }, - "403": { - "description": "Forbidden.", + "415": { + "description": "Unsupported media type", "content": { "application/json": { "schema": { @@ -2879,8 +2993,8 @@ "201": { "description": "Created." }, - "401": { - "description": "Authorization failed.", + "400": { + "description": "Bad request.", "content": { "application/json": { "schema": { @@ -2907,7 +3021,7 @@ ], "summary": "Get searchable values for a fieldName", "description": "The endpoint returns searchable values for given fieldName.", - "operationId": "searchable-values_1", + "operationId": "searchable-values_2", "requestBody": { "content": { "application/json": { @@ -2919,8 +3033,8 @@ "required": true }, "responses": { - "415": { - "description": "Unsupported media type", + "500": { + "description": "Internal server error.", "content": { "application/json": { "schema": { @@ -2929,8 +3043,8 @@ } } }, - "500": { - "description": "Internal server error.", + "404": { + "description": "Not found.", "content": { "application/json": { "schema": { @@ -2939,18 +3053,23 @@ } } }, - "429": { - "description": "Too many requests.", + "200": { + "description": "Returns searchable values for given fieldName.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "maxItems": 2147483647, + "minItems": 0, + "type": "array", + "items": { + "type": "string" + } } } } }, - "404": { - "description": "Not found.", + "429": { + "description": "Too many requests.", "content": { "application/json": { "schema": { @@ -2959,8 +3078,8 @@ } } }, - "400": { - "description": "Bad request.", + "401": { + "description": "Authorization failed.", "content": { "application/json": { "schema": { @@ -2979,23 +3098,18 @@ } } }, - "200": { - "description": "Returns searchable values for given fieldName.", + "415": { + "description": "Unsupported media type", "content": { "application/json": { "schema": { - "maxItems": 2147483647, - "minItems": 0, - "type": "array", - "items": { - "type": "string" - } + "$ref": "#/components/schemas/ErrorResponse" } } } }, - "401": { - "description": "Authorization failed.", + "400": { + "description": "Bad request.", "content": { "application/json": { "schema": { @@ -3033,16 +3147,6 @@ "required": true }, "responses": { - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, "500": { "description": "Internal server error.", "content": { @@ -3053,16 +3157,6 @@ } } }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, "404": { "description": "Not found.", "content": { @@ -3073,18 +3167,8 @@ } } }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden.", + "429": { + "description": "Too many requests.", "content": { "application/json": { "schema": { @@ -3294,6 +3378,36 @@ } } } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } } }, "security": [ @@ -3324,6 +3438,26 @@ } ], "responses": { + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, "200": { "description": "Returns the assets found", "content": { @@ -3511,26 +3645,6 @@ } } }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, "429": { "description": "Too many requests.", "content": { @@ -3541,8 +3655,8 @@ } } }, - "404": { - "description": "Not found.", + "401": { + "description": "Authorization failed.", "content": { "application/json": { "schema": { @@ -3551,8 +3665,8 @@ } } }, - "400": { - "description": "Bad request.", + "403": { + "description": "Forbidden.", "content": { "application/json": { "schema": { @@ -3561,8 +3675,8 @@ } } }, - "403": { - "description": "Forbidden.", + "415": { + "description": "Unsupported media type", "content": { "application/json": { "schema": { @@ -3571,8 +3685,8 @@ } } }, - "401": { - "description": "Authorization failed.", + "400": { + "description": "Bad request.", "content": { "application/json": { "schema": { @@ -3618,26 +3732,6 @@ "required": true }, "responses": { - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, "200": { "description": "Returns the updated asset", "content": { @@ -3825,6 +3919,26 @@ } } }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, "429": { "description": "Too many requests.", "content": { @@ -3835,8 +3949,8 @@ } } }, - "404": { - "description": "Not found.", + "401": { + "description": "Authorization failed.", "content": { "application/json": { "schema": { @@ -3845,8 +3959,8 @@ } } }, - "400": { - "description": "Bad request.", + "403": { + "description": "Forbidden.", "content": { "application/json": { "schema": { @@ -3855,8 +3969,8 @@ } } }, - "403": { - "description": "Forbidden.", + "415": { + "description": "Unsupported media type", "content": { "application/json": { "schema": { @@ -3865,8 +3979,8 @@ } } }, - "401": { - "description": "Authorization failed.", + "400": { + "description": "Bad request.", "content": { "application/json": { "schema": { @@ -3904,6 +4018,16 @@ } ], "responses": { + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, "200": { "description": "Returns the assets found", "content": { @@ -4091,18 +4215,8 @@ } } }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error.", + "404": { + "description": "Not found.", "content": { "application/json": { "schema": { @@ -4121,8 +4235,8 @@ } } }, - "404": { - "description": "Not found.", + "401": { + "description": "Authorization failed.", "content": { "application/json": { "schema": { @@ -4131,8 +4245,8 @@ } } }, - "400": { - "description": "Bad request.", + "403": { + "description": "Forbidden.", "content": { "application/json": { "schema": { @@ -4141,8 +4255,8 @@ } } }, - "403": { - "description": "Forbidden.", + "415": { + "description": "Unsupported media type", "content": { "application/json": { "schema": { @@ -4151,8 +4265,8 @@ } } }, - "401": { - "description": "Authorization failed.", + "400": { + "description": "Bad request.", "content": { "application/json": { "schema": { @@ -4198,36 +4312,6 @@ "required": true }, "responses": { - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, "200": { "description": "Returns the updated asset", "content": { @@ -4415,8 +4499,8 @@ } } }, - "404": { - "description": "Not found.", + "500": { + "description": "Internal server error.", "content": { "application/json": { "schema": { @@ -4425,8 +4509,8 @@ } } }, - "400": { - "description": "Bad request.", + "404": { + "description": "Not found.", "content": { "application/json": { "schema": { @@ -4435,8 +4519,8 @@ } } }, - "403": { - "description": "Forbidden.", + "429": { + "description": "Too many requests.", "content": { "application/json": { "schema": { @@ -4454,51 +4538,9 @@ } } } - } - }, - "security": [ - { - "oAuth2": [ - "profile email" - ] - } - ] - } - }, - "/registry/reload": { - "get": { - "tags": [ - "Registry" - ], - "summary": "Triggers reload of shell descriptors", - "description": "The endpoint Triggers reload of shell descriptors.", - "operationId": "reload", - "responses": { - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "202": { - "description": "Created registry reload job." - }, - "429": { - "description": "Too many requests.", + "403": { + "description": "Forbidden.", "content": { "application/json": { "schema": { @@ -4507,8 +4549,8 @@ } } }, - "404": { - "description": "Not found.", + "415": { + "description": "Unsupported media type", "content": { "application/json": { "schema": { @@ -4526,26 +4568,6 @@ } } } - }, - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } } }, "security": [ @@ -4557,35 +4579,15 @@ ] } }, - "/policies/{policyId}": { + "/registry/reload": { "get": { "tags": [ - "Policies" - ], - "summary": "Gets policy by id", - "description": "The endpoint returns policy by id.", - "operationId": "getPolicyById", - "parameters": [ - { - "name": "policyId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } + "Registry" ], + "summary": "Triggers reload of shell descriptors", + "description": "The endpoint Triggers reload of shell descriptors.", + "operationId": "reload", "responses": { - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, "500": { "description": "Internal server error.", "content": { @@ -4596,16 +4598,19 @@ } } }, - "200": { - "description": "Returns the policies", + "404": { + "description": "Not found.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PolicyResponse" + "$ref": "#/components/schemas/ErrorResponse" } } } }, + "202": { + "description": "Created registry reload job." + }, "429": { "description": "Too many requests.", "content": { @@ -4616,8 +4621,8 @@ } } }, - "404": { - "description": "Not found.", + "401": { + "description": "Authorization failed.", "content": { "application/json": { "schema": { @@ -4626,8 +4631,8 @@ } } }, - "400": { - "description": "Bad request.", + "403": { + "description": "Forbidden.", "content": { "application/json": { "schema": { @@ -4636,8 +4641,8 @@ } } }, - "403": { - "description": "Forbidden.", + "415": { + "description": "Unsupported media type", "content": { "application/json": { "schema": { @@ -4646,8 +4651,8 @@ } } }, - "401": { - "description": "Authorization failed.", + "400": { + "description": "Bad request.", "content": { "application/json": { "schema": { @@ -4664,14 +4669,16 @@ ] } ] - }, - "delete": { + } + }, + "/policies/{policyId}": { + "get": { "tags": [ "Policies" ], - "summary": "Deletes a policy ", - "description": "The endpoint deletes policies.", - "operationId": "deletePolicy", + "summary": "Gets policy by id", + "description": "The endpoint returns policy by id.", + "operationId": "getPolicyById", "parameters": [ { "name": "policyId", @@ -4684,15 +4691,17 @@ ], "responses": { "200": { - "description": "Deletion successful", + "description": "OK.", "content": { "application/json": { - + "schema": { + "$ref": "#/components/schemas/PolicyResponse" + } } } }, - "415": { - "description": "Unsupported media type", + "500": { + "description": "Internal server error.", "content": { "application/json": { "schema": { @@ -4701,8 +4710,8 @@ } } }, - "500": { - "description": "Internal server error.", + "404": { + "description": "Not found.", "content": { "application/json": { "schema": { @@ -4721,8 +4730,8 @@ } } }, - "404": { - "description": "Not found.", + "401": { + "description": "Authorization failed.", "content": { "application/json": { "schema": { @@ -4731,8 +4740,8 @@ } } }, - "400": { - "description": "Bad request.", + "403": { + "description": "Forbidden.", "content": { "application/json": { "schema": { @@ -4741,8 +4750,8 @@ } } }, - "403": { - "description": "Forbidden.", + "415": { + "description": "Unsupported media type", "content": { "application/json": { "schema": { @@ -4751,8 +4760,8 @@ } } }, - "401": { - "description": "Authorization failed.", + "400": { + "description": "Bad request.", "content": { "application/json": { "schema": { @@ -4769,30 +4778,27 @@ ] } ] - } - }, - "/notifications/{notificationId}": { - "get": { + }, + "delete": { "tags": [ - "Notifications" + "Policies" ], - "summary": "Gets notification by id", - "description": "The endpoint returns notification by id.", - "operationId": "getNotification", + "summary": "Deletes a policy ", + "description": "The endpoint deletes policies.", + "operationId": "deletePolicy", "parameters": [ { - "name": "notificationId", + "name": "policyId", "in": "path", "required": true, "schema": { - "type": "integer", - "format": "int64" + "type": "string" } } ], "responses": { - "415": { - "description": "Unsupported media type", + "500": { + "description": "Internal server error.", "content": { "application/json": { "schema": { @@ -4801,27 +4807,20 @@ } } }, - "500": { - "description": "Internal server error.", + "200": { + "description": "Deletion successful", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } + } } }, - "200": { - "description": "OK.", + "404": { + "description": "Not found.", "content": { "application/json": { "schema": { - "maxItems": 2147483647, - "type": "array", - "description": "Notifications", - "items": { - "$ref": "#/components/schemas/NotificationResponse" - } + "$ref": "#/components/schemas/ErrorResponse" } } } @@ -4836,8 +4835,8 @@ } } }, - "404": { - "description": "Not found.", + "401": { + "description": "Authorization failed.", "content": { "application/json": { "schema": { @@ -4846,8 +4845,8 @@ } } }, - "400": { - "description": "Bad request.", + "403": { + "description": "Forbidden.", "content": { "application/json": { "schema": { @@ -4856,8 +4855,8 @@ } } }, - "403": { - "description": "Forbidden.", + "415": { + "description": "Unsupported media type", "content": { "application/json": { "schema": { @@ -4866,8 +4865,8 @@ } } }, - "401": { - "description": "Authorization failed.", + "400": { + "description": "Bad request.", "content": { "application/json": { "schema": { @@ -4886,56 +4885,28 @@ ] } }, - "/notifications/distinctFilterValues": { + "/notifications/{notificationId}": { "get": { "tags": [ "Notifications" ], - "summary": "getDistinctFilterValues", - "description": "The endpoint returns a distinct filter values for given fieldName of notification.", - "operationId": "distinctFilterValues", + "summary": "Gets notification by id", + "description": "The endpoint returns notification by id.", + "operationId": "getNotification", "parameters": [ { - "name": "fieldName", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "size", - "in": "query", + "name": "notificationId", + "in": "path", "required": true, "schema": { "type": "integer", - "format": "int32" - } - }, - { - "name": "startWith", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "channel", - "in": "query", - "required": true, - "schema": { - "type": "string", - "enum": [ - "SENDER", - "RECEIVER" - ] + "format": "int64" } } ], "responses": { - "415": { - "description": "Unsupported media type", + "500": { + "description": "Internal server error.", "content": { "application/json": { "schema": { @@ -4944,18 +4915,23 @@ } } }, - "500": { - "description": "Internal server error.", + "200": { + "description": "OK.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "maxItems": 2147483647, + "type": "array", + "description": "Notifications", + "items": { + "$ref": "#/components/schemas/NotificationResponse" + } } } } }, - "429": { - "description": "Too many requests.", + "404": { + "description": "Not found.", "content": { "application/json": { "schema": { @@ -4964,8 +4940,8 @@ } } }, - "404": { - "description": "Not found.", + "429": { + "description": "Too many requests.", "content": { "application/json": { "schema": { @@ -4974,8 +4950,8 @@ } } }, - "400": { - "description": "Bad request.", + "401": { + "description": "Authorization failed.", "content": { "application/json": { "schema": { @@ -4984,23 +4960,18 @@ } } }, - "200": { - "description": "Returns a distinct filter values for given fieldName.", + "403": { + "description": "Forbidden.", "content": { "application/json": { "schema": { - "maxItems": 2147483647, - "minItems": 0, - "type": "array", - "items": { - "type": "string" - } + "$ref": "#/components/schemas/ErrorResponse" } } } }, - "403": { - "description": "Forbidden.", + "415": { + "description": "Unsupported media type", "content": { "application/json": { "schema": { @@ -5009,8 +4980,8 @@ } } }, - "401": { - "description": "Authorization failed.", + "400": { + "description": "Bad request.", "content": { "application/json": { "schema": { @@ -5038,8 +5009,8 @@ "description": "The endpoint can return limited data based on the user role", "operationId": "dashboard", "responses": { - "415": { - "description": "Unsupported media type", + "500": { + "description": "Internal server error.", "content": { "application/json": { "schema": { @@ -5048,8 +5019,8 @@ } } }, - "500": { - "description": "Internal server error.", + "404": { + "description": "Not found.", "content": { "application/json": { "schema": { @@ -5078,8 +5049,8 @@ } } }, - "404": { - "description": "Not found.", + "401": { + "description": "Authorization failed.", "content": { "application/json": { "schema": { @@ -5088,8 +5059,8 @@ } } }, - "400": { - "description": "Bad request.", + "403": { + "description": "Forbidden.", "content": { "application/json": { "schema": { @@ -5098,8 +5069,8 @@ } } }, - "403": { - "description": "Forbidden.", + "415": { + "description": "Unsupported media type", "content": { "application/json": { "schema": { @@ -5108,8 +5079,8 @@ } } }, - "401": { - "description": "Authorization failed.", + "400": { + "description": "Bad request.", "content": { "application/json": { "schema": { @@ -5148,21 +5119,18 @@ } ], "responses": { - "200": { - "description": "OK.", + "500": { + "description": "Internal server error.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ImportReportResponse" + "$ref": "#/components/schemas/ErrorResponse" } } } }, - "204": { - "description": "No Content." - }, - "415": { - "description": "Unsupported media type", + "404": { + "description": "Not found.", "content": { "application/json": { "schema": { @@ -5171,8 +5139,11 @@ } } }, - "500": { - "description": "Internal server error.", + "204": { + "description": "No Content." + }, + "429": { + "description": "Too many requests.", "content": { "application/json": { "schema": { @@ -5181,8 +5152,8 @@ } } }, - "429": { - "description": "Too many requests.", + "401": { + "description": "Authorization failed.", "content": { "application/json": { "schema": { @@ -5191,8 +5162,8 @@ } } }, - "404": { - "description": "Not found.", + "403": { + "description": "Forbidden.", "content": { "application/json": { "schema": { @@ -5201,8 +5172,8 @@ } } }, - "400": { - "description": "Bad request.", + "415": { + "description": "Unsupported media type", "content": { "application/json": { "schema": { @@ -5211,18 +5182,18 @@ } } }, - "403": { - "description": "Forbidden.", + "200": { + "description": "OK.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/ImportReportResponse" } } } }, - "401": { - "description": "Authorization failed.", + "400": { + "description": "Bad request.", "content": { "application/json": { "schema": { @@ -5268,16 +5239,6 @@ } ], "responses": { - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, "500": { "description": "Internal server error.", "content": { @@ -5288,36 +5249,6 @@ } } }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, "200": { "description": "Returns the paged result found for Asset", "content": { @@ -5510,8 +5441,18 @@ } } }, - "403": { - "description": "Forbidden.", + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", "content": { "application/json": { "schema": { @@ -5529,6 +5470,36 @@ } } } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } } }, "security": [ @@ -5559,8 +5530,8 @@ } ], "responses": { - "415": { - "description": "Unsupported media type", + "500": { + "description": "Internal server error.", "content": { "application/json": { "schema": { @@ -5569,8 +5540,8 @@ } } }, - "500": { - "description": "Internal server error.", + "404": { + "description": "Not found.", "content": { "application/json": { "schema": { @@ -5776,8 +5747,8 @@ } } }, - "404": { - "description": "Not found.", + "401": { + "description": "Authorization failed.", "content": { "application/json": { "schema": { @@ -5786,8 +5757,8 @@ } } }, - "400": { - "description": "Bad request.", + "403": { + "description": "Forbidden.", "content": { "application/json": { "schema": { @@ -5796,8 +5767,8 @@ } } }, - "403": { - "description": "Forbidden.", + "415": { + "description": "Unsupported media type", "content": { "application/json": { "schema": { @@ -5806,8 +5777,8 @@ } } }, - "401": { - "description": "Authorization failed.", + "400": { + "description": "Bad request.", "content": { "application/json": { "schema": { @@ -6045,8 +6016,8 @@ } } }, - "415": { - "description": "Unsupported media type", + "500": { + "description": "Internal server error.", "content": { "application/json": { "schema": { @@ -6055,8 +6026,8 @@ } } }, - "500": { - "description": "Internal server error.", + "404": { + "description": "Not found.", "content": { "application/json": { "schema": { @@ -6075,8 +6046,8 @@ } } }, - "404": { - "description": "Not found.", + "401": { + "description": "Authorization failed.", "content": { "application/json": { "schema": { @@ -6085,8 +6056,8 @@ } } }, - "400": { - "description": "Bad request.", + "403": { + "description": "Forbidden.", "content": { "application/json": { "schema": { @@ -6095,8 +6066,8 @@ } } }, - "403": { - "description": "Forbidden.", + "415": { + "description": "Unsupported media type", "content": { "application/json": { "schema": { @@ -6105,8 +6076,8 @@ } } }, - "401": { - "description": "Authorization failed.", + "400": { + "description": "Bad request.", "content": { "application/json": { "schema": { @@ -6134,12 +6105,17 @@ "description": "The endpoint returns a map for assets consumed by the map.", "operationId": "assetsCountryMap", "responses": { - "415": { - "description": "Unsupported media type", + "200": { + "description": "Returns the assets found", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "maxItems": 2147483647, + "minItems": 0, + "type": "array", + "items": { + "type": "string" + } } } } @@ -6154,17 +6130,12 @@ } } }, - "200": { - "description": "Returns the assets found", + "404": { + "description": "Not found.", "content": { "application/json": { "schema": { - "maxItems": 2147483647, - "minItems": 0, - "type": "array", - "items": { - "type": "string" - } + "$ref": "#/components/schemas/ErrorResponse" } } } @@ -6179,8 +6150,8 @@ } } }, - "404": { - "description": "Not found.", + "401": { + "description": "Authorization failed.", "content": { "application/json": { "schema": { @@ -6189,8 +6160,8 @@ } } }, - "400": { - "description": "Bad request.", + "403": { + "description": "Forbidden.", "content": { "application/json": { "schema": { @@ -6199,8 +6170,8 @@ } } }, - "403": { - "description": "Forbidden.", + "415": { + "description": "Unsupported media type", "content": { "application/json": { "schema": { @@ -6209,8 +6180,8 @@ } } }, - "401": { - "description": "Authorization failed.", + "400": { + "description": "Bad request.", "content": { "application/json": { "schema": { @@ -6248,8 +6219,8 @@ } ], "responses": { - "415": { - "description": "Unsupported media type", + "500": { + "description": "Internal server error.", "content": { "application/json": { "schema": { @@ -6258,8 +6229,8 @@ } } }, - "500": { - "description": "Internal server error.", + "404": { + "description": "Not found.", "content": { "application/json": { "schema": { @@ -6465,8 +6436,8 @@ } } }, - "404": { - "description": "Not found.", + "401": { + "description": "Authorization failed.", "content": { "application/json": { "schema": { @@ -6475,8 +6446,8 @@ } } }, - "400": { - "description": "Bad request.", + "403": { + "description": "Forbidden.", "content": { "application/json": { "schema": { @@ -6485,8 +6456,8 @@ } } }, - "403": { - "description": "Forbidden.", + "415": { + "description": "Unsupported media type", "content": { "application/json": { "schema": { @@ -6495,8 +6466,8 @@ } } }, - "401": { - "description": "Authorization failed.", + "400": { + "description": "Bad request.", "content": { "application/json": { "schema": { @@ -6524,8 +6495,8 @@ "description": "Deletes all submodels from the system.", "operationId": "deleteSubmodels", "responses": { - "415": { - "description": "Unsupported media type", + "500": { + "description": "Internal server error.", "content": { "application/json": { "schema": { @@ -6534,8 +6505,11 @@ } } }, - "500": { - "description": "Internal server error.", + "200": { + "description": "Ok." + }, + "404": { + "description": "Not found.", "content": { "application/json": { "schema": { @@ -6544,9 +6518,6 @@ } } }, - "200": { - "description": "Ok." - }, "429": { "description": "Too many requests.", "content": { @@ -6557,8 +6528,11 @@ } } }, - "404": { - "description": "Not found.", + "204": { + "description": "No Content." + }, + "401": { + "description": "Authorization failed.", "content": { "application/json": { "schema": { @@ -6567,8 +6541,8 @@ } } }, - "400": { - "description": "Bad request.", + "403": { + "description": "Forbidden.", "content": { "application/json": { "schema": { @@ -6577,11 +6551,8 @@ } } }, - "204": { - "description": "No Content." - }, - "403": { - "description": "Forbidden.", + "415": { + "description": "Unsupported media type", "content": { "application/json": { "schema": { @@ -6590,8 +6561,8 @@ } } }, - "401": { - "description": "Authorization failed.", + "400": { + "description": "Bad request.", "content": { "application/json": { "schema": { @@ -6629,8 +6600,8 @@ } ], "responses": { - "415": { - "description": "Unsupported media type", + "500": { + "description": "Internal server error.", "content": { "application/json": { "schema": { @@ -6639,8 +6610,8 @@ } } }, - "500": { - "description": "Internal server error.", + "404": { + "description": "Not found.", "content": { "application/json": { "schema": { @@ -6649,6 +6620,9 @@ } } }, + "200": { + "description": "Okay" + }, "429": { "description": "Too many requests.", "content": { @@ -6659,11 +6633,8 @@ } } }, - "204": { - "description": "Deleted." - }, - "404": { - "description": "Not found.", + "401": { + "description": "Authorization failed.", "content": { "application/json": { "schema": { @@ -6672,8 +6643,8 @@ } } }, - "400": { - "description": "Bad request.", + "403": { + "description": "Forbidden.", "content": { "application/json": { "schema": { @@ -6682,8 +6653,8 @@ } } }, - "403": { - "description": "Forbidden.", + "415": { + "description": "Unsupported media type", "content": { "application/json": { "schema": { @@ -6692,11 +6663,11 @@ } } }, - "200": { - "description": "Okay" + "204": { + "description": "Deleted." }, - "401": { - "description": "Authorization failed.", + "400": { + "description": "Bad request.", "content": { "application/json": { "schema": { @@ -7088,6 +7059,33 @@ } } }, + "SearchableNotificationsRequest": { + "required": [ + "fieldName" + ], + "type": "object", + "properties": { + "fieldName": { + "type": "string" + }, + "startWith": { + "maxLength": 2147483647, + "minLength": 1, + "type": "string" + }, + "size": { + "type": "integer", + "format": "int32" + }, + "channel": { + "type": "string", + "enum": [ + "SENDER", + "RECEIVER" + ] + } + } + }, "OwnPageable": { "type": "object", "properties": { @@ -7533,13 +7531,15 @@ "fieldName": { "type": "string" }, + "startWith": { + "maxLength": 2147483647, + "minLength": 1, + "type": "string" + }, "size": { "type": "integer", "format": "int32" }, - "startWith": { - "type": "string" - }, "owner": { "type": "string", "enum": [ @@ -7550,15 +7550,9 @@ ] }, "inAssetIds": { - "maxItems": 100, - "minItems": 1, "type": "array", - "example": [ - "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" - ], "items": { - "type": "string", - "example": "[\"urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd\"]" + "type": "string" } } }