forked from cnizzardini/cakephp-swagger-bake
-
Notifications
You must be signed in to change notification settings - Fork 0
/
SwagQuery.php
35 lines (32 loc) · 1.06 KB
/
SwagQuery.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
<?php
namespace SwaggerBake\Lib\Annotation;
/**
* Annotation for describing Query Parameter Objects.
*
* Read OpenAPI specification for exact usage of the attributes:
* @see https://swagger.io/specification/ search for "Parameter Object"
*
* For `format` read OpenAPI specification on data formats:
* @see https://swagger.io/docs/specification/data-models/data-types/?sbsearch=Data%20Format
*
* @Annotation
* @Target({"METHOD"})
* @Attributes({
* @Attribute("name", type = "string"),
* @Attribute("type", type = "string"),
* @Attribute("description", type = "string"),
* @Attribute("required", type = "bool"),
* @Attribute("enum", type = "array"),
* @Attribute("deprecated", type = "bool"),
* @Attribute("allowReserved", type = "bool"),
* @Attribute("allowEmptyValue", type = "bool"),
* @Attribute("explode", type = "bool"),
* @Attribute("style", type = "string"),
* @Attribute("format", type = "string"),
* @Attribute("example", type = "mixed"),
* })
* @see AbstractParameter
*/
class SwagQuery extends AbstractParameter
{
}