Extends filter interface description with swagger options

maechler · web-flow · commit c93c35c0ec9b · 2016-11-01T10:31:34.000+01:00
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.
diff --git a/src/Api/FilterInterface.php b/src/Api/FilterInterface.php
@@ -26,6 +26,7 @@ interface FilterInterface
      *   - 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']
      * The description can contain additional data specific to a filter.
      *
      * @param string $resourceClass

Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,7 @@ interface FilterInterface`
`26`	`26`	`* - type: the type of the filter`
`27`	`27`	`* - required: if this filter is required`
`28`	`28`	`* - strategy: the used strategy`
	`29`	`+ * - swagger (optional): additional parameters for the path operation, e.g. 'swagger' => ['description' => 'My Description']`
`29`	`30`	`* The description can contain additional data specific to a filter.`
`30`	`31`	`*`
`31`	`32`	`* @param string $resourceClass`