mirror of
https://github.com/moodle/moodle.git
synced 2025-07-14 10:56:54 +02:00
47 lines
1.6 KiB
PHP
47 lines
1.6 KiB
PHP
<?php
|
|
// This file is part of Moodle - http://moodle.org/
|
|
//
|
|
// Moodle is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// Moodle is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
namespace core\router\schema;
|
|
|
|
/**
|
|
* A Header Object.
|
|
*
|
|
* https://spec.openapis.org/oas/v3.1.0#headerObject
|
|
*
|
|
* The Header Object follows the structure of the Parameter Object with the following changes:
|
|
*
|
|
* - name MUST NOT be specified, it is given in the corresponding headers map.
|
|
* - in MUST NOT be specified, it is implicitly in header.
|
|
* - All traits that are affected by the location MUST be applicable to a location of header (for example, style).
|
|
*
|
|
* @package core
|
|
* @copyright 2023 Andrew Lyons <andrew@nicols.co.uk>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class header_object extends parameters\header_object {
|
|
#[\Override]
|
|
final public function get_openapi_description(
|
|
specification $api,
|
|
?string $path = null,
|
|
): ?\stdClass {
|
|
$data = parent::get_openapi_description($api);
|
|
unset($data->in);
|
|
unset($data->name);
|
|
|
|
return $data;
|
|
}
|
|
}
|