responses array. * * A HTTP status code or default. * * @var string|int */ public $response = Generator::UNDEFINED; /** * A short description of the response. * * CommonMark syntax may be used for rich text representation. * * @var string */ public $description = Generator::UNDEFINED; /** * Maps a header name to its definition. * * RFC7230 states header names are case-insensitive. * * If a response header is defined with the name "Content-Type", it shall be ignored. * * @see [RFC7230](https://tools.ietf.org/html/rfc7230#page-22) * * @var list
*/ public $headers = Generator::UNDEFINED; /** * A map containing descriptions of potential response payloads. * * The key is a media type or media type range and the value describes it. * * For responses that match multiple keys, only the most specific key is applicable; * e.g. text/plain overrides text/*. * * @var MediaType|JsonContent|XmlContent|Attachable|array */ public $content = Generator::UNDEFINED; /** * A map of operations links that can be followed from the response. * * The key of the map is a short name for the link, following the naming constraints of the names for Component * Objects. * * @var list */ public $links = Generator::UNDEFINED; /** * @inheritdoc */ public static $_types = [ 'description' => 'string', ]; /** * @inheritdoc */ public static $_nested = [ MediaType::class => ['content', 'mediaType'], Header::class => ['headers', 'header'], Link::class => ['links', 'link'], Attachable::class => ['attachables'], ]; /** * @inheritdoc */ public static $_parents = [ Components::class, Operation::class, Get::class, Post::class, Put::class, Patch::class, Delete::class, Head::class, Options::class, Trace::class, ]; #[\Override] public function validate(?Analysis $analysis = null, string $version = OpenApi::DEFAULT_VERSION, ?object $context = null): bool { $isValid = parent::validate($analysis, $version, $context); if (Generator::isDefault($this->description) && Generator::isDefault($this->ref)) { $this->_context->logger->warning($this->identity() . ' One of description or ref is required in ' . $this->_context); $isValid = false; } return $isValid; } }