Package 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 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	Description
OpenApiJsonSchemaMapper()

Method Summary

Modifier and Type	Method	Description
Schema.Builder	updateSchema(JsonSchemaMapperContext context, Schema.Builder builder)	Updates a schema builder using information in JsonSchemaMapperContext.

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, updateSchema

Constructor Details

OpenApiJsonSchemaMapper

public OpenApiJsonSchemaMapper()

Method Details

updateSchema

public Schema.Builder updateSchema(JsonSchemaMapperContext context,
 Schema.Builder builder)

Description copied from interface: JsonSchemaMapper

Updates a schema builder using information in JsonSchemaMapperContext. If not implemented, will default to JsonSchemaMapper.updateSchema(Shape, Schema.Builder, JsonSchemaConfig) for backwards-compatibility.

Specified by:

updateSchema in interface JsonSchemaMapper

Parameters:

context - Context with information needed to update the schema.

builder - Schema builder to update.

Returns:

Returns an updated schema builder.