ApiPlatform\OpenApi\Model\PathItem

class ApiPlatform\OpenApi\Model\PathItem
{
    public __construct(null|string $ref, null|string $summary, null|string $description, null|$get, null|`<a href="/docs/main/references/OpenApi/Model/Operation">ApiPlatform\OpenApi\Model\Operation</a>` $put, null|`<a href="/docs/main/references/OpenApi/Model/Operation">ApiPlatform\OpenApi\Model\Operation</a>` $post, null|`<a href="/docs/main/references/OpenApi/Model/Operation">ApiPlatform\OpenApi\Model\Operation</a>` $delete, null|`<a href="/docs/main/references/OpenApi/Model/Operation">ApiPlatform\OpenApi\Model\Operation</a>` $options, null|`<a href="/docs/main/references/OpenApi/Model/Operation">ApiPlatform\OpenApi\Model\Operation</a>` $head, null|`<a href="/docs/main/references/OpenApi/Model/Operation">ApiPlatform\OpenApi\Model\Operation</a>` $patch, null|`<a href="/docs/main/references/OpenApi/Model/Operation">ApiPlatform\OpenApi\Model\Operation $trace, null|array $servers, array $parameters)
    public getRef(): string
    public getSummary(): string
    public getDescription(): string
    public getGet(): ApiPlatform\OpenApi\Model\Operation
    public getPut(): ApiPlatform\OpenApi\Model\Operation
    public getPost(): ApiPlatform\OpenApi\Model\Operation
    public getDelete(): ApiPlatform\OpenApi\Model\Operation
    public getOptions(): ApiPlatform\OpenApi\Model\Operation
    public getHead(): ApiPlatform\OpenApi\Model\Operation
    public getPatch(): ApiPlatform\OpenApi\Model\Operation
    public getTrace(): ApiPlatform\OpenApi\Model\Operation
    public getServers(): array
    public getParameters(): array
    public withRef(string $ref): ApiPlatform\OpenApi\Model\PathItem
    public withSummary(string $summary): ApiPlatform\OpenApi\Model\PathItem
    public withDescription(string $description): ApiPlatform\OpenApi\Model\PathItem
    public withGet(null|$get): `<a href="/docs/main/references/OpenApi/Model/PathItem">ApiPlatform\OpenApi\Model\PathItem
    public withPut(null|$put): `<a href="/docs/main/references/OpenApi/Model/PathItem">ApiPlatform\OpenApi\Model\PathItem
    public withPost(null|$post): `<a href="/docs/main/references/OpenApi/Model/PathItem">ApiPlatform\OpenApi\Model\PathItem
    public withDelete(null|$delete): `<a href="/docs/main/references/OpenApi/Model/PathItem">ApiPlatform\OpenApi\Model\PathItem
    public withOptions($options): `<a href="/docs/main/references/OpenApi/Model/PathItem">ApiPlatform\OpenApi\Model\PathItem
    public withHead($head): `<a href="/docs/main/references/OpenApi/Model/PathItem">ApiPlatform\OpenApi\Model\PathItem
    public withPatch(null|$patch): `<a href="/docs/main/references/OpenApi/Model/PathItem">ApiPlatform\OpenApi\Model\PathItem
    public withTrace($trace): `<a href="/docs/main/references/OpenApi/Model/PathItem">ApiPlatform\OpenApi\Model\PathItem
    public withServers(null|array $servers): ApiPlatform\OpenApi\Model\PathItem
    public withParameters(array $parameters): ApiPlatform\OpenApi\Model\PathItem
    public withExtensionProperty(string $key, $value)
    public getExtensionProperties(): array
}

Properties

methods

array $methods

Methods

__construct

public __construct(null|string $ref, null|string $summary, null|string $description, null|$get, null|`<a href="/docs/main/references/OpenApi/Model/Operation">ApiPlatform\OpenApi\Model\Operation</a>` $put, null|`<a href="/docs/main/references/OpenApi/Model/Operation">ApiPlatform\OpenApi\Model\Operation</a>` $post, null|`<a href="/docs/main/references/OpenApi/Model/Operation">ApiPlatform\OpenApi\Model\Operation</a>` $delete, null|`<a href="/docs/main/references/OpenApi/Model/Operation">ApiPlatform\OpenApi\Model\Operation</a>` $options, null|`<a href="/docs/main/references/OpenApi/Model/Operation">ApiPlatform\OpenApi\Model\Operation</a>` $head, null|`<a href="/docs/main/references/OpenApi/Model/Operation">ApiPlatform\OpenApi\Model\Operation</a>` $patch, null|`<a href="/docs/main/references/OpenApi/Model/Operation">ApiPlatform\OpenApi\Model\Operation $trace, null|array $servers, array $parameters)

Parameters

ref	string
summary	string
description	string
get	`ApiPlatform\OpenApi\Model\Operation`
put	`ApiPlatform\OpenApi\Model\Operation`
post	`ApiPlatform\OpenApi\Model\Operation`
delete	`ApiPlatform\OpenApi\Model\Operation`
options	`ApiPlatform\OpenApi\Model\Operation`
head	`ApiPlatform\OpenApi\Model\Operation`
patch	`ApiPlatform\OpenApi\Model\Operation`
trace	`ApiPlatform\OpenApi\Model\Operation`
servers	array
parameters	array

getRef

public getRef(): string

Returns

string

getSummary

public getSummary(): string

Returns

string

getDescription

public getDescription(): string

Returns

string

getGet

public getGet(): ApiPlatform\OpenApi\Model\Operation

Returns

<a href="/docs/main/references/OpenApi/Model/Operation">ApiPlatform\OpenApi\Model\Operation</a>

getPut

public getPut(): ApiPlatform\OpenApi\Model\Operation

Returns

<a href="/docs/main/references/OpenApi/Model/Operation">ApiPlatform\OpenApi\Model\Operation</a>

getPost

public getPost(): ApiPlatform\OpenApi\Model\Operation

Returns

<a href="/docs/main/references/OpenApi/Model/Operation">ApiPlatform\OpenApi\Model\Operation</a>

getDelete

public getDelete(): ApiPlatform\OpenApi\Model\Operation

Returns

<a href="/docs/main/references/OpenApi/Model/Operation">ApiPlatform\OpenApi\Model\Operation</a>

getOptions

public getOptions(): ApiPlatform\OpenApi\Model\Operation

Returns

<a href="/docs/main/references/OpenApi/Model/Operation">ApiPlatform\OpenApi\Model\Operation</a>

getHead

public getHead(): ApiPlatform\OpenApi\Model\Operation

Returns

<a href="/docs/main/references/OpenApi/Model/Operation">ApiPlatform\OpenApi\Model\Operation</a>

getPatch

public getPatch(): ApiPlatform\OpenApi\Model\Operation

Returns

<a href="/docs/main/references/OpenApi/Model/Operation">ApiPlatform\OpenApi\Model\Operation</a>

getTrace

public getTrace(): ApiPlatform\OpenApi\Model\Operation

Returns

<a href="/docs/main/references/OpenApi/Model/Operation">ApiPlatform\OpenApi\Model\Operation</a>

getServers

public getServers(): array

Returns

array

getParameters

public getParameters(): array

Returns

array

withRef

public withRef(string $ref): ApiPlatform\OpenApi\Model\PathItem

Parameters

ref

string

Returns

<a href="/docs/main/references/OpenApi/Model/PathItem">ApiPlatform\OpenApi\Model\PathItem</a>

withSummary

public withSummary(string $summary): ApiPlatform\OpenApi\Model\PathItem

Parameters

summary

string

Returns

<a href="/docs/main/references/OpenApi/Model/PathItem">ApiPlatform\OpenApi\Model\PathItem</a>

withDescription

public withDescription(string $description): ApiPlatform\OpenApi\Model\PathItem

Parameters

description

string

Returns

<a href="/docs/main/references/OpenApi/Model/PathItem">ApiPlatform\OpenApi\Model\PathItem</a>

withGet

public withGet(null|$get): `<a href="/docs/main/references/OpenApi/Model/PathItem">ApiPlatform\OpenApi\Model\PathItem

Parameters

get

`ApiPlatform\OpenApi\Model\Operation`

Returns

<a href="/docs/main/references/OpenApi/Model/PathItem">ApiPlatform\OpenApi\Model\PathItem</a>

withPut

public withPut(null|$put): `<a href="/docs/main/references/OpenApi/Model/PathItem">ApiPlatform\OpenApi\Model\PathItem

Parameters

put

`ApiPlatform\OpenApi\Model\Operation`

Returns

<a href="/docs/main/references/OpenApi/Model/PathItem">ApiPlatform\OpenApi\Model\PathItem</a>

withPost

public withPost(null|$post): `<a href="/docs/main/references/OpenApi/Model/PathItem">ApiPlatform\OpenApi\Model\PathItem

Parameters

post

`ApiPlatform\OpenApi\Model\Operation`

Returns

<a href="/docs/main/references/OpenApi/Model/PathItem">ApiPlatform\OpenApi\Model\PathItem</a>

withDelete

public withDelete(null|$delete): `<a href="/docs/main/references/OpenApi/Model/PathItem">ApiPlatform\OpenApi\Model\PathItem

Parameters

delete

`ApiPlatform\OpenApi\Model\Operation`

Returns

<a href="/docs/main/references/OpenApi/Model/PathItem">ApiPlatform\OpenApi\Model\PathItem</a>

withOptions

public withOptions($options): `<a href="/docs/main/references/OpenApi/Model/PathItem">ApiPlatform\OpenApi\Model\PathItem

Parameters

options

`ApiPlatform\OpenApi\Model\Operation`

Returns

<a href="/docs/main/references/OpenApi/Model/PathItem">ApiPlatform\OpenApi\Model\PathItem</a>

withHead

public withHead($head): `<a href="/docs/main/references/OpenApi/Model/PathItem">ApiPlatform\OpenApi\Model\PathItem

Parameters

head

`ApiPlatform\OpenApi\Model\Operation`

Returns

<a href="/docs/main/references/OpenApi/Model/PathItem">ApiPlatform\OpenApi\Model\PathItem</a>

withPatch

public withPatch(null|$patch): `<a href="/docs/main/references/OpenApi/Model/PathItem">ApiPlatform\OpenApi\Model\PathItem

Parameters

patch

`ApiPlatform\OpenApi\Model\Operation`

Returns

<a href="/docs/main/references/OpenApi/Model/PathItem">ApiPlatform\OpenApi\Model\PathItem</a>

withTrace

public withTrace($trace): `<a href="/docs/main/references/OpenApi/Model/PathItem">ApiPlatform\OpenApi\Model\PathItem

Parameters

trace

`ApiPlatform\OpenApi\Model\Operation`

Returns

<a href="/docs/main/references/OpenApi/Model/PathItem">ApiPlatform\OpenApi\Model\PathItem</a>

withServers

public withServers(null|array $servers): ApiPlatform\OpenApi\Model\PathItem

Parameters

servers

array

Returns

<a href="/docs/main/references/OpenApi/Model/PathItem">ApiPlatform\OpenApi\Model\PathItem</a>

withParameters

public withParameters(array $parameters): ApiPlatform\OpenApi\Model\PathItem

Parameters

parameters

array

Returns

<a href="/docs/main/references/OpenApi/Model/PathItem">ApiPlatform\OpenApi\Model\PathItem</a>

withExtensionProperty

public withExtensionProperty(string $key, $value)

Parameters

key	string
value

Returns

getExtensionProperties

public getExtensionProperties(): array

Returns

array