Finish re-introducing the optional validation test for paths count. U…

…pdate documentation around the changes.
mattpolzin · Sep 4, 2023 · f5879f0 · f5879f0
1 parent 942ea4a
commit f5879f0
Show file tree

Hide file tree

Showing 6 changed files with 35 additions and 46 deletions.
diff --git a/Sources/OpenAPIKit/Validator/Validation+Builtins.swift b/Sources/OpenAPIKit/Validator/Validation+Builtins.swift
@@ -15,8 +15,8 @@ extension Validation {
     ///
     /// The OpenAPI Specifcation does not require that the document
     /// contain any paths for [security reasons](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.0.md#security-filtering)
-    /// but documentation that is public in nature might only ever have
-    /// an empty `PathItem.Map` in error.
+    /// or even because it only contains webhooks, but authors may still
+    /// want to protect against an empty `PathItem.Map` in some cases.
     ///
     /// - Important: This is not an included validation by default.
     public static var documentContainsPaths: Validation<OpenAPI.Document> {

diff --git a/Sources/OpenAPIKit/Validator/Validator.swift b/Sources/OpenAPIKit/Validator/Validator.swift
@@ -100,6 +100,7 @@ extension OpenAPI.Document {
 ///
 ///     let document = OpenAPI.Document(...)
 ///     let validator = Validator()
+///         .validating(.documentContainsPaths)
 ///         .validating(.pathsContainOperations)
 ///     try document.validate(using: validator)
 ///

diff --git a/Tests/OpenAPIKitErrorReportingTests/PathsErrorTests.swift b/Tests/OpenAPIKitErrorReportingTests/PathsErrorTests.swift
@@ -11,18 +11,6 @@ import OpenAPIKit
 import Yams
 
 final class PathsErrorTests: XCTestCase {
-    func test_missingPaths() {
-        let documentYML =
-        """
-        openapi: "3.1.0"
-        info:
-            title: test
-            version: 1.0
-        """
-
-        XCTAssertNoThrow(try testDecoder.decode(OpenAPI.Document.self, from: documentYML))
-    }
-
     func test_badPathReference() {
         let documentYML =
         """

diff --git a/Tests/OpenAPIKitTests/Document/DocumentTests.swift b/Tests/OpenAPIKitTests/Document/DocumentTests.swift
@@ -1052,44 +1052,28 @@ extension DocumentTests {
           "webhooks" : {
             "webhook-test" : {
               "delete" : {
-                "responses" : {
 
-                }
               },
               "get" : {
-                "responses" : {
 
-                }
               },
               "head" : {
-                "responses" : {
 
-                }
               },
               "options" : {
-                "responses" : {
 
-                }
               },
               "patch" : {
-                "responses" : {
 
-                }
               },
               "post" : {
-                "responses" : {
 
-                }
               },
               "put" : {
-                "responses" : {
 
-                }
               },
               "trace" : {
-                "responses" : {
 
-                }
               }
             }
           }
@@ -1114,36 +1098,20 @@ extension DocumentTests {
         "webhooks": {
           "webhook-test": {
             "delete": {
-              "responses": {
-              }
             },
             "get": {
-              "responses": {
-              }
             },
             "head": {
-              "responses": {
-              }
             },
             "options": {
-              "responses": {
-              }
             },
             "patch": {
-              "responses": {
-              }
             },
             "post": {
-              "responses": {
-              }
             },
             "put": {
-              "responses": {
-              }
             },
             "trace": {
-              "responses": {
-              }
             }
           }
         }

diff --git a/Tests/OpenAPIKitTests/Validator/BuiltinValidationTests.swift b/Tests/OpenAPIKitTests/Validator/BuiltinValidationTests.swift
@@ -11,6 +11,37 @@ import OpenAPIKit
 
 final class BuiltinValidationTests: XCTestCase {
 
+    func test_noPathsOnDocumentFails() {
+        let document = OpenAPI.Document(
+            info: .init(title: "test", version: "1.0"),
+            servers: [],
+            paths: [:],
+            components: .noComponents
+        )
+
+        let validator = Validator.blank.validating(.documentContainsPaths)
+
+        XCTAssertThrowsError(try document.validate(using: validator)) { error in
+            let error = error as? ValidationErrorCollection
+            XCTAssertEqual(error?.values.first?.reason, "Failed to satisfy: Document contains at least one path")
+            XCTAssertEqual(error?.values.first?.codingPath.map { $0.stringValue }, [])
+        }
+    }
+
+    func test_onePathOnDocumentSucceeds() throws {
+        let document = OpenAPI.Document(
+            info: .init(title: "test", version: "1.0"),
+            servers: [],
+            paths: [
+                "/hello/world": .init()
+            ],
+            components: .noComponents
+        )
+
+        let validator = Validator.blank.validating(.documentContainsPaths)
+        try document.validate(using: validator)
+    }
+
     func test_noOperationsOnPathItemFails() {
         let document = OpenAPI.Document(
             info: .init(title: "test", version: "1.0"),

diff --git a/documentation/validation.md b/documentation/validation.md
@@ -579,6 +579,7 @@ Here's a table of Array/Map types for which this quirk is relevant and which mod
   | `OpenAPI.Components.securitySchemes` | `ComponentDictionary`   | x            | x          |
   | `OpenAPI.Document.components`        | `Components`            | x            | x          |
   | `OpenAPI.Document.security`          | `[SecurityRequirement]` | x            | x          |
+  | `OpenAPI.Document.paths`             | `PathItem.Map`          |              | x          |
   | `OpenAPI.Document.servers`           | `[Server]`              | x            | x          |
   | `OpenAPI.Document.webhooks`          | `OrderedDictionary`     |              | x          |
   | `OpenAPI.Link.parameters`            | `OrderedDictionary`     | x            | x          |