Added mention about OpenAPI #2836
Merged
Conversation
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
Preview of modified filesPreview of modified Markdown: |
Comment on lines
21
to
22
| php bin/console ibexa:openapi --output=spec.json # JSON output | ||
| php bin/console ibexa:openapi --yaml --output=spec.yaml # YAML output |
There was a problem hiding this comment.
Re-reading this, I would use the recommended name:
Suggested change
| php bin/console ibexa:openapi --output=spec.json # JSON output | |
| php bin/console ibexa:openapi --yaml --output=spec.yaml # YAML output | |
| php bin/console ibexa:openapi --output=openapi.json # JSON output | |
| php bin/console ibexa:openapi --yaml --output=openapi.yaml # YAML output |
Side note, I have always redirect the output to a file instead of using the --output option or its -o shortcut. The option probably ease command embedding/wrapping (like when you need to pass it to a container).
adriendupuis
approved these changes
Jul 21, 2025
|
|
||
| !!! info | ||
|
|
||
| In [Symfony's `dev` environment](environments.md), you can access a REST API reference generated for your project by visiting the `/api/ibexa/v2/doc` route in the browser. |
There was a problem hiding this comment.
This is when debug is turned on, which is what dev env does. I'm not sure we need to enter into this detail. For me it's OK written like that.
https://github.com/ibexa/rest/blob/main/src/bundle/Resources/config/routing.yml#L16
There was a problem hiding this comment.
I'd leave it as is as well 👍
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.