ci(openapi): vacuum instead of swagger-cli

Author: soyuka

.github/workflows/ci.yml

@@ -470,26 +470,6 @@ jobs:
           export PATH="$PATH:$HOME/.composer/vendor/bin"
           php-coveralls --coverage_clover=build/logs/behat/clover.xml
         continue-on-error: true
-      - 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'
-      - 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
 
   postgresql:
     name: Behat (PHP ${{ matrix.php }}) (PostgreSQL)
@@ -1272,26 +1252,53 @@ jobs:
           name: behat-logs-php${{ matrix.php }}
           path: build/logs/behat
         continue-on-error: true
+
+  openapi:
+    name: OpenAPI
+    runs-on: ubuntu-latest
+    timeout-minutes: 20
+    strategy:
+      matrix:
+        php:
+          - '8.4'
+      fail-fast: false
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          tools: pecl, composer
+          extensions: intl, bcmath, curl, openssl, mbstring, pdo_sqlite, mongodb
+          ini-values: memory_limit=-1
+      - name: Setup node
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22'
+      - name: Get composer cache directory
+        id: composercache
+        run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
+      - name: Cache dependencies
+        uses: actions/cache@v4
+        with:
+          path: ${{ steps.composercache.outputs.dir }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}
+          restore-keys: ${{ runner.os }}-composer-
+      - name: Update project dependencies
+        run: |
+          composer global require soyuka/pmu
+          composer global config allow-plugins.soyuka/pmu true --no-interaction
+          composer global link .
+      - name: Clear test app cache
+        run: tests/Fixtures/app/console cache:clear --ansi
       - 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'
       - 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 -r tests/Fixtures/app/ruleset.yaml build/out/openapi/openapi_v3.yaml -d
 
   laravel:
     name: Laravel (PHP ${{ matrix.php }})

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']])),

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)

tests/Fixtures/TestBundle/ApiResource/Headers.php

@@ -27,7 +27,7 @@
 )]
 class Headers
 {
-    public $id;
+    public int $id;
 
     public static function provide(): self
     {

tests/Fixtures/TestBundle/ApiResource/Issue6211/ArrayPropertyDtoOperation.php

@@ -16,7 +16,7 @@
 use ApiPlatform\Metadata\Get;
 use ApiPlatform\Tests\Fixtures\TestBundle\Dto\ArrayPropertyDto;
 
-#[Get(provider: [ArrayPropertyDtoOperation::class, 'provide'], output: ArrayPropertyDto::class)]
+#[Get(provider: [ArrayPropertyDtoOperation::class, 'provide'], output: ArrayPropertyDto::class, openapi: false)]
 class ArrayPropertyDtoOperation
 {
     public static function provide(): ArrayPropertyDto

tests/Fixtures/TestBundle/ApiResource/Issue6299/Issue6299.php

@@ -17,7 +17,7 @@
 use ApiPlatform\Metadata\Get;
 
 #[ApiResource]
-#[Get(output: Issue6299OutputDto::class)]
+#[Get(output: Issue6299OutputDto::class, openapi: false)]
 final class Issue6299
 {
 }

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'],

tests/Fixtures/TestBundle/ApiResource/Issue6810/JsonLdContextOutput.php

@@ -16,7 +16,7 @@
 use ApiPlatform\Metadata\Get;
 use ApiPlatform\Metadata\Operation;
 
-#[Get('/json_ld_context_output', provider: [self::class, 'getData'], output: Output::class, normalizationContext: ['hydra_prefix' => false])]
+#[Get('/json_ld_context_output', provider: [self::class, 'getData'], output: Output::class, normalizationContext: ['hydra_prefix' => false], openapi: false)]
 class JsonLdContextOutput
 {
     public function __construct(public string $id)

tests/Fixtures/TestBundle/Document/User.php

@@ -34,7 +34,7 @@
  * @author Théo FIDRY <[email protected]>
  * @author Kévin Dunglas <[email protected]>
  */
-#[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
 {

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
 {
 }