blob: 1d0fbbfa0c30f509b5e9724a53cecb52ef7ffcae (
plain)
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
|
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OCP\AppFramework\Http\Attribute;
use Attribute;
/**
* This attribute allows documenting request headers and is primarily intended for OpenAPI documentation.
* It should be added whenever you use a request header in a controller method, in order to properly describe the header and its functionality.
* There are no checks that ensure the header is set, so you will still need to do this yourself in the controller method.
*
* @since 32.0.0
*/
#[Attribute(Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)]
class RequestHeader {
/**
* @param lowercase-string $name The name of the request header
* @param non-empty-string $description The description of the request header
* @param bool $indirect Allow indirect usage of the header for example in a middleware. Enabling this turns off the check which ensures that the header must be referenced in the controller method.
*/
public function __construct(
protected string $name,
protected string $description,
protected bool $indirect = false,
) {
}
}
|
