test(openapi/validate): cleanup 🧹

__tests__/__fixtures__/invalid-ref-oas/external-components.json

@@ -0,0 +1,179 @@
+{
+  "requestBodies": {
+    "Pet": {
+      "content": {
+        "application/json": {
+          "schema": {
+            "$ref": "#/schemas/Pet"
+          }
+        },
+        "application/xml": {
+          "schema": {
+            "$ref": "#/schemas/Pet"
+          }
+        }
+      },
+      "description": "Pet object that needs to be added to the store",
+      "required": true
+    }
+  },
+  "schemas": {
+    "Order": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "integer",
+          "format": "int64"
+        },
+        "petId": {
+          "type": "integer",
+          "format": "int64"
+        },
+        "quantity": {
+          "type": "integer",
+          "format": "int32"
+        },
+        "shipDate": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "status": {
+          "type": "string",
+          "description": "Order Status",
+          "enum": [
+            "placed",
+            "approved",
+            "delivered"
+          ]
+        },
+        "complete": {
+          "type": "boolean",
+          "default": false
+        }
+      },
+      "xml": {
+        "name": "Order"
+      }
+    },
+    "Category": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "integer",
+          "format": "int64"
+        },
+        "name": {
+          "type": "string"
+        }
+      },
+      "xml": {
+        "name": "Category"
+      }
+    },
+    "User": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "integer",
+          "format": "int64"
+        },
+        "username": {
+          "type": "string"
+        },
+        "firstName": {
+          "type": "string"
+        },
+        "lastName": {
+          "type": "string"
+        },
+        "email": {
+          "type": "string"
+        },
+        "password": {
+          "type": "string"
+        },
+        "phone": {
+          "type": "string"
+        },
+        "userStatus": {
+          "type": "integer",
+          "format": "int32",
+          "description": "User Status"
+        }
+      },
+      "xml": {
+        "name": "User"
+      }
+    },
+    "Tag": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "integer",
+          "format": "int64"
+        },
+        "name": {
+          "type": "string"
+        }
+      },
+      "xml": {
+        "name": "Tag"
+      }
+    },
+    "Pet": {
+      "type": "object",
+      "required": [
+        "name",
+        "photoUrls"
+      ],
+      "properties": {
+        "id": {
+          "type": "integer",
+          "format": "int64",
+          "default": 40,
+          "example": 25
+        },
+        "category": {
+          "$ref": "#/schemas/Category"
+        },
+        "name": {
+          "type": "string",
+          "example": "doggie"
+        },
+        "photoUrls": {
+          "type": "array",
+          "xml": {
+            "name": "photoUrl",
+            "wrapped": true
+          },
+          "items": {
+            "type": "string",
+            "example": "https://example.com/photo.png"
+          }
+        },
+        "tags": {
+          "type": "array",
+          "xml": {
+            "name": "tag",
+            "wrapped": true
+          },
+          "items": {
+            "$ref": "#/schemas/Tag"
+          }
+        },
+        "status": {
+          "type": "string",
+          "description": "pet status in the store",
+          "enum": [
+            "available",
+            "pending",
+            "sold"
+          ]
+        }
+      },
+      "xml": {
+        "name": "Pet"
+      }
+    }
+  }
+}

__tests__/__fixtures__/invalid-ref-oas/petstore.json

@@ -0,0 +1,132 @@
+{
+  "openapi": "3.0.0",
+  "info": {
+    "version": "1.0.0",
+    "title": "Example petstore to demo our handling of external $ref pointers"
+  },
+  "servers": [
+    {
+      "url": "http://petstore.swagger.io/v2"
+    }
+  ],
+  "paths": {
+    "/pet": {
+      "post": {
+        "tags": ["pet"],
+        "summary": "Add a new pet to the store",
+        "description": "",
+        "operationId": "addPet",
+        "requestBody": {
+          "$ref": "__tests__/__fixtures__/ref-oas/external-components.json#/requestBodies/Petty"
+        },
+        "responses": {
+          "405": {
+            "description": "Invalid input"
+          }
+        },
+        "security": [
+          {
+            "petstore_auth": ["write:pets", "read:pets"]
+          }
+        ]
+      },
+      "put": {
+        "tags": ["pet"],
+        "summary": "Update an existing pet",
+        "description": "",
+        "operationId": "updatePet",
+        "requestBody": {
+          "$ref": "__tests__/__fixtures__/ref-oas/external-components.json#/requestBodies/Petty"
+        },
+        "responses": {
+          "400": {
+            "description": "Invalid ID supplied"
+          },
+          "404": {
+            "description": "Pet not found"
+          },
+          "405": {
+            "description": "Validation exception"
+          }
+        },
+        "security": [
+          {
+            "petstore_auth": ["write:pets", "read:pets"]
+          }
+        ]
+      }
+    },
+    "/pet/{petId}": {
+      "get": {
+        "tags": ["pet"],
+        "summary": "Find pet by ID",
+        "description": "Returns a single pet",
+        "operationId": "getPetById",
+        "parameters": [
+          {
+            "name": "petId",
+            "in": "path",
+            "description": "ID of pet to return",
+            "required": true,
+            "schema": {
+              "type": "integer",
+              "format": "int64"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "successful operation",
+            "content": {
+              "application/xml": {
+                "schema": {
+                  "$ref": "__tests__/__fixtures__/ref-oas/external-components.json#/schemas/Petty"
+                }
+              },
+              "application/json": {
+                "schema": {
+                  "$ref": "__tests__/__fixtures__/ref-oas/external-components.json#/schemas/Petty"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Invalid ID supplied"
+          },
+          "404": {
+            "description": "Pet not found"
+          },
+          "default": {
+            "description": "successful response"
+          }
+        },
+        "security": [
+          {
+            "api_key": []
+          }
+        ]
+      }
+    }
+  },
+  "components": {
+    "securitySchemes": {
+      "petstore_auth": {
+        "type": "oauth2",
+        "flows": {
+          "implicit": {
+            "authorizationUrl": "http://petstore.swagger.io/oauth/dialog",
+            "scopes": {
+              "write:pets": "modify pets in your account",
+              "read:pets": "read your pets"
+            }
+          }
+        }
+      },
+      "api_key": {
+        "type": "apiKey",
+        "name": "api_key",
+        "in": "header"
+      }
+    }
+  }
+}

__tests__/cmds/__snapshots__/openapi.test.js.snap

@@ -14,7 +14,9 @@ REQUIRED must have required property 'name'
   29 |     }]
 `;
 
-exports[`rdme openapi should bundle and upload the expected content 1`] = `
+exports[`rdme openapi error handling should throw an error if an invalid ref is supplied 1`] = `[MissingPointerError: Token "Petty" does not exist.]`;
+
+exports[`rdme openapi upload should bundle and upload the expected content 1`] = `
 Object {
   "components": Object {
     "securitySchemes": Object {
@@ -250,7 +252,7 @@ Object {
 }
 `;
 
-exports[`rdme openapi should use specified working directory and upload the expected content 1`] = `
+exports[`rdme openapi upload should use specified working directory and upload the expected content 1`] = `
 Object {
   "components": Object {
     "securitySchemes": Object {

__tests__/cmds/__snapshots__/validate.test.js.snap

@@ -1,19 +1,5 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`rdme validate error handling should throw an error if an in valid Swagger definition is supplied 1`] = `
-[SyntaxError: Swagger schema validation failed.
-
-ADDITIONAL PROPERTY must NOT have additional properties
-
-  23 |         "description": "Find out more",
-  24 |         "url": "http://swagger.io",
-> 25 |         "this-shouldnt-be-here": true
-     |         ^^^^^^^^^^^^^^^^^^^^^^^ 😲  this-shouldnt-be-here is not expected to be here!
-  26 |       }
-  27 |     }
-  28 |   ],]
-`;
-
 exports[`rdme validate error handling should throw an error if an invalid OpenAPI 3.1 definition is supplied 1`] = `
 [SyntaxError: OpenAPI schema validation failed.
 
@@ -27,3 +13,17 @@ REQUIRED must have required property 'name'
   28 |       }
   29 |     }]
 `;
+
+exports[`rdme validate error handling should throw an error if an invalid Swagger definition is supplied 1`] = `
+[SyntaxError: Swagger schema validation failed.
+
+ADDITIONAL PROPERTY must NOT have additional properties
+
+  23 |         "description": "Find out more",
+  24 |         "url": "http://swagger.io",
+> 25 |         "this-shouldnt-be-here": true
+     |         ^^^^^^^^^^^^^^^^^^^^^^^ 😲  this-shouldnt-be-here is not expected to be here!
+  26 |       }
+  27 |     }
+  28 |   ],]
+`;