Auth docs

doc/endpoint/auth.md

@@ -0,0 +1,16 @@
+# Authentication
+
+Inputs which carry authentication data wrap another input can be marked as such by declaring them using members of the
+`auth` object. Apart from predefined codecs for some authentication methods, such inputs will be treated differently]
+when generating documentation. Otherwise, they behave as normal inputs which map to the the given type.
+
+Currently, the following authentication inputs are available (assuming `import tapir._`):
+
+* `auth.apiKey(anotherInput)`: wraps any other input and designates it as an api key. The input is typically a header 
+or a query parameter
+* `auth.basic: EndpointInput[UsernamePassword]`: maps to the base64-encoded username/password pair in the 
+`Authorization` header
+* `auth.bearer: EndpointInput[String]`: maps to `Bearer [token]` in the `Authorization` header
+
+Multiple authentication inputs indicate that all of the given authentication values should be provided. Specifying
+alternative authentication methods (where only one value out of many needs to be provided) is currently not supported.

doc/endpoint/forms.md

@@ -54,4 +54,8 @@ For example:
 case class RegistrationForm(userData: User, photo: Part[File], news: Boolean)
 
 multipartBody[RegistrationForm]
-```
+```
+
+## Next
+
+Read on about [authentication](auth.html).

doc/index.md

@@ -76,6 +76,7 @@ which is a slight extension of the above.
 * [Endpoints: codecs](endpoint/codecs.md)
 * [Endpoints: working with JSON](endpoint/json.md)
 * [Endpoints: forms](endpoint/forms.md)
+* [Endpoints: authentication](endpoint/auth.md)
 * [Servers: akka-http interpreter](server/akkahttp.md)
 * [Servers: http4s interpreter](server/http4s.md)
 * [Servers: common configuration](server/common.md)