Skip to content

Latest commit

 

History

History
93 lines (59 loc) · 4.13 KB

processors.md

File metadata and controls

93 lines (59 loc) · 4.13 KB

Processor Reference

This page is generated automatically from the swagger-php sources.

For improvements head over to GitHub and create a PR ;)

Processors are listed in the default order of execution.

Processors

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.

Merge all @OA\OpenApi annotations into one.

Merge reusable annotation into @OA\Schemas.

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.

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).

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).

Expands PHP enums.

Determines schema, enum and type.

Use the Schema context to extract useful information and inject that into the annotation.

Merges properties.

Use the RequestBody context to extract useful information and inject that into the annotation.

Use the property context to extract useful information and inject that into the annotation.

Build the openapi->paths using the detected @OA\PathItem and @OA\Operation (@OA\Get, @OA\Post, etc).

Config settings

augmentParameters.augmentOperationParameters : bool

No details available.

Split JsonContent into Schema and MediaType.

Split XmlContent into Schema and MediaType.

Generate the OperationId based on the context of the OpenApi annotation.

Config settings

operationId.hash : bool

No details available.