class ApiPlatform\OpenApi\Model\Header
{
public __construct(string $in, string $description, bool $required, bool $deprecated, bool $allowEmptyValue, array $schema, null|string $style, bool $explode, bool $allowReserved, $example, null|ArrayObject $examples, null|ArrayObject $content)
public getIn(): string
public getDescription(): string
public getRequired(): bool
public getDeprecated(): bool
public canAllowEmptyValue(): bool
public getAllowEmptyValue(): bool
public getSchema(): array
public getStyle(): string
public canExplode(): bool
public getExplode(): bool
public canAllowReserved(): bool
public getAllowReserved(): bool
public getExample()
public getExamples(): ArrayObject
public getContent(): ArrayObject
public withDescription(string $description): ApiPlatform\OpenApi\Model\Header
public withRequired(bool $required): ApiPlatform\OpenApi\Model\Header
public withDeprecated(bool $deprecated): ApiPlatform\OpenApi\Model\Header
public withAllowEmptyValue(bool $allowEmptyValue): ApiPlatform\OpenApi\Model\Header
public withSchema(array $schema): ApiPlatform\OpenApi\Model\Header
public withStyle(string $style): ApiPlatform\OpenApi\Model\Header
public withExplode(bool $explode): ApiPlatform\OpenApi\Model\Header
public withAllowReserved(bool $allowReserved): ApiPlatform\OpenApi\Model\Header
public withExample($example): ApiPlatform\OpenApi\Model\Header
public withExamples(ArrayObject $examples): ApiPlatform\OpenApi\Model\Header
public withContent(ArrayObject $content): ApiPlatform\OpenApi\Model\Header
public withExtensionProperty(string $key, $value)
public getExtensionProperties(): array
}public __construct(string $in, string $description, bool $required, bool $deprecated, bool $allowEmptyValue, array $schema, null|string $style, bool $explode, bool $allowReserved, $example, null|ArrayObject $examples, null|ArrayObject $content)| in | string | |
| description | string | |
| required | bool | |
| deprecated | bool | |
| allowEmptyValue | bool | |
| schema | array | |
| style | string | |
| explode | bool | |
| allowReserved | bool | |
| example | ||
| examples | ArrayObject | |
| content | ArrayObject |
public getIn(): stringstring
public getDescription(): stringstring
public getRequired(): boolbool
public getDeprecated(): boolbool
public canAllowEmptyValue(): boolbool
public getAllowEmptyValue(): boolbool
public getSchema(): arrayarray
public getStyle(): stringstring
public canExplode(): boolbool
public getExplode(): boolbool
public canAllowReserved(): boolbool
public getAllowReserved(): boolbool
public getExample()public getExamples(): ArrayObjectArrayObject
public getContent(): ArrayObjectArrayObject
public withDescription(string $description): ApiPlatform\OpenApi\Model\Header| description | string |
<a href="/docs/main/references/OpenApi/Model/Header">ApiPlatform\OpenApi\Model\Header</a>
public withRequired(bool $required): ApiPlatform\OpenApi\Model\Header| required | bool |
<a href="/docs/main/references/OpenApi/Model/Header">ApiPlatform\OpenApi\Model\Header</a>
public withDeprecated(bool $deprecated): ApiPlatform\OpenApi\Model\Header| deprecated | bool |
<a href="/docs/main/references/OpenApi/Model/Header">ApiPlatform\OpenApi\Model\Header</a>
public withAllowEmptyValue(bool $allowEmptyValue): ApiPlatform\OpenApi\Model\Header| allowEmptyValue | bool |
<a href="/docs/main/references/OpenApi/Model/Header">ApiPlatform\OpenApi\Model\Header</a>
public withSchema(array $schema): ApiPlatform\OpenApi\Model\Header| schema | array |
<a href="/docs/main/references/OpenApi/Model/Header">ApiPlatform\OpenApi\Model\Header</a>
public withStyle(string $style): ApiPlatform\OpenApi\Model\Header| style | string |
<a href="/docs/main/references/OpenApi/Model/Header">ApiPlatform\OpenApi\Model\Header</a>
public withExplode(bool $explode): ApiPlatform\OpenApi\Model\Header| explode | bool |
<a href="/docs/main/references/OpenApi/Model/Header">ApiPlatform\OpenApi\Model\Header</a>
public withAllowReserved(bool $allowReserved): ApiPlatform\OpenApi\Model\Header| allowReserved | bool |
<a href="/docs/main/references/OpenApi/Model/Header">ApiPlatform\OpenApi\Model\Header</a>
public withExample($example): ApiPlatform\OpenApi\Model\Header| example |
<a href="/docs/main/references/OpenApi/Model/Header">ApiPlatform\OpenApi\Model\Header</a>
public withExamples(ArrayObject $examples): ApiPlatform\OpenApi\Model\Header| examples | ArrayObject |
<a href="/docs/main/references/OpenApi/Model/Header">ApiPlatform\OpenApi\Model\Header</a>
public withContent(ArrayObject $content): ApiPlatform\OpenApi\Model\Header| content | ArrayObject |
<a href="/docs/main/references/OpenApi/Model/Header">ApiPlatform\OpenApi\Model\Header</a>
public withExtensionProperty(string $key, $value)| key | string | |
| value |
public getExtensionProperties(): arrayarray
Made with love by
Les-Tilleuls.coop can help you design and develop your APIs and web projects, and train your teams in API Platform, Symfony, Next.js, Kubernetes and a wide range of other technologies.
Learn more