-
-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Issues with the api documentation override #14553
Copy link
Copy link
Open
Labels
EnhancementMinor issues and PRs improving the current solutions (optimizations, typo fixes, etc.).Minor issues and PRs improving the current solutions (optimizations, typo fixes, etc.).MaintenanceCI configurations, READMEs, releases, etc.CI configurations, READMEs, releases, etc.
Metadata
Metadata
Assignees
Labels
EnhancementMinor issues and PRs improving the current solutions (optimizations, typo fixes, etc.).Minor issues and PRs improving the current solutions (optimizations, typo fixes, etc.).MaintenanceCI configurations, READMEs, releases, etc.CI configurations, READMEs, releases, etc.
Type
Fields
Give feedbackNo fields configured for issues without a type.
Problem
Because ApiPlatform uses final classes, you had to override entirely the documentation controller of the API. It's working. But last versions of ApiPlatform use a different way to get the documentation and they changed a lot their own controller.
Basically, their version conflicts with how you manage the documentation. It leads to issues in OpenApi output.
Solution
First, I think you can add your experimental flag to the documentation without overriding the whole controller since ApiPlatform team added a way to change the assets.
To support ApiPlatform 2.7 as well as keep compatibility with 2.5, it seems to be required to have DocumentationNormalizers as well as OpenApiFactory...
To make things better here, we need many changes in the code base, some code duplication and... work.
I wanted to know your feeling about all of this before working on some pull requests to fix this doc-related issue.