Package software.amazon.smithy.docgen.sections

Record Class AuthSection

java.lang.Object
java.lang.Record
software.amazon.smithy.docgen.sections.AuthSection
Record Components:
context - The context used to generate documentation.
service - The service whose documentation is being generated.
All Implemented Interfaces:
CodeSection
public record AuthSection(DocGenerationContext context, ServiceShape service) extends Record implements CodeSection
Contains the documentation for the auth schemes that the service supports.

By default, the auth schemes are documented in a definition list. The title used for each auth scheme is the name that results from passing the auth trait's shape to the DocSymbolProvider. The name can be customized by decorating the provider with SmithyIntegration.decorateSymbolProvider(software.amazon.smithy.model.Model, S, software.amazon.smithy.codegen.core.SymbolProvider).

The body of each auth scheme's docs is treated like a typical shape section, with a ShapeSection, ShapeSubheadingSection, ShapeDetailsSection, and documentation pulled from the shape. Details based on the trait's values can be inserted via one of those sections, intercepting when the shape's id matches the id of the auth trait's shape.

See Also:

  • Constructor Details

    • AuthSection

      public AuthSection(DocGenerationContext context, ServiceShape service)
      Creates an instance of a AuthSection record class.
      Parameters:
      context - the value for the context record component
      service - the value for the service record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • context

      public DocGenerationContext context()
      Returns the value of the context record component.
      Returns:
      the value of the context record component

    • service

      public ServiceShape service()
      Returns the value of the service record component.
      Returns:
      the value of the service record component