All Classes and Interfaces

Class
Description
Converts the aws.protocols#restJson1 protocol to OpenAPI.
Adds AWS signature version in a way that"s compatible with AWS API Gateway.
 
 
Checks for greedy labels and fails/warns depending on configuration.
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.
Abstract class used for most OpenAPI model components.
 
 
 
Context<T extends software.amazon.smithy.model.traits.Trait>
Smithy to OpenAPI conversion context object.
Registers the core Smithy2OpenApi functionality.
 
 
 
 
 
 
Uses an HTTP header named X-Api-Key that contains an API key.
Applies Basic HTTP auth.
Uses the Bearer scheme of the Authentication header.
Applies Digest HTTP auth.
 
 
 
 
 
 
 
 
"openapi" smithy-build plugin configuration settings.
Specifies what to do when the httpPrefixHeaders trait is found in a model.
Converts a Smithy model to OpenAPI.
 
Adds JSON values into the generated OpenAPI model using a JSON Patch like "add" operation that also generated intermediate objects as needed.
Applies OpenAPI extensions to a Schema using configuration settings found in OpenApiConfig.
Substitutes JSON string values using the mapping defined in openapi.substitutions.
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>
An OpenAPI protocol is used to convert a Smithy protocol into HTTP-specific bindings.
Represents an operation entry to add to an OpenApi.Builder.
OpenAPI versions supported by the converter.
 
 
 
 
 
 
Ref<T extends software.amazon.smithy.model.node.ToNode>
 
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.
Removes unused components from the OpenAPI model.
 
 
 
 
 
 
SecuritySchemeConverter<T extends software.amazon.smithy.model.traits.Trait>
Converts a Smithy authentication scheme to an OpenAPI security scheme and applies security requirements to operations.
 
 
Converts Smithy to an OpenAPI model and saves it as a JSON file.
An extension mechanism used to influence how Smithy models are converted to OpenAPI models.
 
 
Logs each instance of traits and features that are known to not work in OpenAPI.