software.amazon.smithy.openapi.fromsmithy.mappers

Class CheckForPrefixHeaders

java.lang.Object

software.amazon.smithy.openapi.fromsmithy.mappers.CheckForPrefixHeaders

All Implemented Interfaces:

OpenApiMapper

public class CheckForPrefixHeaders
extends java.lang.Object
implements OpenApiMapper

Checks for prefix headers in the input or output of an operation, and handles the settings for throwing an exception or warning if they're found.

Custom values for this setting need to be handled in a OpenApiProtocol.

Constructor Summary

Constructors

Constructor and Description
CheckForPrefixHeaders()

Method Summary

Modifier and Type	Method and Description
void	before(Context<? extends Trait> context, OpenApi.Builder builder) Updates an OpenApi.Builder before converting the model.
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

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

Constructor Detail

CheckForPrefixHeaders

public CheckForPrefixHeaders()

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.

before

public void before(Context<? extends Trait> context,
                   OpenApi.Builder builder)

Description copied from interface: OpenApiMapper

Updates an OpenApi.Builder before converting the model.

Specified by:

before in interface OpenApiMapper

Parameters:

context - Conversion context.

builder - OpenAPI builder to modify.