fix(openapi): vacuum instead of swagger-cli

soyuka · soyuka · commit faa147b5ecaa · 2025-05-07T14:56:23.000+02:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -473,23 +473,14 @@ jobs:
       - name: Export OpenAPI documents
         run: |
           mkdir -p build/out/openapi
-          tests/Fixtures/app/console api:openapi:export -o build/out/openapi/openapi_v3.json
           tests/Fixtures/app/console api:openapi:export --yaml -o build/out/openapi/openapi_v3.yaml
       - name: Setup node
         uses: actions/setup-node@v4
         with:
-          node-version: '14'
+          node-version: '22'
       - name: Validate OpenAPI documents
         run: |
-          npx swagger-cli validate build/out/openapi/openapi_v3.json
-          npx swagger-cli validate build/out/openapi/openapi_v3.yaml
-      - name: Upload OpenAPI artifacts
-        if: always()
-        uses: actions/upload-artifact@v4
-        with:
-          name: openapi-docs-php${{ matrix.php }}
-          path: build/out/openapi
-        continue-on-error: true
+          npx @quobix/vacuum lint build/out/openapi/openapi_v3.yaml
 
   postgresql:
     name: Behat (PHP ${{ matrix.php }}) (PostgreSQL)
@@ -1275,23 +1266,14 @@ jobs:
       - name: Export OpenAPI documents
         run: |
           mkdir -p build/out/openapi
-          tests/Fixtures/app/console api:openapi:export -o build/out/openapi/openapi_v3.json
           tests/Fixtures/app/console api:openapi:export --yaml -o build/out/openapi/openapi_v3.yaml
       - name: Setup node
         uses: actions/setup-node@v4
         with:
-          node-version: '14'
+          node-version: '22'
       - name: Validate OpenAPI documents
         run: |
-          npx swagger-cli validate build/out/openapi/openapi_v3.json
-          npx swagger-cli validate build/out/openapi/openapi_v3.yaml
-      - name: Upload OpenAPI artifacts
-        if: always()
-        uses: actions/upload-artifact@v4
-        with:
-          name: openapi-docs-php${{ matrix.php }}
-          path: build/out/openapi
-        continue-on-error: true
+          npx @quobix/vacuum lint build/out/openapi/openapi_v3.yaml
 
   laravel:
     name: Laravel (PHP ${{ matrix.php }})
diff --git a/tests/Fixtures/TestBundle/ApiResource/Crud.php b/tests/Fixtures/TestBundle/ApiResource/Crud.php
@@ -23,6 +23,7 @@
 use ApiPlatform\OpenApi\Model\Operation;
 
 #[ApiResource(
+    description: 'A resource used for OpenAPI tests.',
     operations: [
         new Get(),
         new GetCollection(openapi: new Operation(extensionProperties: [OpenApiFactory::API_PLATFORM_TAG => ['internal', 'anotherone']])),
diff --git a/tests/Fixtures/TestBundle/ApiResource/EntityClassWithDateTime.php b/tests/Fixtures/TestBundle/ApiResource/EntityClassWithDateTime.php
@@ -25,7 +25,6 @@
         ),
         new GetCollection(
             uriTemplate: '/EntityClassWithDateTime',
-            uriVariables: ['id']
         ),
     ],
     stateOptions: new Options(entityClass: \ApiPlatform\Tests\Fixtures\TestBundle\Entity\EntityClassWithDateTime::class)
diff --git a/tests/Fixtures/TestBundle/ApiResource/Headers.php b/tests/Fixtures/TestBundle/ApiResource/Headers.php
@@ -27,7 +27,7 @@
 )]
 class Headers
 {
-    public $id;
+    public int $id;
 
     public static function provide(): self
     {
diff --git a/tests/Fixtures/TestBundle/ApiResource/Issue6355/OrderProductCount.php b/tests/Fixtures/TestBundle/ApiResource/Issue6355/OrderProductCount.php
@@ -32,6 +32,7 @@ class: OrderDto::class,
             read: false,
             write: false,
             name: 'order_product_update_count',
+            uriVariables: ['id']
         ),
     ],
     order: ['position' => 'ASC'],
diff --git a/tests/Fixtures/TestBundle/Document/User.php b/tests/Fixtures/TestBundle/Document/User.php
@@ -34,7 +34,7 @@
  * @author Théo FIDRY <theo.fidry@gmail.com>
  * @author Kévin Dunglas <dunglas@gmail.com>
  */
-#[ApiResource(operations: [new Get(), new Put(), new Delete(), new Put(input: RecoverPasswordInput::class, output: RecoverPasswordOutput::class, uriTemplate: 'users/recover/{id}'), new Post(), new GetCollection(), new Post(uriTemplate: '/users/password_reset_request', messenger: 'input', input: PasswordResetRequest::class, output: PasswordResetRequestResult::class, normalizationContext: ['groups' => ['user_password_reset_request']], denormalizationContext: ['groups' => ['user_password_reset_request']])], normalizationContext: ['groups' => ['user', 'user-read']], denormalizationContext: ['groups' => ['user', 'user-write']])]
+#[ApiResource(openapi: false, operations: [new Get(), new Put(), new Delete(), new Put(input: RecoverPasswordInput::class, output: RecoverPasswordOutput::class, uriTemplate: 'users/recover/{id}'), new Post(), new GetCollection(), new Post(uriTemplate: '/users/password_reset_request', messenger: 'input', input: PasswordResetRequest::class, output: PasswordResetRequestResult::class, normalizationContext: ['groups' => ['user_password_reset_request']], denormalizationContext: ['groups' => ['user_password_reset_request']])], normalizationContext: ['groups' => ['user', 'user-read']], denormalizationContext: ['groups' => ['user', 'user-write']])]
 #[ODM\Document(collection: 'user_test')]
 class User implements UserInterface, PasswordAuthenticatedUserInterface
 {
diff --git a/tests/Fixtures/TestBundle/Entity/AttributeOnlyOperation.php b/tests/Fixtures/TestBundle/Entity/AttributeOnlyOperation.php
@@ -14,8 +14,9 @@
 namespace ApiPlatform\Tests\Fixtures\TestBundle\Entity;
 
 use ApiPlatform\Metadata\Get;
+use ApiPlatform\OpenApi\Model\Operation;
 
-#[Get(name: 'my own name')]
+#[Get(name: 'my own name', openapi: new Operation(operationId: 'my_own_name'))]
 final class AttributeOnlyOperation
 {
 }
diff --git a/tests/Fixtures/TestBundle/Entity/FilteredDateParameter.php b/tests/Fixtures/TestBundle/Entity/FilteredDateParameter.php
@@ -32,18 +32,18 @@
         'date' => new QueryParameter(
             filter: new DateFilter(),
             property: 'createdAt',
-            openApi: new Parameter('createdAt', 'query', allowEmptyValue: true)
+            openApi: new Parameter('date', 'query', allowEmptyValue: true)
         ),
         'date_include_null_always' => new QueryParameter(
             filter: new DateFilter(),
             property: 'createdAt',
             filterContext: DateFilterInterface::INCLUDE_NULL_BEFORE_AND_AFTER,
-            openApi: new Parameter('createdAt', 'query', allowEmptyValue: true)
+            openApi: new Parameter('date_include_null_always', 'query', allowEmptyValue: true)
         ),
         'date_old_way' => new QueryParameter(
             filter: new DateFilter(properties: ['createdAt' => DateFilterInterface::INCLUDE_NULL_BEFORE_AND_AFTER]),
             property: 'createdAt',
-            openApi: new Parameter('createdAt', 'query', allowEmptyValue: true)
+            openApi: new Parameter('date_old_way', 'query', allowEmptyValue: true)
         ),
     ],
 )]
diff --git a/tests/Fixtures/TestBundle/Entity/FilteredRangeParameter.php b/tests/Fixtures/TestBundle/Entity/FilteredRangeParameter.php
@@ -26,12 +26,12 @@
     parameters: [
         'quantity' => new QueryParameter(
             filter: new RangeFilter(),
-            openApi: new Parameter('createdAt', 'query', allowEmptyValue: true)
+            openApi: new Parameter('quantity', 'query', allowEmptyValue: true)
         ),
         'amount' => new QueryParameter(
             filter: new RangeFilter(),
             property: 'quantity',
-            openApi: new Parameter('createdAt', 'query', allowEmptyValue: true)
+            openApi: new Parameter('amount', 'query', allowEmptyValue: true)
         ),
     ],
 )]
diff --git a/tests/Fixtures/TestBundle/Entity/IdentifierShortcut.php b/tests/Fixtures/TestBundle/Entity/IdentifierShortcut.php
diff --git a/tests/Fixtures/TestBundle/Entity/Issue5625/Currency.php b/tests/Fixtures/TestBundle/Entity/Issue5625/Currency.php
@@ -21,7 +21,7 @@
  * Currency.
  */
 #[ApiResource(operations: [
-    new Get(uriTemplate: '/get_security_1', openapi: new Operation(security: [['JWT' => ['CURRENCY_READ']]])),
+    new Get(uriTemplate: '/get_security_1', openapi: new Operation(security: [['oauth' => ['CURRENCY_READ']]])),
 ])]
 class Currency
 {
diff --git a/tests/Fixtures/TestBundle/Entity/Issue5662/Book.php b/tests/Fixtures/TestBundle/Entity/Issue5662/Book.php
@@ -13,10 +13,12 @@
 
 namespace ApiPlatform\Tests\Fixtures\TestBundle\Entity\Issue5662;
 
+use ApiPlatform\Metadata\ApiResource;
 use ApiPlatform\Metadata\Get;
 use ApiPlatform\Metadata\GetCollection;
 use ApiPlatform\Metadata\Operation;
 
+#[ApiResource(openapi: false)]
 #[GetCollection(
     uriTemplate: '/issue5662/books{._format}',
     itemUriTemplate: '/issue5662/books/{id}{._format}',
diff --git a/tests/Fixtures/TestBundle/Entity/Issue5662/Review.php b/tests/Fixtures/TestBundle/Entity/Issue5662/Review.php
@@ -13,13 +13,15 @@
 
 namespace ApiPlatform\Tests\Fixtures\TestBundle\Entity\Issue5662;
 
+use ApiPlatform\Metadata\ApiResource;
 use ApiPlatform\Metadata\Get;
 use ApiPlatform\Metadata\GetCollection;
 use ApiPlatform\Metadata\Link;
 use ApiPlatform\Metadata\Operation;
 use ApiPlatform\Metadata\Post;
 use ApiPlatform\State\CreateProvider;
 
+#[ApiResource(openapi: false)]
 #[GetCollection(
     uriTemplate: '/issue5662/admin/reviews{._format}',
     itemUriTemplate: '/issue5662/reviews/{id}{._format}',
diff --git a/tests/Fixtures/TestBundle/Entity/JsonSchemaResource.php b/tests/Fixtures/TestBundle/Entity/JsonSchemaResource.php
@@ -22,7 +22,7 @@
 class JsonSchemaResource
 {
     #[ApiProperty(identifier: true)]
-    public $id;
+    public string $id;
 
     #[ApiProperty(writable: false, readableLink: true)]
     public ?JsonSchemaResourceRelated $resourceRelated = null;
diff --git a/tests/Fixtures/TestBundle/Entity/SearchFilterParameter.php b/tests/Fixtures/TestBundle/Entity/SearchFilterParameter.php
@@ -14,6 +14,7 @@
 namespace ApiPlatform\Tests\Fixtures\TestBundle\Entity;
 
 use ApiPlatform\Metadata\ApiFilter;
+use ApiPlatform\Metadata\ApiResource;
 use ApiPlatform\Metadata\GetCollection;
 use ApiPlatform\Metadata\GraphQl\QueryCollection;
 use ApiPlatform\Metadata\QueryParameter;
@@ -22,6 +23,7 @@
 use ApiPlatform\Tests\Fixtures\TestBundle\Filter\SearchTextAndDateFilter;
 use Doctrine\ORM\Mapping as ORM;
 
+#[ApiResource(openapi: false)]
 #[GetCollection(
     uriTemplate: 'search_filter_parameter{._format}',
     parameters: [
diff --git a/tests/Fixtures/TestBundle/Entity/User.php b/tests/Fixtures/TestBundle/Entity/User.php
@@ -36,12 +36,6 @@
  * @author Kévin Dunglas <dunglas@gmail.com>
  */
 #[ApiResource(operations: [
-    new Get(),
-    new Put(),
-    new Delete(),
-    new Put(input: RecoverPasswordInput::class, output: RecoverPasswordOutput::class, uriTemplate: 'users/recover/{id}', processor: RecoverPasswordProcessor::class),
-    new Post(),
-    new GetCollection(),
     new Post(
         uriTemplate: '/users/password_reset_request',
         messenger: 'input',
@@ -50,6 +44,12 @@
         normalizationContext: ['groups' => ['user_password_reset_request']],
         denormalizationContext: ['groups' => ['user_password_reset_request']]
     ),
+    new Put(input: RecoverPasswordInput::class, output: RecoverPasswordOutput::class, uriTemplate: 'users/recover/{id}', processor: RecoverPasswordProcessor::class),
+    new Get(),
+    new Put(),
+    new Delete(),
+    new Post(),
+    new GetCollection(),
     new Get('users-with-groups/{id}', normalizationContext: ['groups' => ['api-test-case-group']]),
     new GetCollection('users-with-groups', normalizationContext: ['groups' => ['api-test-case-group']]),
 ], normalizationContext: ['groups' => ['user', 'user-read']], denormalizationContext: ['groups' => ['user', 'user-write']])]
diff --git a/tests/Functional/OpenApiTest.php b/tests/Functional/OpenApiTest.php
@@ -82,7 +82,7 @@ public function testFilterExtensionTags(): void
         $this->assertArrayHasKey('/cruds', $res['paths']);
         $this->assertArrayHasKey('post', $res['paths']['/cruds']);
         $this->assertArrayHasKey('get', $res['paths']['/cruds']);
-        $this->assertEquals([['name' => 'Crud']], $res['tags']);
+        $this->assertEquals([['name' => 'Crud', 'description' => 'A resource used for OpenAPI tests.']], $res['tags']);
 
         $response = self::createClient()->request('GET', '/docs?filter_tags[]=anotherone', [
             'headers' => ['Accept' => 'application/vnd.openapi+json'],
@@ -96,6 +96,6 @@ public function testFilterExtensionTags(): void
         $this->assertArrayNotHasKey('post', $res['paths']['/cruds']);
         $this->assertArrayHasKey('get', $res['paths']['/cruds']);
         $this->assertArrayHasKey('/crud_open_api_api_platform_tags/{id}', $res['paths']);
-        $this->assertEquals([['name' => 'Crud'], ['name' => 'CrudOpenApiApiPlatformTag', 'description' => 'Something nice']], $res['tags']);
+        $this->assertEquals([['name' => 'Crud', 'description' => 'A resource used for OpenAPI tests.'], ['name' => 'CrudOpenApiApiPlatformTag', 'description' => 'Something nice']], $res['tags']);
     }
 }
diff --git a/tests/OpenApi/Command/OpenApiCommandTest.php b/tests/OpenApi/Command/OpenApiCommandTest.php
@@ -67,12 +67,12 @@ public function testExecute(): void
     #[\PHPUnit\Framework\Attributes\Group('orm')]
     public function testExecuteWithYaml(): void
     {
-        // $this->setMetadataClasses([DummyCar::class, Currency::class]);
         $this->tester->run(['command' => 'api:openapi:export', '--yaml' => true]);
 
         $result = $this->tester->getDisplay();
 
         $this->assertYaml($result);
+
         $operationId = 'api_dummy_cars_get_collection';
 
         $expected = <<<YAML
@@ -83,7 +83,7 @@ public function testExecuteWithYaml(): void
         - DummyCar
 YAML;
 
-        $this->assertStringContainsString(str_replace(\PHP_EOL, "\n", $expected), $result, 'nested object should be present.');
+        $this->assertStringContainsString($expected, $result, 'nested object should be present.');
 
         $operationId = 'api_dummy_cars_id_get';
         $expected = <<<YAML
@@ -93,35 +93,34 @@ public function testExecuteWithYaml(): void
       tags: []
 YAML;
 
-        $this->assertStringContainsString(str_replace(\PHP_EOL, "\n", $expected), $result, 'arrays should be correctly formatted.');
+        $this->assertStringContainsString($expected, $result, 'arrays should be correctly formatted.');
         $this->assertStringContainsString('openapi: '.OpenApi::VERSION, $result);
 
         $expected = <<<YAML
 info:
   title: 'My Dummy API'
 YAML;
-        $this->assertStringContainsString(str_replace(\PHP_EOL, "\n", $expected), $result, 'multiline formatting must be preserved (using literal style).');
+        $this->assertStringContainsString($expected, $result, 'multiline formatting must be preserved (using literal style).');
 
         $expected = <<<YAML
     This is a test API.
     Made with love
   version: 0.0.0
 YAML;
 
-        $this->assertStringContainsString(str_replace(\PHP_EOL, "\n", $expected), $result);
+        $this->assertStringContainsString($expected, $result);
 
         $expected = <<<YAML
       security:
         -
-          JWT:
+          oauth:
             - CURRENCY_READ
 YAML;
-        $this->assertStringContainsString(str_replace(\PHP_EOL, "\n", $expected), $result);
+        $this->assertStringContainsString($expected, $result);
     }
 
     public function testWriteToFile(): void
     {
-        // $this->setMetadataClasses([DummyCar::class]);
         /** @var string $tmpFile */
         $tmpFile = tempnam(sys_get_temp_dir(), 'test_write_to_file');
 
@@ -136,7 +135,6 @@ public function testWriteToFile(): void
      */
     public function testBackedEnumExamplesAreNotLost(): void
     {
-        // $this->setMetadataClasses([Issue6317::class]);
         $this->tester->run(['command' => 'api:openapi:export']);
         $result = $this->tester->getDisplay();
         $json = json_decode($result, true, 512, \JSON_THROW_ON_ERROR);
@@ -175,6 +173,6 @@ public function testFilterXApiPlatformTag(): void
         $this->assertArrayHasKey('/cruds', $res['paths']);
         $this->assertArrayNotHasKey('post', $res['paths']['/cruds']);
         $this->assertArrayHasKey('get', $res['paths']['/cruds']);
-        $this->assertEquals([['name' => 'Crud']], $res['tags']);
+        $this->assertEquals([['name' => 'Crud', 'description' => 'A resource used for OpenAPI tests.']], $res['tags']);
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@`
`27`	`27`	`)]`
`28`	`28`	`class Headers`
`29`	`29`	`{`
`30`		`- public $id;`
	`30`	`+ public int $id;`
`31`	`31`
`32`	`32`	`public static function provide(): self`
`33`	`33`	`{`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@`
`34`	`34`	`* @author Théo FIDRY <[email protected]>`
`35`	`35`	`* @author Kévin Dunglas <[email protected]>`
`36`	`36`	`*/`
`37`		-#[ApiResource(operations: [new Get(), new Put(), new Delete(), new Put(input: RecoverPasswordInput::class, output: RecoverPasswordOutput::class, uriTemplate: 'users/recover/{id}'), new Post(), new GetCollection(), new Post(uriTemplate: '/users/password_reset_request', messenger: 'input', input: PasswordResetRequest::class, output: PasswordResetRequestResult::class, normalizationContext: ['groups' => ['user_password_reset_request']], denormalizationContext: ['groups' => ['user_password_reset_request']])], normalizationContext: ['groups' => ['user', 'user-read']], denormalizationContext: ['groups' => ['user', 'user-write']])]
	`37`	+#[ApiResource(openapi: false, operations: [new Get(), new Put(), new Delete(), new Put(input: RecoverPasswordInput::class, output: RecoverPasswordOutput::class, uriTemplate: 'users/recover/{id}'), new Post(), new GetCollection(), new Post(uriTemplate: '/users/password_reset_request', messenger: 'input', input: PasswordResetRequest::class, output: PasswordResetRequestResult::class, normalizationContext: ['groups' => ['user_password_reset_request']], denormalizationContext: ['groups' => ['user_password_reset_request']])], normalizationContext: ['groups' => ['user', 'user-read']], denormalizationContext: ['groups' => ['user', 'user-write']])]
`38`	`38`	`#[ODM\Document(collection: 'user_test')]`
`39`	`39`	`class User implements UserInterface, PasswordAuthenticatedUserInterface`
`40`	`40`	`{`
Original file line number	Diff line number	Diff line change
`@@ -14,8 +14,9 @@`
`14`	`14`	`namespace ApiPlatform\Tests\Fixtures\TestBundle\Entity;`
`15`	`15`
`16`	`16`	`use ApiPlatform\Metadata\Get;`
	`17`	`+use ApiPlatform\OpenApi\Model\Operation;`
`17`	`18`
`18`		`-#[Get(name: 'my own name')]`
	`19`	`+#[Get(name: 'my own name', openapi: new Operation(operationId: 'my_own_name'))]`
`19`	`20`	`final class AttributeOnlyOperation`
`20`	`21`	`{`
`21`	`22`	`}`