Debian Codegraph @

vendor/zircote/swagger-php/src/Attributes/Schema.php

raw
1 <?php declare(strict_types=1);
2
3 /**
4 * @license Apache 2.0
5 */
6
7 namespace OpenApi\Attributes;
8
9 use OpenApi\Annotations as OA;
10 use OpenApi\Generator;
11
12 #[\Attribute(\Attribute::TARGET_CLASS | \Attribute::TARGET_METHOD | \Attribute::TARGET_PROPERTY | \Attribute::IS_REPEATABLE)]
13 class Schema extends OA\Schema
14 {
15 /**
16 * @param string|class-string|object|null $ref
17 * @param list<string> $required
18 * @param list<Property> $properties
19 * @param string|non-empty-array<string>|null $type
20 * @param array<Examples> $examples
21 * @param array<Schema|OA\Schema> $allOf
22 * @param array<Schema|OA\Schema> $anyOf
23 * @param array<Schema|OA\Schema> $oneOf
24 * @param list<string|int|float|bool|\UnitEnum|null>|class-string|null $enum
25 * @param array<string,mixed>|null $x
26 * @param list<Attachable>|null $attachables
27 */
28 public function __construct(
29 // Schema
30 string|object|null $ref = null,
31 ?string $schema = null,
32 ?string $title = null,
33 ?string $description = Generator::UNDEFINED,
34 ?int $maxProperties = null,
35 ?int $minProperties = null,
36 ?array $required = null,
37 ?array $properties = null,
38 string|array|null $type = null,
39 ?string $format = null,
40 ?Items $items = null,
41 ?string $collectionFormat = null,
42 ?string $pattern = null,
43 ?Discriminator $discriminator = null,
44 ?bool $readOnly = null,
45 ?bool $writeOnly = null,
46 ?Xml $xml = null,
47 ?ExternalDocumentation $externalDocs = null,
48 mixed $example = Generator::UNDEFINED,
49 ?array $examples = null,
50 ?bool $nullable = null,
51 ?bool $deprecated = null,
52 ?array $allOf = null,
53 ?array $anyOf = null,
54 ?array $oneOf = null,
55 ?string $contentEncoding = null,
56 ?string $contentMediaType = null,
57
58 // JSON Schema
59 mixed $default = Generator::UNDEFINED,
60 int|float|null $maximum = null,
61 bool|int|float|null $exclusiveMaximum = null,
62 int|float|null $minimum = null,
63 bool|int|float|null $exclusiveMinimum = null,
64 int|null $maxLength = null,
65 int|null $minLength = null,
66 int|null $maxItems = null,
67 int|null $minItems = null,
68 bool|null $uniqueItems = null,
69 array|string|null $enum = null,
70 mixed $not = Generator::UNDEFINED,
71 bool|AdditionalProperties|null $additionalProperties = null,
72 array|null $additionalItems = null,
73 array|null $contains = null,
74 array|null $patternProperties = null,
75 array|null $unevaluatedProperties = null,
76 mixed $dependencies = Generator::UNDEFINED,
77 mixed $propertyNames = Generator::UNDEFINED,
78 mixed $const = Generator::UNDEFINED,
79
80 // abstract annotation
81 ?array $x = null,
82 ?array $attachables = null
83 ) {
84 parent::__construct([
85 'ref' => $ref ?? Generator::UNDEFINED,
86 'schema' => $schema ?? Generator::UNDEFINED,
87 'title' => $title ?? Generator::UNDEFINED,
88 'description' => $description,
89 'maxProperties' => $maxProperties ?? Generator::UNDEFINED,
90 'minProperties' => $minProperties ?? Generator::UNDEFINED,
91 'required' => $required ?? Generator::UNDEFINED,
92 'properties' => $properties ?? Generator::UNDEFINED,
93 'type' => $type ?? Generator::UNDEFINED,
94 'format' => $format ?? Generator::UNDEFINED,
95 'collectionFormat' => $collectionFormat ?? Generator::UNDEFINED,
96 'pattern' => $pattern ?? Generator::UNDEFINED,
97 'readOnly' => $readOnly ?? Generator::UNDEFINED,
98 'writeOnly' => $writeOnly ?? Generator::UNDEFINED,
99 'xml' => $xml ?? Generator::UNDEFINED,
100 'example' => $example,
101 'nullable' => $nullable ?? Generator::UNDEFINED,
102 'deprecated' => $deprecated ?? Generator::UNDEFINED,
103 'allOf' => $allOf ?? Generator::UNDEFINED,
104 'anyOf' => $anyOf ?? Generator::UNDEFINED,
105 'oneOf' => $oneOf ?? Generator::UNDEFINED,
106 'contentEncoding' => $contentEncoding ?? Generator::UNDEFINED,
107 'contentMediaType' => $contentMediaType ?? Generator::UNDEFINED,
108
109 // JSON Schema
110 'default' => $default,
111 'maximum' => $maximum ?? Generator::UNDEFINED,
112 'exclusiveMaximum' => $exclusiveMaximum ?? Generator::UNDEFINED,
113 'minimum' => $minimum ?? Generator::UNDEFINED,
114 'exclusiveMinimum' => $exclusiveMinimum ?? Generator::UNDEFINED,
115 'maxLength' => $maxLength ?? Generator::UNDEFINED,
116 'minLength' => $minLength ?? Generator::UNDEFINED,
117 'maxItems' => $maxItems ?? Generator::UNDEFINED,
118 'minItems' => $minItems ?? Generator::UNDEFINED,
119 'uniqueItems' => $uniqueItems ?? Generator::UNDEFINED,
120 'enum' => $enum ?? Generator::UNDEFINED,
121 'not' => $not,
122 'additionalProperties' => $additionalProperties ?? Generator::UNDEFINED,
123 'additionalItems' => $additionalItems ?? Generator::UNDEFINED,
124 'contains' => $contains ?? Generator::UNDEFINED,
125 'patternProperties' => $patternProperties ?? Generator::UNDEFINED,
126 'unevaluatedProperties' => $unevaluatedProperties ?? Generator::UNDEFINED,
127 'dependencies' => $dependencies,
128 'propertyNames' => $propertyNames,
129 'const' => $const,
130
131 // abstract annotation
132 'x' => $x ?? Generator::UNDEFINED,
133 'attachables' => $attachables ?? Generator::UNDEFINED,
134 'value' => $this->combine($items, $discriminator, $externalDocs, $examples),
135 ]);
136 }
137 }