add maxDepth on subresources doc #351
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
sroze
reviewed
Nov 24, 2017
core/operations.md
Outdated
| @@ -344,6 +344,49 @@ Note that the operation name, here `api_questions_answer_get_subresource`, is th | |||
| It'll be automatically set to `$resources_$subresource(s)_get_subresource`. To find the correct operation name you | |||
| may use `bin/console debug:router`. | |||
|
|
|||
| Add to that, you can control depth of subresources with the parameter `maxDepth`. For example, if `Answer` entity also have subresource such as `comments`, you would like to not generate the route `api/questions/{id}/answers/{id}/comments`. You can do this by adding the parameter maxDepth in ApiSubresource annotation or yml/xml file configuration. | |||
There was a problem hiding this comment.
I'd add a new title:
### Control the depth of subresources
A bit of language change proposal:
- Add to that,- you would like to not generate the route `...`
+ and you don't want the route `...` to be generated
sroze
approved these changes
Nov 24, 2017
|
Feature PR is merged ✅ |
|
Thanks @Nightbr ! |
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.
Related to this PR api-platform/core#1520
Add maxDepth parameter on ApiSubresource in order to control the depth of subresources.