feat: added Endpoint Documentation to Meta Data page (#300)

refactor: renamed standardlicense to standardLicense
International-Data-Spaces-Association · Oct 28, 2022 · b223ba7 · b223ba7
1 parent df60f95
commit b223ba7
Show file tree

Hide file tree

Showing 8 changed files with 81 additions and 41 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,15 @@
 All notable changes to this project will be documented in this file.
 
 
+## [x.x.x] - xxxx-xx-xx
+
+### Added
+- Endpoint Documentation to Meta Data page
+
+### Changed
+- renamed variable standardlicense to standardLicense
+
+
 ## [10.1.0] - 2022-10-06
 
 ### Fixed

diff --git a/src/datamodel/clientDataModel.js b/src/datamodel/clientDataModel.js
@@ -1,8 +1,10 @@
 import dataUtils from "@/utils/dataUtils";
 
 export default {
-    createResource(url, id, creationDate, title, description, language, paymentMethod, keywords, version, standardlicense,
-        publisher, fileType, contractName, policyNames, contractPeriodFromValue, contractPeriodToValue, ruleIds, ruleJsons, artifactId, representationId, brokerUris, samples, catalogs, additional = {}) {
+    createResource(url, id, creationDate, title, description, language, paymentMethod, keywords, version,
+        standardLicense, publisher, fileType, contractName, policyNames, contractPeriodFromValue, contractPeriodToValue,
+        ruleIds, ruleJsons, artifactId, representationId, brokerUris, samples, catalogs, additional,
+        endpointDocumentation = {}) {
         let resource = {};
         if (url === undefined) {
             resource.url = "";
@@ -49,10 +51,15 @@ export default {
         } else {
             resource.version = version;
         }
-        if (standardlicense === undefined) {
-            resource.standardlicense = "";
+        if (standardLicense === undefined) {
+            resource.standardLicense = "";
         } else {
-            resource.standardlicense = standardlicense;
+            resource.standardLicense = standardLicense;
+        }
+        if (endpointDocumentation === undefined) {
+            resource.endpointDocumentation = "";
+        } else {
+            resource.endpointDocumentation = endpointDocumentation;
         }
         if (publisher === undefined) {
             resource.publisher = "";
@@ -394,7 +401,7 @@ export default {
         return this.createResource(idsResource._links.self.href, dataUtils.getIdOfConnectorResponse(idsResource), idsResource.creationDate, title, description,
             idsResource.language.replace("https://w3id.org/idsa/code/", ""), idsResource.paymentModality, idsResource.keywords,
             idsResource.version, idsResource.license, idsResource.publisher, fileType, contractName, policyNames, contractPeriodFromValue, contractPeriodToValue, ruleIds, ruleJsons, artifactId, representationId, brokerUris,
-            idsResource.samples, catalogs, idsResource.additional);
+            idsResource.samples, catalogs, idsResource.additional,idsResource.endpointDocumentation);
     },
 
 

diff --git a/src/pages/dataconsumption/dataconsumption/IDSDataConsumptionPage.js b/src/pages/dataconsumption/dataconsumption/IDSDataConsumptionPage.js
@@ -68,7 +68,10 @@ export default {
                 value: 'publisher'
             }, {
                 text: 'License',
-                value: 'standardlicense'
+                value: 'standardLicense'
+            }, {
+                text: 'Endpoint Documentation',
+                value: 'endpointDocumentation'
             }, {
                 text: 'Offered from',
                 value: 'contractPeriodFromValue'
@@ -163,7 +166,7 @@ export default {
         },
         getConnectorSelfDescription() {
             // this.$root.$emit('showBusyIndicator', true);
-            // TODO Get resources 
+            // TODO Get resources
         },
         clear() {
             this.$data.selectedCatalog = "";
@@ -316,7 +319,12 @@ export default {
         },
 
         async requestArtifact(item) {
-            this.$refs.artifactDialog.show(this.$data.selectedResource["ids:contractOffer"][0]["ids:permission"], this.$data.selectedResource["ids:standardLicense"]["@id"], item, this.clickAcceptContract);
+            this.$refs.artifactDialog.show(
+                this.$data.selectedResource["ids:contractOffer"][0]["ids:permission"],
+                this.$data.selectedResource["ids:standardLicense"]["@id"],
+                item,
+                this.clickAcceptContract
+            );
         },
 
         clickAcceptContract(artifact, subscribe, subscriptionLocation) {

diff --git a/src/pages/dataoffering/resources/addresource/AddResourcePage.js b/src/pages/dataoffering/resources/addresource/AddResourcePage.js
@@ -161,7 +161,8 @@ export default {
             let language = this.$refs.metaDataPage.language;
             let paymentMethod = this.$refs.metaDataPage.paymentMethod;
             let keywords = dataUtils.commaSeperatedStringToArray(this.$refs.metaDataPage.keywords);
-            let standardlicense = this.$refs.metaDataPage.standardlicense;
+            let standardLicense = this.$refs.metaDataPage.standardLicense;
+            let endpointDocumentation = this.$refs.metaDataPage.endpointDocumentation;
             let publisher = this.$refs.metaDataPage.publisher;
             let samples = this.$refs.metaDataPage.samples;
             let additionalFields = {};
@@ -189,22 +190,22 @@ export default {
 
             if (this.fromRoutePage === 'true') {
                 // On route page this data is initially stored only in the node and will be saved with the route.
-                this.$emit("saved", catalogIds, title, description, language, paymentMethod, keywords, 0, standardlicense, publisher, templateTitle,
-                    policyDescriptions, contractPeriodFromValue, contractPeriodToValue, filetype, 0, brokerList);
+                this.$emit("saved", catalogIds, title, description, language, paymentMethod, keywords, 0, standardLicense, publisher, templateTitle,
+                    policyDescriptions, contractPeriodFromValue, contractPeriodToValue, filetype, 0, brokerList, endpointDocumentation);
             } else {
                 this.$root.$emit('showBusyIndicator', true);
                 this.$root.$emit('blockNavigationMenu', true);
                 if (this.$data.currentResource == null) {
-                    await dataUtils.createResourceWithMinimalRoute(catalogIds, title, description, language, paymentMethod, keywords, standardlicense, publisher,
-                        templateTitle, policyDescriptions, contractPeriodFromValue, contractPeriodToValue, filetype, brokerList, file, genericEndpoint, additionalFields);
+                    await dataUtils.createResourceWithMinimalRoute(catalogIds, title, description, language, paymentMethod, keywords, standardLicense, publisher,
+                        templateTitle, policyDescriptions, contractPeriodFromValue, contractPeriodToValue, filetype, brokerList, file, genericEndpoint, additionalFields, endpointDocumentation);
                     await this.$router.push('idsresourcesoffering');
                     this.$root.$emit('showBusyIndicator', false);
                     this.$root.$emit('blockNavigationMenu', false);
                 } else {
                     await dataUtils.editResource(this.$data.currentResource.id, this.$data.currentResource.representationId, catalogIds, deletedCatalogIds,
-                        title, description, language, paymentMethod, keywords, standardlicense, publisher, samples, templateTitle, policyDescriptions, contractPeriodFromValue,
+                        title, description, language, paymentMethod, keywords, standardLicense, publisher, samples, templateTitle, policyDescriptions, contractPeriodFromValue,
                         contractPeriodToValue, filetype, brokerList, brokerDeleteList, file, genericEndpoint, this.$data.currentResource.ruleId,
-                        this.$data.currentResource.artifactId, additionalFields);
+                        this.$data.currentResource.artifactId, additionalFields, endpointDocumentation);
                     this.$router.push('idsresourcesoffering');
                     this.$root.$emit('showBusyIndicator', false);
                     this.$root.$emit('blockNavigationMenu', false);

diff --git a/src/pages/dataoffering/resources/addresource/metadata/ResourceMetaDataPage.html b/src/pages/dataoffering/resources/addresource/metadata/ResourceMetaDataPage.html
@@ -9,7 +9,9 @@
             </v-text-field>
             <v-text-field label="Keywords" v-model="keywords" readonly>
             </v-text-field>
-            <v-text-field label="Standard License" v-model="standardlicense" readonly>
+            <v-text-field label="Standard License" v-model="standardLicense" readonly>
+            </v-text-field>
+            <v-text-field label="Endpoint Documentation" v-model="endpointDocumentation" readonly>
             </v-text-field>
             <v-select label="Language" v-model="language" :items="languageItems" item-text="displayName"
                 item-value="originalName" readonly>
@@ -29,7 +31,9 @@
             </v-text-field>
             <v-text-field label="Keywords" v-model="keywords" :rules="defaultRule" required>
             </v-text-field>
-            <v-text-field label="Standard License" v-model="standardlicense" :rules="urlRule" required>
+            <v-text-field label="Standard License" v-model="standardLicense" :rules="urlRule" required>
+            </v-text-field>
+            <v-text-field label="Endpoint Documentation" v-model="endpointDocumentation" :rules="urlNotRequiredRule" required>
             </v-text-field>
             <v-select label="Language" v-model="language" :items="languageItems" item-text="displayName"
                 item-value="originalName" :rules="defaultRule" required>

diff --git a/src/pages/dataoffering/resources/addresource/metadata/ResourceMetaDataPage.js b/src/pages/dataoffering/resources/addresource/metadata/ResourceMetaDataPage.js
@@ -14,7 +14,8 @@ export default {
             description: "",
             keywords: "",
             publisher: "",
-            standardlicense: "",
+            standardLicense: "",
+            endpointDocumentation: "",
             language: "",
             samples: [],
             languageItems: [],
@@ -23,6 +24,7 @@ export default {
             valid: false,
             defaultRule: validationUtils.getRequiredRule(),
             urlRule: validationUtils.getUrlRequiredRule(),
+            urlNotRequiredRule: validationUtils.getUrlNotRequiredRule(),
             readonly: false,
             onlyMetaData: false
         };
@@ -56,7 +58,8 @@ export default {
                 this.$data.language = resource.language.substring(resource.language.lastIndexOf("/") + 1);
                 this.$data.paymentMethod = resource.paymentMethod;
                 this.$data.keywords = dataUtils.arrayToCommaSeperatedString(resource.keywords);
-                this.$data.standardlicense = resource.standardlicense;
+                this.$data.standardLicense = resource.standardLicense;
+                this.$data.endpointDocumentation = resource.endpointDocumentation;
                 this.$data.publisher = resource.publisher;
                 this.$data.samples = resource.samples;
             }

diff --git a/src/pages/dataoffering/routes/addroute/dialog/editidsendpointdialog/EditIdsEndpointDialog.js b/src/pages/dataoffering/routes/addroute/dialog/editidsendpointdialog/EditIdsEndpointDialog.js
@@ -44,8 +44,8 @@ export default {
             this.$refs.addResourcePage.set(resource, false);
             this.$data.dialog = true;
         },
-        saved(catalogIds, title, description, language, paymentMethod, keywords, version, standardlicense, publisher, templateTitle, policyDescriptions,
-            contractPeriodFromValue, contractPeriodToValue, filetype, bytesize, brokerList) {
+        saved(catalogIds, title, description, language, paymentMethod, keywords, version, standardLicense, publisher, templateTitle, policyDescriptions,
+            contractPeriodFromValue, contractPeriodToValue, filetype, bytesize, brokerList, endpointDocumentation) {
             let isNew = false;
             if (this.$data.node == null) {
                 isNew = true;
@@ -68,7 +68,8 @@ export default {
             resource.paymentMethod = paymentMethod;
             resource.keywords = keywords;
             resource.version = version;
-            resource.standardlicense = standardlicense;
+            resource.standardLicense = standardLicense;
+            resource.endpointDocumentation = endpointDocumentation;
             resource.publisher = publisher;
             resource.title = templateTitle;
             resource.policyDescriptions = policyDescriptions;

diff --git a/src/utils/dataUtils.js b/src/utils/dataUtils.js
@@ -958,8 +958,8 @@ export default {
         }
     },
 
-    async createResourceWithMinimalRoute(catalogIds, title, description, language, paymentMethod, keywords, standardlicense, publisher, templateTitle, policyDescriptions,
-        contractPeriodFromValue, contractPeriodToValue, filetype, brokerUris, file, genericEndpoint, additionalFields = {}) {
+    async createResourceWithMinimalRoute(catalogIds, title, description, language, paymentMethod, keywords, standardLicense, publisher, templateTitle, policyDescriptions,
+        contractPeriodFromValue, contractPeriodToValue, filetype, brokerUris, file, genericEndpoint, additionalFields, endpointDocumentation = {}) {
         try {
             let routeSelfLink = null;
             if (genericEndpoint != null) {
@@ -968,25 +968,26 @@ export default {
                 routeSelfLink = response._links.self.href;
                 await restUtils.callConnector("PUT", "/api/routes/" + routeId + "/endpoint/start", null, "\"" + genericEndpoint.selfLink + "\"");
             }
-            let resourceResponse = await this.createResource(catalogIds, title, description, language, paymentMethod, keywords, standardlicense, publisher,
-                policyDescriptions, templateTitle, contractPeriodFromValue, contractPeriodToValue, filetype, file, routeSelfLink, additionalFields);
+            let resourceResponse = await this.createResource(catalogIds, title, description, language, paymentMethod, keywords, standardLicense, publisher,
+                policyDescriptions, templateTitle, contractPeriodFromValue, contractPeriodToValue, filetype, file, routeSelfLink, additionalFields, endpointDocumentation);
             await this.updateResourceAtBrokers(brokerUris, resourceResponse.resourceId);
         } catch (error) {
             errorUtils.showError(error, "Save resource");
         }
     },
 
-    async createResource(catalogIds, title, description, language, paymentMethod, keywords, standardlicense, publisher, policyDescriptions, templateTitle,
-        contractPeriodFromValue, contractPeriodToValue, filetype, file, routeSelfLink, additionalFields= {}) {
-        // TODO Sovereign, EndpointDocumentation
+    async createResource(catalogIds, title, description, language, paymentMethod, keywords, standardLicense, publisher, policyDescriptions, templateTitle,
+        contractPeriodFromValue, contractPeriodToValue, filetype, file, routeSelfLink, additionalFields, endpointDocumentation= {}) {
+        // TODO Sovereign
         let resourceFields = {
             "title": title,
             "description": description,
             "keywords": keywords,
             "publisher": publisher,
             "language": language,
             "paymentMethod": paymentMethod,
-            "license": standardlicense
+            "license": standardLicense,
+            "endpointDocumentation": endpointDocumentation
         }
         let response = (await restUtils.callConnector("POST", "/api/offers", null, Object.assign(resourceFields, additionalFields)));
 
@@ -1033,8 +1034,8 @@ export default {
     },
 
     async editResource(resourceId, representationId, catalogIds, deletedCatalogIds, title, description, language, paymentMethod,
-        keywords, standardlicense, publisher, samples, templateTitle, policyDescriptions, contractPeriodFromValue, contractPeriodToValue,
-        filetype, brokerUris, brokerDeleteUris, file, genericEndpoint, ruleId, artifactId, additionalFields = {}) {
+        keywords, standardLicense, publisher, samples, templateTitle, policyDescriptions, contractPeriodFromValue, contractPeriodToValue,
+        filetype, brokerUris, brokerDeleteUris, file, genericEndpoint, ruleId, artifactId, additionalFields, endpointDocumentation = {}) {
         try {
             let resourceFields = {
                 "title": title,
@@ -1043,7 +1044,8 @@ export default {
                 "publisher": publisher,
                 "language": language,
                 "paymentMethod": paymentMethod,
-                "license": standardlicense,
+                "license": standardLicense,
+                "endpointDocumentation": endpointDocumentation,
                 "samples": samples
             }
             await restUtils.callConnector("PUT", "/api/offers/" + resourceId, null, Object.assign(resourceFields, additionalFields));
@@ -1117,7 +1119,8 @@ export default {
                 "publisher": resource.publisher,
                 "language": resource.language,
                 "paymentMethod": resource.paymentMethod,
-                "license": resource.standardlicense,
+                "license": resource.standardLicense,
+                "endpointDocumentation": resource.endpointDocumentation,
                 "samples": samples
             });
         } catch (error) {
@@ -1142,16 +1145,17 @@ export default {
         let language = resource.language;
         let paymentMethod = resource.paymentMethod;
         let keywords = resource.keywords;
-        let standardlicense = resource.standardlicense;
+        let standardLicense = resource.standardLicense;
+        let endpointDocumentation = resource.endpointDocumentation;
         let publisher = resource.publisher;
         let policyDescriptions = resource.policyDescriptions;
         let contractPeriodFromValue = resource.contractPeriodFromValue;
         let contractPeriodToValue = resource.contractPeriodToValue;
         let filetype = resource.fileType;
         let brokerUris = resource.brokerUris;
         let contractName = resource.contractName;
-        let resourceResponse = await this.createResource(catalogIds, title, description, language, paymentMethod, keywords, standardlicense, publisher,
-            policyDescriptions, contractName, contractPeriodFromValue, contractPeriodToValue, filetype, null, routeSelfLink);
+        let resourceResponse = await this.createResource(catalogIds, title, description, language, paymentMethod, keywords, standardLicense, publisher,
+            policyDescriptions, contractName, contractPeriodFromValue, contractPeriodToValue, filetype, null, routeSelfLink, undefined, endpointDocumentation);
 
         await this.updateResourceAtBrokers(brokerUris, resourceResponse.resourceId);
     },
@@ -1461,7 +1465,8 @@ export default {
             keywords.push(idsKeyword["@value"]);
         }
         let version = resource["ids:version"];
-        let standardlicense = resource["ids:standardLicense"]["@id"];
+        let standardLicense = resource["ids:standardLicense"]["@id"];
+        let endpointDocumentation = resource["ids:endpointDocumentation"]["@id"];
         let publisher = resource["ids:publisher"]["@id"];
         let fileType = null;
         if (resource["ids:representation"] !== undefined && resource["ids:representation"].length > 0) {
@@ -1474,8 +1479,10 @@ export default {
             contractPeriodToValue = resource["ids:contractOffer"][0]["ids:contractEnd"]["@value"];
         }
         let contractName = resource.contractName;
-        let clientResource = clientDataModel.createResource(resource["@id"], id, creationDate, title, description, language, paymentMethod, keywords, version, standardlicense,
-            publisher, fileType, contractName, "", contractPeriodFromValue, contractPeriodToValue, null);
+        let clientResource = clientDataModel.createResource(resource["@id"], id, creationDate, title, description,
+            language, paymentMethod, keywords, version, standardLicense, publisher, fileType, contractName, "",
+            contractPeriodFromValue, contractPeriodToValue, undefined, undefined, undefined, undefined, undefined,
+            undefined, undefined, undefined, endpointDocumentation);
         clientResource.idsResource = resource;
         resources.push(clientResource);
     },