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

Class SpecificationExtensionsMapper

java.lang.Object

software.amazon.smithy.openapi.fromsmithy.mappers.SpecificationExtensionsMapper

All Implemented Interfaces:

OpenApiMapper

public class SpecificationExtensionsMapper
extends java.lang.Object
implements OpenApiMapper

Maps trait shapes tagged with SpecificationExtensionTrait into OpenAPI specification extensions.

Constructor Summary

Constructors

Constructor	Description
SpecificationExtensionsMapper()

Method Summary

Modifier and Type	Method	Description
OpenApi	after(Context<? extends Trait> context, OpenApi openapi)	Attach Specification Extensions to Service.
OperationObject	updateOperation(Context<? extends Trait> context, OperationShape shape, OperationObject operation, java.lang.String httpMethodName, java.lang.String path)	Attach Specification Extensions to Operation.

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, getOrder, postProcessOperation, updateDefaultSettings, updateNode, updateParameter, updatePathItem, updateRequestBody, updateResponse, updateSecurity, updateSecurityScheme

Constructor Detail

SpecificationExtensionsMapper

public SpecificationExtensionsMapper()

Method Detail

after

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

Attach Specification Extensions to Service.

Specified by:

after in interface OpenApiMapper

Parameters:

context - Conversion context.

openapi - OpenAPI object to modify.

Returns:

Returns the updated OpenApi object.

updateOperation

public OperationObject updateOperation(Context<? extends Trait> context,
                                       OperationShape shape,
                                       OperationObject operation,
                                       java.lang.String httpMethodName,
                                       java.lang.String path)

Attach Specification Extensions to Operation.

Specified by:

updateOperation in interface OpenApiMapper

Parameters:

context - Conversion context.

shape - Operation being converted.

operation - OperationObject being built.

httpMethodName - The HTTP method of the operation.

path - The HTTP URI of the operation.

Returns:

Returns the updated operation object.