Extends filter interface description with swagger options #819
Conversation
This file contains 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
It took me some time to figure out how to provide a description for a parameter, so I thought it might be useful to add this to the comment.
dunglas
approved these changes
Nov 1, 2016
|
I thought about that too, but the docs about custom filters only reference |
|
Thanks @maechler. I would add a "Swagger" section with an example in this file: https://github.com/api-platform/docs/blob/master/core/filters.md |
teohhanhui
reviewed
Nov 3, 2016
| @@ -26,6 +26,7 @@ | |||
| * - type: the type of the filter | |||
| * - required: if this filter is required | |||
| * - strategy: the used strategy | |||
| * - swagger (optional): additional parameters for the path operation, e.g. 'swagger' => ['description' => 'My Description'] | |||
There was a problem hiding this comment.
Not sure this belongs in the interface...
magarzon
pushed a commit
to magarzon/core
that referenced
this pull request
Feb 12, 2017
…cription Extends filter interface description with swagger options
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.
It took me some time to figure out how to provide a description for a parameter, so I thought it might be useful to add this to the comment.