Skip to content

fix(openapi): output partial query parameter to OpenAPI when pagination_client_enabled is true#7295

Merged
soyuka merged 2 commits into
api-platform:4.1from
ttskch:fix/openapi-factory
Jul 16, 2025
Merged

fix(openapi): output partial query parameter to OpenAPI when pagination_client_enabled is true#7295
soyuka merged 2 commits into
api-platform:4.1from
ttskch:fix/openapi-factory

Conversation

@ttskch

@ttskch ttskch commented Jul 15, 2025

Copy link
Copy Markdown
Contributor
Q A
Branch? 4.1
Tickets N/A
License MIT
Doc PR N/A

Currently, even if we set pagination_client_enabled to true, the partial query parameter is not automatically output to the OpenAPI document.

This PR makes it so that it is automatically output.

e.g.

  # config/packages/api_platform.yaml
  api_platform:
      title: Hello API Platform
      version: 1.0.0
      defaults:
          stateless: true
          cache_headers:
              vary: ['Content-Type', 'Authorization', 'Origin']
+         pagination_client_enabled: true
+         pagination_client_items_per_page: true
+         pagination_client_partial: true
Before After

Related PRs

@ttskch ttskch force-pushed the fix/openapi-factory branch from ec5a756 to c489cb2 Compare July 15, 2025 14:57
@ttskch ttskch force-pushed the fix/openapi-factory branch from c489cb2 to d8221f6 Compare July 15, 2025 15:07
@soyuka soyuka merged commit 2cde062 into api-platform:4.1 Jul 16, 2025
111 checks passed
@soyuka

soyuka commented Jul 16, 2025

Copy link
Copy Markdown
Member

Thanks @ttskch !

@ttskch ttskch deleted the fix/openapi-factory branch July 16, 2025 16:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants