Package software.amazon.smithy.openapi.fromsmithy.mappers

Class RemoveUnusedComponents

java.lang.Object

software.amazon.smithy.openapi.fromsmithy.mappers.RemoveUnusedComponents

All Implemented Interfaces:

OpenApiMapper

public final class RemoveUnusedComponents
extends Object
implements OpenApiMapper

Removes unused components from the OpenAPI model.

This plugin will take effect by default, but can be disabled by setting "openapi.keepUnusedComponents" to true. Refs are removed in rounds until a round of removals has no effect.

TODO: This plugin currently only supports the removal of schemas and security schemes.

Constructor Summary

Constructors

Constructor	Description
RemoveUnusedComponents()

Method Summary

Modifier and Type	Method	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, postProcessOperation, updateDefaultSettings, updateNode, updateOperation, updateParameter, updatePathItem, updateRequestBody, updateResponse, updateSecurity, updateSecurityScheme

Constructor Details

RemoveUnusedComponents

public RemoveUnusedComponents()

Method Details

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.