SWAMPy

✎ CARVE FLESH

EDITING: header_object.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;
    }
}

CANCEL

Name	Type	Size	Modified	Actions
↩ ..	DIR	—	—
📁 objects/	DIR	—	2026-02-11 01:44
📁 parameters/	DIR	—	2026-02-11 01:44
📁 response/	DIR	—	2026-02-11 01:44
📄 example.php	PHP	3.6 KB	2026-02-11 01:44	EDIT
📄 header_object.php	PHP	1.6 KB	2026-02-11 01:44	EDIT
📄 openapi_base.php	PHP	7.5 KB	2026-02-11 01:44	EDIT
📄 parameter.php	PHP	5.7 KB	2026-02-11 01:44	EDIT
📄 referenced_object.php	PHP	1.1 KB	2026-02-11 01:44	EDIT
📄 request_body.php	PHP	4.5 KB	2026-02-11 01:44	EDIT
📄 specification.php	PHP	16 KB	2026-02-11 01:44	EDIT