PHP 8.1 attributes (#982)

* PHP 8.1 support * Annotations can be used as PHP attributes * New annotation `PathParameter` added * Removal of deprecated static properties used to configure the underlying Doctrine annotations parser * New annotation `Attachable` to allow to attach any data to annotations/attributes without affecting the generated spec
zircote · Nov 28, 2021 · dd5f1b7 · dd5f1b7
1 parent 68c76ce
commit dd5f1b7
Show file tree

Hide file tree

Showing 243 changed files with 5,169 additions and 1,723 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -2,7 +2,11 @@ name: build
 
 on:
   push:
+    branches:
+      - master
   pull_request:
+    branches:
+      - master
 
 jobs:
   test:
@@ -11,8 +15,11 @@ jobs:
       fail-fast: true
       matrix:
         operating-system: [ ubuntu-latest ]
-        php: [ '7.2', '7.3', '7.4', '8.0' ]
+        php: [ '7.2', '7.3', '7.4', '8.0', '8.1' ]
         dependencies: [ 'lowest', 'highest' ]
+        exclude:
+          - php: '8.1'
+            dependencies: 'lowest'
 
     name: PHP ${{ matrix.php }} on ${{ matrix.operating-system }} with ${{ matrix.dependencies }} dependencies
 
@@ -33,3 +40,8 @@ jobs:
 
       - name: PHPUnit Tests
         run: bin/phpunit --configuration phpunit.xml.dist --coverage-text
+
+      - name: PHPUnit Legacy Tests
+        run: bin/phpunit --configuration phpunit.xml.dist --coverage-text
+        env:
+          PHPUNIT_ANALYSER: 'legacy'
diff --git a/.github/workflows/code-style.yml b/.github/workflows/code-style.yml
@@ -2,7 +2,11 @@ name: code-style
 
 on:
   push:
+    branches:
+      - master
   pull_request:
+    branches:
+      - master
 
 jobs:
   php-cs:

diff --git a/.github/workflows/security-checks.yml b/.github/workflows/security-checks.yml
@@ -2,7 +2,11 @@ name: security-checks
 
 on:
   push:
+    branches:
+      - master
   pull_request:
+    branches:
+      - master
 
 jobs:
   security-checker:

diff --git a/Examples/Readme.md b/Examples/Readme.md
@@ -8,6 +8,7 @@ Collection of code/annotation examples and their corresponding OpenAPI specs gen
   using swagger-php annotations.
 
   * openapi-spec: [source](openapi-spec) / [spec](openapi-spec/openapi-spec.yaml)
+  * openapi-spec-attributes: [source](openapi-spec-attributes) / [spec](openapi-spec-attributes/openapi-spec-attributes.yaml) - **requires PHP 8.1**
   * petstore-3.0 (includes oauth2 auth flow): [source](petstore-3.0) / [spec](openapi-spec/petstore-3.0.yaml)
 
 * **petstore.swagger.io**

diff --git a/Examples/example-object/example-object.php b/Examples/example-object/example-object.php
@@ -1,5 +1,7 @@
 <?php
 
+namespace OpenApi\Examples\ExampleObject;
+
 use OpenApi\Annotations as OA;
 
 /**
@@ -8,6 +10,9 @@
  *     title="Example for response examples value"
  * )
  */
+class OpenApiSpec
+{
+}
 
 /**
  * @OA\Put(
@@ -28,6 +33,9 @@
  *     )
  * )
  */
+class UserUpdateEndpoint
+{
+}
 
 /**
  * @OA\Post(
@@ -70,18 +78,24 @@
  *     )
  * )
  */
+class UserAddEndpoint
+{
+}
 
 /**
  * @OA\Schema(
  *  schema="Result",
  *  title="Sample schema for using references",
  * 	@OA\Property(
- * 		property="status",
- * 		type="string"
- * 	),
+ *        property="status",
+ *        type="string"
+ *    ),
  * 	@OA\Property(
- * 		property="error",
- * 		type="string"
- * 	)
+ *        property="error",
+ *        type="string"
+ *    )
  * )
  */
+class ResultSchema
+{
+}
diff --git a/Examples/misc/misc-api.php b/Examples/misc/misc-api.php
@@ -1,7 +1,17 @@
 <?php
+
+namespace OpenApi\Examples\Misc;
+
 /**
  * @OA\OpenApi(
  *    security={{"bearerAuth": {}}}
+ * )
+ *
+ * @OA\Info(
+ *   title="Testing annotations from bugreports",
+ *   version="1.0.0",
+ *   description="NOTE:
+This sentence is on a new line"
  * )
  *
  * @OA\Components(
@@ -12,18 +22,7 @@
  *     ),
  *     @OA\Attachable()
  * )
- */
-
-/**
- * @OA\Info(
- *   title="Testing annotations from bugreports",
- *   version="1.0.0",
- *   description="NOTE:
-This sentence is on a new line"
- * )
- */
-
-/**
+ *
  * @OA\Server(
  *      url="{schema}://host.dev",
  *      description="OpenApi parameters",
@@ -34,6 +33,9 @@
  *      )
  * )
  */
+class OpenApiSpec
+{
+}
 
 /**
  * An API endpoint.
@@ -48,7 +50,10 @@
  *   @OA\Response(response=200, description="Success")
  * )
  */
-
+class Endpoint
+{
+}
+
 /**
  * @OA\Response(
  *     response=200,
@@ -64,4 +69,6 @@
  *     )
  *   )
  */
-
+class Response
+{
+}
diff --git a/Examples/nesting/ActualModel.php b/Examples/nesting/ActualModel.php
@@ -1,6 +1,6 @@
 <?php declare(strict_types=1);
 
-namespace OpenApi\Tests\Fixtures\Processors\Nesting;
+namespace OpenApi\Examples\Nesting;
 
 /**
  * @OA\Schema()

diff --git a/Examples/nesting/AlmostModel.php b/Examples/nesting/AlmostModel.php
@@ -1,6 +1,6 @@
 <?php declare(strict_types=1);
 
-namespace OpenApi\Tests\Fixtures\Processors\Nesting;
+namespace OpenApi\Examples\Nesting;
 
 /**
  * @OA\Schema()

diff --git a/Examples/nesting/ApiController.php b/Examples/nesting/ApiController.php
@@ -1,6 +1,6 @@
 <?php declare(strict_types=1);
 
-namespace OpenApi\Tests\Fixtures\Processors\Nesting;
+namespace OpenApi\Examples\Nesting;
 
 /**
  * An entity controller class.

diff --git a/Examples/nesting/BaseModel.php b/Examples/nesting/BaseModel.php
@@ -1,6 +1,6 @@
 <?php declare(strict_types=1);
 
-namespace OpenApi\Tests\Fixtures\Processors\Nesting;
+namespace OpenApi\Examples\Nesting;
 
 /**
  * @OA\Schema()

diff --git a/Examples/nesting/IntermediateModel.php b/Examples/nesting/IntermediateModel.php
@@ -1,6 +1,6 @@
 <?php declare(strict_types=1);
 
-namespace OpenApi\Tests\Fixtures\Processors\Nesting;
+namespace OpenApi\Examples\Nesting;
 
 /**
  * No schema!

diff --git a/Examples/nesting/SoCloseModel.php b/Examples/nesting/SoCloseModel.php
@@ -1,6 +1,6 @@
 <?php declare(strict_types=1);
 
-namespace OpenApi\Tests\Fixtures\Processors\Nesting;
+namespace OpenApi\Examples\Nesting;
 
 /**
  * No schema!

diff --git a/Examples/nesting/nesting.yaml b/Examples/nesting/nesting.yaml
@@ -8,7 +8,7 @@ paths:
     get:
       tags:
         - api
-      operationId: 4db0bcd1e9358f78c662034e39c702b6
+      operationId: dd148eadcee53770e24b2350f932e3bd
       parameters:
         -
           name: id

diff --git a/Examples/openapi-spec-attributes/PullRequest.php b/Examples/openapi-spec-attributes/PullRequest.php
@@ -0,0 +1,41 @@
+<?php
+
+namespace OpenApi\Examples\OpenapiSpecAttributes;
+
+use OpenApi\Annotations as OA;
+
+/**
+ * @OA\Schema(schema="pullrequest")
+ */
+#[OA\Schema(schema: 'pullrequest')]
+class PullRequest
+{
+
+    /**
+     * @OA\Property()
+     * @var integer
+     */
+    #[OA\Property(type: 'integer')]
+    public $id;
+
+    /**
+     * @OA\Property()
+     * @var string
+     */
+    #[OA\Property(type: 'string')]
+    public $title;
+
+    /**
+     * @OA\Property()
+     * @var Repository
+     */
+    #[OA\Property(ref: '#/components/schemas/repository')]
+    public $repository;
+
+    /**
+     * @OA\Property()
+     * @var User
+     */
+    #[OA\Property(ref: '#/components/schemas/user')]
+    public $author;
+}
-Original file line number
+Diff line change
@@ Expand Up / @@ -2,7 +2,11 @@ name: code-style @@
     on:
       push:
+        branches:
+          - master
       pull_request:
+        branches:
+          - master
     jobs:
       php-cs:
@@ Expand Down @@