software.amazon.smithy.openapi.fromsmithy.mappers

Class CheckForGreedyLabels

java.lang.Object

software.amazon.smithy.openapi.fromsmithy.mappers.CheckForGreedyLabels

All Implemented Interfaces:

OpenApiMapper

public class CheckForGreedyLabels
extends java.lang.Object
implements OpenApiMapper

Checks for greedy labels and fails/warns depending on configuration.

Some vendors like API Gateway support greedy labels in the form of "{foo+}", while others do not.

Constructor Summary

Constructors

Constructor and Description
CheckForGreedyLabels()

Method Summary

Modifier and Type	Method and Description
OpenApi	after(Context<? extends Trait> context, OpenApi openApi) Updates an OpenApi object after it is built.
byte	getOrder() Gets the sort order of the plugin from -128 to 127.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.smithy.openapi.fromsmithy.OpenApiMapper

before, compose, postProcessOperation, updateDefaultSettings, updateNode, updateOperation, updateParameter, updatePathItem, updateRequestBody, updateResponse, updateSecurity, updateSecurityScheme

Constructor Detail

CheckForGreedyLabels

public CheckForGreedyLabels()

Method Detail

getOrder

public byte getOrder()

Description copied from interface: OpenApiMapper

Gets the sort order of the plugin from -128 to 127.

Plugins are applied according to this sort order. Lower values are executed before higher values (for example, -128 comes before 0, comes before 127). Plugins default to 0, which is the middle point between the minimum and maximum order values.

Specified by:

getOrder in interface OpenApiMapper

Returns:

Returns the sort order, defaulting to 0.

after

public OpenApi after(Context<? extends Trait> context,
                     OpenApi openApi)

Description copied from interface: OpenApiMapper

Updates an OpenApi object after it is built.

Specified by:

after in interface OpenApiMapper

Parameters:

context - Conversion context.

openApi - OpenAPI object to modify.

Returns:

Returns the updated OpenApi object.