forked from cebe/php-openapi
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathInfo.php
More file actions
51 lines (46 loc) · 1.36 KB
/
Copy pathInfo.php
File metadata and controls
51 lines (46 loc) · 1.36 KB
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
<?php
/**
* @copyright Copyright (c) 2018 Carsten Brandt <mail@cebe.cc> and contributors
* @license https://github.com/cebe/php-openapi/blob/master/LICENSE
*/
namespace cebe\openapi\spec;
use cebe\openapi\SpecBaseObject;
/**
* The object provides metadata about the API.
*
* The metadata MAY be used by the clients if needed, and MAY be presented in editing or documentation generation tools for convenience.
*
* @link https://github.com/OAI/OpenAPI-Specification/blob/3.0.2/versions/3.0.2.md#infoObject
*
* @property string $title
* @property string $description
* @property string $termsOfService
* @property Contact|null $contact
* @property License|null $license
* @property string $version
*
*/
class Info extends SpecBaseObject
{
/**
* @return array array of attributes available in this object.
*/
protected function attributes(): array
{
return [
'title' => Type::STRING,
'description' => Type::STRING,
'termsOfService' => Type::STRING,
'contact' => Contact::class,
'license' => License::class,
'version' => Type::STRING,
];
}
/**
* Perform validation on this object, check data against OpenAPI Specification rules.
*/
protected function performValidation()
{
$this->requireProperties(['title', 'version']);
}
}