software.amazon.smithy.openapi.fromsmithy.mappers

Class RemoveEmptyComponents

java.lang.Object

software.amazon.smithy.openapi.fromsmithy.mappers.RemoveEmptyComponents

All Implemented Interfaces:

OpenApiMapper

public final class RemoveEmptyComponents
extends java.lang.Object
implements OpenApiMapper

Removes empty key-value pairs in the "components" of a model if empty, and removes the "components" key-value pair of a model if it is empty.

Constructor Summary

Constructors

Constructor and Description
RemoveEmptyComponents()

Method Summary

Modifier and Type	Method and Description
byte	getOrder() Gets the sort order of the plugin from -128 to 127.
ObjectNode	updateNode(Context<? extends Trait> context, OpenApi openapi, ObjectNode node) Modifies the Node/JSON representation of an OpenAPI object.

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, before, compose, postProcessOperation, updateDefaultSettings, updateOperation, updateParameter, updatePathItem, updateRequestBody, updateResponse, updateSecurity, updateSecurityScheme

Constructor Detail

RemoveEmptyComponents

public RemoveEmptyComponents()

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.

updateNode

public ObjectNode updateNode(Context<? extends Trait> context,
                             OpenApi openapi,
                             ObjectNode node)

Description copied from interface: OpenApiMapper

Modifies the Node/JSON representation of an OpenAPI object.

Specified by:

updateNode in interface OpenApiMapper

Parameters:

context - Conversion context.

openapi - OpenAPI object being converted to a node.

node - OpenAPI object node.

Returns:

Returns the updated ObjectNode.