OpenApi 3.1.0 updates for Licence (#1038)

Also fixes a couple spectral validation issues

Examples/processors/schema-query-parameter/app/ProductController.php

@@ -12,6 +12,10 @@ class ProductController
      * @OA\Get(
      *   tags={"Products"},
      *   path="/products/{id}",
+     *   @OA\PathParameter(
+     *     name="id",
+     *     required=true
+     *   ),
      *   @OA\Response(
      *     response=200,
      *     description="A single product",

Examples/processors/schema-query-parameter/schema-query-parameter.yaml

@@ -8,6 +8,11 @@ paths:
       tags:
         - Products
       operationId: 399b71a7672f0a46be1b5f4c120c355d
+      parameters:
+        -
+          name: id
+          in: path
+          required: true
       responses:
         '200':
           description: 'A single product'

Examples/swagger-spec/petstore-simple/api.php

@@ -14,7 +14,7 @@
  *         description="A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification",
  *         termsOfService="http://swagger.io/terms/",
  *         @OA\Contact(name="Swagger API Team"),
- *         @OA\License(name="MIT")
+ *         @OA\License(name="MIT", identifier="MIT")
  *     ),
  * )
  */
@@ -39,4 +39,4 @@ class OpenApiSpec
  */
 class ErrorModel
 {
-}
+}

Examples/swagger-spec/petstore-simple/petstore-simple.yaml

@@ -7,6 +7,7 @@ info:
     name: 'Swagger API Team'
   license:
     name: MIT
+    identifier: MIT
   version: 1.0.0
 servers:
   -

Examples/swagger-spec/petstore/api.php

@@ -7,7 +7,7 @@
  *     @OA\Info(
  *         version="1.0.0",
  *         title="Swagger Petstore",
- *         @OA\License(name="MIT")
+ *         @OA\License(name="MIT", identifier="MIT")
  *     ),
  *     @OA\Server(
  *         description="Api server",

Examples/swagger-spec/petstore/petstore.yaml

@@ -3,6 +3,7 @@ info:
   title: 'Swagger Petstore'
   license:
     name: MIT
+    identifier: MIT
   version: 1.0.0
 servers:
   -

src/Annotations/License.php

@@ -25,7 +25,16 @@ class License extends AbstractAnnotation
     public $name = Generator::UNDEFINED;
 
     /**
-     * A URL to the license used for the API.
+     * An SPDX license expression for the API. The `identifier` field is mutually exclusive of the `url` field.
+     *
+     * @var string
+     */
+    public $identifier = Generator::UNDEFINED;
+
+    /**
+     * A URL to the license used for the API. This MUST be in the form of a URL.
+     *
+     * The `url` field is mutually exclusive of the `identifier` field.
      *
      * @var string
      */
@@ -36,6 +45,7 @@ class License extends AbstractAnnotation
      */
     public static $_types = [
         'name' => 'string',
+        'identifier' => 'string',
         'url' => 'string',
     ];
 
@@ -57,4 +67,19 @@ class License extends AbstractAnnotation
     public static $_nested = [
         Attachable::class => ['attachables'],
     ];
+
+    /**
+     * @inheritdoc
+     */
+    public function validate(array $parents = [], array $skip = [], string $ref = ''): bool
+    {
+        $valid = parent::validate($parents, $skip);
+
+        if ($this->url !== Generator::UNDEFINED && $this->identifier !== Generator::UNDEFINED) {
+            $this->_context->logger->warning('@OA\\License() url and identifier are mutually exclusive');
+            $valid = false;
+        }
+
+        return $valid;
+    }
 }

src/Attributes/License.php

@@ -13,15 +13,17 @@ class License extends \OpenApi\Annotations\License
 {
     public function __construct(
         string $name = Generator::UNDEFINED,
+        string $identifier = Generator::UNDEFINED,
         string $url = Generator::UNDEFINED,
         ?array $x = null,
         ?array $attachables = null
     ) {
         parent::__construct([
-                'name' => $name,
-                'url' => $url,
-                'x' => $x ?? Generator::UNDEFINED,
-                'value' => $this->combine($attachables),
-            ]);
+            'name' => $name,
+            'identifier' => $identifier,
+            'url' => $url,
+            'x' => $x ?? Generator::UNDEFINED,
+            'value' => $this->combine($attachables),
+        ]);
     }
 }

tests/Annotations/LicenseTest.php

@@ -0,0 +1,19 @@
+<?php declare(strict_types=1);
+
+/**
+ * @license Apache 2.0
+ */
+
+namespace OpenApi\Tests\Annotations;
+
+use OpenApi\Tests\OpenApiTestCase;
+
+class LicenseTest extends OpenApiTestCase
+{
+    public function testValidation()
+    {
+        $annotations = $this->annotationsFromDocBlockParser('@OA\License(name="MIT", identifier="MIT", url="http://localhost")');
+        $this->assertOpenApiLogEntryContains('@OA\License() url and identifier are mutually exclusive');
+        $annotations[0]->validate();
+    }
+}