php-openapi/src/spec/Response.php at master · php-openapi/php-openapi · GitHub

44 lines (39 loc) · 1.22 KB

<?php

/**

* @license https://github.com/cebe/php-openapi/blob/master/LICENSE

namespace cebe\openapi\spec;

use cebe\openapi\SpecBaseObject;

/**

* Describes a single response from an API Operation, including design-time, static links to operations based on the response.

* @link https://github.com/OAI/OpenAPI-Specification/blob/3.0.2/versions/3.0.2.md#responseObject

* @property string $description

* @property Header[]|Reference[] $headers

* @property MediaType[] $content

* @property Link[]|Reference[] $links

class Response extends SpecBaseObject

{

/**

* @return array array of attributes available in this object.

protected function attributes(): array

{

return [

'description' => Type::STRING,

'headers' => [Type::STRING, Header::class],

'content' => [Type::STRING, MediaType::class],

'links' => [Type::STRING, Link::class],

];

}

/**

* Perform validation on this object, check data against OpenAPI Specification rules.

protected function performValidation()

{

$this->requireProperties(['description']);

}

Expand file tree