software.amazon.smithy.openapi.fromsmithy

Class OpenApiJsonSchemaMapper

java.lang.Object

software.amazon.smithy.openapi.fromsmithy.OpenApiJsonSchemaMapper

All Implemented Interfaces:

JsonSchemaMapper

public final class OpenApiJsonSchemaMapper
extends java.lang.Object
implements JsonSchemaMapper

Applies OpenAPI extensions to a Schema using configuration settings found in OpenApiConfig.

Note: the properties and features added by this mapper can be removed using JsonSchemaConfig.setDisableFeatures(java.util.Set<java.lang.String>).

Constructor Summary

Constructors

Constructor and Description
OpenApiJsonSchemaMapper()

Method Summary

Modifier and Type	Method and Description
Schema.Builder	updateSchema(Shape shape, Schema.Builder builder, JsonSchemaConfig config) Updates a schema builder.

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.jsonschema.JsonSchemaMapper

getOrder

Constructor Detail

OpenApiJsonSchemaMapper

public OpenApiJsonSchemaMapper()

Method Detail

updateSchema

public Schema.Builder updateSchema(Shape shape,
                                   Schema.Builder builder,
                                   JsonSchemaConfig config)

Description copied from interface: JsonSchemaMapper

Updates a schema builder.

Specified by:

updateSchema in interface JsonSchemaMapper

Parameters:

shape - Shape used for the conversion.

builder - Schema builder to update.

config - JSON Schema config.

Returns:

Returns an updated schema builder.