doc-detective-common 1.21.0-openapi.9 → 1.21.1-dev.0

package/src/schemas/output_schemas/test_v2.schema.json

@@ -141,6 +141,101 @@
         ]
       }
     },
+    "openApi": {
+      "type": "array",
+      "items": {
+        "allOf": [
+          {
+            "version": "1.0.0",
+            "$schema": "http://json-schema.org/draft-07/schema#",
+            "title": "openApi",
+            "type": "object",
+            "description": "OpenAPI definition and configuration.",
+            "additionalProperties": false,
+            "properties": {
+              "name": {
+                "type": "string",
+                "description": "Name of the OpenAPI definition, as defined in your configuration."
+              },
+              "descriptionPath": {
+                "type": "string",
+                "description": "URL or local path to the OpenAPI definition."
+              },
+              "operationId": {
+                "type": "string",
+                "description": "ID of the operation to use for the request."
+              },
+              "server": {
+                "type": "string",
+                "description": "Server to use for example requests. Only valid if `useExample` is `request` or `both`. If not specified but an example is used for the request, uses the first server defined in the OpenAPI definition."
+              },
+              "validateAgainstSchema": {
+                "type": "string",
+                "description": "Validates the request and/or response against the schema in the OpenAPI definition. If the request or response doesn't match the schema, the step fails.",
+                "enum": [
+                  "request",
+                  "response",
+                  "both",
+                  "none"
+                ],
+                "default": "both"
+              },
+              "mockResponse": {
+                "type": "boolean",
+                "description": "If `true`, doesn't make the HTTP request, but instead uses the response example or schema from the OpenAPI definition as the response data. Useful for creating tests when an API isn't fully implemented yet. If `statusCode` isn't specified, uses the first defined response code."
+              },
+              "statusCode": {
+                "type": "integer",
+                "description": "Response code to use for validation, examples, and status code checking. If the response code doesn't match, the step fails. `statusCodes` overrides this value when specified."
+              },
+              "useExample": {
+                "type": [
+                  "string"
+                ],
+                "description": "Uses the example from the OpenAPI definition as the request and response data. If the request or response has multiple examples, specify `exampleKey`. If `statusCode` isn't specified, uses the first defined response code. `requestData`, `requestParams`, and `requestHeaders` override portions of request examples when specified. `responseData` overrides portions of response examples when specified.",
+                "enum": [
+                  "request",
+                  "response",
+                  "both",
+                  "none"
+                ],
+                "default": "none"
+              },
+              "exampleKey": {
+                "type": "string",
+                "description": "Key of the example to use from the `examples` property in the OpenAPI definition. If an `examples` key isn't specified or isn't available for a given parameter or object, the `example` property value is used.",
+                "default": ""
+              },
+              "requestHeaders": {
+                "type": "object",
+                "description": "Request headers to add to the request. If specified in both a config and a step, the step value overrides the config value.",
+                "additionalProperties": {
+                  "type": "string"
+                }
+              }
+            },
+            "examples": [
+              {
+                "descriptionPath": "https://petstore.swagger.io/v2/swagger.json"
+              }
+            ]
+          },
+          {
+            "type": "object",
+            "properties": {
+              "operationId": {
+                "type": "null",
+                "$commment": "Only allow operationId at the step level."
+              }
+            },
+            "required": [
+              "name",
+              "descriptionPath"
+            ]
+          }
+        ]
+      }
+    },
     "setup": {
       "type": "string",
       "description": "Path to a test specification to perform before this test, while maintaining this test's context. Useful for setting up testing environments. Only the `steps` property is used from the first test in the setup spec."
@@ -326,6 +421,8 @@
               "openApi": {
                 "allOf": [
                   {
+                    "version": "1.0.0",
+                    "$schema": "http://json-schema.org/draft-07/schema#",
                     "title": "openApi",
                     "type": "object",
                     "description": "OpenAPI definition and configuration.",
@@ -335,7 +432,7 @@
                         "type": "string",
                         "description": "Name of the OpenAPI definition, as defined in your configuration."
                       },
-                      "definitionPath": {
+                      "descriptionPath": {
                         "type": "string",
                         "description": "URL or local path to the OpenAPI definition."
                       },
@@ -394,7 +491,7 @@
                     },
                     "examples": [
                       {
-                        "definitionPath": "https://petstore.swagger.io/v2/swagger.json"
+                        "descriptionPath": "https://petstore.swagger.io/v2/swagger.json"
                       }
                     ]
                   },
@@ -649,7 +746,7 @@
               {
                 "action": "httpRequest",
                 "openApi": {
-                  "definitionPath": "https://api.example.com/openapi.json",
+                  "descriptionPath": "https://api.example.com/openapi.json",
                   "operationId": "getUserById"
                 },
                 "requestParams": {
@@ -659,7 +756,7 @@
               {
                 "action": "httpRequest",
                 "openApi": {
-                  "definitionPath": "https://api.example.com/openapi.json",
+                  "descriptionPath": "https://api.example.com/openapi.json",
                   "operationId": "createUser",
                   "useExample": "both"
                 }
@@ -667,7 +764,7 @@
               {
                 "action": "httpRequest",
                 "openApi": {
-                  "definitionPath": "https://api.example.com/openapi.json",
+                  "descriptionPath": "https://api.example.com/openapi.json",
                   "operationId": "updateUser",
                   "useExample": "request",
                   "exampleKey": "acme"
@@ -676,7 +773,7 @@
               {
                 "action": "httpRequest",
                 "openApi": {
-                  "definitionPath": "https://api.example.com/openapi.json",
+                  "descriptionPath": "https://api.example.com/openapi.json",
                   "operationId": "updateUser",
                   "useExample": "request",
                   "exampleKey": "acme",
@@ -1535,6 +1632,26 @@
           "action": "saveScreenshot"
         }
       ]
+    },
+    {
+      "openApi": [
+        {
+          "name": "Acme",
+          "descriptionPath": "https://www.acme.com/openapi.json",
+          "server": "https://api.acme.com"
+        }
+      ],
+      "steps": [
+        {
+          "action": "httpRequest",
+          "openApi": {
+            "operationId": "getUserById"
+          },
+          "requestParams": {
+            "id": 123
+          }
+        }
+      ]
     }
   ]
 }