Package software.amazon.smithy.docgen.interceptors
package software.amazon.smithy.docgen.interceptors
-
ClassesClassDescriptionAdds additional context to the description of api key auth based on the customized values.Adds default value information to trait documentation.Adds deprecation warnings to shape docs.Adds endpoint prefix information to operations based on the endpoint trait if the protocol supports it.Adds a line to the error shape docs to indicate whether the error is a client or service error.Adds external doc links after a shape's modeled docs based on the externalDocumentation trait.Documents usage for members targeted with the hostLabel trait if the protocol supports it..Adds information about query bindings from the httpQuery trait if the protocol supports it.Adds the http response code for errors from the httpError trait if the protocol supports it.Adds information about header bindings from the httpHeader trait if the protocol supports it.Adds information to operations from the http trait.Adds information about label bindings from the httpLabel trait if the protocol supports it.Adds information about payload bindings from the httpPayload trait if the protocol supports it.Adds information about header bindings from the httpPrefixHeaders trait if the protocol supports it.Adds information about query bindings from the httpQuery trait if the protocol supports it.Adds information about query bindings from the httpQueryParams trait if the protocol supports it.Adds information about response code bindings from the httpResponseCode trait if the protocol supports it.Provides information about idempotency depending on a number of traits.Adds an admonition to shapes marked as internal.Adds a member's jsonName to the
ProtocolSectionif the protocol supports it.Adds information to shapes if they have the length trait.Adds the media type to member documentation if it has the mediaType trait.Adds the noReplace admonition to the resource lifecycle property list on the resource page.Adds the noReplace admonition to the resource operation's doc page.Adds nullability information to member docs.Adds a priority list of supported auth schemes for operations with optional auth or operations which don't support all of a service's auth schemes.This adds pagination information to operation docs.Adds information to shapes if they have the pattern trait.Adds information to shapes if they have the range trait.Adds a notice for recommended members based on the recommended trait.Adds a "see also" to structures / operations that reference resources using the references trait.Adds information about request compression to operations with the requestCompression trait.This adds badges and notices to errors that are retryable.Adds danger admonitions to shapes that have the sensitive trait.Adds admonitions for when a shape was introduced based on the since trait.Adds an admonition to shapes that have the sparse trait.Adds documentation for the streaming trait.Adds a member's timestamp format to theProtocolSectionif the protocol supports it.Adds an annotation to docs for lists with the uniqueItems trait.Adds a warning admonition to shapes marked as unstable.Notes that a member is an xml attribute in theProtocolSectionif the protocol supports it.Adds information to the protocol section for members indicating whether they target a flat list/map or wrapped list/map depending on whether they have the xmlFlattened trait.Adds a member's xmlName to theProtocolSectionif the protocol supports it.Notes that a member needs an xml namespace in theProtocolSectionif the protocol supports it.