Package software.amazon.smithy.docgen.sections
package software.amazon.smithy.docgen.sections
-
ClassDescriptionContains the documentation for the auth schemes that the service supports.Contains the documentation for individual operations bound to a service or resource.Contains the documentation for all operations bound to a service or resource.Contains the documentation for individual (sub)resources bound to a service or resource.Contains the documentation for all (sub)resources bound to a service or resource.Contains a listing of all the errors that an operation might throw, or errors common to a resource or service.Generates a single operation example as defined by the
examples
trait.Generates the documentation for an operation's examples as defined by theexample
trait.Contains the documentation for individual resource lifecycle operations.The type of lifecycle binding an operation can use.Contains the documentation for all resource lifecycle operations.Enables modifying or overwriting the documentation for a member.A section that contains protocol-specific information for a specific protocol for a given shape.A section that contains all protocol-specific information for the given shape for all protocols.Enables injecting details immediately after a shape's modeled documentation.Generates a listing of a shape's members.Generates documentation for shapes.Enables injecting details immediately before a shape's modeled documentation.