Application
Interfaces, Classes, Traits and Enums
- OpenApiAttributeInterface
- Callback
- The attribute may be used at method level to add one ore more callbacks to the operation definition.
- Consumes
- Delete
- Extension
- An optionally named list of extension properties.
- ExtensionProperty
- A name/value property within a OpenApi extension
- ExternalDocumentation
- The attribute may be used at method level or as field of {@see Operation} to add a reference to an external resource for extended documentation of an Operation (OpenAPI specification).
- Get
- Header
- The attribute may be used to add one or more headers to the definition of a response or as attribute of content encoding by defining it as field {@see \OpenApi\Attributes\Responses\ApiResponse::$headers} or {@see \OpenApi\Attributes\Media\Content::$encoding}.
- Hidden
- Marks a given resource, class or bean type as hidden, skipping while reading / resolving
- Contact
- The attribute may be used in {@see Info::$contact} to define a contact for the OpenAPI spec.
- Info
- The attribute may be used in {@see OpenAPIDefinition::$info} to populate the Info section of the OpenAPI document.
- License
- The attribute may be used in {@see Info::$license} to define a license for the OpenAPI spec.
- Link
- The attribute may be applied in {@see \OpenApi\Attributes\Responses\ApiResponse::$links} to add OpenAPI links to a response.
- LinkParameter
- Represents a parameter to pass to an operation as specified with operationId or identified via operationRef.
- 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.
- Method
- OpenAPIDefinition
- The attribute that may be used to populate OpenAPI Object fields info, tags, servers, security and externalDocs.
- Operation
- The attribute may be used to define a resource method as an OpenAPI Operation, and/or to define additional properties for the Operation.
- Parameter
- The attribute may be used on a method parameter to define it as a parameter for the operation, and/or to define additional properties for the Parameter. It can also be used independently in {@see Operation::$parameters} or at method level to add a parameter to the operation, even if not bound to any method parameter.
- RequestBody
- The attribute may be used on a method parameter to define it as the Request Body of the operation, and/or to define additional properties for such request body.
- Patch
- Path
- Post
- Produces
- Put
- ApiResponse
- The attribute may be used at method level or as field of {@see \OpenApi\Attributes\Operation} to define one or more responses of the Operation.
- OAuthFlow
- Configuration details for a supported OAuth Flow.
- OAuthFlows
- Allows configuration of the supported OAuth Flows.
- OAuthScope
- Represents an OAuth scope.
- SecurityRequirement
- The attribute may be applied at class or method level, or in {@see \OpenApi\Attributes\Operation::$security} to define security requirements for the single operation (when applied at method level) or for all operations of a class (when applied at class level).
- SecurityScheme
- The attribute may be used at class level (also on multiple classes) to add securitySchemes to spec components section.
- Server
- The attribute may be applied at class or method level, or in {@see \OpenApi\Attributes\Operation::$servers} to define servers for the single operation (when applied at method level) or for all operations of a class (when applied at class level). It can also be used in {@see \OpenApi\Attributes\OpenAPIDefinition::$servers} to define spec level servers.
- ServerVariable
- An object representing a Server Variable for server URL template substitution.
- Tag
- The attribute may be applied at class or method level, or in {@see \OpenApi\Attributes\Operation::$tags} to define tags for the single operation (when applied at method level) or for all operations of a class (when applied at class level).