Fixed and enhanced OpenAPI#195
Draft
adriendupuis wants to merge 34 commits into
Draft
Conversation
|
adriendupuis
force-pushed
the
enh-openapi
branch
from
83dacb3 to
c23b5cf
Compare
adamwojs
approved these changes
Oct 5, 2025
|
adriendupuis
force-pushed
the
enh-openapi
branch
from
3783933 to
5ab7594
Compare
|
adriendupuis
force-pushed
the
enh-openapi
branch
from
d131ed2 to
22843ab
Compare
|
Probably there because modified in #199 for 4.6
```
[6] openapi.yaml:30509:15 at #/components/schemas/Limitation/properties/values/required/0
Required property '$ref' is not defined.
30507 | type: object
30508 | required:
30509 | - $ref
| ^^^^
30510 | properties:
30511 | ref:
```
|
This was referenced May 12, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Related PRs:
Description:
AcceptandContent-Typeheadershttps://spec.openapis.org/oas/v3.1.1.html#x4-8-12-2-1-common-fixed-fields
https://swagger.io/docs/specification/v3_0/describing-parameters/#header-parameters
When using "Try it out' on live doc (
/api/ibexa/v2/doc#/Objects/api_contentobjects_contentId_get), the previously displayed Accept header parameter form input was never taken into account. To choose an Accept header, one must be selected in the Responses panel.So, I removed the useless and ignored Accept header parameter definition, and moved it's description up into the ressource description.
Other changes
X-CSRF-Tokenheader on not safe methodsIf-None-Matchheader isn't required. TheResponse::HTTP_NOT_MODIFIED304 description was saying the opposite of its meaning.operationIdwith route ID as value (eventually append the method when several are supported by the same route, or a param name when an optional parameter force documenting two routes)Ibexa\Core\MVC\Symfony\Security\Authentication\AuthenticatorInterfaceusages to comply with Symfony-based authentication #101 removed XML support for JWT token so I removed it in JWT: The XML input and output aren't supported #217 and here.Copilot's help
See #218 and ibexa/segmentation#167 for how I used Copilot for repetitive tasks.
Between the two, I added, for example, the mime-type sorting, more example fixing instructions, the
operationId.Summary
#217fix-jwt-docBinaryContent,ContentTypeCopyController,…TemplateControllerAssetVariationController&AssetControllerCampaignListControllerProductTourControllerUsersWithPermissionInfoControllerShipmentCreateController, format the othersibexa/documentation-developer#3194 removes the script forcing JSON before XML as it won't be needed anymore.
For QA:
You can generate the specification and user other tools to check it.
php bin/console ibexa:openapi --yamlPasted in SwaggerEditor: only report warnings about
GETroutes with payloads:requestBody does not have well-defined semantics for GET, HEAD and DELETE operationsUsing Redocly CLI
lintcommand several errors are reported.You can compare with and without the fixes to see many errors disappearing. I ignore several rules for now. I use JSON output to not have line numbers and ease the comparison between the outputs without/with the fixes.
Documentation: