Index (smithy-openapi 1.24.0 API)

A B C D E F G H I L M N O P R S T U V W X
All Classes and Interfaces|All Packages|Serialized Form

A

addOpenApiMapper(OpenApiMapper) - Method in class software.amazon.smithy.openapi.fromsmithy.OpenApiConverter: Adds an OpenApiMapper to the converter.
addParameter(ParameterObject) - Method in class software.amazon.smithy.openapi.model.OperationObject.Builder
addParameter(ParameterObject) - Method in class software.amazon.smithy.openapi.model.PathItem.Builder
addParameter(Ref<ParameterObject>) - Method in class software.amazon.smithy.openapi.model.PathItem.Builder
addSecurity(Map<String, List<String>>) - Method in class software.amazon.smithy.openapi.model.OpenApi.Builder
addSecurity(Map<String, List<String>>) - Method in class software.amazon.smithy.openapi.model.OperationObject.Builder
addServer(ServerObject) - Method in class software.amazon.smithy.openapi.model.OpenApi.Builder
addServer(ServerObject) - Method in class software.amazon.smithy.openapi.model.OperationObject.Builder
addServer(ServerObject) - Method in class software.amazon.smithy.openapi.model.PathItem.Builder
addTag(String) - Method in class software.amazon.smithy.openapi.model.OperationObject.Builder
addTag(TagObject) - Method in class software.amazon.smithy.openapi.model.OpenApi.Builder
after(Context<? extends Trait>, OpenApi) - Method in class software.amazon.smithy.openapi.fromsmithy.mappers.CheckForGreedyLabels
after(Context<? extends Trait>, OpenApi) - Method in class software.amazon.smithy.openapi.fromsmithy.mappers.RemoveUnusedComponents
after(Context<? extends Trait>, OpenApi) - Method in interface software.amazon.smithy.openapi.fromsmithy.OpenApiMapper: Updates an OpenApi object after it is built.
allowEmptyValue(boolean) - Method in class software.amazon.smithy.openapi.model.ParameterObject.Builder
allowReserved(boolean) - Method in class software.amazon.smithy.openapi.model.EncodingObject.Builder
allowReserved(boolean) - Method in class software.amazon.smithy.openapi.model.ParameterObject.Builder
attribute(boolean) - Method in class software.amazon.smithy.openapi.model.XmlObject.Builder
AwsRestJson1Protocol - Class in software.amazon.smithy.openapi.fromsmithy.protocols: Converts the aws.protocols#restJson1 protocol to OpenAPI.
AwsRestJson1Protocol() - Constructor for class software.amazon.smithy.openapi.fromsmithy.protocols.AwsRestJson1Protocol
AwsV4Converter - Class in software.amazon.smithy.openapi.fromsmithy.security: Adds AWS signature version in a way that"s compatible with AWS API Gateway.
AwsV4Converter() - Constructor for class software.amazon.smithy.openapi.fromsmithy.security.AwsV4Converter

B

bearerFormat(String) - Method in class software.amazon.smithy.openapi.model.SecurityScheme.Builder
before(Context<? extends Trait>, OpenApi.Builder) - Method in class software.amazon.smithy.openapi.fromsmithy.mappers.CheckForPrefixHeaders
before(Context<? extends Trait>, OpenApi.Builder) - Method in class software.amazon.smithy.openapi.fromsmithy.mappers.UnsupportedTraits
before(Context<? extends Trait>, OpenApi.Builder) - Method in interface software.amazon.smithy.openapi.fromsmithy.OpenApiMapper: Updates an OpenApi.Builder before converting the model.
build() - Method in class software.amazon.smithy.openapi.model.CallbackObject.Builder
build() - Method in class software.amazon.smithy.openapi.model.ComponentsObject.Builder
build() - Method in class software.amazon.smithy.openapi.model.EncodingObject.Builder
build() - Method in class software.amazon.smithy.openapi.model.ExampleObject.Builder
build() - Method in class software.amazon.smithy.openapi.model.ExternalDocumentation.Builder
build() - Method in class software.amazon.smithy.openapi.model.InfoObject.Builder
build() - Method in class software.amazon.smithy.openapi.model.LinkObject.Builder
build() - Method in class software.amazon.smithy.openapi.model.MediaTypeObject.Builder
build() - Method in class software.amazon.smithy.openapi.model.OpenApi.Builder
build() - Method in class software.amazon.smithy.openapi.model.OperationObject.Builder
build() - Method in class software.amazon.smithy.openapi.model.ParameterObject.Builder
build() - Method in class software.amazon.smithy.openapi.model.PathItem.Builder
build() - Method in class software.amazon.smithy.openapi.model.RequestBodyObject.Builder
build() - Method in class software.amazon.smithy.openapi.model.ResponseObject.Builder
build() - Method in class software.amazon.smithy.openapi.model.SecurityScheme.Builder
build() - Method in class software.amazon.smithy.openapi.model.ServerObject.Builder
build() - Method in class software.amazon.smithy.openapi.model.TagObject.Builder
build() - Method in class software.amazon.smithy.openapi.model.XmlObject.Builder
builder() - Static method in class software.amazon.smithy.openapi.model.CallbackObject
builder() - Static method in class software.amazon.smithy.openapi.model.ComponentsObject
builder() - Static method in class software.amazon.smithy.openapi.model.EncodingObject
builder() - Static method in class software.amazon.smithy.openapi.model.ExampleObject
builder() - Static method in class software.amazon.smithy.openapi.model.ExternalDocumentation
builder() - Static method in class software.amazon.smithy.openapi.model.InfoObject
builder() - Static method in class software.amazon.smithy.openapi.model.LinkObject
builder() - Static method in class software.amazon.smithy.openapi.model.MediaTypeObject
builder() - Static method in class software.amazon.smithy.openapi.model.OpenApi
builder() - Static method in class software.amazon.smithy.openapi.model.OperationObject
builder() - Static method in class software.amazon.smithy.openapi.model.ParameterObject
builder() - Static method in class software.amazon.smithy.openapi.model.PathItem
builder() - Static method in class software.amazon.smithy.openapi.model.RequestBodyObject
builder() - Static method in class software.amazon.smithy.openapi.model.ResponseObject
builder() - Static method in class software.amazon.smithy.openapi.model.SecurityScheme
builder() - Static method in class software.amazon.smithy.openapi.model.ServerObject
builder() - Static method in class software.amazon.smithy.openapi.model.TagObject
builder() - Static method in class software.amazon.smithy.openapi.model.XmlObject
Builder() - Constructor for class software.amazon.smithy.openapi.model.Component.Builder
Builder() - Constructor for class software.amazon.smithy.openapi.model.SecurityScheme.Builder
Builder() - Constructor for class software.amazon.smithy.openapi.model.ServerObject.Builder

C

CallbackObject - Class in software.amazon.smithy.openapi.model
CallbackObject.Builder - Class in software.amazon.smithy.openapi.model
callbacks(Map<String, CallbackObject>) - Method in class software.amazon.smithy.openapi.model.ComponentsObject.Builder
callbacks(Map<String, CallbackObject>) - Method in class software.amazon.smithy.openapi.model.OperationObject.Builder
CheckForGreedyLabels - Class in software.amazon.smithy.openapi.fromsmithy.mappers: Checks for greedy labels and fails/warns depending on configuration.
CheckForGreedyLabels() - Constructor for class software.amazon.smithy.openapi.fromsmithy.mappers.CheckForGreedyLabels
CheckForPrefixHeaders - Class in software.amazon.smithy.openapi.fromsmithy.mappers: Checks for prefix headers in the input or output of an operation, and handles the settings for throwing an exception or warning if they're found.
CheckForPrefixHeaders() - Constructor for class software.amazon.smithy.openapi.fromsmithy.mappers.CheckForPrefixHeaders
classLoader(ClassLoader) - Method in class software.amazon.smithy.openapi.fromsmithy.OpenApiConverter: Sets a ClassLoader to use to discover JsonSchemaMapper, OpenApiMapper, and OpenApiProtocol service providers through SPI.
clearSecurity() - Method in class software.amazon.smithy.openapi.model.OpenApi.Builder
clearServer() - Method in class software.amazon.smithy.openapi.model.OpenApi.Builder
clearTags() - Method in class software.amazon.smithy.openapi.model.OpenApi.Builder
Component - Class in software.amazon.smithy.openapi.model: Abstract class used for most OpenAPI model components.
Component(Component.Builder<?, ?>) - Constructor for class software.amazon.smithy.openapi.model.Component
Component.Builder<B extends Component.Builder,C extends Component> - Class in software.amazon.smithy.openapi.model
components(ComponentsObject) - Method in class software.amazon.smithy.openapi.model.OpenApi.Builder
ComponentsObject - Class in software.amazon.smithy.openapi.model
ComponentsObject.Builder - Class in software.amazon.smithy.openapi.model
compose(List<OpenApiMapper>) - Static method in interface software.amazon.smithy.openapi.fromsmithy.OpenApiMapper: Creates an OpenApiMapper that is composed of multiple mappers.
config(OpenApiConfig) - Method in class software.amazon.smithy.openapi.fromsmithy.OpenApiConverter: Set the OpenAPI configuration settings.
contact(ObjectNode) - Method in class software.amazon.smithy.openapi.model.InfoObject.Builder
content(Map<String, MediaTypeObject>) - Method in class software.amazon.smithy.openapi.model.ParameterObject.Builder
content(Map<String, MediaTypeObject>) - Method in class software.amazon.smithy.openapi.model.RequestBodyObject.Builder
content(Map<String, MediaTypeObject>) - Method in class software.amazon.smithy.openapi.model.ResponseObject.Builder
contentType(String) - Method in class software.amazon.smithy.openapi.model.EncodingObject.Builder
Context<T extends software.amazon.smithy.model.traits.Trait> - Class in software.amazon.smithy.openapi.fromsmithy: Smithy to OpenAPI conversion context object.
convert(Model) - Method in class software.amazon.smithy.openapi.fromsmithy.OpenApiConverter: Converts the Smithy model to OpenAPI.
convertToNode(Model) - Method in class software.amazon.smithy.openapi.fromsmithy.OpenApiConverter: Converts the given service shape to a JSON/Node representation of an OpenAPI model using the given Smithy model.
CoreExtension - Class in software.amazon.smithy.openapi.fromsmithy: Registers the core Smithy2OpenApi functionality.
CoreExtension() - Constructor for class software.amazon.smithy.openapi.fromsmithy.CoreExtension
create() - Static method in class software.amazon.smithy.openapi.fromsmithy.OpenApiConverter
create(String, String, OperationObject.Builder) - Static method in class software.amazon.smithy.openapi.fromsmithy.OpenApiProtocol.Operation: Creates a new operation entry.
createNodeBuilder() - Method in class software.amazon.smithy.openapi.model.CallbackObject
createNodeBuilder() - Method in class software.amazon.smithy.openapi.model.Component
createNodeBuilder() - Method in class software.amazon.smithy.openapi.model.ComponentsObject
createNodeBuilder() - Method in class software.amazon.smithy.openapi.model.EncodingObject
createNodeBuilder() - Method in class software.amazon.smithy.openapi.model.ExampleObject
createNodeBuilder() - Method in class software.amazon.smithy.openapi.model.ExternalDocumentation
createNodeBuilder() - Method in class software.amazon.smithy.openapi.model.InfoObject
createNodeBuilder() - Method in class software.amazon.smithy.openapi.model.LinkObject
createNodeBuilder() - Method in class software.amazon.smithy.openapi.model.MediaTypeObject
createNodeBuilder() - Method in class software.amazon.smithy.openapi.model.OpenApi
createNodeBuilder() - Method in class software.amazon.smithy.openapi.model.OperationObject
createNodeBuilder() - Method in class software.amazon.smithy.openapi.model.ParameterObject
createNodeBuilder() - Method in class software.amazon.smithy.openapi.model.PathItem
createNodeBuilder() - Method in class software.amazon.smithy.openapi.model.RequestBodyObject
createNodeBuilder() - Method in class software.amazon.smithy.openapi.model.ResponseObject
createNodeBuilder() - Method in class software.amazon.smithy.openapi.model.SecurityScheme
createNodeBuilder() - Method in class software.amazon.smithy.openapi.model.ServerObject
createNodeBuilder() - Method in class software.amazon.smithy.openapi.model.TagObject
createNodeBuilder() - Method in class software.amazon.smithy.openapi.model.XmlObject
createOperation(Context<T>, OperationShape) - Method in interface software.amazon.smithy.openapi.fromsmithy.OpenApiProtocol: Creates an operation entry, including the method, URI, and operation object builder.
createOperation(Context<RestJson1Trait>, OperationShape) - Method in class software.amazon.smithy.openapi.fromsmithy.protocols.AwsRestJson1Protocol
createRef(ToShapeId) - Method in class software.amazon.smithy.openapi.fromsmithy.Context: Creates a schema that contains a $ref that points to a schema component.
createSecurityRequirements(Context<? extends Trait>, T, Shape) - Method in interface software.amazon.smithy.openapi.fromsmithy.SecuritySchemeConverter: Creates a "security" requirements property to apply to an operation or top-level service using the Smithy auth scheme name as the key.
createSecurityScheme(Context<? extends Trait>, SigV4Trait) - Method in class software.amazon.smithy.openapi.fromsmithy.security.AwsV4Converter
createSecurityScheme(Context<? extends Trait>, HttpApiKeyAuthTrait) - Method in class software.amazon.smithy.openapi.fromsmithy.security.HttpApiKeyAuthConverter
createSecurityScheme(Context<? extends Trait>, HttpBasicAuthTrait) - Method in class software.amazon.smithy.openapi.fromsmithy.security.HttpBasicConverter
createSecurityScheme(Context<? extends Trait>, HttpBearerAuthTrait) - Method in class software.amazon.smithy.openapi.fromsmithy.security.HttpBearerConverter
createSecurityScheme(Context<? extends Trait>, HttpDigestAuthTrait) - Method in class software.amazon.smithy.openapi.fromsmithy.security.HttpDigestConverter
createSecurityScheme(Context<? extends Trait>, T) - Method in interface software.amazon.smithy.openapi.fromsmithy.SecuritySchemeConverter: Creates an OpenAPI security scheme.

D

delete(OperationObject) - Method in class software.amazon.smithy.openapi.model.PathItem.Builder
deprecated(boolean) - Method in class software.amazon.smithy.openapi.model.OperationObject.Builder
deprecated(boolean) - Method in class software.amazon.smithy.openapi.model.ParameterObject.Builder
deref(ComponentsObject) - Method in class software.amazon.smithy.openapi.model.Ref: Dereferences the value stored in a ref.
description(String) - Method in class software.amazon.smithy.openapi.model.ExampleObject.Builder
description(String) - Method in class software.amazon.smithy.openapi.model.ExternalDocumentation.Builder
description(String) - Method in class software.amazon.smithy.openapi.model.InfoObject.Builder
description(String) - Method in class software.amazon.smithy.openapi.model.LinkObject.Builder
description(String) - Method in class software.amazon.smithy.openapi.model.OperationObject.Builder
description(String) - Method in class software.amazon.smithy.openapi.model.ParameterObject.Builder
description(String) - Method in class software.amazon.smithy.openapi.model.PathItem.Builder
description(String) - Method in class software.amazon.smithy.openapi.model.RequestBodyObject.Builder
description(String) - Method in class software.amazon.smithy.openapi.model.ResponseObject.Builder
description(String) - Method in class software.amazon.smithy.openapi.model.SecurityScheme.Builder
description(String) - Method in class software.amazon.smithy.openapi.model.ServerObject.Builder
description(String) - Method in class software.amazon.smithy.openapi.model.TagObject.Builder

E

encoding(Map<String, EncodingObject>) - Method in class software.amazon.smithy.openapi.model.MediaTypeObject.Builder
EncodingObject - Class in software.amazon.smithy.openapi.model
EncodingObject.Builder - Class in software.amazon.smithy.openapi.model
equals(Object) - Method in class software.amazon.smithy.openapi.model.Component
example(Node) - Method in class software.amazon.smithy.openapi.model.MediaTypeObject.Builder
example(Node) - Method in class software.amazon.smithy.openapi.model.ParameterObject.Builder
ExampleObject - Class in software.amazon.smithy.openapi.model
ExampleObject.Builder - Class in software.amazon.smithy.openapi.model
examples(Map<String, Node>) - Method in class software.amazon.smithy.openapi.model.MediaTypeObject.Builder
examples(Map<String, Node>) - Method in class software.amazon.smithy.openapi.model.ParameterObject.Builder
execute(PluginContext) - Method in class software.amazon.smithy.openapi.fromsmithy.Smithy2OpenApi
explode(boolean) - Method in class software.amazon.smithy.openapi.model.EncodingObject.Builder
explode(boolean) - Method in class software.amazon.smithy.openapi.model.ParameterObject.Builder
extensions(Map<String, Node>) - Method in class software.amazon.smithy.openapi.model.Component.Builder
extensions(ObjectNode) - Method in class software.amazon.smithy.openapi.model.Component.Builder
externalDocs(ExternalDocumentation) - Method in class software.amazon.smithy.openapi.model.OpenApi.Builder
externalDocs(ExternalDocumentation) - Method in class software.amazon.smithy.openapi.model.OperationObject.Builder
externalDocs(ExternalDocumentation) - Method in class software.amazon.smithy.openapi.model.TagObject.Builder
ExternalDocumentation - Class in software.amazon.smithy.openapi.model
ExternalDocumentation.Builder - Class in software.amazon.smithy.openapi.model
externalValue(String) - Method in class software.amazon.smithy.openapi.model.ExampleObject.Builder

F

FAIL - Enum constant in enum class software.amazon.smithy.openapi.OpenApiConfig.HttpPrefixHeadersStrategy: The default setting that causes the build to fail.
flows(ObjectNode) - Method in class software.amazon.smithy.openapi.model.SecurityScheme.Builder
fromNode(Node) - Static method in class software.amazon.smithy.openapi.model.ExampleObject
fromNode(Node) - Static method in class software.amazon.smithy.openapi.OpenApiConfig: Creates an OpenApiConfig from a Node value.

G

get(OperationObject) - Method in class software.amazon.smithy.openapi.model.PathItem.Builder
getAllSecuritySchemeRequestHeaders() - Method in class software.amazon.smithy.openapi.fromsmithy.Context: Gets an alphabetically sorted set of request headers used by every security scheme associated with the API.
getAllSecuritySchemeResponseHeaders() - Method in class software.amazon.smithy.openapi.fromsmithy.Context: Gets an alphabetically sorted set of response headers used by every security scheme associated with the API.
getAuthRequestHeaders(Context<? extends Trait>, SigV4Trait) - Method in class software.amazon.smithy.openapi.fromsmithy.security.AwsV4Converter
getAuthRequestHeaders(Context<? extends Trait>, HttpApiKeyAuthTrait) - Method in class software.amazon.smithy.openapi.fromsmithy.security.HttpApiKeyAuthConverter
getAuthRequestHeaders(Context<? extends Trait>, T) - Method in interface software.amazon.smithy.openapi.fromsmithy.SecuritySchemeConverter: Gets the names of the headers set on HTTP requests used by this authentication scheme.
getAuthResponseHeaders(Context<? extends Trait>, T) - Method in interface software.amazon.smithy.openapi.fromsmithy.SecuritySchemeConverter: Gets the names of the headers set on HTTP responses used by this authentication scheme.
getAuthSchemeId() - Method in interface software.amazon.smithy.openapi.fromsmithy.SecuritySchemeConverter: Gets the shape ID of the auth scheme type.
getAuthSchemeType() - Method in class software.amazon.smithy.openapi.fromsmithy.security.AwsV4Converter
getAuthSchemeType() - Method in class software.amazon.smithy.openapi.fromsmithy.security.HttpApiKeyAuthConverter
getAuthSchemeType() - Method in class software.amazon.smithy.openapi.fromsmithy.security.HttpBasicConverter
getAuthSchemeType() - Method in class software.amazon.smithy.openapi.fromsmithy.security.HttpBearerConverter
getAuthSchemeType() - Method in class software.amazon.smithy.openapi.fromsmithy.security.HttpDigestConverter
getAuthSchemeType() - Method in interface software.amazon.smithy.openapi.fromsmithy.SecuritySchemeConverter: Get the U that matches this converter.
getBearerFormat() - Method in class software.amazon.smithy.openapi.model.SecurityScheme
getCallbacks() - Method in class software.amazon.smithy.openapi.model.ComponentsObject
getCallbacks() - Method in class software.amazon.smithy.openapi.model.OperationObject
getComponents() - Method in class software.amazon.smithy.openapi.model.OpenApi
getConfig() - Method in class software.amazon.smithy.openapi.fromsmithy.Context: Gets the configuration object used for the conversion.
getConfig() - Method in class software.amazon.smithy.openapi.fromsmithy.OpenApiConverter: Get the OpenAPI configuration settings.
getContact() - Method in class software.amazon.smithy.openapi.model.InfoObject
getContent() - Method in class software.amazon.smithy.openapi.model.ParameterObject
getContent() - Method in class software.amazon.smithy.openapi.model.RequestBodyObject
getContent() - Method in class software.amazon.smithy.openapi.model.ResponseObject
getContentType() - Method in class software.amazon.smithy.openapi.model.EncodingObject
getDefaultBlobFormat() - Method in class software.amazon.smithy.openapi.OpenApiConfig
getDelete() - Method in class software.amazon.smithy.openapi.model.PathItem
getDescription() - Method in class software.amazon.smithy.openapi.model.ExampleObject
getDescription() - Method in class software.amazon.smithy.openapi.model.ExternalDocumentation
getDescription() - Method in class software.amazon.smithy.openapi.model.InfoObject
getDescription() - Method in class software.amazon.smithy.openapi.model.LinkObject
getDescription() - Method in class software.amazon.smithy.openapi.model.OperationObject
getDescription() - Method in class software.amazon.smithy.openapi.model.ParameterObject
getDescription() - Method in class software.amazon.smithy.openapi.model.PathItem
getDescription() - Method in class software.amazon.smithy.openapi.model.RequestBodyObject
getDescription() - Method in class software.amazon.smithy.openapi.model.ResponseObject
getDescription() - Method in class software.amazon.smithy.openapi.model.SecurityScheme
getDescription() - Method in class software.amazon.smithy.openapi.model.ServerObject
getDescription() - Method in class software.amazon.smithy.openapi.model.TagObject
getEncoding() - Method in class software.amazon.smithy.openapi.model.MediaTypeObject
getEventStreamMediaType(Context<RestJson1Trait>, EventStreamInfo) - Method in class software.amazon.smithy.openapi.fromsmithy.protocols.AwsRestJson1Protocol: Gets the media type of an event stream for the protocol.
getExample() - Method in class software.amazon.smithy.openapi.model.MediaTypeObject
getExample() - Method in class software.amazon.smithy.openapi.model.ParameterObject
getExamples() - Method in class software.amazon.smithy.openapi.model.MediaTypeObject
getExamples() - Method in class software.amazon.smithy.openapi.model.ParameterObject
getExtension(String) - Method in class software.amazon.smithy.openapi.model.Component
getExtensions() - Method in class software.amazon.smithy.openapi.model.Component.Builder
getExtensions() - Method in class software.amazon.smithy.openapi.model.Component
getExternalDocs() - Method in class software.amazon.smithy.openapi.model.OpenApi
getExternalDocs() - Method in class software.amazon.smithy.openapi.model.OperationObject
getExternalDocs() - Method in class software.amazon.smithy.openapi.model.TagObject
getExternalDocs() - Method in class software.amazon.smithy.openapi.OpenApiConfig
getExternalValue() - Method in class software.amazon.smithy.openapi.model.ExampleObject
getFlows() - Method in class software.amazon.smithy.openapi.model.SecurityScheme
getForbidGreedyLabels() - Method in class software.amazon.smithy.openapi.OpenApiConfig
getGet() - Method in class software.amazon.smithy.openapi.model.PathItem
getHead() - Method in class software.amazon.smithy.openapi.model.PathItem
getHeader(String) - Method in class software.amazon.smithy.openapi.model.ResponseObject: Gets a header by case-insensitive header name.
getHeaders() - Method in class software.amazon.smithy.openapi.model.ComponentsObject
getHeaders() - Method in class software.amazon.smithy.openapi.model.EncodingObject
getHeaders() - Method in class software.amazon.smithy.openapi.model.ResponseObject
getIgnoreUnsupportedTraits() - Method in class software.amazon.smithy.openapi.OpenApiConfig
getIn() - Method in class software.amazon.smithy.openapi.model.ParameterObject
getIn() - Method in class software.amazon.smithy.openapi.model.SecurityScheme
getInfo() - Method in class software.amazon.smithy.openapi.model.OpenApi
getJsonAdd() - Method in class software.amazon.smithy.openapi.OpenApiConfig
getJsonContentType() - Method in class software.amazon.smithy.openapi.OpenApiConfig
getJsonSchemaConverter() - Method in class software.amazon.smithy.openapi.fromsmithy.Context: Gets the JSON schema converter.
getJsonSchemaMappers() - Method in class software.amazon.smithy.openapi.fromsmithy.CoreExtension
getJsonSchemaMappers() - Method in interface software.amazon.smithy.openapi.fromsmithy.Smithy2OpenApiExtension: Registers JsonSchema mappers that are used to modify JsonSchema definitions created from a Smithy model.
getKeepUnusedComponents() - Method in class software.amazon.smithy.openapi.OpenApiConfig
getLicense() - Method in class software.amazon.smithy.openapi.model.InfoObject
getLinks() - Method in class software.amazon.smithy.openapi.model.ComponentsObject
getLinks() - Method in class software.amazon.smithy.openapi.model.ResponseObject
getMethod() - Method in class software.amazon.smithy.openapi.fromsmithy.OpenApiProtocol.Operation
getModel() - Method in class software.amazon.smithy.openapi.fromsmithy.Context: Gets the Smithy model being converted.
getName() - Method in class software.amazon.smithy.openapi.fromsmithy.Smithy2OpenApi
getName() - Method in class software.amazon.smithy.openapi.model.ParameterObject
getName() - Method in class software.amazon.smithy.openapi.model.SecurityScheme
getName() - Method in class software.amazon.smithy.openapi.model.TagObject
getName() - Method in class software.amazon.smithy.openapi.model.XmlObject
getNamespace() - Method in class software.amazon.smithy.openapi.model.XmlObject
getOnHttpPrefixHeaders() - Method in class software.amazon.smithy.openapi.OpenApiConfig
getOpenapi() - Method in class software.amazon.smithy.openapi.model.OpenApi
getOpenApiAuthSchemeName() - Method in interface software.amazon.smithy.openapi.fromsmithy.SecuritySchemeConverter: Gets the name of OpenApi auth scheme.
getOpenApiMappers() - Method in class software.amazon.smithy.openapi.fromsmithy.CoreExtension
getOpenApiMappers() - Method in interface software.amazon.smithy.openapi.fromsmithy.Smithy2OpenApiExtension: Registers OpenAPI mappers, classes used to modify and extend the process of converting a Smithy model to OpenAPI.
getOpenApiProtocol() - Method in class software.amazon.smithy.openapi.fromsmithy.Context: Gets the OpenAPI protocol conversion object.
getOpenIdConnectUrl() - Method in class software.amazon.smithy.openapi.model.SecurityScheme
getOperation() - Method in class software.amazon.smithy.openapi.fromsmithy.OpenApiProtocol.Operation
getOperationId() - Method in class software.amazon.smithy.openapi.model.LinkObject
getOperationId() - Method in class software.amazon.smithy.openapi.model.OperationObject
getOperationMethod(Context<T>, OperationShape) - Method in interface software.amazon.smithy.openapi.fromsmithy.OpenApiProtocol: Gets the HTTP method of an operation.
getOperationRef() - Method in class software.amazon.smithy.openapi.model.LinkObject
getOperationResponseStatusCode(Context<T>, ToShapeId) - Method in interface software.amazon.smithy.openapi.fromsmithy.OpenApiProtocol: Gets the response status code of an operation or error shape.
getOperations() - Method in class software.amazon.smithy.openapi.model.PathItem
getOperationUri(Context<T>, OperationShape) - Method in interface software.amazon.smithy.openapi.fromsmithy.OpenApiProtocol: Gets the URI of an operation.
getOptions() - Method in class software.amazon.smithy.openapi.model.PathItem
getOrder() - Method in class software.amazon.smithy.openapi.fromsmithy.mappers.CheckForGreedyLabels
getOrder() - Method in class software.amazon.smithy.openapi.fromsmithy.mappers.CheckForPrefixHeaders
getOrder() - Method in class software.amazon.smithy.openapi.fromsmithy.mappers.OpenApiJsonAdd
getOrder() - Method in class software.amazon.smithy.openapi.fromsmithy.mappers.OpenApiJsonSubstitutions
getOrder() - Method in class software.amazon.smithy.openapi.fromsmithy.mappers.RemoveEmptyComponents
getOrder() - Method in class software.amazon.smithy.openapi.fromsmithy.mappers.RemoveUnusedComponents
getOrder() - Method in class software.amazon.smithy.openapi.fromsmithy.mappers.UnsupportedTraits
getOrder() - Method in interface software.amazon.smithy.openapi.fromsmithy.OpenApiMapper: Gets the sort order of the plugin from -128 to 127.
getParameters() - Method in class software.amazon.smithy.openapi.model.ComponentsObject
getParameters() - Method in class software.amazon.smithy.openapi.model.LinkObject
getParameters() - Method in class software.amazon.smithy.openapi.model.OperationObject
getParameters() - Method in class software.amazon.smithy.openapi.model.PathItem
getPatch() - Method in class software.amazon.smithy.openapi.model.PathItem
getPaths() - Method in class software.amazon.smithy.openapi.model.CallbackObject
getPaths() - Method in class software.amazon.smithy.openapi.model.OpenApi
getPointer() - Method in class software.amazon.smithy.openapi.model.Ref: Gets the JSON pointer to the component.
getPointer(ToShapeId) - Method in class software.amazon.smithy.openapi.fromsmithy.Context: Gets the JSON pointer string to a specific shape.
getPost() - Method in class software.amazon.smithy.openapi.model.PathItem
getPrefix() - Method in class software.amazon.smithy.openapi.model.XmlObject
getProtocol() - Method in class software.amazon.smithy.openapi.OpenApiConfig
getProtocolRequestHeaders(Context<RestJson1Trait>, OperationShape) - Method in class software.amazon.smithy.openapi.fromsmithy.protocols.AwsRestJson1Protocol
getProtocolRequestHeaders(Context<T>, OperationShape) - Method in interface software.amazon.smithy.openapi.fromsmithy.OpenApiProtocol: Gets the unmodeled protocol-specific HTTP headers of a request that are considered significant for the provided operation.
getProtocolResponseHeaders(Context<RestJson1Trait>, OperationShape) - Method in class software.amazon.smithy.openapi.fromsmithy.protocols.AwsRestJson1Protocol
getProtocolResponseHeaders(Context<T>, OperationShape) - Method in interface software.amazon.smithy.openapi.fromsmithy.OpenApiProtocol: Gets the unmodeled protocol-specific HTTP headers of a response that are considered significant for the provided operation.
getProtocols() - Method in class software.amazon.smithy.openapi.fromsmithy.CoreExtension
getProtocols() - Method in interface software.amazon.smithy.openapi.fromsmithy.Smithy2OpenApiExtension: Registers additional protocols that handle serialization and deserialization.
getProtocolTrait() - Method in class software.amazon.smithy.openapi.fromsmithy.Context: Gets the protocol trait that is being converted.
getProtocolType() - Method in interface software.amazon.smithy.openapi.fromsmithy.OpenApiProtocol: Gets the protocol type that this converter handles.
getProtocolType() - Method in class software.amazon.smithy.openapi.fromsmithy.protocols.AwsRestJson1Protocol
getPut() - Method in class software.amazon.smithy.openapi.model.PathItem
getRemoveGreedyParameterSuffix() - Method in class software.amazon.smithy.openapi.OpenApiConfig
getRequestBodies() - Method in class software.amazon.smithy.openapi.model.ComponentsObject
getRequestBody() - Method in class software.amazon.smithy.openapi.model.LinkObject
getRequestBody() - Method in class software.amazon.smithy.openapi.model.OperationObject
getResponses() - Method in class software.amazon.smithy.openapi.model.ComponentsObject
getResponses() - Method in class software.amazon.smithy.openapi.model.OperationObject
getSchema() - Method in class software.amazon.smithy.openapi.model.MediaTypeObject
getSchema() - Method in class software.amazon.smithy.openapi.model.ParameterObject
getSchema(String) - Method in class software.amazon.smithy.openapi.fromsmithy.Context: Gets a converted schema from the context object by JSON pointer and throws if the schema does not exist.
getSchemas() - Method in class software.amazon.smithy.openapi.model.ComponentsObject
getScheme() - Method in class software.amazon.smithy.openapi.model.SecurityScheme
getSecurity() - Method in class software.amazon.smithy.openapi.model.OpenApi
getSecurity() - Method in class software.amazon.smithy.openapi.model.OperationObject
getSecuritySchemeConverters() - Method in class software.amazon.smithy.openapi.fromsmithy.Context: Gets the security scheme converters that are compatible with the selected protocol.
getSecuritySchemeConverters() - Method in class software.amazon.smithy.openapi.fromsmithy.CoreExtension
getSecuritySchemeConverters() - Method in interface software.amazon.smithy.openapi.fromsmithy.Smithy2OpenApiExtension: Registers additional security scheme converters.
getSecuritySchemes() - Method in class software.amazon.smithy.openapi.model.ComponentsObject
getServer() - Method in class software.amazon.smithy.openapi.model.LinkObject
getServers() - Method in class software.amazon.smithy.openapi.model.OpenApi
getServers() - Method in class software.amazon.smithy.openapi.model.OperationObject
getServers() - Method in class software.amazon.smithy.openapi.model.PathItem
getService() - Method in class software.amazon.smithy.openapi.fromsmithy.Context: Gets the service shape being converted.
getStyle() - Method in class software.amazon.smithy.openapi.model.EncodingObject
getStyle() - Method in class software.amazon.smithy.openapi.model.ParameterObject
getSubstitutions() - Method in class software.amazon.smithy.openapi.OpenApiConfig
getSummary() - Method in class software.amazon.smithy.openapi.model.ExampleObject
getSummary() - Method in class software.amazon.smithy.openapi.model.OperationObject
getSummary() - Method in class software.amazon.smithy.openapi.model.PathItem
getSupportedTags() - Method in class software.amazon.smithy.openapi.OpenApiConfig
getSynthesizedSchemas() - Method in class software.amazon.smithy.openapi.fromsmithy.Context: Gets all of the synthesized schemas that needed to be created while generating the OpenAPI artifact.
getTags() - Method in class software.amazon.smithy.openapi.model.OpenApi
getTags() - Method in class software.amazon.smithy.openapi.model.OperationObject
getTags() - Method in class software.amazon.smithy.openapi.OpenApiConfig
getTermsOfService() - Method in class software.amazon.smithy.openapi.model.InfoObject
getTitle() - Method in class software.amazon.smithy.openapi.model.InfoObject
getTrace() - Method in class software.amazon.smithy.openapi.model.PathItem
getType() - Method in class software.amazon.smithy.openapi.model.SecurityScheme
getUri() - Method in class software.amazon.smithy.openapi.fromsmithy.OpenApiProtocol.Operation
getUrl() - Method in class software.amazon.smithy.openapi.model.ExternalDocumentation
getUrl() - Method in class software.amazon.smithy.openapi.model.ServerObject
getUseIntegerType() - Method in class software.amazon.smithy.openapi.OpenApiConfig
getValue() - Method in class software.amazon.smithy.openapi.model.ExampleObject
getVariables() - Method in class software.amazon.smithy.openapi.model.ServerObject
getVersion() - Method in class software.amazon.smithy.openapi.model.InfoObject
getVersion() - Method in class software.amazon.smithy.openapi.OpenApiConfig

H

hashCode() - Method in class software.amazon.smithy.openapi.model.Component
head(OperationObject) - Method in class software.amazon.smithy.openapi.model.PathItem.Builder
headers(Map<String, ParameterObject>) - Method in class software.amazon.smithy.openapi.model.ComponentsObject.Builder
headers(Map<String, ParameterObject>) - Method in class software.amazon.smithy.openapi.model.EncodingObject.Builder
headers(Map<String, Ref<ParameterObject>>) - Method in class software.amazon.smithy.openapi.model.ResponseObject.Builder
HttpApiKeyAuthConverter - Class in software.amazon.smithy.openapi.fromsmithy.security: Uses an HTTP header named X-Api-Key that contains an API key.
HttpApiKeyAuthConverter() - Constructor for class software.amazon.smithy.openapi.fromsmithy.security.HttpApiKeyAuthConverter
HttpBasicConverter - Class in software.amazon.smithy.openapi.fromsmithy.security: Applies Basic HTTP auth.
HttpBasicConverter() - Constructor for class software.amazon.smithy.openapi.fromsmithy.security.HttpBasicConverter
HttpBearerConverter - Class in software.amazon.smithy.openapi.fromsmithy.security: Uses the Bearer scheme of the Authentication header.
HttpBearerConverter() - Constructor for class software.amazon.smithy.openapi.fromsmithy.security.HttpBearerConverter
HttpDigestConverter - Class in software.amazon.smithy.openapi.fromsmithy.security: Applies Digest HTTP auth.
HttpDigestConverter() - Constructor for class software.amazon.smithy.openapi.fromsmithy.security.HttpDigestConverter

I

in(String) - Method in class software.amazon.smithy.openapi.model.ParameterObject.Builder
in(String) - Method in class software.amazon.smithy.openapi.model.SecurityScheme.Builder
info(InfoObject) - Method in class software.amazon.smithy.openapi.model.OpenApi.Builder
InfoObject - Class in software.amazon.smithy.openapi.model
InfoObject.Builder - Class in software.amazon.smithy.openapi.model
inlineOrReferenceSchema(MemberShape) - Method in class software.amazon.smithy.openapi.fromsmithy.Context: Gets the exiting schema of the shape if it's meant to be inlined, otherwise creates a $ref to the shape if it is meant to be reused across the generated schema.
isAllowEmptyValue() - Method in class software.amazon.smithy.openapi.model.ParameterObject
isAllowReserved() - Method in class software.amazon.smithy.openapi.model.EncodingObject
isAllowReserved() - Method in class software.amazon.smithy.openapi.model.ParameterObject
isAttribute() - Method in class software.amazon.smithy.openapi.model.XmlObject
isDeprecated() - Method in class software.amazon.smithy.openapi.model.OperationObject
isDeprecated() - Method in class software.amazon.smithy.openapi.model.ParameterObject
isEmpty() - Method in class software.amazon.smithy.openapi.model.ServerObject
isExplode() - Method in class software.amazon.smithy.openapi.model.EncodingObject
isExplode() - Method in class software.amazon.smithy.openapi.model.ParameterObject
isRequired() - Method in class software.amazon.smithy.openapi.model.ParameterObject
isRequired() - Method in class software.amazon.smithy.openapi.model.RequestBodyObject
isWrapped() - Method in class software.amazon.smithy.openapi.model.XmlObject

L

license(ObjectNode) - Method in class software.amazon.smithy.openapi.model.InfoObject.Builder
LinkObject - Class in software.amazon.smithy.openapi.model
LinkObject.Builder - Class in software.amazon.smithy.openapi.model
links(Map<String, LinkObject>) - Method in class software.amazon.smithy.openapi.model.ComponentsObject.Builder
links(Map<String, Ref<LinkObject>>) - Method in class software.amazon.smithy.openapi.model.ResponseObject.Builder
local(T) - Static method in class software.amazon.smithy.openapi.model.Ref: Creates a local ref to a value that is inlined.

M

MediaTypeObject - Class in software.amazon.smithy.openapi.model
MediaTypeObject.Builder - Class in software.amazon.smithy.openapi.model

N

name(String) - Method in class software.amazon.smithy.openapi.model.ParameterObject.Builder
name(String) - Method in class software.amazon.smithy.openapi.model.SecurityScheme.Builder
name(String) - Method in class software.amazon.smithy.openapi.model.TagObject.Builder
name(String) - Method in class software.amazon.smithy.openapi.model.XmlObject.Builder
namespace(String) - Method in class software.amazon.smithy.openapi.model.XmlObject.Builder

O

openapi(String) - Method in class software.amazon.smithy.openapi.model.OpenApi.Builder
OpenApi - Class in software.amazon.smithy.openapi.model
OpenApi.Builder - Class in software.amazon.smithy.openapi.model
OpenApiConfig - Class in software.amazon.smithy.openapi: "openapi" smithy-build plugin configuration settings.
OpenApiConfig() - Constructor for class software.amazon.smithy.openapi.OpenApiConfig
OpenApiConfig.HttpPrefixHeadersStrategy - Enum Class in software.amazon.smithy.openapi: Specifies what to do when the httpPrefixHeaders trait is found in a model.
OpenApiConverter - Class in software.amazon.smithy.openapi.fromsmithy: Converts a Smithy model to OpenAPI.
OpenApiException - Exception in software.amazon.smithy.openapi
OpenApiException(RuntimeException) - Constructor for exception software.amazon.smithy.openapi.OpenApiException
OpenApiException(String) - Constructor for exception software.amazon.smithy.openapi.OpenApiException
OpenApiException(String, Throwable) - Constructor for exception software.amazon.smithy.openapi.OpenApiException
OpenApiJsonAdd - Class in software.amazon.smithy.openapi.fromsmithy.mappers: Adds JSON values into the generated OpenAPI model using a JSON Patch like "add" operation that also generated intermediate objects as needed.
OpenApiJsonAdd() - Constructor for class software.amazon.smithy.openapi.fromsmithy.mappers.OpenApiJsonAdd
OpenApiJsonSchemaMapper - Class in software.amazon.smithy.openapi.fromsmithy: Applies OpenAPI extensions to a Schema using configuration settings found in OpenApiConfig.
OpenApiJsonSchemaMapper() - Constructor for class software.amazon.smithy.openapi.fromsmithy.OpenApiJsonSchemaMapper
OpenApiJsonSubstitutions - Class in software.amazon.smithy.openapi.fromsmithy.mappers: Substitutes JSON string values using the mapping defined in openapi.substitutions.
OpenApiJsonSubstitutions() - Constructor for class software.amazon.smithy.openapi.fromsmithy.mappers.OpenApiJsonSubstitutions
OpenApiMapper - Interface in software.amazon.smithy.openapi.fromsmithy: Provides a plugin infrastructure used to hook into the Smithy to OpenAPI conversion process and map over the result.
OpenApiProtocol<T extends software.amazon.smithy.model.traits.Trait> - Interface in software.amazon.smithy.openapi.fromsmithy: An OpenAPI protocol is used to convert a Smithy protocol into HTTP-specific bindings.
OpenApiProtocol.Operation - Class in software.amazon.smithy.openapi.fromsmithy: Represents an operation entry to add to an OpenApi.Builder.
OpenApiVersion - Enum Class in software.amazon.smithy.openapi: OpenAPI versions supported by the converter.
openIdConnectUrl(String) - Method in class software.amazon.smithy.openapi.model.SecurityScheme.Builder
operationId(String) - Method in class software.amazon.smithy.openapi.model.LinkObject.Builder
operationId(String) - Method in class software.amazon.smithy.openapi.model.OperationObject.Builder
OperationObject - Class in software.amazon.smithy.openapi.model
OperationObject.Builder - Class in software.amazon.smithy.openapi.model
operationRef(String) - Method in class software.amazon.smithy.openapi.model.LinkObject.Builder
operations() - Method in class software.amazon.smithy.openapi.model.PathItem
options(OperationObject) - Method in class software.amazon.smithy.openapi.model.PathItem.Builder

P

ParameterObject - Class in software.amazon.smithy.openapi.model
ParameterObject.Builder - Class in software.amazon.smithy.openapi.model
parameters(Collection<ParameterObject>) - Method in class software.amazon.smithy.openapi.model.OperationObject.Builder
parameters(List<Ref<ParameterObject>>) - Method in class software.amazon.smithy.openapi.model.PathItem.Builder
parameters(Map<String, Node>) - Method in class software.amazon.smithy.openapi.model.LinkObject.Builder
parameters(Map<String, ParameterObject>) - Method in class software.amazon.smithy.openapi.model.ComponentsObject.Builder
patch(OperationObject) - Method in class software.amazon.smithy.openapi.model.PathItem.Builder
PathItem - Class in software.amazon.smithy.openapi.model
PathItem.Builder - Class in software.amazon.smithy.openapi.model
paths(Map<String, PathItem>) - Method in class software.amazon.smithy.openapi.model.CallbackObject.Builder
paths(Map<String, PathItem>) - Method in class software.amazon.smithy.openapi.model.OpenApi.Builder
post(OperationObject) - Method in class software.amazon.smithy.openapi.model.PathItem.Builder
postProcessOperation(Context<? extends Trait>, OperationShape, OperationObject, String, String) - Method in interface software.amazon.smithy.openapi.fromsmithy.OpenApiMapper: Updates an operation after invoking the plugin system on the contents of the operation (specifically, after OpenApiMapper.updateOperation(software.amazon.smithy.openapi.fromsmithy.Context<? extends software.amazon.smithy.model.traits.Trait>, software.amazon.smithy.model.shapes.OperationShape, software.amazon.smithy.openapi.model.OperationObject, java.lang.String, java.lang.String), OpenApiMapper.updateParameter(software.amazon.smithy.openapi.fromsmithy.Context<? extends software.amazon.smithy.model.traits.Trait>, software.amazon.smithy.model.shapes.OperationShape, java.lang.String, java.lang.String, software.amazon.smithy.openapi.model.ParameterObject), OpenApiMapper.updateRequestBody(software.amazon.smithy.openapi.fromsmithy.Context<? extends software.amazon.smithy.model.traits.Trait>, software.amazon.smithy.model.shapes.OperationShape, java.lang.String, java.lang.String, software.amazon.smithy.openapi.model.RequestBodyObject), OpenApiMapper.updateResponse(software.amazon.smithy.openapi.fromsmithy.Context<? extends software.amazon.smithy.model.traits.Trait>, software.amazon.smithy.model.shapes.OperationShape, java.lang.String, java.lang.String, java.lang.String, software.amazon.smithy.openapi.model.ResponseObject), and OpenApiMapper.updateRequestBody(software.amazon.smithy.openapi.fromsmithy.Context<? extends software.amazon.smithy.model.traits.Trait>, software.amazon.smithy.model.shapes.OperationShape, java.lang.String, java.lang.String, software.amazon.smithy.openapi.model.RequestBodyObject)).
prefix(String) - Method in class software.amazon.smithy.openapi.model.XmlObject.Builder
put(OperationObject) - Method in class software.amazon.smithy.openapi.model.PathItem.Builder
putCallback(String, CallbackObject) - Method in class software.amazon.smithy.openapi.model.OperationObject.Builder
putCallbacks(String, CallbackObject) - Method in class software.amazon.smithy.openapi.model.ComponentsObject.Builder
putContent(String, MediaTypeObject) - Method in class software.amazon.smithy.openapi.model.ParameterObject.Builder
putContent(String, MediaTypeObject) - Method in class software.amazon.smithy.openapi.model.RequestBodyObject.Builder
putContent(String, MediaTypeObject) - Method in class software.amazon.smithy.openapi.model.ResponseObject.Builder
putEncoding(String, EncodingObject) - Method in class software.amazon.smithy.openapi.model.MediaTypeObject.Builder
putExample(String, Node) - Method in class software.amazon.smithy.openapi.model.ParameterObject.Builder
putExample(String, ExampleObject) - Method in class software.amazon.smithy.openapi.model.MediaTypeObject.Builder
putExtension(String, Boolean) - Method in class software.amazon.smithy.openapi.model.Component.Builder
putExtension(String, Number) - Method in class software.amazon.smithy.openapi.model.Component.Builder
putExtension(String, String) - Method in class software.amazon.smithy.openapi.model.Component.Builder
putExtension(String, Node) - Method in class software.amazon.smithy.openapi.model.Component.Builder
putHeader(String, ParameterObject) - Method in class software.amazon.smithy.openapi.model.ComponentsObject.Builder
putHeader(String, ParameterObject) - Method in class software.amazon.smithy.openapi.model.EncodingObject.Builder
putHeader(String, Ref<ParameterObject>) - Method in class software.amazon.smithy.openapi.model.ResponseObject.Builder
putLink(String, LinkObject) - Method in class software.amazon.smithy.openapi.model.ComponentsObject.Builder
putLink(String, LinkObject) - Method in class software.amazon.smithy.openapi.model.ResponseObject.Builder
putLink(String, Ref<LinkObject>) - Method in class software.amazon.smithy.openapi.model.ResponseObject.Builder
putParameter(String, ParameterObject) - Method in class software.amazon.smithy.openapi.model.ComponentsObject.Builder
putPath(String, PathItem) - Method in class software.amazon.smithy.openapi.model.CallbackObject.Builder
putPath(String, PathItem) - Method in class software.amazon.smithy.openapi.model.OpenApi.Builder
putRequestBodies(String, RequestBodyObject) - Method in class software.amazon.smithy.openapi.model.ComponentsObject.Builder
putResponse(String, ResponseObject) - Method in class software.amazon.smithy.openapi.model.ComponentsObject.Builder
putResponse(String, ResponseObject) - Method in class software.amazon.smithy.openapi.model.OperationObject.Builder
putSchema(String, Schema) - Method in class software.amazon.smithy.openapi.model.ComponentsObject.Builder
putSecurityScheme(String, SecurityScheme) - Method in class software.amazon.smithy.openapi.model.ComponentsObject.Builder
putSynthesizedSchema(String, Schema) - Method in class software.amazon.smithy.openapi.fromsmithy.Context: Puts a new synthesized schema that is needed to convert to OpenAPI.

R

Ref<T extends software.amazon.smithy.model.node.ToNode> - Class in software.amazon.smithy.openapi.model
Ref() - Constructor for class software.amazon.smithy.openapi.model.Ref
remote(String) - Static method in class software.amazon.smithy.openapi.model.Ref: Creates a remote reference using a JSON pointer.
RemoveEmptyComponents - Class in software.amazon.smithy.openapi.fromsmithy.mappers: 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.
RemoveEmptyComponents() - Constructor for class software.amazon.smithy.openapi.fromsmithy.mappers.RemoveEmptyComponents
removeExtension(String) - Method in class software.amazon.smithy.openapi.model.Component.Builder
removePath(String) - Method in class software.amazon.smithy.openapi.model.OpenApi.Builder
removeSchema(String) - Method in class software.amazon.smithy.openapi.model.ComponentsObject.Builder
removeSecurityScheme(String) - Method in class software.amazon.smithy.openapi.model.ComponentsObject.Builder
RemoveUnusedComponents - Class in software.amazon.smithy.openapi.fromsmithy.mappers: Removes unused components from the OpenAPI model.
RemoveUnusedComponents() - Constructor for class software.amazon.smithy.openapi.fromsmithy.mappers.RemoveUnusedComponents
requestBodies(Map<String, RequestBodyObject>) - Method in class software.amazon.smithy.openapi.model.ComponentsObject.Builder
requestBody(Node) - Method in class software.amazon.smithy.openapi.model.LinkObject.Builder
requestBody(RequestBodyObject) - Method in class software.amazon.smithy.openapi.model.OperationObject.Builder
RequestBodyObject - Class in software.amazon.smithy.openapi.model
RequestBodyObject.Builder - Class in software.amazon.smithy.openapi.model
required(boolean) - Method in class software.amazon.smithy.openapi.model.ParameterObject.Builder
required(boolean) - Method in class software.amazon.smithy.openapi.model.RequestBodyObject.Builder
ResponseObject - Class in software.amazon.smithy.openapi.model
ResponseObject.Builder - Class in software.amazon.smithy.openapi.model
responses(Map<String, ResponseObject>) - Method in class software.amazon.smithy.openapi.model.ComponentsObject.Builder
responses(Map<String, ResponseObject>) - Method in class software.amazon.smithy.openapi.model.OperationObject.Builder

S

schema(Schema) - Method in class software.amazon.smithy.openapi.model.MediaTypeObject.Builder
schema(Schema) - Method in class software.amazon.smithy.openapi.model.ParameterObject.Builder
schemas(Map<String, Schema>) - Method in class software.amazon.smithy.openapi.model.ComponentsObject.Builder
scheme(String) - Method in class software.amazon.smithy.openapi.model.SecurityScheme.Builder
security(Collection<Map<String, List<String>>>) - Method in class software.amazon.smithy.openapi.model.OpenApi.Builder
security(Collection<Map<String, List<String>>>) - Method in class software.amazon.smithy.openapi.model.OperationObject.Builder
SecurityScheme - Class in software.amazon.smithy.openapi.model
SecurityScheme.Builder - Class in software.amazon.smithy.openapi.model
SecuritySchemeConverter<T extends software.amazon.smithy.model.traits.Trait> - Interface in software.amazon.smithy.openapi.fromsmithy: Converts a Smithy authentication scheme to an OpenAPI security scheme and applies security requirements to operations.
securitySchemes(Map<String, SecurityScheme>) - Method in class software.amazon.smithy.openapi.model.ComponentsObject.Builder
server(ServerObject) - Method in class software.amazon.smithy.openapi.model.LinkObject.Builder
ServerObject - Class in software.amazon.smithy.openapi.model
ServerObject.Builder - Class in software.amazon.smithy.openapi.model
servers(Collection<ServerObject>) - Method in class software.amazon.smithy.openapi.model.OperationObject.Builder
servers(List<ServerObject>) - Method in class software.amazon.smithy.openapi.model.PathItem.Builder
setDefaultBlobFormat(String) - Method in class software.amazon.smithy.openapi.OpenApiConfig: Sets the default OpenAPI format property used when converting blob shapes in Smithy to strings in OpenAPI.
setExternalDocs(List<String>) - Method in class software.amazon.smithy.openapi.OpenApiConfig: Limits the source of converted "externalDocs" fields to the specified priority ordered list of names in an externalDocumentation trait.
setForbidGreedyLabels(boolean) - Method in class software.amazon.smithy.openapi.OpenApiConfig: Set to true to forbid greedy URI labels.
setIgnoreUnsupportedTraits(boolean) - Method in class software.amazon.smithy.openapi.OpenApiConfig: Set to true to emit warnings rather than failing when unsupported traits like endpoint and hostLabel are encountered.
setJsonAdd(Map<String, Node>) - Method in class software.amazon.smithy.openapi.OpenApiConfig: Adds or replaces the JSON value in the generated OpenAPI document at the given JSON pointer locations with a different JSON value.
setJsonContentType(String) - Method in class software.amazon.smithy.openapi.OpenApiConfig: Sets a custom media-type to associate with the JSON payload of JSON-based protocols.
setKeepUnusedComponents(boolean) - Method in class software.amazon.smithy.openapi.OpenApiConfig: Set to true to prevent unused OpenAPI components from being removed from the created specification.
setOnHttpPrefixHeaders(OpenApiConfig.HttpPrefixHeadersStrategy) - Method in class software.amazon.smithy.openapi.OpenApiConfig: Specifies what to do when the httpPrefixHeaders} trait is found in a model.
setProtocol(ShapeId) - Method in class software.amazon.smithy.openapi.OpenApiConfig: Sets the protocol shape ID to use when converting Smithy to OpenAPI.
setRemoveGreedyParameterSuffix(boolean) - Method in class software.amazon.smithy.openapi.OpenApiConfig: Set to true to remove the "+" suffix that is added to the generated parameter name for greedy labels.
setSubstitutions(Map<String, Node>) - Method in class software.amazon.smithy.openapi.OpenApiConfig: Defines a map of strings to any JSON value to find and replace in the generated OpenAPI model.
setSupportedTags(List<String>) - Method in class software.amazon.smithy.openapi.OpenApiConfig: Limits the exported tags to a specific set of tags.
setTags(boolean) - Method in class software.amazon.smithy.openapi.OpenApiConfig: Sets whether or not to include Smithy tags in the result as OpenAPI tags.
setUseIntegerType(boolean) - Method in class software.amazon.smithy.openapi.OpenApiConfig: Set to true to use the "integer" type when converting byte, short, integer, and long shapes to OpenAPI.
setVersion(OpenApiVersion) - Method in class software.amazon.smithy.openapi.OpenApiConfig
Smithy2OpenApi - Class in software.amazon.smithy.openapi.fromsmithy: Converts Smithy to an OpenAPI model and saves it as a JSON file.
Smithy2OpenApi() - Constructor for class software.amazon.smithy.openapi.fromsmithy.Smithy2OpenApi
Smithy2OpenApiExtension - Interface in software.amazon.smithy.openapi.fromsmithy: An extension mechanism used to influence how Smithy models are converted to OpenAPI models.
software.amazon.smithy.openapi - package software.amazon.smithy.openapi
software.amazon.smithy.openapi.fromsmithy - package software.amazon.smithy.openapi.fromsmithy
software.amazon.smithy.openapi.fromsmithy.mappers - package software.amazon.smithy.openapi.fromsmithy.mappers
software.amazon.smithy.openapi.fromsmithy.protocols - package software.amazon.smithy.openapi.fromsmithy.protocols
software.amazon.smithy.openapi.fromsmithy.security - package software.amazon.smithy.openapi.fromsmithy.security
software.amazon.smithy.openapi.model - package software.amazon.smithy.openapi.model
style(String) - Method in class software.amazon.smithy.openapi.model.EncodingObject.Builder
style(String) - Method in class software.amazon.smithy.openapi.model.ParameterObject.Builder
summary(String) - Method in class software.amazon.smithy.openapi.model.ExampleObject.Builder
summary(String) - Method in class software.amazon.smithy.openapi.model.OperationObject.Builder
summary(String) - Method in class software.amazon.smithy.openapi.model.PathItem.Builder
supportsContentEncodingKeyword() - Method in enum class software.amazon.smithy.openapi.OpenApiVersion

T

TagObject - Class in software.amazon.smithy.openapi.model
TagObject.Builder - Class in software.amazon.smithy.openapi.model
tags(Collection<String>) - Method in class software.amazon.smithy.openapi.model.OperationObject.Builder
termsOfService(String) - Method in class software.amazon.smithy.openapi.model.InfoObject.Builder
title(String) - Method in class software.amazon.smithy.openapi.model.InfoObject.Builder
toBuilder() - Method in class software.amazon.smithy.openapi.model.CallbackObject
toBuilder() - Method in class software.amazon.smithy.openapi.model.ComponentsObject
toBuilder() - Method in class software.amazon.smithy.openapi.model.EncodingObject
toBuilder() - Method in class software.amazon.smithy.openapi.model.ExampleObject
toBuilder() - Method in class software.amazon.smithy.openapi.model.ExternalDocumentation
toBuilder() - Method in class software.amazon.smithy.openapi.model.InfoObject
toBuilder() - Method in class software.amazon.smithy.openapi.model.LinkObject
toBuilder() - Method in class software.amazon.smithy.openapi.model.MediaTypeObject
toBuilder() - Method in class software.amazon.smithy.openapi.model.OpenApi
toBuilder() - Method in class software.amazon.smithy.openapi.model.OperationObject
toBuilder() - Method in class software.amazon.smithy.openapi.model.ParameterObject
toBuilder() - Method in class software.amazon.smithy.openapi.model.PathItem
toBuilder() - Method in class software.amazon.smithy.openapi.model.RequestBodyObject
toBuilder() - Method in class software.amazon.smithy.openapi.model.ResponseObject
toBuilder() - Method in class software.amazon.smithy.openapi.model.SecurityScheme
toBuilder() - Method in class software.amazon.smithy.openapi.model.ServerObject
toBuilder() - Method in class software.amazon.smithy.openapi.model.TagObject
toBuilder() - Method in class software.amazon.smithy.openapi.model.XmlObject
toNode() - Method in class software.amazon.smithy.openapi.model.Component
toString() - Method in enum class software.amazon.smithy.openapi.OpenApiVersion
trace(OperationObject) - Method in class software.amazon.smithy.openapi.model.PathItem.Builder
type(String) - Method in class software.amazon.smithy.openapi.model.SecurityScheme.Builder

U

UnsupportedTraits - Class in software.amazon.smithy.openapi.fromsmithy.mappers: Logs each instance of traits and features that are known to not work in OpenAPI.
UnsupportedTraits() - Constructor for class software.amazon.smithy.openapi.fromsmithy.mappers.UnsupportedTraits
updateDefaultSettings(Model, OpenApiConfig) - Method in interface software.amazon.smithy.openapi.fromsmithy.OpenApiMapper: Sets default values on the OpenAPI configuration object.
updateDefaultSettings(Model, OpenApiConfig) - Method in interface software.amazon.smithy.openapi.fromsmithy.OpenApiProtocol: Sets protocol-specific default values on the OpenAPI configuration object.
updateDefaultSettings(Model, OpenApiConfig) - Method in class software.amazon.smithy.openapi.fromsmithy.protocols.AwsRestJson1Protocol
updateNode(Context<? extends Trait>, OpenApi, ObjectNode) - Method in class software.amazon.smithy.openapi.fromsmithy.mappers.OpenApiJsonAdd
updateNode(Context<? extends Trait>, OpenApi, ObjectNode) - Method in class software.amazon.smithy.openapi.fromsmithy.mappers.OpenApiJsonSubstitutions
updateNode(Context<? extends Trait>, OpenApi, ObjectNode) - Method in class software.amazon.smithy.openapi.fromsmithy.mappers.RemoveEmptyComponents
updateNode(Context<? extends Trait>, OpenApi, ObjectNode) - Method in interface software.amazon.smithy.openapi.fromsmithy.OpenApiMapper: Modifies the Node/JSON representation of an OpenAPI object.
updateOperation(Context<? extends Trait>, OperationShape, OperationObject, String, String) - Method in interface software.amazon.smithy.openapi.fromsmithy.OpenApiMapper: Updates an operation before invoking the plugin system on the contents of the operation (specifically, before OpenApiMapper.updateParameter(software.amazon.smithy.openapi.fromsmithy.Context<? extends software.amazon.smithy.model.traits.Trait>, software.amazon.smithy.model.shapes.OperationShape, java.lang.String, java.lang.String, software.amazon.smithy.openapi.model.ParameterObject), OpenApiMapper.updateRequestBody(software.amazon.smithy.openapi.fromsmithy.Context<? extends software.amazon.smithy.model.traits.Trait>, software.amazon.smithy.model.shapes.OperationShape, java.lang.String, java.lang.String, software.amazon.smithy.openapi.model.RequestBodyObject), OpenApiMapper.updateResponse(software.amazon.smithy.openapi.fromsmithy.Context<? extends software.amazon.smithy.model.traits.Trait>, software.amazon.smithy.model.shapes.OperationShape, java.lang.String, java.lang.String, java.lang.String, software.amazon.smithy.openapi.model.ResponseObject), OpenApiMapper.updateRequestBody(software.amazon.smithy.openapi.fromsmithy.Context<? extends software.amazon.smithy.model.traits.Trait>, software.amazon.smithy.model.shapes.OperationShape, java.lang.String, java.lang.String, software.amazon.smithy.openapi.model.RequestBodyObject), and OpenApiMapper.postProcessOperation(software.amazon.smithy.openapi.fromsmithy.Context<? extends software.amazon.smithy.model.traits.Trait>, software.amazon.smithy.model.shapes.OperationShape, software.amazon.smithy.openapi.model.OperationObject, java.lang.String, java.lang.String)).
updateParameter(Context<? extends Trait>, OperationShape, String, String, ParameterObject) - Method in interface software.amazon.smithy.openapi.fromsmithy.OpenApiMapper: Updates a parameter.
updatePathItem(Context<? extends Trait>, String, PathItem) - Method in interface software.amazon.smithy.openapi.fromsmithy.OpenApiMapper: Updates a path item.
updateRequestBody(Context<? extends Trait>, OperationShape, String, String, RequestBodyObject) - Method in interface software.amazon.smithy.openapi.fromsmithy.OpenApiMapper: Updates the request body of an operation.
updateResponse(Context<? extends Trait>, OperationShape, String, String, String, ResponseObject) - Method in interface software.amazon.smithy.openapi.fromsmithy.OpenApiMapper: Updates a response object.
updateSchema(Shape, Schema.Builder, JsonSchemaConfig) - Method in class software.amazon.smithy.openapi.fromsmithy.OpenApiJsonSchemaMapper
updateSecurity(Context<? extends Trait>, Shape, SecuritySchemeConverter<? extends Trait>, Map<String, List<String>>) - Method in interface software.amazon.smithy.openapi.fromsmithy.OpenApiMapper: Updates a security requirement map.
updateSecurityScheme(Context<? extends Trait>, Trait, SecurityScheme) - Method in interface software.amazon.smithy.openapi.fromsmithy.OpenApiMapper: Updates a security scheme object.
url(String) - Method in class software.amazon.smithy.openapi.model.ExternalDocumentation.Builder
url(String) - Method in class software.amazon.smithy.openapi.model.ServerObject.Builder
usesHttpCredentials() - Method in class software.amazon.smithy.openapi.fromsmithy.Context: Reports if any authentication mechanisms in the entire model use HTTP credentials, such as cookies, browser-managed usernames and passwords, or TLS client certificates.
usesHttpCredentials() - Method in interface software.amazon.smithy.openapi.fromsmithy.SecuritySchemeConverter: Reports if this authentication mechanism uses HTTP credentials, such as cookies, browser-managed usernames and passwords, or TLS client certificates.

V

value(Node) - Method in class software.amazon.smithy.openapi.model.ExampleObject.Builder
valueOf(String) - Static method in enum class software.amazon.smithy.openapi.OpenApiConfig.HttpPrefixHeadersStrategy: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class software.amazon.smithy.openapi.OpenApiVersion: Returns the enum constant of this class with the specified name.
values() - Static method in enum class software.amazon.smithy.openapi.OpenApiConfig.HttpPrefixHeadersStrategy: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class software.amazon.smithy.openapi.OpenApiVersion: Returns an array containing the constants of this enum class, in the order they are declared.
variables(Map<String, ObjectNode>) - Method in class software.amazon.smithy.openapi.model.ServerObject.Builder
version(String) - Method in class software.amazon.smithy.openapi.model.InfoObject.Builder
VERSION_3_0_2 - Enum constant in enum class software.amazon.smithy.openapi.OpenApiVersion
VERSION_3_1_0 - Enum constant in enum class software.amazon.smithy.openapi.OpenApiVersion

W

WARN - Enum constant in enum class software.amazon.smithy.openapi.OpenApiConfig.HttpPrefixHeadersStrategy: The header is omitted from the OpenAPI model and a warning is logged.
wrapped(boolean) - Method in class software.amazon.smithy.openapi.model.XmlObject.Builder

X

XmlObject - Class in software.amazon.smithy.openapi.model
XmlObject.Builder - Class in software.amazon.smithy.openapi.model

A B C D E F G H I L M N O P R S T U V W X
All Classes and Interfaces|All Packages|Serialized Form