Merge pull request #22 from JaredCE/correctly-handle-OpenAPI-parameters

Correctly handle open api parameters

Author: JaredCE

README.md

@@ -63,6 +63,12 @@ jq --arg password "$secret_password" '.workflowId1.password = $password' input.j
 
 Obviously, if you have a lot of secret variables that need adding as inputs, then you might need to write a script that can alter the `input.json` file for you within your CI/CD runner.
 
+## OpenAPI Parameters
+
+OpenAPI Documents allow you to specify [`header`, `path` and `query` parameters](https://spec.openapis.org/oas/latest.html#parameter-object) in myriad of styles. This Arazzo Runner will respect your styling and send the format to the server as specified by your OpenAPI document.
+
+It currently does not follow the `allowEmptyValue`, `allowReserved` or the `content` keywords currently.
+
 ## Logging And Reporting
 
 ### Logging
@@ -93,14 +99,18 @@ Work on Reporting still needs completeing.
 
 ## Still unsupported
 
-### OpenAPI Params
+### PathOperation
 
-OpenAPI parameter types with style and explode are not quite supported yet
+Accessing an OpenAPI operation by Operation Path `'{$sourceDescriptions.petstoreDescription.url}#/paths/~1pet~1findByStatus/get'` does not work currently
 
 ### OpenAPI Servers on various levels
 
 This pulls from the top level servers object of an OpenAPI Document. Server variables do not work either.
 
+### OpenAPI server variables
+
+OpenAPI server variables currently do not work
+
 ### JSONPath and XPath criteria objects
 
 Criteria Objects set as type JSON Path or XPath do not work

package-lock.json

@@ -41,7 +41,7 @@
     "@swaggerexpert/json-pointer": "^2.10.2",
     "ajv": "^8.17.1",
     "jsonpath": "^1.1.1",
-    "openapi-params": "^0.0.4",
+    "openapi-params": "^0.0.5",
     "stream-chain": "^3.4.0",
     "stream-json": "^1.9.1"
   }

package.json

@@ -68,7 +68,6 @@ class Arazzo extends Document {
       } catch (err) {
         if (err.name === "AbortError") {
           if (err.goto) {
-            // console.log("goto error");
             await this.handleGotoRule(err.goto);
           }
         } else {
@@ -692,8 +691,6 @@ class Arazzo extends Document {
 
     if (this.retryLimits[whatNext.name] === 0)
       this.retrySet.delete(whatNext.name);
-
-    // console.log("I need to return here after retrying");
   }
 
   /**
@@ -738,41 +735,76 @@ class Arazzo extends Document {
    * @private
    */
   mapParameters() {
-    const headers = new Headers();
-    const queryParams = new URLSearchParams();
-    const pathParams = {};
+    const headersObj = new Headers();
+    const headers = new URLParams();
+    const queryParams = new URLParams();
+    const pathParams = new URLParams();
 
     for (const param of this.step?.parameters || []) {
       const operationDetailParam =
-        this.sourceDescription.operationDetails?.parameters
+        this.sourceDescriptionFile.operationDetails?.parameters
           .filter((obj) => obj.name === param.name && obj.in === param.in)
           .at(0);
 
       const value = this.expression.resolveExpression(param.value);
 
       switch (param.in) {
         case "header":
-          headers.append(param.name, value);
+          const headerStyle = operationDetailParam?.style || "simple";
+          const headerExplode = operationDetailParam?.explode || false;
+          headers.append(param.name, value, {
+            style: headerStyle,
+            explode: headerExplode,
+          });
+          for (const [header, value] of headers) {
+            if (header === param.name) {
+              headersObj.append(param.name, value);
+            }
+          }
 
           break;
 
         case "path":
           for (const operation of this.operations) {
-            operation.url = operation.url.replace(`{${param.name}}`, value);
-            Object.assign(pathParams, { [param.name]: value });
+            const pathStyle = operationDetailParam?.style || "simple";
+            const pathExplode = operationDetailParam?.explode || false;
+            pathParams.append(param.name, value, {
+              style: pathStyle,
+              explode: pathExplode,
+            });
+            for (const [name, value] of pathParams.entries()) {
+              operation.url = operation.url.replace(`{${name}}`, value);
+            }
+            // operation.url = operation.url.replace(`{${param.name}}`, value);
+            // Object.assign(pathParams, { [param.name]: value });
           }
           break;
 
         case "query":
-          queryParams.append(param.name, value);
+          // queryParams.append(param.name, value);
+          const style = operationDetailParam?.style || "form";
+          let explode = false;
+          if (Object.hasOwn(operationDetailParam, "explode")) {
+            explode = operationDetailParam.explode;
+          } else {
+            if (style === "form") {
+              explode = true;
+            }
+          }
+          // const explode = operationDetailParam?.explode || false;
+          queryParams.append(param.name, value, {
+            style: style,
+            explode: explode,
+          });
           break;
       }
     }
 
-    this.expression.addToContext("request.path", pathParams);
+    this.addParamsToContext(pathParams, "path", "request");
+    // this.expression.addToContext("request.path", pathParams);
 
     for (const operation of this.operations) {
-      operation.headers = headers;
+      operation.headers = headersObj;
       operation.queryParams = queryParams;
     }
   }

src/Arazzo.js

@@ -10,7 +10,7 @@
   "sourceDescriptions": [
     {
       "name": "pets-openAPI",
-      "url": "https://raw.githubusercontent.com/JaredCE/Arazzo-Runner/refs/heads/main/test/mocks/openapi/parameter-styles/path/label/simple-array-exploded.json",
+      "url": "https://raw.githubusercontent.com/JaredCE/Arazzo-Runner/refs/heads/main/test/mocks/openapi/parameter-styles/path/label/array-exploded.json",
       "type": "openapi"
     }
   ],

test/mocks/arazzo/openapi-parameter-tests/path/label/array-exploded.json

@@ -10,7 +10,7 @@
   "sourceDescriptions": [
     {
       "name": "pets-openAPI",
-      "url": "https://raw.githubusercontent.com/JaredCE/Arazzo-Runner/refs/heads/main/test/mocks/openapi/parameter-styles/path/label/simple-array-exploded.json",
+      "url": "https://raw.githubusercontent.com/JaredCE/Arazzo-Runner/refs/heads/main/test/mocks/openapi/parameter-styles/path/label/array.json",
       "type": "openapi"
     }
   ],

test/mocks/arazzo/openapi-parameter-tests/path/label/array.json

@@ -10,7 +10,7 @@
   "sourceDescriptions": [
     {
       "name": "pets-openAPI",
-      "url": "https://raw.githubusercontent.com/JaredCE/Arazzo-Runner/refs/heads/main/test/mocks/openapi/parameter-styles/path/label/simple-array-exploded.json",
+      "url": "https://raw.githubusercontent.com/JaredCE/Arazzo-Runner/refs/heads/main/test/mocks/openapi/parameter-styles/path/label/object-exploded.json",
       "type": "openapi"
     }
   ],

test/mocks/arazzo/openapi-parameter-tests/path/label/object-exploded.json

@@ -10,7 +10,7 @@
   "sourceDescriptions": [
     {
       "name": "pets-openAPI",
-      "url": "https://raw.githubusercontent.com/JaredCE/Arazzo-Runner/refs/heads/main/test/mocks/openapi/parameter-styles/path/label/simple-array-exploded.json",
+      "url": "https://raw.githubusercontent.com/JaredCE/Arazzo-Runner/refs/heads/main/test/mocks/openapi/parameter-styles/path/label/object.json",
       "type": "openapi"
     }
   ],

test/mocks/arazzo/openapi-parameter-tests/path/label/object.json

@@ -10,7 +10,7 @@
   "sourceDescriptions": [
     {
       "name": "pets-openAPI",
-      "url": "https://raw.githubusercontent.com/JaredCE/Arazzo-Runner/refs/heads/main/test/mocks/openapi/parameter-styles/path/label/simple-array-exploded.json",
+      "url": "https://raw.githubusercontent.com/JaredCE/Arazzo-Runner/refs/heads/main/test/mocks/openapi/parameter-styles/path/label/primitive-exploded.json",
       "type": "openapi"
     }
   ],
@@ -23,7 +23,7 @@
         "type": "object",
         "properties": {
           "petId": {
-            "type": "integer"
+            "type": "string"
           }
         }
       },

test/mocks/arazzo/openapi-parameter-tests/path/label/primitive-exploded.json

@@ -10,7 +10,7 @@
   "sourceDescriptions": [
     {
       "name": "pets-openAPI",
-      "url": "https://raw.githubusercontent.com/JaredCE/Arazzo-Runner/refs/heads/main/test/mocks/openapi/parameter-styles/path/label/simple-array-exploded.json",
+      "url": "https://raw.githubusercontent.com/JaredCE/Arazzo-Runner/refs/heads/main/test/mocks/openapi/parameter-styles/path/label/primitive.json",
       "type": "openapi"
     }
   ],
@@ -23,7 +23,7 @@
         "type": "object",
         "properties": {
           "petId": {
-            "type": "integer"
+            "type": "string"
           }
         }
       },