Media
Interfaces, Classes, Traits and Enums
- ArraySchema
- The attribute may be used to define a schema of type "array" for a set of elements of the OpenAPI spec, and/or to define additional properties for the schema. It is applicable e.g. to parameters, schema classes (aka "models"), properties of such models, request and response content, header. The attribute {@see Schema} shall be used for non array elements; {@see ArraySchema} and {@see Schema} cannot coexist.
- Content
- The attribute may be used to define the content/media type of a parameter, request or response, by defining it as field {@see \OpenApi\Attributes\Parameter::$content}, {@see \OpenApi\Attributes\Parameters\RequestBody::$content} or {@see \OpenApi\Attributes\Responses\ApiResponse::$content}.
- DiscriminatorMapping
- The attribute may be used in {@see Schema::$discriminatorMapping} to define an optional mapping definition in scenarios involving composition / inheritance where the value of the discriminator field does not match the schema name or implicit mapping is not possible.
- Encoding
- The attribute may be used to add encoding details to the definition of a parameter, request or response content, by defining it as field {@see Content::$encoding}
- ExampleObject
- The attribute may be used to add one or more examples to the definition of a parameter, request or response content, by defining it as field {@see \OpenApi\Attributes\Parameter::$examples} or {@see Content::$examples}
- Schema
- The attribute may be used to define a Schema for a set of elements of the OpenAPI spec, and/or to define additional properties for the schema. It is applicable e.g. to parameters, schema classes (aka "models"), properties of such models, request and response content, header.