From e0a4500479f73df464dacfc4977957bd7070b26e Mon Sep 17 00:00:00 2001 From: ChetanT-System Date: Thu, 4 Apr 2024 14:47:46 +0530 Subject: [PATCH 1/6] - Documents updated --- README.md | 3 + .../src/main/resources/sde-open-api.yml | 741 ++++++++++++++---- modules/sde-submodules/pcf/pcf.md | 11 +- modules/sde-submodules/submodules.md | 4 +- 4 files changed, 583 insertions(+), 176 deletions(-) diff --git a/README.md b/README.md index 72b909e52..28d3f741f 100644 --- a/README.md +++ b/README.md @@ -289,7 +289,10 @@ To find information about supported submodules and there version in SDE please v | **GET:- localhost:8080/api/legal-entities** |This API is used to fetch legal entities (list of company's) for Process| Refer Api Doc |Refer Api Doc| | **POST:- localhost:8080/api/connectors-discovery** |This API is used to fetch connectors information | Refer Api Doc |Refer Api Doc| +- Detailed API specs available under: +https://github.com/catenax-ng/tx-managed-simple-data-exchanger-backend/blob/main/modules/sde-core/src/main/resources/sde-open-api.yml +Backend API Swagger-ui : https:///backend/api/swagger-ui/index.html --- #### **Response Status** --- diff --git a/modules/sde-core/src/main/resources/sde-open-api.yml b/modules/sde-core/src/main/resources/sde-open-api.yml index e13a3b7f8..a7fc61156 100644 --- a/modules/sde-core/src/main/resources/sde-open-api.yml +++ b/modules/sde-core/src/main/resources/sde-open-api.yml @@ -1,6 +1,6 @@ #******************************************************************************** -# Copyright (c) 2024 T-Systems International GmbH -# Copyright (c) 2024 Contributors to the Eclipse Foundation +# Copyright (c) 2023, 2024 T-Systems International GmbH +# Copyright (c) 2023, 2024 Contributors to the Eclipse Foundation # # See the NOTICE file(s) distributed with this work for additional # information regarding copyright ownership. @@ -22,14 +22,143 @@ openapi: 3.0.1 info: title: DFT/SDE API information description: This Service handles all DFT data provider and consumer operations - version: '1.0' + version: "1.0" servers: - - url: http://localhost:8080/api + - url: https://dft-api.int.demo.catena-x.net/api description: Generated server url security: - bearerAuth: [] paths: - /{submodel}/upload: + "/policy/{uuid}": + get: + tags: + - policy-controller + operationId: getPolicy + parameters: + - name: uuid + in: path + required: true + schema: + type: string + responses: + "200": + description: OK + content: + "*/*": + schema: + $ref: "#/components/schemas/PolicyModel" + put: + tags: + - policy-controller + operationId: updatePolicy + parameters: + - name: uuid + in: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/PolicyModel" + required: true + responses: + "200": + description: OK + content: + "*/*": + schema: + $ref: "#/components/schemas/PolicyModel" + delete: + tags: + - policy-controller + operationId: deletePolicy + parameters: + - name: uuid + in: path + required: true + schema: + type: string + responses: + "200": + description: OK + content: + "*/*": + schema: + type: object + "/pcf/productIds/{productId}": + get: + tags: + - pcf-exchange-controller + operationId: getPcfByProduct + parameters: + - name: productId + in: path + required: true + schema: + type: string + - name: BPN + in: query + required: true + schema: + type: string + - name: requestId + in: query + required: true + schema: + type: string + - name: message + in: query + required: true + schema: + type: string + responses: + "200": + description: OK + content: + "*/*": + schema: + type: object + put: + tags: + - pcf-exchange-controller + operationId: uploadPcfSubmodel + parameters: + - name: productId + in: path + required: true + schema: + type: string + - name: BPN + in: query + required: true + schema: + type: string + - name: requestId + in: query + required: false + schema: + type: string + - name: message + in: query + required: false + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/JsonNode" + required: true + responses: + "200": + description: OK + content: + "*/*": + schema: + type: object + "/{submodel}/upload": post: tags: - submodel-process-controller @@ -57,13 +186,13 @@ paths: type: string format: binary responses: - '200': + "200": description: OK content: - '*/*': + "*/*": schema: - type: string - /{submodel}/manualentry: + type: object + "/{submodel}/manualentry": post: tags: - submodel-process-controller @@ -78,15 +207,38 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SubmodelJsonRequest' + $ref: "#/components/schemas/SubmodelJsonRequest" required: true responses: - '200': + "200": description: OK content: - '*/*': + "*/*": schema: - type: string + type: object + /upload: + post: + tags: + - submodel-process-controller + operationId: autoUpload + requestBody: + content: + application/json: + schema: + required: + - file + type: object + properties: + file: + type: string + format: binary + responses: + "200": + description: OK + content: + "*/*": + schema: + type: object /subscribe-download-data-offers: post: tags: @@ -96,10 +248,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ConsumerRequest' + $ref: "#/components/schemas/ConsumerRequest" required: true responses: - '200': + "200": description: OK /subscribe-download-data-offers-async: post: @@ -110,13 +262,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ConsumerRequest' + $ref: "#/components/schemas/ConsumerRequest" required: true responses: - '200': + "200": description: OK content: - '*/*': + "*/*": schema: type: object /subscribe-data-offers: @@ -128,13 +280,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ConsumerRequest' + $ref: "#/components/schemas/ConsumerRequest" required: true responses: - '200': + "200": description: OK content: - '*/*': + "*/*": schema: type: object /role: @@ -146,16 +298,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RolePojo' + $ref: "#/components/schemas/RolePojo" required: true responses: - '200': + "200": description: OK content: - '*/*': + "*/*": schema: - $ref: '#/components/schemas/RolePojo' - /role/{role}/permissions: + $ref: "#/components/schemas/RolePojo" + "/role/{role}/permissions": get: tags: - role-management-controller @@ -167,10 +319,10 @@ paths: schema: type: string responses: - '200': + "200": description: OK content: - '*/*': + "*/*": schema: type: array maxItems: 100 @@ -196,12 +348,56 @@ paths: type: string required: true responses: - '200': + "200": description: OK content: - '*/*': + "*/*": schema: - type: string + type: object + additionalProperties: + type: string + /policy: + get: + tags: + - policy-controller + operationId: getAllPolicies + parameters: + - name: page + in: query + required: true + schema: + type: integer + format: int32 + - name: pageSize + in: query + required: true + schema: + type: integer + format: int32 + responses: + "200": + description: OK + content: + "*/*": + schema: + $ref: "#/components/schemas/PagingResponse" + post: + tags: + - policy-controller + operationId: savePolicy + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/PolicyModel" + required: true + responses: + "200": + description: OK + content: + "*/*": + schema: + $ref: "#/components/schemas/PolicyModel" /policy-hub/policy-content: get: tags: @@ -234,12 +430,12 @@ paths: schema: type: string responses: - '200': + "200": description: OK content: - '*/*': + "*/*": schema: - $ref: '#/components/schemas/JsonNode' + $ref: "#/components/schemas/JsonNode" post: tags: - policy-hub-controller @@ -248,15 +444,96 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PolicyContentRequest' + $ref: "#/components/schemas/PolicyContentRequest" + responses: + "200": + description: OK + content: + "*/*": + schema: + $ref: "#/components/schemas/JsonNode" + "/pcf/request/{productId}": + post: + tags: + - pcf-exchange-controller + operationId: requestForPcfDataOffer + parameters: + - name: productId + in: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/ConsumerRequest" + required: true + responses: + "200": + description: OK + content: + "*/*": + schema: + type: object + /pcf/request/nonexistdataoffer: + post: + tags: + - pcf-exchange-controller + operationId: requestForPcfNotExistDataOffer + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/PcfRequestModel" + required: true + responses: + "200": + description: OK + content: + "*/*": + schema: + type: object + /pcf/actionsonrequest: + post: + tags: + - pcf-exchange-controller + operationId: actionOnPcfRequestAndSendNotificationToConsumer + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/PcfRequestModel" + required: true + responses: + "200": + description: OK + content: + "*/*": + schema: + type: object + /offer-policy-details: + post: + tags: + - consumer-controller + operationId: getEDCPolicy + requestBody: + content: + application/json: + schema: + type: array + maxItems: 100 + items: + $ref: "#/components/schemas/QueryDataOfferRequest" + required: true responses: - '200': + "200": description: OK content: - '*/*': + "*/*": schema: - $ref: '#/components/schemas/JsonNode' - /contract-agreements/{negotiationId}/provider/decline: + type: object + "/contract-agreements/{negotiationId}/provider/decline": post: tags: - contract-management-controller @@ -268,13 +545,13 @@ paths: schema: type: string responses: - '200': + "200": description: OK content: application/json: schema: type: object - /contract-agreements/{negotiationId}/provider/cancel: + "/contract-agreements/{negotiationId}/provider/cancel": post: tags: - contract-management-controller @@ -286,13 +563,13 @@ paths: schema: type: string responses: - '200': + "200": description: OK content: application/json: schema: type: object - /contract-agreements/{negotiationId}/consumer/cancel: + "/contract-agreements/{negotiationId}/consumer/cancel": post: tags: - contract-management-controller @@ -304,7 +581,7 @@ paths: schema: type: string responses: - '200': + "200": description: OK content: application/json: @@ -325,16 +602,16 @@ paths: type: string required: true responses: - '200': + "200": description: OK content: - '*/*': + "*/*": schema: type: array maxItems: 100 items: - $ref: '#/components/schemas/ConnectorInfo' - /{submodel}/public/{uuid}: + $ref: "#/components/schemas/ConnectorInfo" + "/{submodel}/public/{uuid}": get: tags: - submodel-process-controller @@ -357,10 +634,10 @@ paths: type: string default: json responses: - '200': + "200": description: OK content: - '*/*': + "*/*": schema: type: object additionalProperties: @@ -384,13 +661,13 @@ paths: type: integer format: int32 responses: - '200': + "200": description: OK content: - '*/*': + "*/*": schema: type: object - /view-download-history/{processId}: + "/view-download-history/{processId}": get: tags: - consumer-controller @@ -402,10 +679,10 @@ paths: schema: type: string responses: - '200': + "200": description: OK content: - '*/*': + "*/*": schema: type: object /user/role/permissions: @@ -414,10 +691,10 @@ paths: - role-management-controller operationId: getAllRolePermissions responses: - '200': + "200": description: OK content: - '*/*': + "*/*": schema: type: array maxItems: 100 @@ -429,10 +706,10 @@ paths: - submodel-controller operationId: getAllUsecases responses: - '200': + "200": description: OK content: - '*/*': + "*/*": schema: type: array maxItems: 100 @@ -440,7 +717,7 @@ paths: type: object additionalProperties: type: object - /unified-bpn-validation/{bpn}: + "/unified-bpn-validation/{bpn}": get: tags: - portal-proxy-controller @@ -452,12 +729,12 @@ paths: schema: type: string responses: - '200': + "200": description: OK content: - '*/*': + "*/*": schema: - $ref: '#/components/schemas/UnifiedBpnValidationResponse' + $ref: "#/components/schemas/UnifiedBpnValidationResponse" /submodels: get: tags: @@ -473,10 +750,10 @@ paths: items: type: string responses: - '200': + "200": description: OK content: - '*/*': + "*/*": schema: type: array maxItems: 100 @@ -484,7 +761,7 @@ paths: type: object additionalProperties: type: string - /submodels/{submodelName}: + "/submodels/{submodelName}": get: tags: - submodel-controller @@ -496,10 +773,10 @@ paths: schema: type: string responses: - '200': + "200": description: OK content: - '*/*': + "*/*": schema: type: object additionalProperties: @@ -519,10 +796,10 @@ paths: items: type: string responses: - '200': + "200": description: OK content: - '*/*': + "*/*": schema: type: array maxItems: 100 @@ -564,10 +841,10 @@ paths: type: integer format: int32 responses: - '200': + "200": description: OK content: - '*/*': + "*/*": schema: type: object /processing-report: @@ -589,13 +866,13 @@ paths: type: integer format: int32 responses: - '200': + "200": description: OK content: application/json: schema: - $ref: '#/components/schemas/ProcessReportPageResponse' - /processing-report/{submodel}/success-details/{id}: + $ref: "#/components/schemas/ProcessReportPageResponse" + "/processing-report/{submodel}/success-details/{id}": get: tags: - process-report-controller @@ -612,7 +889,7 @@ paths: schema: type: string responses: - '200': + "200": description: OK content: application/json: @@ -624,7 +901,7 @@ paths: maxItems: 100 items: type: string - /processing-report/{id}: + "/processing-report/{id}": get: tags: - process-report-controller @@ -636,13 +913,13 @@ paths: schema: type: string responses: - '200': + "200": description: OK content: application/json: schema: - $ref: '#/components/schemas/ProcessReport' - /processing-report/failure-details/{id}: + $ref: "#/components/schemas/ProcessReport" + "/processing-report/failure-details/{id}": get: tags: - process-report-controller @@ -654,7 +931,7 @@ paths: schema: type: string responses: - '200': + "200": description: OK content: application/json: @@ -662,7 +939,27 @@ paths: type: array maxItems: 100 items: - $ref: '#/components/schemas/ProcessFailureDetails' + $ref: "#/components/schemas/ProcessFailureDetails" + /policy/is-policy-name-valid: + get: + tags: + - policy-controller + operationId: isPolicyNameValid + parameters: + - name: policyName + in: query + required: true + schema: + type: string + responses: + "200": + description: OK + content: + "*/*": + schema: + type: object + additionalProperties: + type: boolean /policy-hub/policy-types: get: tags: @@ -680,25 +977,25 @@ paths: schema: type: string responses: - '200': + "200": description: OK content: - '*/*': + "*/*": schema: type: array maxItems: 100 items: - $ref: '#/components/schemas/PolicyTypeResponse' + $ref: "#/components/schemas/PolicyTypeResponse" /policy-hub/policy-attributes: get: tags: - policy-hub-controller operationId: policyAttributes responses: - '200': + "200": description: OK content: - '*/*': + "*/*": schema: type: array maxItems: 100 @@ -710,66 +1007,116 @@ paths: - ping-controller operationId: getProcessReportById_1 responses: - '200': + "200": description: OK content: - '*/*': + "*/*": schema: type: string - /legal-entities: + "/pcf/{type}/requests": get: tags: - - portal-proxy-controller - operationId: fetchLegalEntitiesData + - pcf-exchange-controller + operationId: getPcfProviderData parameters: - - name: searchText - in: query + - name: type + in: path required: true schema: type: string + enum: + - CONSUMER + - PROVIDER + - name: status + in: query + required: false + schema: + type: string + enum: + - REQUESTED + - APPROVED + - PUSHING_DATA + - PUSHING_UPDATED_DATA + - REJECTED + - SENDING_REJECT_NOTIFICATION + - PUSHED + - PUSHED_UPDATED_DATA + - RECEIVED + - FAILED_TO_PUSH_DATA + - FAILED_TO_SEND_REJECT_NOTIFICATION + - FAILED + - SENDING_REQUEST + - PENDING_DATA_FROM_PROVIDER - name: page in: query required: true schema: type: integer format: int32 - - name: size + - name: pageSize in: query required: true schema: type: integer format: int32 responses: - '200': + "200": description: OK content: - '*/*': + "*/*": schema: - type: array - maxItems: 100 - items: - $ref: '#/components/schemas/LegalEntityResponse' - /getEDCPolicy: + type: object + "/pcf/request/{requestId}": get: tags: - - consumer-controller - operationId: getEDCPolicy + - pcf-exchange-controller + operationId: viewForPcfDataOffer parameters: - - name: queryDataOfferRequest - in: query + - name: requestId + in: path required: true schema: - type: array - maxItems: 100 - items: - $ref: '#/components/schemas/QueryDataOfferRequest' + type: string responses: - '200': + "200": description: OK content: - '*/*': + "*/*": schema: type: object + /legal-entities: + get: + tags: + - portal-proxy-controller + operationId: fetchLegalEntitiesData + parameters: + - name: searchText + in: query + required: true + schema: + type: string + - name: page + in: query + required: true + schema: + type: integer + format: int32 + - name: size + in: query + required: true + schema: + type: integer + format: int32 + responses: + "200": + description: OK + content: + "*/*": + schema: + type: array + maxItems: 100 + items: + $ref: "#/components/schemas/LegalEntityResponse" /download-data-offers: get: tags: @@ -788,9 +1135,9 @@ paths: type: string default: csv responses: - '200': + "200": description: OK - /contract-agreements/{negotiationId}/consumer/decline: + "/contract-agreements/{negotiationId}/consumer/decline": get: tags: - contract-management-controller @@ -802,7 +1149,7 @@ paths: schema: type: string responses: - '200': + "200": description: OK content: application/json: @@ -827,7 +1174,7 @@ paths: type: integer format: int32 responses: - '200': + "200": description: OK content: application/json: @@ -852,7 +1199,7 @@ paths: type: integer format: int32 responses: - '200': + "200": description: OK content: application/json: @@ -864,10 +1211,10 @@ paths: - ping-controller operationId: clearBpnnumberCache responses: - '200': + "200": description: OK content: - '*/*': + "*/*": schema: type: string /cache/clear-ddtrurl: @@ -876,13 +1223,13 @@ paths: - ping-controller operationId: clearDdtrurlCache responses: - '200': + "200": description: OK content: - '*/*': + "*/*": schema: type: string - /{submodel}/delete/{processId}: + "/{submodel}/delete/{processId}": delete: tags: - submodel-process-controller @@ -899,15 +1246,13 @@ paths: schema: type: string responses: - '200': + "200": description: OK content: application/json: schema: type: object - additionalProperties: - type: string - /role/{role}: + "/role/{role}": delete: tags: - role-management-controller @@ -919,7 +1264,7 @@ paths: schema: type: string responses: - '200': + "200": description: OK components: schemas: @@ -933,6 +1278,28 @@ components: maxItems: 100 items: type: string + PolicyModel: + type: object + properties: + uuid: + type: string + lastUpdatedTime: + type: string + format: date-time + policy_name: + type: string + Access: + type: array + maxItems: 100 + items: + $ref: "#/components/schemas/Policies" + Usage: + type: array + maxItems: 100 + items: + $ref: "#/components/schemas/Policies" + JsonNode: + type: object SubmodelJsonRequest: required: - row_data @@ -951,16 +1318,16 @@ components: - NEW policy_name: type: string - access_policies: + Access: type: array maxItems: 100 items: - $ref: '#/components/schemas/Policies' - usage_policies: + $ref: "#/components/schemas/Policies" + Usage: type: array maxItems: 100 items: - $ref: '#/components/schemas/Policies' + $ref: "#/components/schemas/Policies" row_data: type: array maxItems: 100 @@ -976,14 +1343,14 @@ components: type: array maxItems: 100 items: - $ref: '#/components/schemas/Offer' + $ref: "#/components/schemas/Offer" downloadDataAs: type: string usage_policies: type: array maxItems: 100 items: - $ref: '#/components/schemas/Policies' + $ref: "#/components/schemas/Policies" Offer: required: - assetId @@ -1049,9 +1416,60 @@ components: type: array maxItems: 100 items: - $ref: '#/components/schemas/Constraint' - JsonNode: + $ref: "#/components/schemas/Constraint" + PcfRequestModel: + required: + - bpnNumber + - productId + type: object + properties: + requestId: + type: string + productId: + type: string + bpnNumber: + type: string + type: + type: string + enum: + - CONSUMER + - PROVIDER + message: + type: string + remark: + type: string + status: + type: string + enum: + - REQUESTED + - APPROVED + - PUSHING_DATA + - PUSHING_UPDATED_DATA + - REJECTED + - SENDING_REJECT_NOTIFICATION + - PUSHED + - PUSHED_UPDATED_DATA + - RECEIVED + - FAILED_TO_PUSH_DATA + - FAILED_TO_SEND_REJECT_NOTIFICATION + - FAILED + - SENDING_REQUEST + - PENDING_DATA_FROM_PROVIDER + requestedTime: + type: integer + format: int64 + lastUpdatedTime: + type: integer + format: int64 + QueryDataOfferRequest: type: object + properties: + assetId: + type: string + connectorOfferUrl: + type: string + policy: + $ref: "#/components/schemas/PolicyModel" ConnectorInfo: type: object properties: @@ -1108,12 +1526,12 @@ components: type: array maxItems: 100 items: - $ref: '#/components/schemas/Policies' + $ref: "#/components/schemas/Policies" usagePolicies: type: array maxItems: 100 items: - $ref: '#/components/schemas/Policies' + $ref: "#/components/schemas/Policies" numberOfUpdatedItems: type: integer format: int32 @@ -1138,7 +1556,7 @@ components: type: array maxItems: 100 items: - $ref: '#/components/schemas/ProcessReport' + $ref: "#/components/schemas/ProcessReport" ProcessFailureDetails: type: object properties: @@ -1151,6 +1569,20 @@ components: dateTime: type: string format: date-time + PagingResponse: + type: object + properties: + page: + type: integer + format: int32 + pageSize: + type: integer + format: int32 + totalItems: + type: integer + format: int64 + items: + type: object PolicyAttributeResponse: type: object properties: @@ -1179,7 +1611,7 @@ components: type: array maxItems: 100 items: - $ref: '#/components/schemas/PolicyAttributeResponse' + $ref: "#/components/schemas/PolicyAttributeResponse" technicalEnforced: type: boolean LegalEntityResponse: @@ -1189,37 +1621,8 @@ components: type: string bpn: type: string - PolicyModel: - type: object - properties: - uuid: - type: string - lastUpdatedTime: - type: string - format: date-time - policy_name: - type: string - access_policies: - type: array - maxItems: 100 - items: - $ref: '#/components/schemas/Policies' - usage_policies: - type: array - maxItems: 100 - items: - $ref: '#/components/schemas/Policies' - QueryDataOfferRequest: - type: object - properties: - assetId: - type: string - connectorOfferUrl: - type: string - policy: - $ref: '#/components/schemas/PolicyModel' securitySchemes: bearerAuth: type: http scheme: bearer - bearerFormat: JWT \ No newline at end of file + bearerFormat: JWT diff --git a/modules/sde-submodules/pcf/pcf.md b/modules/sde-submodules/pcf/pcf.md index 87535416f..04846930c 100644 --- a/modules/sde-submodules/pcf/pcf.md +++ b/modules/sde-submodules/pcf/pcf.md @@ -5,9 +5,9 @@ This module use for PCF submodel specification and descriptors. It's contain the codes related to PCF to validate, parse and transfer data for DigitalTwins and EDC to create aspect twins and data offer. --- -#### Version: 4.0.1 -#### PCF Aspect Model URN: urn:bamm:io.catenax.pcf:4.0.1#Pcf -#### Semantic Id: urn:bamm:io.catenax.pcf:4.0.1 +#### Version: 6.0.0 +#### PCF Aspect Model URN: urn:bamm:io.catenax.pcf:6.0.0#Pcf +#### Semantic Id: urn:bamm:io.catenax.pcf:6.0.0 --- ### Schema @@ -82,8 +82,9 @@ Please find below links for schema details: | extTFS_distributionStageLuGhgEmissions | Yes | 60 | | carbonContentTotal | Yes | 61 | | extWBCSD_fossilCarbonContent | No | 62 | -| carbonContentBiogenic | Yes | 63 | -| assetLifeCyclePhase | Yes | 64 | +| distributionStageAircraftGhgEmissions | No | 63 | +| carbonContentBiogenic | Yes | 64 | +| assetLifeCyclePhase | Yes | 65 | #### [CSV Sample File Link] diff --git a/modules/sde-submodules/submodules.md b/modules/sde-submodules/submodules.md index fad15975c..3bb98ef05 100644 --- a/modules/sde-submodules/submodules.md +++ b/modules/sde-submodules/submodules.md @@ -15,7 +15,7 @@ Currently SDE supports below submodels. #### [singleLevelBoMAsPlanned in Version 1.0.1] #### [partSiteInformationAsPlanned in Version 1.0.0] #### [SingleLevelUsageAsBuilt in Version 1.0.1] -#### [Product Carbon Footprint(PCF) in Version 4.0.1] +#### [Product Carbon Footprint(PCF) in Version 6.0.0] ### How we can add Submodels? @@ -43,4 +43,4 @@ Once your maven module ready just do the clean build and install so submodel wil [singleLevelBoMAsPlanned in Version 1.0.1]: single-level-bom-as-planned/single-level-bom-as-planned.md [partSiteInformationAsPlanned in Version 1.0.0]: part-site-information-as-planned/part-site-information-as-planned.md [SingleLevelUsageAsBuilt in Version 1.0.1]: single-level-usage-as-built/single-level-usage-as-built.md -[Product Carbon Footprint(PCF) in Version 4.0.1]: pcf/pcf.md +[Product Carbon Footprint(PCF) in Version 6.0.0]: pcf/pcf.md From 20071976506ca96f2d812ec08c3467bb467c5b06 Mon Sep 17 00:00:00 2001 From: ChetanT-System Date: Thu, 4 Apr 2024 14:49:53 +0530 Subject: [PATCH 2/6] - open api yml file updated --- modules/sde-core/src/main/resources/sde-open-api.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/modules/sde-core/src/main/resources/sde-open-api.yml b/modules/sde-core/src/main/resources/sde-open-api.yml index a7fc61156..79ff96600 100644 --- a/modules/sde-core/src/main/resources/sde-open-api.yml +++ b/modules/sde-core/src/main/resources/sde-open-api.yml @@ -1,6 +1,6 @@ #******************************************************************************** -# Copyright (c) 2023, 2024 T-Systems International GmbH -# Copyright (c) 2023, 2024 Contributors to the Eclipse Foundation +# Copyright (c) 2024 T-Systems International GmbH +# Copyright (c) 2024 Contributors to the Eclipse Foundation # # See the NOTICE file(s) distributed with this work for additional # information regarding copyright ownership. @@ -24,7 +24,7 @@ info: description: This Service handles all DFT data provider and consumer operations version: "1.0" servers: - - url: https://dft-api.int.demo.catena-x.net/api + - url: http://localhost:8080/api description: Generated server url security: - bearerAuth: [] From cfc178c95e0f1de5a747d1c1b53be55b03efb20d Mon Sep 17 00:00:00 2001 From: ChetanT-System Date: Thu, 4 Apr 2024 14:52:23 +0530 Subject: [PATCH 3/6] - Updated changelog file --- CHANGELOG.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 78da4eb56..f42f3c42f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,13 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), + +## [Unreleased] + +### Added +- Updated readme.md and open api yml file. + + ## [2.3.6] - 2024-03-06 ### Fixed - open api fix in sde-open-api.yml. From f6bdef5ac49cb9171d9c1fc0beb40a2ac1edb876 Mon Sep 17 00:00:00 2001 From: ChetanT-System Date: Thu, 4 Apr 2024 16:36:07 +0530 Subject: [PATCH 4/6] - Readme.md file updated --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 28d3f741f..d4447d1b7 100644 --- a/README.md +++ b/README.md @@ -289,10 +289,12 @@ To find information about supported submodules and there version in SDE please v | **GET:- localhost:8080/api/legal-entities** |This API is used to fetch legal entities (list of company's) for Process| Refer Api Doc |Refer Api Doc| | **POST:- localhost:8080/api/connectors-discovery** |This API is used to fetch connectors information | Refer Api Doc |Refer Api Doc| -- Detailed API specs available under: +## Detailed API specs available under: +https://github.com/eclipse-tractusx/managed-simple-data-exchanger-backend/blob/main/modules/sde-core/src/main/resources/sde-open-api.yml + +## Backend API Swagger-ui : +https:///backend/api/swagger-ui/index.html -https://github.com/catenax-ng/tx-managed-simple-data-exchanger-backend/blob/main/modules/sde-core/src/main/resources/sde-open-api.yml -Backend API Swagger-ui : https:///backend/api/swagger-ui/index.html --- #### **Response Status** --- From 007bfaa0497e71124c993cfe3a8d0e816cb83717 Mon Sep 17 00:00:00 2001 From: ChetanT-System Date: Thu, 4 Apr 2024 17:33:23 +0530 Subject: [PATCH 5/6] - readme.md file updated --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d4447d1b7..5d64e248a 100644 --- a/README.md +++ b/README.md @@ -290,7 +290,8 @@ To find information about supported submodules and there version in SDE please v | **POST:- localhost:8080/api/connectors-discovery** |This API is used to fetch connectors information | Refer Api Doc |Refer Api Doc| ## Detailed API specs available under: -https://github.com/eclipse-tractusx/managed-simple-data-exchanger-backend/blob/main/modules/sde-core/src/main/resources/sde-open-api.yml + +/modules/sde-core/src/main/resources/sde-open-api.yml ## Backend API Swagger-ui : https:///backend/api/swagger-ui/index.html From 25e8df728e831c18914da7df7006c73792b522fc Mon Sep 17 00:00:00 2001 From: ChetanT-System Date: Fri, 5 Apr 2024 12:35:24 +0530 Subject: [PATCH 6/6] - readme.md file updated --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5d64e248a..609a91fac 100644 --- a/README.md +++ b/README.md @@ -291,7 +291,7 @@ To find information about supported submodules and there version in SDE please v ## Detailed API specs available under: -/modules/sde-core/src/main/resources/sde-open-api.yml +- [SDE-OPEN-API](src/main/resources/sde-open-api.yml) ## Backend API Swagger-ui : https:///backend/api/swagger-ui/index.html