Attributes
- Companion
- class
- Source
- TraitApplication.scala
- Graph
-
- Supertypes
- Self type
-
TraitApplication.type
Members list
Type members
Inherited and Abstract types
The names of the product elements.
The name of the type.
Value members
Concrete methods
Creates the @documentation trait with the given documentation text.
Creates the @documentation trait with the given documentation text.
This is a convenience factory for the smithy.api#documentation trait.
Value parameters
- text
-
the documentation string
Attributes
- Returns
-
a TraitApplication for the @documentation trait
- Source
- TraitApplication.scala
Creates the @error trait with the given error classification.
Creates the @error trait with the given error classification.
This is a convenience factory for the smithy.api#error trait, which marks a shape as an error and specifies its classification.
Value parameters
- value
-
the error classification (typically "client" or "server")
Attributes
- Returns
-
a TraitApplication for the @error trait
- Source
- TraitApplication.scala
Creates the @http trait with the given HTTP method and URI.
Creates the @http trait with the given HTTP method and URI.
This is a convenience factory for the smithy.api#http trait, which configures HTTP bindings for a shape (typically an operation).
Value parameters
- method
-
the HTTP method (e.g., "GET", "POST", "PUT", "DELETE")
- uri
-
the URI template (e.g., "/users/{id}")
Attributes
- Returns
-
a TraitApplication for the @http trait
- Source
- TraitApplication.scala
Creates the @required trait, which marks a shape as required.
Creates the @required trait, which marks a shape as required.
This is a convenience factory for the smithy.api#required trait, which takes no configuration value.
Attributes
- Returns
-
a TraitApplication for the @required trait
- Source
- TraitApplication.scala