From 49cd178a2688dd7a653a2cd0df08b2a59ad2152d Mon Sep 17 00:00:00 2001 From: SujitMBRDI Date: Fri, 22 Nov 2024 13:18:23 +0530 Subject: [PATCH] docs(bpdm): update openApi spec for rc5 --- docs/api/gate.json | 2 +- docs/api/gate.yaml | 2 +- docs/api/orchestrator.json | 37 +++++++++++++++++++++++++++++++++---- docs/api/orchestrator.yaml | 26 ++++++++++++++++++++++---- docs/api/pool.json | 26 +++++++++++++------------- docs/api/pool.yaml | 26 +++++++++++++------------- 6 files changed, 83 insertions(+), 36 deletions(-) diff --git a/docs/api/gate.json b/docs/api/gate.json index 91e5731aa..68a721eee 100644 --- a/docs/api/gate.json +++ b/docs/api/gate.json @@ -3,7 +3,7 @@ "info": { "title": "Business Partner Data Management Gate", "description": "A gate for a member to share business partner data with CatenaX", - "version": "6.2.0-SNAPSHOT" + "version": "6.2.0-rc5" }, "servers": [ { diff --git a/docs/api/gate.yaml b/docs/api/gate.yaml index cf0955775..960ff4f1c 100644 --- a/docs/api/gate.yaml +++ b/docs/api/gate.yaml @@ -2,7 +2,7 @@ openapi: 3.0.1 info: title: Business Partner Data Management Gate description: A gate for a member to share business partner data with CatenaX - version: 6.2.0-SNAPSHOT + version: 6.2.0-rc5 servers: - url: http://localhost:8081 description: Generated server url diff --git a/docs/api/orchestrator.json b/docs/api/orchestrator.json index 236ccadb0..190870dfe 100644 --- a/docs/api/orchestrator.json +++ b/docs/api/orchestrator.json @@ -3,7 +3,7 @@ "info": { "title": "Business Partner Data Management Orchestrator", "description": "Orchestrator component acts as a passive component and offers for each processing steps individual endpoints", - "version": "6.2.0-SNAPSHOT" + "version": "6.2.0-rc5" }, "servers": [ { @@ -11,6 +11,14 @@ "description": "Generated server url" } ], + "security": [ + { + "open_id_scheme": [] + }, + { + "bearer_scheme": [] + } + ], "paths": { "/v6/golden-record-tasks": { "post": { @@ -494,15 +502,15 @@ "properties": { "longitude": { "type": "number", - "format": "float" + "format": "double" }, "latitude": { "type": "number", - "format": "float" + "format": "double" }, "altitude": { "type": "number", - "format": "float" + "format": "double" } }, "description": "The exact location of the physical postal address in latitude, longitude, and altitude." @@ -1194,6 +1202,27 @@ }, "description": "Business partner data that has not yet or can not be categorized" } + }, + "securitySchemes": { + "open_id_scheme": { + "type": "oauth2", + "flows": { + "clientCredentials": { + "tokenUrl": "http://localhost:8180/realms/CX-Central/protocol/openid-connect/token" + }, + "authorizationCode": { + "authorizationUrl": "http://localhost:8180/realms/CX-Central/protocol/openid-connect/auth", + "tokenUrl": "http://localhost:8180/realms/CX-Central/protocol/openid-connect/token", + "refreshUrl": "http://localhost:8180/realms/CX-Central/protocol/openid-connect/token", + "scopes": {} + } + } + }, + "bearer_scheme": { + "type": "http", + "scheme": "bearer", + "bearerFormat": "JWT" + } } } } \ No newline at end of file diff --git a/docs/api/orchestrator.yaml b/docs/api/orchestrator.yaml index a5a432811..a2794a966 100644 --- a/docs/api/orchestrator.yaml +++ b/docs/api/orchestrator.yaml @@ -2,10 +2,13 @@ openapi: 3.0.1 info: title: Business Partner Data Management Orchestrator description: Orchestrator component acts as a passive component and offers for each processing steps individual endpoints - version: 6.2.0-SNAPSHOT + version: 6.2.0-rc5 servers: - url: http://localhost:8085 description: Generated server url +security: + - open_id_scheme: [] + - bearer_scheme: [] paths: /v6/golden-record-tasks: post: @@ -347,13 +350,13 @@ components: properties: longitude: type: number - format: float + format: double latitude: type: number - format: float + format: double altitude: type: number - format: float + format: double description: The exact location of the physical postal address in latitude, longitude, and altitude. Identifier: type: object @@ -861,3 +864,18 @@ components: address: $ref: '#/components/schemas/PostalAddress' description: Business partner data that has not yet or can not be categorized + securitySchemes: + open_id_scheme: + type: oauth2 + flows: + clientCredentials: + tokenUrl: http://localhost:8180/realms/CX-Central/protocol/openid-connect/token + authorizationCode: + authorizationUrl: http://localhost:8180/realms/CX-Central/protocol/openid-connect/auth + tokenUrl: http://localhost:8180/realms/CX-Central/protocol/openid-connect/token + refreshUrl: http://localhost:8180/realms/CX-Central/protocol/openid-connect/token + scopes: {} + bearer_scheme: + type: http + scheme: bearer + bearerFormat: JWT diff --git a/docs/api/pool.json b/docs/api/pool.json index 1023850d3..475dabee2 100644 --- a/docs/api/pool.json +++ b/docs/api/pool.json @@ -3,7 +3,7 @@ "info": { "title": "Business Partner Data Management Pool", "description": "Service that manages and shares business partner data with other CatenaX services", - "version": "6.2.0-SNAPSHOT" + "version": "6.2.0-rc5" }, "servers": [ { @@ -2281,11 +2281,11 @@ "$ref": "#/components/schemas/ErrorInfoAddressCreateError" } }, - "errorCount": { + "entityCount": { "type": "integer", "format": "int32" }, - "entityCount": { + "errorCount": { "type": "integer", "format": "int32" } @@ -2340,11 +2340,11 @@ "$ref": "#/components/schemas/ErrorInfoAddressUpdateError" } }, - "errorCount": { + "entityCount": { "type": "integer", "format": "int32" }, - "entityCount": { + "errorCount": { "type": "integer", "format": "int32" } @@ -4174,11 +4174,11 @@ "$ref": "#/components/schemas/ErrorInfoLegalEntityCreateError" } }, - "errorCount": { + "entityCount": { "type": "integer", "format": "int32" }, - "entityCount": { + "errorCount": { "type": "integer", "format": "int32" } @@ -4243,11 +4243,11 @@ "$ref": "#/components/schemas/ErrorInfoLegalEntityUpdateError" } }, - "errorCount": { + "entityCount": { "type": "integer", "format": "int32" }, - "entityCount": { + "errorCount": { "type": "integer", "format": "int32" } @@ -6545,11 +6545,11 @@ "$ref": "#/components/schemas/ErrorInfoSiteCreateError" } }, - "errorCount": { + "entityCount": { "type": "integer", "format": "int32" }, - "entityCount": { + "errorCount": { "type": "integer", "format": "int32" } @@ -6610,11 +6610,11 @@ "$ref": "#/components/schemas/ErrorInfoSiteUpdateError" } }, - "errorCount": { + "entityCount": { "type": "integer", "format": "int32" }, - "entityCount": { + "errorCount": { "type": "integer", "format": "int32" } diff --git a/docs/api/pool.yaml b/docs/api/pool.yaml index fd6b320b2..d865f2b5c 100644 --- a/docs/api/pool.yaml +++ b/docs/api/pool.yaml @@ -2,7 +2,7 @@ openapi: 3.0.1 info: title: Business Partner Data Management Pool description: Service that manages and shares business partner data with other CatenaX services - version: 6.2.0-SNAPSHOT + version: 6.2.0-rc5 servers: - url: http://localhost:8080 description: Generated server url @@ -1682,10 +1682,10 @@ components: type: array items: $ref: '#/components/schemas/ErrorInfoAddressCreateError' - errorCount: + entityCount: type: integer format: int32 - entityCount: + errorCount: type: integer format: int32 description: Holds information about successfully and failed entities after the creating/updating of several objects @@ -1724,10 +1724,10 @@ components: type: array items: $ref: '#/components/schemas/ErrorInfoAddressUpdateError' - errorCount: + entityCount: type: integer format: int32 - entityCount: + errorCount: type: integer format: int32 description: Holds information about successfully and failed entities after the creating/updating of several objects @@ -3364,10 +3364,10 @@ components: type: array items: $ref: '#/components/schemas/ErrorInfoLegalEntityCreateError' - errorCount: + entityCount: type: integer format: int32 - entityCount: + errorCount: type: integer format: int32 description: Holds information about successfully and failed entities after the creating/updating of several objects @@ -3413,10 +3413,10 @@ components: type: array items: $ref: '#/components/schemas/ErrorInfoLegalEntityUpdateError' - errorCount: + entityCount: type: integer format: int32 - entityCount: + errorCount: type: integer format: int32 description: Holds information about successfully and failed entities after the creating/updating of several objects @@ -5499,10 +5499,10 @@ components: type: array items: $ref: '#/components/schemas/ErrorInfoSiteCreateError' - errorCount: + entityCount: type: integer format: int32 - entityCount: + errorCount: type: integer format: int32 description: Holds information about successfully and failed entities after the creating/updating of several objects @@ -5545,10 +5545,10 @@ components: type: array items: $ref: '#/components/schemas/ErrorInfoSiteUpdateError' - errorCount: + entityCount: type: integer format: int32 - entityCount: + errorCount: type: integer format: int32 description: Holds information about successfully and failed entities after the creating/updating of several objects