forked from cebe/php-openapi
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathHeader.php
More file actions
36 lines (32 loc) · 1.19 KB
/
Header.php
File metadata and controls
36 lines (32 loc) · 1.19 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
<?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 Header Object follows the structure of the Parameter Object with the following changes:
*
* 1. name MUST NOT be specified, it is given in the corresponding headers map.
* 2. in MUST NOT be specified, it is implicitly in header.
* 3. All traits that are affected by the location MUST be applicable to a location of header (for example, style).
*
* @link https://github.com/OAI/OpenAPI-Specification/blob/3.0.2/versions/3.0.2.md#headerObject
*
*/
class Header extends Parameter
{
public function performValidation()
{
if (!empty($this->name)) {
$this->addError("'name' must not be specified in Header Object.");
}
if (!empty($this->in)) {
$this->addError("'in' must not be specified in Header Object.");
}
if (!empty($this->content) && !empty($this->schema)) {
$this->addError("A Header Object MUST contain either a schema property, or a content property, but not both. ");
}
}
}