php swagger OAT\Schema Property Reference

Ah... how many times have I forgotten this, only to forget it again... I figured it would be faster to write it down on the blog and search for it, so here I am writing it down. ## Swagger OAT\Schema Property List ### Writing Requests (#\[OAT\Property]) #### When the type is array and you're adding a Laravel Data value ```php #[OAT\Property(property: 'productOptions', type: 'array', items: new OAT\Items(ref: '#/components/schemas/OptionData', type: 'object'))] ``` #### When the type is array and no value is set ```php #[OAT\Property(property: 'features', type: 'array', items: new OAT\Items())] ``` #### When the type is array and you're adding an Enum value ```php #[OAT\Property(property: 'meta', type: 'array', items: new OAT\Items(ref: '#/components/schemas/MetaEnum'))] ``` #### When the type is object and you're adding a Laravel Data value ```php #[OAT\Property(property: 'link', ref: '#/components/schemas/LinkData', type: 'object')] ``` #### When the type is enum and you want to use a single selection ```php #[OAT\Property(property: 'state', ref: '#/components/schemas/State', type: 'enum')] ``` #### When using the date-time type ```php #[OAT\Property(property: 'start_at', type: 'string', format: 'date-time')] ``` ### Writing Controllers #### When it's an array resource ```php new OAT\Property(property: 'data', type: 'array', items: new OAT\Items(ref: '#/components/schemas/UserResource')), ``` #### When data needs to be included as an object in the response ```php new OAT\Property(property: 'data', ref: '#/components/schemas/GroupResource', type: 'object'), ```

php swagger OAT\Schema Property Reference

Swagger OAT\Schema Property List#

Writing Requests (#[OAT\Property])#

When the type is array and you're adding a Laravel Data value#

More posts

When the type is array and no value is set#

When the type is array and you're adding an Enum value#

When the type is object and you're adding a Laravel Data value#

When the type is enum and you want to use a single selection#

When using the date-time type#

Writing Controllers#

When it's an array resource#

When data needs to be included as an object in the response#