Debian Codegraph @

vendor/zircote/swagger-php/src/Annotations/JsonContent.php

raw
1 <?php declare(strict_types=1);
2
3 /**
4 * @license Apache 2.0
5 */
6
7 namespace OpenApi\Annotations;
8
9 use OpenApi\Annotations as OA;
10 use OpenApi\Generator;
11
12 /**
13 * Shorthand for a json response.
14 *
15 * Example:
16 * ```php
17 * @OA\JsonContent(
18 * ref="#/components/schemas/user"
19 * )
20 * ```
21 * vs.
22 * ```php
23 * @OA\MediaType(
24 * mediaType="application/json",
25 * @OA\Schema(
26 * ref="#/components/schemas/user"
27 * )
28 * )
29 * ```
30 *
31 * @Annotation
32 */
33 class JsonContent extends Schema
34 {
35 /**
36 * A map between a property name and its encoding information.
37 *
38 * @var list<Encoding>
39 */
40 public $encoding = Generator::UNDEFINED;
41
42 /**
43 * @inheritdoc
44 */
45 public static $_parents = [];
46
47 /**
48 * @inheritdoc
49 */
50 public static $_nested = [
51 Discriminator::class => 'discriminator',
52 Items::class => 'items',
53 Property::class => ['properties', 'property'],
54 ExternalDocumentation::class => 'externalDocs',
55 AdditionalProperties::class => 'additionalProperties',
56 Encoding::class => ['encoding', 'property'],
57 Examples::class => ['examples', 'example'],
58 Attachable::class => ['attachables'],
59 ];
60 }