data-model-openapi30/src/Tag.php at main · zero-to-prod/data-model-openapi30 · 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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
<?php

namespace Zerotoprod\DataModelOpenapi30;

use Zerotoprod\DataModel\Describe;
use Zerotoprod\DataModelOpenapi30\Helpers\DataModel;

/**
 * Adds metadata to a single tag that is used by the Operation Object.
 * It is not mandatory to have a Tag Object per tag defined in the
 * Operation Object instances.
 *
 * @see  https://spec.openapis.org/oas/v3.0.4.html#tag-object
 * @link https://github.com/zero-to-prod/data-model-openapi30
 */
class Tag
{
    use DataModel;

    /**
     * **REQUIRED**. The name of the tag.
     *
     * @see  https://spec.openapis.org/oas/v3.0.4.html#fixed-fields-18
     * @see  $name
     * @link https://github.com/zero-to-prod/data-model-openapi30
     */
    public const name = 'name';

    /**
     * **REQUIRED**. The name of the tag.
     *
     * @see  https://spec.openapis.org/oas/v3.0.4.html#fixed-fields-18
     * @link https://github.com/zero-to-prod/data-model-openapi30
     */
    #[Describe(['required'])]
    public string $name;

    /**
     * A description for the tag. [CommonMark] syntax _MAY_ be used for
     * rich text representation.
     *
     * @see  https://spec.openapis.org/oas/v3.0.4.html#fixed-fields-18
     * @see  $description
     * @link https://github.com/zero-to-prod/data-model-openapi30
     */
    public const description = 'description';

    /**
     * A description for the tag. [CommonMark] syntax _MAY_ be used for
     * rich text representation.
     *
     * @see  https://spec.openapis.org/oas/v3.0.4.html#fixed-fields-18
     * @link https://github.com/zero-to-prod/data-model-openapi30
     */
    #[Describe(['nullable'])]
    public ?string $description;

    /**
     * Additional external documentation for this tag.
     *
     * @see  https://spec.openapis.org/oas/v3.0.4.html#fixed-fields-18
     * @see  $externalDocs
     * @link https://github.com/zero-to-prod/data-model-openapi30
     */
    public const externalDocs = 'externalDocs';

    /**
     * Additional external documentation for this tag.
     *
     * @see  https://spec.openapis.org/oas/v3.0.4.html#fixed-fields-18
     * @link https://github.com/zero-to-prod/data-model-openapi30
     */
    #[Describe(['nullable'])]
    public ?ExternalDocumentation $externalDocs;
}