cakephp-swagger-bake/src/Lib/Annotation/SwagEntityAttribute.php at master · bmudda/cakephp-swagger-bake · GitHub

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
36
37
38
39
40
41
42
43
44
45
46
<?php

namespace SwaggerBake\Lib\Annotation;

use InvalidArgumentException;

/**
 * Annotation for describing Entity properties.
 *
 * Read OpenAPI specification for exact usage of the attributes:
 * @see https://swagger.io/specification/ search for "Schema Object"
 *
 * For `format` read OpenAPI specification on data formats:
 * @see https://swagger.io/docs/specification/data-models/data-types
 *
 * @Annotation
 * @Target({"CLASS"})
 * @Attributes({
 *   @Attribute("name", type = "string"),
 *   @Attribute("type",  type = "string"),
 *   @Attribute("format",  type = "string"),
 *   @Attribute("description",  type = "string"),
 *   @Attribute("readOnly",  type = "bool"),
 *   @Attribute("writeOnly",  type = "bool"),
 *   @Attribute("required",  type = "bool"),
 *   @Attribute("multipleOf", type = "float"),
 *   @Attribute("maximum",  type = "float"),
 *   @Attribute("exclusiveMaximum",  type = "bool"),
 *   @Attribute("minimum",  type = "float"),
 *   @Attribute("exclusiveMinimum",  type = "bool"),
 *   @Attribute("maxLength",  type = "integer"),
 *   @Attribute("minLength", type = "integer"),
 *   @Attribute("pattern",  type = "string"),
 *   @Attribute("maxItems",  type = "integer"),
 *   @Attribute("minItems",  type = "integer"),
 *   @Attribute("uniqueItems",  type = "bool"),
 *   @Attribute("maxProperties",  type = "integer"),
 *   @Attribute("minProperties", type = "integer"),
 *   @Attribute("enum", type = "array"),
 * })
 * @see AbstractSchemaProperty
 */
class SwagEntityAttribute extends AbstractSchemaProperty
{

}