OpenAPIMetadata
: string
Cases
-
DEFAULT
= 'openapi_default'
-
DEPRECATED
= 'openapi_deprecated'
-
DESCRIPTION
= 'openapi_description'
-
EXAMPLE
= 'openapi_example'
-
EXAMPLES
= 'openapi_examples'
-
FORMAT
= 'openapi_format'
-
NULLABLE
= 'openapi_nullable'
-
READ_ONLY
= 'openapi_read_only'
-
TITLE
= 'openapi_title'
-
WRITE_ONLY
= 'openapi_write_only'
Methods
-
default()
: Metadata
-
deprecated()
: Metadata
-
description()
: Metadata
-
example()
: Metadata
-
examples()
: Metadata
-
format()
: Metadata
-
nullable()
: Metadata
-
readOnly()
: Metadata
-
title()
: Metadata
-
writeOnly()
: Metadata
DEFAULT
DEPRECATED
DESCRIPTION
EXAMPLE
EXAMPLES
NULLABLE
READ_ONLY
TITLE
WRITE_ONLY
default()
public
static default(array<string|int, mixed>|bool|float|int|string $default) : Metadata
Parameters
-
$default
: array<string|int, mixed>|bool|float|int|string
-
deprecated()
public
static deprecated([bool $deprecated = true ]) : Metadata
Parameters
-
$deprecated
: bool
= true
-
description()
public
static description(string $description) : Metadata
Parameters
-
$description
: string
-
example()
public
static example(array<string|int, mixed>|bool|float|int|string $example) : Metadata
Parameters
-
$example
: array<string|int, mixed>|bool|float|int|string
-
examples()
public
static examples(array<string, mixed> $examples) : Metadata
Parameters
-
$examples
: array<string, mixed>
-
public
static format(string $format) : Metadata
Parameters
-
$format
: string
-
nullable()
public
static nullable([bool $nullable = true ]) : Metadata
Parameters
-
$nullable
: bool
= true
-
readOnly()
public
static readOnly([bool $readOnly = true ]) : Metadata
Parameters
-
$readOnly
: bool
= true
-
title()
public
static title(string $title) : Metadata
Parameters
-
$title
: string
-
writeOnly()
public
static writeOnly([bool $writeOnly = true ]) : Metadata
Parameters
-
$writeOnly
: bool
= true
-