Processors
This page is generated automatically from the swagger-php
sources.
For improvements head over to GitHub and create a PR 😉
DocBlockDescriptions
Checks if the annotation has a summary and/or description property and uses the text in the comment block (above the annotations) as summary and/or description.
Use null
, for example: @Annotation(description=null)
, if you don't want the annotation to have a description.
MergeIntoOpenApi
Merge all @OA\OpenApi annotations into one.
MergeIntoComponents
Merge reusable annotation into @OA\Schemas.
ExpandClasses
Iterate over the chain of ancestors of a schema and:
- if the ancestor has a schema => inherit from the ancestor if it has a schema (allOf) and stop.
- else => merge ancestor properties into the schema.
ExpandInterfaces
Look at all (direct) interfaces for a schema and:
- merge interfaces annotations/methods into the schema if the interface does not have a schema itself
- inherit from the interface if it has a schema (allOf).
ExpandTraits
Look at all (direct) traits for a schema and:
- merge trait annotations/methods/properties into the schema if the trait does not have a schema itself
- inherit from the trait if it has a schema (allOf).
ExpandEnums
Expands PHP enums.
Determines schema
, enum
and type
.
AugmentSchemas
Use the Schema context to extract useful information and inject that into the annotation.
Merges properties.
AugmentProperties
Use the property context to extract useful information and inject that into the annotation.
BuildPaths
Build the openapi->paths using the detected @OA\PathItem
and @OA\Operation
(@OA\Get
, @OA\Post
, etc).
AugmentParameters
Config settings
- augmentParameters.augmentOperationParameters : bool
If set to
true
try to find operation parameter descriptions in the operation docblock.
AugmentRefs
MergeJsonContent
Split JsonContent into Schema and MediaType.
MergeXmlContent
Split XmlContent into Schema and MediaType.
OperationId
Generate the OperationId based on the context of the OpenApi annotation.
Config settings
- operationId.hash : bool
If set to
true
generate ids (md5) instead of clear text operation ids.