OpenAPI v3.1: Add schema and validation to CLI

Co-authored-by: Cees-Jan Kiewiet <[email protected]>
cebe · Oct 18, 2021 · 82b0db7 · 82b0db7
1 parent 69c07ef
commit 82b0db7
Show file tree

Hide file tree

Showing 7 changed files with 2,288 additions and 14 deletions.
diff --git a/Makefile b/Makefile
@@ -36,10 +36,13 @@ stan:
 	php $(PHPARGS) vendor/bin/phpstan analyse -l 5 src
 
 # copy openapi3 json schema
-schemas/openapi-v3.0.json: vendor/oai/openapi-specification/schemas/v3.0/schema.json
+schemas/openapi-v3.0.json: vendor/oai/openapi-specification-3.0/schemas/v3.0/schema.json
 	cp $< $@
-
-schemas/openapi-v3.0.yaml: vendor/oai/openapi-specification/schemas/v3.0/schema.yaml
+schemas/openapi-v3.0.yaml: vendor/oai/openapi-specification-3.0/schemas/v3.0/schema.yaml
+	cp $< $@
+schemas/openapi-v3.1.json: vendor/oai/openapi-specification-3.1/schemas/v3.1/schema.json
+	cp $< $@
+schemas/openapi-v3.1.yaml: vendor/oai/openapi-specification-3.1/schemas/v3.1/schema.yaml
 	cp $< $@
 
 php-cs-fixer.phar:

diff --git a/bin/php-openapi b/bin/php-openapi
@@ -131,16 +131,22 @@ switch ($command) {
 
         // Validate
 
+        // OpenAPI version check
+        $openApiVersion = $openApi->getMajorVersion();
+        if ($openApiVersion === \cebe\openapi\spec\OpenApi::VERSION_UNSUPPORTED) {
+            error("Unsupported OpenAPI version: " . $openApi->openapi);
+        }
+
         $openApi->validate();
         $errors = array_merge($errors, $openApi->getErrors());
 
         $validator = new JsonSchema\Validator;
         $openApiData = $openApi->getSerializableData();
-        $validator->validate($openApiData, (object)['$ref' => 'file://' . dirname(__DIR__) . '/schemas/openapi-v3.0.json']);
+        $validator->validate($openApiData, (object)['$ref' => 'file://' . dirname(__DIR__) . "/schemas/openapi-v{$openApiVersion}.json"]);
 
         if ($validator->isValid() && empty($errors)) {
             if(!$silentMode) {
-                print_formatted("The supplied API Description \B\Gvalidates\C against the OpenAPI v3.0 schema.\n", STDERR);
+                print_formatted("The supplied API Description \B\Gvalidates\C against the OpenAPI v{$openApiVersion} schema.\n", STDERR);
             }
             exit(0);
         }
@@ -163,7 +169,7 @@ switch ($command) {
             }
         }
         if (!$validator->isValid()) {
-            print_formatted("\BOpenAPI v3.0 schema violations:\C\n", STDERR);
+            print_formatted("\BOpenAPI v{$openApiVersion} schema violations:\C\n", STDERR);
             $errors = $validator->getErrors();
             foreach ($errors as $error) {
                 // hide some errors triggered by other errors further down the path

diff --git a/composer.json b/composer.json
@@ -27,7 +27,9 @@
 		"cebe/indent": "*",
 		"phpunit/phpunit": "^6.5 || ^7.5 || ^8.5 || ^9.4",
 
-		"oai/openapi-specification": "3.0.3",
+		"oai/openapi-specification-3.0": "3.0.3",
+		"oai/openapi-specification-3.1": "3.1.0",
+
 		"mermade/openapi3-examples": "1.0.0",
 		"apis-guru/openapi-directory": "1.0.0",
 		"nexmo/api-specification": "1.0.0",
@@ -50,7 +52,7 @@
 		{
 			"type": "package",
 			"package": {
-				"name": "oai/openapi-specification",
+				"name": "oai/openapi-specification-3.0",
 				"version": "3.0.3",
 				"source": {
 					"url": "https://github.com/OAI/OpenAPI-Specification",
@@ -59,6 +61,18 @@
 				}
 			}
 		},
+		{
+			"type": "package",
+			"package": {
+				"name": "oai/openapi-specification-3.1",
+				"version": "3.1.0",
+				"source": {
+					"url": "https://github.com/OAI/OpenAPI-Specification",
+					"type": "git",
+					"reference": "v3.1.1-dev"
+				}
+			}
+		},
 		{
 			"type": "package",
 			"package": {