refactor: project-wide change of OAS vendor extensions cactus -> cacti

1. Did a complete find & replace of the old vendor extensions and the new ones. In theory this is a change that the compiler guarantees for us to verify completely, but even with that said, I'll leave the CI on so that we can double check to be sure. This is also a BREAKING CHANGE because if someone had installed the older packages and they imported endpoint definitions from the OAS spec based on the vendor extensions then their could would stop compiling. Therefore this change must be done before we issue the 2.0.0 release. 2. Also added a bug-fix to tools/custom-checks/check-open-api-json-specs.ts because it wasn't just validating HTTP verbs within "paths" but also any property that was in there such as "summary" or "description" but of course those are string properties so they won't pass the validation we impose on HTTP verb definitions for the endpoints. Fixes hyperledger#2872 Signed-off-by: Peter Somogyvari <[email protected]>
outSH · Nov 15, 2023 · 31ac3f1 · 31ac3f1
1 parent bf9dfe8
commit 31ac3f1
Show file tree

Hide file tree

Showing 149 changed files with 447 additions and 417 deletions.
diff --git a/examples/cactus-example-carbon-accounting-business-logic-plugin/src/main/json/openapi.json b/examples/cactus-example-carbon-accounting-business-logic-plugin/src/main/json/openapi.json
@@ -155,7 +155,7 @@
       "post": {
         "operationId": "enrollAdminV1",
         "summary": "Registers an admin account within the Fabric organization specified.",
-        "x-hyperledger-cactus": {
+        "x-hyperledger-cacti": {
           "authz": {
             "isProtected": true,
             "requiredRoles": ["group:admin"]
@@ -192,7 +192,7 @@
       "post": {
         "operationId": "daoTokenGetAllowanceV1",
         "summary": "Get the number of tokens `spender` is approved to spend on behalf of `account`",
-        "x-hyperledger-cactus": {
+        "x-hyperledger-cacti": {
           "http": {
             "verbLowerCase": "post",
             "path": "/api/v1/plugins/@hyperledger/cactus-example-carbon-accounting-backend/dao-token/get-allowance"

diff --git a/...rc/main/typescript/business-logic-plugin/web-services/dao-token/get-allowance-endpoint.ts b/...rc/main/typescript/business-logic-plugin/web-services/dao-token/get-allowance-endpoint.ts
@@ -63,11 +63,11 @@ export class GetAllowanceEndpoint implements IWebServiceEndpoint {
   }
 
   public getVerbLowerCase(): string {
-    return this.oasPath.post["x-hyperledger-cactus"].http.verbLowerCase;
+    return this.oasPath.post["x-hyperledger-cacti"].http.verbLowerCase;
   }
 
   public getPath(): string {
-    return this.oasPath.post["x-hyperledger-cactus"].http.path;
+    return this.oasPath.post["x-hyperledger-cacti"].http.path;
   }
 
   public getExpressRequestHandler(): IExpressRequestHandler {

diff --git a/.../business-logic-plugin/web-services/utility-emissions-channel/enroll-admin-v1-endpoint.ts b/.../business-logic-plugin/web-services/utility-emissions-channel/enroll-admin-v1-endpoint.ts
@@ -48,7 +48,7 @@ export class EnrollAdminV1Endpoint implements IWebServiceEndpoint {
 
   getAuthorizationOptionsProvider(): IAsyncProvider<IEndpointAuthzOptions> {
     return {
-      get: async () => this.oasPath.post["x-hyperledger-cactus"].authz,
+      get: async () => this.oasPath.post["x-hyperledger-cacti"].authz,
     };
   }
 
@@ -57,11 +57,11 @@ export class EnrollAdminV1Endpoint implements IWebServiceEndpoint {
   }
 
   public getVerbLowerCase(): string {
-    return this.oasPath.post["x-hyperledger-cactus"].http.verbLowerCase;
+    return this.oasPath.post["x-hyperledger-cacti"].http.verbLowerCase;
   }
 
   public getPath(): string {
-    return this.oasPath.post["x-hyperledger-cactus"].http.path;
+    return this.oasPath.post["x-hyperledger-cacti"].http.path;
   }
 
   public getExpressRequestHandler(): IExpressRequestHandler {

diff --git a/examples/cactus-example-supply-chain-business-logic-plugin/src/main/json/openapi.json b/examples/cactus-example-supply-chain-business-logic-plugin/src/main/json/openapi.json
@@ -215,7 +215,7 @@
     "/api/v1/plugins/@hyperledger/cactus-example-supply-chain-backend/insert-bookshelf": {
       "post": {
         "operationId": "insertBookshelfV1",
-        "x-hyperledger-cactus": {
+        "x-hyperledger-cacti": {
           "http": {
             "verbLowerCase": "post",
             "path": "/api/v1/plugins/@hyperledger/cactus-example-supply-chain-backend/insert-bookshelf"
@@ -249,7 +249,7 @@
     "/api/v1/plugins/@hyperledger/cactus-example-supply-chain-backend/list-bookshelf": {
       "get": {
         "operationId": "listBookshelfV1",
-        "x-hyperledger-cactus": {
+        "x-hyperledger-cacti": {
           "http": {
             "verbLowerCase": "get",
             "path": "/api/v1/plugins/@hyperledger/cactus-example-supply-chain-backend/list-bookshelf"
@@ -273,7 +273,7 @@
     },
     "/api/v1/plugins/@hyperledger/cactus-example-supply-chain-backend/insert-shipment": {
       "post": {
-        "x-hyperledger-cactus": {
+        "x-hyperledger-cacti": {
           "http": {
             "verbLowerCase": "post",
             "path": "/api/v1/plugins/@hyperledger/cactus-example-supply-chain-backend/insert-shipment"
@@ -307,7 +307,7 @@
     },
     "/api/v1/plugins/@hyperledger/cactus-example-supply-chain-backend/list-shipment": {
       "get": {
-        "x-hyperledger-cactus": {
+        "x-hyperledger-cacti": {
           "http": {
             "verbLowerCase": "get",
             "path": "/api/v1/plugins/@hyperledger/cactus-example-supply-chain-backend/list-shipment"
@@ -333,7 +333,7 @@
     "/api/v1/plugins/@hyperledger/cactus-example-supply-chain-backend/insert-bamboo-harvest": {
       "post": {
         "operationId": "insertBambooHarvestV1",
-        "x-hyperledger-cactus": {
+        "x-hyperledger-cacti": {
           "http": {
             "verbLowerCase": "post",
             "path": "/api/v1/plugins/@hyperledger/cactus-example-supply-chain-backend/insert-bamboo-harvest"
@@ -367,7 +367,7 @@
     "/api/v1/plugins/@hyperledger/cactus-example-supply-chain-backend/list-bamboo-harvest": {
       "get": {
         "operationId": "listBambooHarvestV1",
-        "x-hyperledger-cactus": {
+        "x-hyperledger-cacti": {
           "http": {
             "verbLowerCase": "get",
             "path": "/api/v1/plugins/@hyperledger/cactus-example-supply-chain-backend/list-bamboo-harvest"

diff --git a/.../src/main/typescript/business-logic-plugin/web-services/insert-bamboo-harvest-endpoint.ts b/.../src/main/typescript/business-logic-plugin/web-services/insert-bamboo-harvest-endpoint.ts
@@ -94,12 +94,12 @@ export class InsertBambooHarvestEndpoint implements IWebServiceEndpoint {
 
   public getVerbLowerCase(): string {
     const apiPath = this.getOasPath();
-    return apiPath.post["x-hyperledger-cactus"].http.verbLowerCase;
+    return apiPath.post["x-hyperledger-cacti"].http.verbLowerCase;
   }
 
   public getPath(): string {
     const apiPath = this.getOasPath();
-    return apiPath.post["x-hyperledger-cactus"].http.path;
+    return apiPath.post["x-hyperledger-cacti"].http.path;
   }
 
   public getExpressRequestHandler(): IExpressRequestHandler {

diff --git a/...lugin/src/main/typescript/business-logic-plugin/web-services/insert-bookshelf-endpoint.ts b/...lugin/src/main/typescript/business-logic-plugin/web-services/insert-bookshelf-endpoint.ts
@@ -82,12 +82,12 @@ export class InsertBookshelfEndpoint implements IWebServiceEndpoint {
 
   public getVerbLowerCase(): string {
     const apiPath = this.getOasPath();
-    return apiPath.post["x-hyperledger-cactus"].http.verbLowerCase;
+    return apiPath.post["x-hyperledger-cacti"].http.verbLowerCase;
   }
 
   public getPath(): string {
     const apiPath = this.getOasPath();
-    return apiPath.post["x-hyperledger-cactus"].http.path;
+    return apiPath.post["x-hyperledger-cacti"].http.path;
   }
 
   public getExpressRequestHandler(): IExpressRequestHandler {

diff --git a/...plugin/src/main/typescript/business-logic-plugin/web-services/insert-shipment-endpoint.ts b/...plugin/src/main/typescript/business-logic-plugin/web-services/insert-shipment-endpoint.ts
@@ -75,12 +75,12 @@ export class InsertShipmentEndpoint implements IWebServiceEndpoint {
 
   getPath(): string {
     const apiPath = this.getOasPath();
-    return apiPath.post["x-hyperledger-cactus"].http.path;
+    return apiPath.post["x-hyperledger-cacti"].http.path;
   }
 
   getVerbLowerCase(): string {
     const apiPath = this.getOasPath();
-    return apiPath.post["x-hyperledger-cactus"].http.verbLowerCase;
+    return apiPath.post["x-hyperledger-cacti"].http.verbLowerCase;
   }
 
   public getOperationId(): string {

diff --git a/...in/src/main/typescript/business-logic-plugin/web-services/list-bamboo-harvest-endpoint.ts b/...in/src/main/typescript/business-logic-plugin/web-services/list-bamboo-harvest-endpoint.ts
@@ -81,12 +81,12 @@ export class ListBambooHarvestEndpoint implements IWebServiceEndpoint {
 
   public getVerbLowerCase(): string {
     const apiPath = this.getOasPath();
-    return apiPath.get["x-hyperledger-cactus"].http.verbLowerCase;
+    return apiPath.get["x-hyperledger-cacti"].http.verbLowerCase;
   }
 
   public getPath(): string {
     const apiPath = this.getOasPath();
-    return apiPath.get["x-hyperledger-cactus"].http.path;
+    return apiPath.get["x-hyperledger-cacti"].http.path;
   }
 
   public getExpressRequestHandler(): IExpressRequestHandler {

diff --git a/...-plugin/src/main/typescript/business-logic-plugin/web-services/list-bookshelf-endpoint.ts b/...-plugin/src/main/typescript/business-logic-plugin/web-services/list-bookshelf-endpoint.ts
@@ -79,12 +79,12 @@ export class ListBookshelfEndpoint implements IWebServiceEndpoint {
 
   public getVerbLowerCase(): string {
     const apiPath = this.getOasPath();
-    return apiPath.get["x-hyperledger-cactus"].http.verbLowerCase;
+    return apiPath.get["x-hyperledger-cacti"].http.verbLowerCase;
   }
 
   public getPath(): string {
     const apiPath = this.getOasPath();
-    return apiPath.get["x-hyperledger-cactus"].http.path;
+    return apiPath.get["x-hyperledger-cacti"].http.path;
   }
 
   public getExpressRequestHandler(): IExpressRequestHandler {

diff --git a/...c-plugin/src/main/typescript/business-logic-plugin/web-services/list-shipment-endpoint.ts b/...c-plugin/src/main/typescript/business-logic-plugin/web-services/list-shipment-endpoint.ts
@@ -46,12 +46,12 @@ export class ListShipmentEndpoint implements IWebServiceEndpoint {
 
   getPath(): string {
     const apiPath = this.getOasPath();
-    return apiPath.get["x-hyperledger-cactus"].http.path;
+    return apiPath.get["x-hyperledger-cacti"].http.path;
   }
 
   getVerbLowerCase(): string {
     const apiPath = this.getOasPath();
-    return apiPath.get["x-hyperledger-cactus"].http.verbLowerCase;
+    return apiPath.get["x-hyperledger-cacti"].http.verbLowerCase;
   }
 
   public getOperationId(): string {

diff --git a/extensions/cactus-plugin-htlc-coordinator-besu/src/main/json/openapi.json b/extensions/cactus-plugin-htlc-coordinator-besu/src/main/json/openapi.json
@@ -213,7 +213,7 @@
   "paths": {
     "/api/v1/plugins/@hyperledger/cactus-plugin-htlc-coordinator-besu/own-htlc": {
       "post": {
-        "x-hyperledger-cactus": {
+        "x-hyperledger-cacti": {
           "http": {
             "verbLowerCase": "post",
             "path": "/api/v1/plugins/@hyperledger/cactus-plugin-htlc-coordinator-besu/own-htlc"
@@ -245,7 +245,7 @@
     },
     "/api/v1/plugins/@hyperledger/cactus-plugin-htlc-coordinator-besu/counterparty-htlc": {
       "post": {
-        "x-hyperledger-cactus": {
+        "x-hyperledger-cacti": {
           "http": {
             "verbLowerCase": "post",
             "path": "/api/v1/plugins/@hyperledger/cactus-plugin-htlc-coordinator-besu/counterparty-htlc"
@@ -277,7 +277,7 @@
     },
     "/api/v1/plugins/@hyperledger/cactus-plugin-htlc-coordinator-besu/withdraw-counterparty": {
       "post": {
-        "x-hyperledger-cactus": {
+        "x-hyperledger-cacti": {
           "http": {
             "verbLowerCase": "post",
             "path": "/api/v1/plugins/@hyperledger/cactus-plugin-htlc-coordinator-besu/withdraw-counterparty"

diff --git a/...ugin-htlc-coordinator-besu/src/main/typescript/web-services/counterparty-htlc-endpoint.ts b/...ugin-htlc-coordinator-besu/src/main/typescript/web-services/counterparty-htlc-endpoint.ts
@@ -55,12 +55,12 @@ export class CounterpartyHTLCEndpoint implements IWebServiceEndpoint {
 
   public getPath(): string {
     const apiPath = this.getOasPath();
-    return apiPath.post["x-hyperledger-cactus"].http.path;
+    return apiPath.post["x-hyperledger-cacti"].http.path;
   }
 
   public getVerbLowerCase(): string {
     const apiPath = this.getOasPath();
-    return apiPath.post["x-hyperledger-cactus"].http.verbLowerCase;
+    return apiPath.post["x-hyperledger-cacti"].http.verbLowerCase;
   }
 
   public getOperationId(): string {

diff --git a/...cactus-plugin-htlc-coordinator-besu/src/main/typescript/web-services/own-htlc-endpoint.ts b/...cactus-plugin-htlc-coordinator-besu/src/main/typescript/web-services/own-htlc-endpoint.ts
@@ -55,12 +55,12 @@ export class OwnHTLCEndpoint implements IWebServiceEndpoint {
 
   public getPath(): string {
     const apiPath = this.getOasPath();
-    return apiPath.post["x-hyperledger-cactus"].http.path;
+    return apiPath.post["x-hyperledger-cacti"].http.path;
   }
 
   public getVerbLowerCase(): string {
     const apiPath = this.getOasPath();
-    return apiPath.post["x-hyperledger-cactus"].http.verbLowerCase;
+    return apiPath.post["x-hyperledger-cacti"].http.verbLowerCase;
   }
 
   public getOperationId(): string {

diff --git a/...-htlc-coordinator-besu/src/main/typescript/web-services/withdraw-counterparty-endpoint.ts b/...-htlc-coordinator-besu/src/main/typescript/web-services/withdraw-counterparty-endpoint.ts
@@ -57,12 +57,12 @@ export class WithdrawCounterpartyEndpoint implements IWebServiceEndpoint {
 
   public getPath(): string {
     const apiPath = this.getOasPath();
-    return apiPath.post["x-hyperledger-cactus"].http.path;
+    return apiPath.post["x-hyperledger-cacti"].http.path;
   }
 
   public getVerbLowerCase(): string {
     const apiPath = this.getOasPath();
-    return apiPath.post["x-hyperledger-cactus"].http.verbLowerCase;
+    return apiPath.post["x-hyperledger-cacti"].http.verbLowerCase;
   }
 
   public getOperationId(): string {

diff --git a/extensions/cactus-plugin-object-store-ipfs/src/main/json/openapi.json b/extensions/cactus-plugin-object-store-ipfs/src/main/json/openapi.json
@@ -37,7 +37,7 @@
   "paths": {
     "/api/v1/plugins/@hyperledger/cactus-plugin-object-store-ipfs/get-object": {
       "post": {
-        "x-hyperledger-cactus": {
+        "x-hyperledger-cacti": {
           "http": {
             "verbLowerCase": "post",
             "path": "/api/v1/plugins/@hyperledger/cactus-plugin-object-store-ipfs/get-object"
@@ -58,7 +58,7 @@
     },
     "/api/v1/plugins/@hyperledger/cactus-plugin-object-store-ipfs/set-object": {
       "post": {
-        "x-hyperledger-cactus": {
+        "x-hyperledger-cacti": {
           "http": {
             "verbLowerCase": "post",
             "path": "/api/v1/plugins/@hyperledger/cactus-plugin-object-store-ipfs/set-object"
@@ -79,7 +79,7 @@
     },
     "/api/v1/plugins/@hyperledger/cactus-plugin-object-store-ipfs/has-object": {
       "post": {
-        "x-hyperledger-cactus": {
+        "x-hyperledger-cacti": {
           "http": {
             "verbLowerCase": "post",
             "path": "/api/v1/plugins/@hyperledger/cactus-plugin-object-store-ipfs/has-object"

diff --git a/...actus-plugin-object-store-ipfs/src/main/typescript/web-services/get-object-endpoint-v1.ts b/...actus-plugin-object-store-ipfs/src/main/typescript/web-services/get-object-endpoint-v1.ts
@@ -72,11 +72,11 @@ export class GetObjectEndpointV1 implements IWebServiceEndpoint {
   }
 
   public getVerbLowerCase(): string {
-    return this.getOperation()["x-hyperledger-cactus"].http.verbLowerCase;
+    return this.getOperation()["x-hyperledger-cacti"].http.verbLowerCase;
   }
 
   public getPath(): string {
-    return this.getOperation()["x-hyperledger-cactus"].http.path;
+    return this.getOperation()["x-hyperledger-cacti"].http.path;
   }
 
   public getExpressRequestHandler(): IExpressRequestHandler {

diff --git a/...actus-plugin-object-store-ipfs/src/main/typescript/web-services/has-object-endpoint-v1.ts b/...actus-plugin-object-store-ipfs/src/main/typescript/web-services/has-object-endpoint-v1.ts
@@ -72,11 +72,11 @@ export class HasObjectEndpointV1 implements IWebServiceEndpoint {
   }
 
   public getVerbLowerCase(): string {
-    return this.getOperation()["x-hyperledger-cactus"].http.verbLowerCase;
+    return this.getOperation()["x-hyperledger-cacti"].http.verbLowerCase;
   }
 
   public getPath(): string {
-    return this.getOperation()["x-hyperledger-cactus"].http.path;
+    return this.getOperation()["x-hyperledger-cacti"].http.path;
   }
 
   public getExpressRequestHandler(): IExpressRequestHandler {

diff --git a/...actus-plugin-object-store-ipfs/src/main/typescript/web-services/set-object-endpoint-v1.ts b/...actus-plugin-object-store-ipfs/src/main/typescript/web-services/set-object-endpoint-v1.ts
@@ -72,11 +72,11 @@ export class SetObjectEndpointV1 implements IWebServiceEndpoint {
   }
 
   public getVerbLowerCase(): string {
-    return this.getOperation()["x-hyperledger-cactus"].http.verbLowerCase;
+    return this.getOperation()["x-hyperledger-cacti"].http.verbLowerCase;
   }
 
   public getPath(): string {
-    return this.getOperation()["x-hyperledger-cactus"].http.path;
+    return this.getOperation()["x-hyperledger-cacti"].http.path;
   }
 
   public getExpressRequestHandler(): IExpressRequestHandler {

diff --git a/packages/cactus-cmd-api-server/src/main/json/openapi.json b/packages/cactus-cmd-api-server/src/main/json/openapi.json
@@ -83,7 +83,7 @@
       "get": {
         "summary": "Can be used to verify liveness of an API server instance",
         "description": "Returns the current timestamp of the API server as proof of health/liveness",
-        "x-hyperledger-cactus": {
+        "x-hyperledger-cacti": {
           "http": {
             "verbLowerCase": "get",
             "path": "/api/v1/api-server/healthcheck"
@@ -107,7 +107,7 @@
     },
     "/api/v1/api-server/get-prometheus-exporter-metrics": {
       "get": {
-        "x-hyperledger-cactus": {
+        "x-hyperledger-cacti": {
           "http": {
             "verbLowerCase": "get",
             "path": "/api/v1/api-server/get-prometheus-exporter-metrics"
@@ -133,7 +133,7 @@
     "/api/v1/api-server/get-open-api-spec": {
       "get": {
         "description": "Returns the openapi.json document of specific plugin.",
-        "x-hyperledger-cactus": {
+        "x-hyperledger-cacti": {
           "http": {
             "verbLowerCase": "get",
             "path": "/api/v1/api-server/get-open-api-spec"

diff --git a/packages/cactus-cmd-api-server/src/main/typescript/api-server.ts b/packages/cactus-cmd-api-server/src/main/typescript/api-server.ts
@@ -577,9 +577,9 @@ export class ApiServer {
         oas: OAS,
         oasPath,
         operationId,
-        path: oasPath.get["x-hyperledger-cactus"].http.path,
+        path: oasPath.get["x-hyperledger-cacti"].http.path,
         pluginRegistry,
-        verbLowerCase: oasPath.get["x-hyperledger-cactus"].http.verbLowerCase,
+        verbLowerCase: oasPath.get["x-hyperledger-cacti"].http.verbLowerCase,
         logLevel,
       };
       const endpoint = new GetOpenApiSpecV1Endpoint(opts);
@@ -595,7 +595,7 @@ export class ApiServer {
     };
 
     const { "/api/v1/api-server/healthcheck": oasPath } = OAS.paths;
-    const { http } = oasPath.get["x-hyperledger-cactus"];
+    const { http } = oasPath.get["x-hyperledger-cacti"];
     const { path: httpPath, verbLowerCase: httpVerb } = http;
     if (!isExpressHttpVerbMethodName(httpVerb)) {
       const eMsg = `${fnTag} Invalid HTTP verb "${httpVerb}" in cmd-api-server OpenAPI specification for HTTP path: "${httpPath}"`;
@@ -634,7 +634,7 @@ export class ApiServer {
     } = OAS.paths;
 
     const { http: httpPrometheus } =
-      oasPathPrometheus.get["x-hyperledger-cactus"];
+      oasPathPrometheus.get["x-hyperledger-cacti"];
 
     const { path: httpPathPrometheus, verbLowerCase: httpVerbPrometheus } =
       httpPrometheus;