forked from cebe/php-openapi
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathOperation.php
More file actions
70 lines (63 loc) · 1.99 KB
/
Operation.php
File metadata and controls
70 lines (63 loc) · 1.99 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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
<?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;
/**
* Describes a single API operation on a path.
*
* @link https://github.com/OAI/OpenAPI-Specification/blob/3.0.2/versions/3.0.2.md#operationObject
*
* @property string[] $tags
* @property string $summary
* @property string $description
* @property ExternalDocumentation|null $externalDocs
* @property string $operationId
* @property Parameter[]|Reference[] $parameters
* @property RequestBody|Reference|null $requestBody
* @property Responses|Response[]|null $responses
* @property Callback[]|Reference[] $callbacks
* @property bool $deprecated
* @property SecurityRequirement[] $security
* @property Server[] $servers
*/
class Operation extends SpecBaseObject
{
/**
* @return array array of attributes available in this object.
*/
protected function attributes(): array
{
return [
'tags' => [Type::STRING],
'summary' => Type::STRING,
'description' => Type::STRING,
'externalDocs' => ExternalDocumentation::class,
'operationId' => Type::STRING,
'parameters' => [Parameter::class],
'requestBody' => RequestBody::class,
'responses' => Responses::class,
'callbacks' => [Type::STRING, Callback::class],
'deprecated' => Type::BOOLEAN,
'security' => [SecurityRequirement::class],
'servers' => [Server::class],
];
}
protected function attributeDefaults(): array
{
return [
'security' => null,
];
}
/**
* Perform validation on this object, check data against OpenAPI Specification rules.
*
* Call `addError()` in case of validation errors.
*/
protected function performValidation()
{
$this->requireProperties(['responses']);
}
}