zio.http.endpoint.openapi.OpenAPI.scala Maven / Gradle / Ivy
The newest version!
/*
* Copyright 2021 - 2023 Sporta Technologies PVT LTD & the ZIO HTTP contributors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package zio.http.endpoint.openapi
import java.net.URI
import scala.annotation.nowarn
import scala.collection.immutable.ListMap
import scala.util.matching.Regex
import zio.Chunk
import zio.json.ast._
import zio.schema._
import zio.schema.annotation.{caseName, discriminatorName, fieldName, noDiscriminator}
import zio.schema.codec.JsonCodec
import zio.schema.codec.json._
import zio.http.Status
import zio.http.codec.Doc
import zio.http.endpoint.openapi.OpenAPI.SecurityScheme.SecurityRequirement
/**
* This is the root document object of the OpenAPI document.
*
* @param openapi
* This string MUST be the semantic version number of the OpenAPI
* Specification version that the OpenAPI document uses. The openapi field
* SHOULD be used by tooling specifications and clients to interpret the
* OpenAPI document. This is not related to the API info.version string.
* @param info
* Provides metadata about the API. The metadata MAY be used by tooling as
* required.
* @param servers
* A List of Server Objects, which provide connectivity information to a
* target server. If the servers property is empty, the default value would be
* a Server Object with a url value of /.
* @param paths
* The available paths and operations for the API.
* @param components
* An element to hold various schemas for the specification.
* @param security
* A declaration of which security mechanisms can be used across the API. The
* list of values includes alternative security requirement objects that can
* be used. Only one of the security requirement objects need to be satisfied
* to authorize a request. Individual operations can override this definition.
* To make security optional, an empty security requirement ({}) can be
* included in the List.
* @param tags
* A list of tags used by the specification with additional metadata. The
* order of the tags can be used to reflect on their order by the parsing
* tools. Not all tags that are used by the Operation Object must be declared.
* The tags that are not declared MAY be organized randomly or based on the
* tools’ logic. Each tag name in the list MUST be unique.
* @param externalDocs
* Additional external documentation.
*/
final case class OpenAPI(
openapi: String,
info: OpenAPI.Info,
servers: List[OpenAPI.Server] = List.empty,
paths: ListMap[OpenAPI.Path, OpenAPI.PathItem] = ListMap.empty,
components: Option[OpenAPI.Components],
security: List[SecurityRequirement] = List.empty,
tags: List[OpenAPI.Tag] = List.empty,
externalDocs: Option[OpenAPI.ExternalDoc],
) {
def ++(other: OpenAPI): OpenAPI = OpenAPI(
openapi = openapi,
info = info,
servers = servers ++ other.servers,
paths = mergePaths(paths, other.paths),
components = (components.toSeq ++ other.components).reduceOption(_ ++ _),
security = security ++ other.security,
tags = tags ++ other.tags,
externalDocs = externalDocs,
)
private def mergePaths(paths: ListMap[OpenAPI.Path, OpenAPI.PathItem]*): ListMap[OpenAPI.Path, OpenAPI.PathItem] =
ListMap(
paths
.flatMap(_.toSeq)
.groupBy(_._1)
.map { case (path, pathItems) =>
val pathItem = pathItems.map(_._2).reduce { (i, j) =>
i.copy(
get = i.get.orElse(j.get),
put = i.put.orElse(j.put),
post = i.post.orElse(j.post),
delete = i.delete.orElse(j.delete),
options = i.options.orElse(j.options),
head = i.head.orElse(j.head),
patch = i.patch.orElse(j.patch),
trace = i.trace.orElse(j.trace),
)
}
(path, pathItem)
}
.toSeq: _*,
)
def path(path: OpenAPI.Path, pathItem: OpenAPI.PathItem): OpenAPI =
copy(paths = mergePaths(ListMap(path -> pathItem), paths))
def toJson: String =
JsonCodec
.jsonEncoder(JsonCodec.Config(ignoreEmptyCollections = true))(OpenAPI.schema)
.encodeJson(this, None)
.toString
def toJsonPretty: String =
JsonCodec
.jsonEncoder(JsonCodec.Config(ignoreEmptyCollections = true))(OpenAPI.schema)
.encodeJson(this, Some(0))
.toString
def title(title: String): OpenAPI = copy(info = info.copy(title = title))
def version(version: String): OpenAPI = copy(info = info.copy(version = version))
}
object OpenAPI {
implicit val schema: Schema[OpenAPI] =
DeriveSchema.gen[OpenAPI]
def fromJson(json: String): Either[String, OpenAPI] =
JsonCodec
.jsonDecoder(OpenAPI.schema)
.decodeJson(json)
def empty: OpenAPI = OpenAPI(
openapi = "3.1.0",
info = Info(
title = "",
description = None,
termsOfService = None,
contact = None,
license = None,
version = "",
),
servers = List.empty,
paths = ListMap.empty,
components = None,
security = List.empty,
tags = List.empty,
externalDocs = None,
)
implicit def statusSchema: Schema[Status] =
zio.schema
.Schema[String]
.transform[Status](
s => Status.fromInt(s.toInt),
p => p.text,
)
implicit def pathMapSchema: Schema[ListMap[Path, PathItem]] =
DeriveSchema
.gen[Map[String, PathItem]]
.transformOrFail(
m => {
val it = m.iterator
var transformed = ListMap.empty[Path, PathItem]
var error: Left[String, ListMap[Path, PathItem]] = null
while (it.hasNext && error == null) {
val (k, v) = it.next()
Path.fromString(k) match {
case Some(path) => transformed += path -> v
case None => error = Left(s"Invalid path: $k")
}
}
if (error != null) error
else Right(transformed)
},
(m: Map[Path, PathItem]) => Right(ListMap(m.toSeq.sortBy(_._1.name).map { case (k, v) => k.name -> v }: _*)),
)
implicit def keyMapSchema[T](implicit
schema: Schema[T],
): Schema[ListMap[Key, T]] =
Schema
.map[String, T]
.transformOrFail(
m => {
val it = m.iterator
var transformed = Vector.empty[(Key, T)]
var error: Left[String, ListMap[Key, T]] = null
while (it.hasNext && error == null) {
val (k, v) = it.next()
Key.fromString(k) match {
case Some(key) => transformed :+= key -> v
case None => error = Left(s"Invalid key: $k")
}
}
if (error != null) error
else Right(ListMap(transformed.sortBy(_._1.name): _*))
},
(m: Map[Key, T]) => Right(ListMap(m.toSeq.sortBy(_._1.name).map { case (k, v) => k.name -> v }: _*)),
)
implicit def statusMapSchema[T](implicit
schema: Schema[T],
): Schema[Map[StatusOrDefault, T]] =
Schema
.map[String, T]
.transformOrFail(
m => {
val it = m.iterator
var transformed = Map.empty[StatusOrDefault, T]
var error: Left[String, Map[StatusOrDefault, T]] = null
while (it.hasNext && error == null) {
val (k, v) = it.next()
if (k == "default") transformed += StatusOrDefault.Default -> v
else {
zio.http.Status.fromString(k) match {
case Some(key) => transformed += StatusOrDefault.StatusValue(key) -> v
case None => error = Left(s"Invalid status: $k")
}
}
}
if (error != null) error
else Right(transformed)
},
(m: Map[StatusOrDefault, T]) => Right(m.map { case (k, v) => k.text -> v }),
)
implicit def mediaTypeTupleSchema: Schema[(String, MediaType)] =
zio.schema
.Schema[Map[String, MediaType]]
.transformOrFail(
m => {
if (m.size == 1) {
val (k, v) = m.head
Right((k, v))
} else Left("Invalid media type")
},
t => Right(Map(t._1 -> t._2)),
)
implicit def securityRequirementSchema: Schema[SecurityRequirement] = {
zio.schema
.Schema[Map[String, List[String]]]
.transform[SecurityRequirement](
m => SecurityRequirement(m),
s => s.securitySchemes,
)
}
/**
* Allows referencing an external resource for extended documentation.
*
* @param description
* A short description of the target documentation. CommonMark syntax MAY be
* used for rich text representation.
* @param url
* The URL for the target documentation.
*/
final case class ExternalDoc(description: Option[Doc], url: URI)
/**
* The object provides metadata about the API. The metadata MAY be used by the
* clients if needed, and MAY be presented in editing or documentation
* generation tools for convenience.
*
* @param title
* The title of the API.
* @param description
* A short description of the API.
* @param termsOfService
* A URL to the Terms of Service for the API.
* @param contact
* The contact information for the exposed API.
* @param license
* The license information for the exposed API.
* @param version
* The version of the OpenAPI document (which is distinct from the OpenAPI
* Specification version or the API implementation version).
*/
final case class Info(
title: String,
description: Option[Doc],
termsOfService: Option[URI],
contact: Option[Contact],
license: Option[License],
version: String,
)
/**
* Contact information for the exposed API.
*
* @param name
* The identifying name of the contact person/organization.
* @param url
* The URL pointing to the contact information.
* @param email
* The email address of the contact person/organization. MUST be in the
* format of an email address.
*/
final case class Contact(name: Option[String], url: Option[URI], email: Option[String])
/**
* License information for the exposed API.
*
* @param name
* The license name used for the API.
* @param url
* A URL to the license used for the API.
*/
final case class License(name: String, url: Option[URI])
/**
* An object representing a Server.
*
* @param url
* A URL to the target host. This URL supports Server Variables and MAY be
* relative, to indicate that the host location is relative to the location
* where the OpenAPI document is being served. Variable substitutions will
* be made when a variable is named in {brackets}.
* @param description
* Describing the host designated by the URL.
* @param variables
* A map between a variable name and its value. The value is used for
* substitution in the server’s URL template.
*/
final case class Server(
url: URI,
description: Option[Doc],
variables: Map[String, ServerVariable] = Map.empty,
)
/**
* An object representing a Server Variable for server URL template
* substitution.
*
* @param enum
* An enumeration of string values to be used if the substitution options
* are from a limited set.
* @param default
* The default value to use for substitution, which SHALL be sent if an
* alternate value is not supplied. Note this behavior is different than the
* Schema Object’s treatment of default values, because in those cases
* parameter values are optional. If the enum is defined, the value SHOULD
* exist in the enum’s values.
* @param description
* A description for the server variable.
*/
final case class ServerVariable(`enum`: Chunk[String], default: String, description: Doc)
object ServerVariable {
implicit val schema: Schema[ServerVariable] =
DeriveSchema.gen[ServerVariable]
}
/**
* Holds a set of reusable objects for different aspects of the OAS. All
* objects defined within the components object will have no effect on the API
* unless they are explicitly referenced from properties outside the
* components object.
*
* @param schemas
* An object to hold reusable Schema Objects.
* @param responses
* An object to hold reusable Response Objects.
* @param parameters
* An object to hold reusable Parameter Objects.
* @param examples
* An object to hold reusable Example Objects.
* @param requestBodies
* An object to hold reusable Request Body Objects.
* @param headers
* An object to hold reusable Header Objects.
* @param securitySchemes
* An object to hold reusable Security Scheme Objects.
* @param links
* An object to hold reusable Link Objects.
* @param callbacks
* An object to hold reusable Callback Objects.
*/
final case class Components(
schemas: ListMap[Key, ReferenceOr[JsonSchema]] = ListMap.empty,
responses: ListMap[Key, ReferenceOr[Response]] = ListMap.empty,
parameters: ListMap[Key, ReferenceOr[Parameter]] = ListMap.empty,
examples: ListMap[Key, ReferenceOr[Example]] = ListMap.empty,
requestBodies: ListMap[Key, ReferenceOr[RequestBody]] = ListMap.empty,
headers: ListMap[Key, ReferenceOr[Header]] = ListMap.empty,
securitySchemes: ListMap[Key, ReferenceOr[SecurityScheme]] = ListMap.empty,
links: ListMap[Key, ReferenceOr[Link]] = ListMap.empty,
callbacks: ListMap[Key, ReferenceOr[Callback]] = ListMap.empty,
) {
def ++(other: Components): Components = Components(
schemas = schemas ++ other.schemas,
responses = responses ++ other.responses,
parameters = parameters ++ other.parameters,
examples = examples ++ other.examples,
requestBodies = requestBodies ++ other.requestBodies,
headers = headers ++ other.headers,
securitySchemes = securitySchemes ++ other.securitySchemes,
links = links ++ other.links,
callbacks = callbacks ++ other.callbacks,
)
}
sealed abstract case class Key private (name: String)
object Key {
implicit val schema: Schema[Key] =
zio.schema
.Schema[String]
.transformOrFail[Key](
s => fromString(s).toRight(s"Invalid Key $s"),
p => Right(p.name),
)
/**
* All Components objects MUST use Keys that match the regular expression.
*/
val validName: Regex = "^[a-zA-Z0-9.\\-_]+$".r
def fromString(name: String): Option[Key] = name match {
case validName() => Some(new Key(name) {})
case _ => None
}
}
/**
* The path is appended (no relative URL resolution) to the expanded URL from
* the Server Object's url field in order to construct the full URL. Path
* templating is allowed. When matching URLs, concrete (non-templated) paths
* would be matched before their templated counterparts. Templated paths with
* the same hierarchy but different templated names MUST NOT exist as they are
* identical. In case of ambiguous matching, it’s up to the tooling to decide
* which one to use.
*
* @param name
* The field name of the relative path MUST begin with a forward slash (/).
*/
case class Path private (name: String)
object Path {
implicit val schema: Schema[Path] = Schema[String].transformOrFail[Path](
s => fromString(s).toRight(s"Invalid Path $s"),
p => Right(p.name),
)
// todo maybe not the best regex, but the old one was not working at all
// safe chars from RFC1738 "$" | "-" | "_" | "." | "+"
private val validPath: Regex = """\/[\/a-zA-Z0-9\-_{}$.+]*""".r
def fromString(name: String): Option[Path] = name match {
case validPath() => Some(Path(name))
case _ => None
}
}
/**
* Describes the operations available on a single path. A Path Item MAY be
* empty, due to ACL constraints. The path itself is still exposed to the
* documentation viewer but they will not know which operations and parameters
* are available.
*
* @param ref
* Allows for an external definition of this path item. The referenced
* structure MUST be in the format of a Path Item Object. In case a Path
* Item Object field appears both in the defined object and the referenced
* object, the behavior is undefined.
* @param summary
* An optional, string summary, intended to apply to all operations in this
* path.
* @param description
* A description, intended to apply to all operations in this path.
* @param get
* A definition of a GET operation on this path.
* @param put
* A definition of a PUT operation on this path.
* @param post
* A definition of a POST operation on this path.
* @param delete
* A definition of a DELETE operation on this path.
* @param options
* A definition of a OPTIONS operation on this path.
* @param head
* A definition of a HEAD operation on this path.
* @param patch
* A definition of a PATCH operation on this path.
* @param trace
* A definition of a TRACE operation on this path.
* @param servers
* An alternative server List to service all operations in this path.
* @param parameters
* A Set of parameters that are applicable for all the operations described
* under this path. These parameters can be overridden at the operation
* level, but cannot be removed there. The Set can use the Reference Object
* to link to parameters that are defined at the OpenAPI Object’s
* components/parameters.
*/
@nowarn("msg=possible missing interpolator")
final case class PathItem(
@fieldName("$ref") ref: Option[String],
summary: Option[String],
description: Option[Doc],
get: Option[Operation],
put: Option[Operation],
post: Option[Operation],
delete: Option[Operation],
options: Option[Operation],
head: Option[Operation],
patch: Option[Operation],
trace: Option[Operation],
servers: List[Server] = List.empty,
parameters: Set[ReferenceOr[Parameter]] = Set.empty,
) {
def addGet(operation: Operation): PathItem = copy(get = Some(operation))
def addPut(operation: Operation): PathItem = copy(put = Some(operation))
def addPost(operation: Operation): PathItem = copy(post = Some(operation))
def addDelete(operation: Operation): PathItem = copy(delete = Some(operation))
def addOptions(operation: Operation): PathItem = copy(options = Some(operation))
def addHead(operation: Operation): PathItem = copy(head = Some(operation))
def addPatch(operation: Operation): PathItem = copy(patch = Some(operation))
def addTrace(operation: Operation): PathItem = copy(trace = Some(operation))
def any(operation: Operation): PathItem =
copy(
get = Some(operation),
put = Some(operation),
post = Some(operation),
delete = Some(operation),
options = Some(operation),
head = Some(operation),
patch = Some(operation),
trace = Some(operation),
)
}
object PathItem {
implicit val schema: Schema[PathItem] =
DeriveSchema.gen[PathItem]
val empty: PathItem = PathItem(
ref = None,
summary = None,
description = None,
get = None,
put = None,
post = None,
delete = None,
options = None,
head = None,
patch = None,
trace = None,
servers = List.empty,
parameters = Set.empty,
)
}
/**
* Describes a single API operation on a path.
*
* @param tags
* A list of tags for API documentation control. Tags can be used for
* logical grouping of operations by resources or any other qualifier.
* @param summary
* A short summary of what the operation does.
* @param description
* A verbose explanation of the operation behavior.
* @param externalDocs
* Additional external documentation for this operation.
* @param operationId
* Unique string used to identify the operation. The id MUST be unique among
* all operations described in the API. The operationId value is
* case-sensitive. Tools and libraries MAY use the operationId to uniquely
* identify an operation, therefore, it is RECOMMENDED to follow common
* programming naming conventions.
* @param parameters
* A List of parameters that are applicable for this operation. If a
* parameter is already defined at the Path Item, the new definition will
* override it but can never remove it. The list MUST NOT include duplicated
* parameters. A unique parameter is defined by a combination of a name and
* location. The list can use the Reference Object to link to parameters
* that are defined at the OpenAPI Object’s components/parameters.
* @param requestBody
* The request body applicable for this operation. The requestBody is only
* supported in HTTP methods where the HTTP 1.1 specification [RFC7231] has
* explicitly defined semantics for request bodies. In other cases where the
* HTTP spec is vague, requestBody SHALL be ignored by consumers.
* @param responses
* The List of possible responses as they are returned from executing this
* operation.
* @param callbacks
* A map of possible out-of band callbacks related to the parent operation.
* The key is a unique identifier for the Callback Object. Each value in the
* map is a Callback Object that describes a request that may be initiated
* by the API provider and the expected responses.
* @param deprecated
* Declares this operation to be deprecated. Consumers SHOULD refrain from
* usage of the declared operation.
* @param security
* A declaration of which security mechanisms can be used for this
* operation. The List of values includes alternative security requirement
* objects that can be used. Only one of the security requirement objects
* need to be satisfied to authorize a request. To make security optional,
* an empty security requirement ({}) can be included in the array. This
* definition overrides any declared top-level security. To remove a
* top-level security declaration, an empty List can be used.
* @param servers
* An alternative server List to service this operation. If an alternative
* server object is specified at the Path Item Object or Root level, it will
* be overridden by this value.
*/
final case class Operation(
tags: List[String] = List.empty,
summary: Option[String],
description: Option[Doc],
externalDocs: Option[ExternalDoc],
operationId: Option[String],
parameters: Set[ReferenceOr[Parameter]] = Set.empty,
requestBody: Option[ReferenceOr[RequestBody]],
responses: Map[StatusOrDefault, ReferenceOr[Response]] = Map.empty,
callbacks: Map[String, ReferenceOr[Callback]] = Map.empty,
deprecated: Option[Boolean] = None,
security: List[SecurityRequirement] = List.empty,
servers: List[Server] = List.empty,
)
/**
* Describes a single operation parameter.
*/
final case class Parameter(
name: String,
in: String,
description: Option[Doc],
required: Option[Boolean] = None,
deprecated: Option[Boolean] = None,
schema: Option[ReferenceOr[JsonSchema]],
explode: Option[Boolean] = None,
examples: Map[String, ReferenceOr[Example]] = Map.empty,
allowReserved: Option[Boolean],
style: Option[String],
content: Option[(String, MediaType)],
) {
override def equals(obj: Any): Boolean = obj match {
case p: Parameter if name == p.name && in == p.in => true
case _ => false
}
}
object Parameter {
implicit val schema: Schema[Parameter] =
DeriveSchema.gen[Parameter]
final case class Content(key: String, mediaType: MediaType)
sealed trait PathStyle
sealed trait QueryStyle
object Style {
case object Matrix extends PathStyle
case object Label extends PathStyle
case object Form extends QueryStyle
case object Simple extends PathStyle
case object SpaceDelimited extends QueryStyle
case object PipeDelimited extends QueryStyle
case object DeepObject extends QueryStyle
}
/**
* Parameters that are appended to the URL. For example, in /items?id=###,
* the query parameter is id.
*
* @param name
* The name of the parameter. Parameter names are case sensitive.
* @param description
* A brief description of the parameter.
* @param deprecated
* Specifies that a parameter is deprecated and SHOULD be transitioned out
* of usage.
*/
def queryParameter(
name: String,
description: Option[Doc],
schema: Option[ReferenceOr[JsonSchema]],
examples: Map[String, ReferenceOr[Example]],
deprecated: Boolean = false,
explode: Boolean = true,
required: Boolean = false,
allowReserved: Boolean = false,
style: QueryStyle = Style.Form,
): Parameter = Parameter(
name,
"query",
description,
if (required) Some(required) else None,
if (deprecated) Some(deprecated) else None,
schema,
if (explode) Some(explode) else None,
examples,
Some(allowReserved),
style = Some(style match {
case Style.Form => "form"
case Style.SpaceDelimited => "spaceDelimited"
case Style.PipeDelimited => "pipeDelimited"
case Style.DeepObject => "deepObject"
}),
None,
)
/**
* Custom headers that are expected as part of the request. Note that
* [RFC7230] states header names are case insensitive.
*
* @param name
* The name of the parameter. Parameter names are case sensitive.
* @param description
* A brief description of the parameter.
* @param required
* Determines whether this parameter is mandatory.
* @param deprecated
* Specifies that a parameter is deprecated and SHOULD be transitioned out
* of usage.
*/
def headerParameter(
name: String,
description: Option[Doc],
required: Boolean,
deprecated: Boolean = false,
definition: Option[ReferenceOr[JsonSchema]] = None,
explode: Boolean = false,
examples: Map[String, ReferenceOr[Example]],
): Parameter = Parameter(
name,
"header",
description,
if (required) Some(required) else None,
if (deprecated) Some(deprecated) else None,
definition,
if (explode) Some(explode) else None,
examples,
allowReserved = None,
style = Some("simple"),
None,
)
/**
* Used together with Path Templating, where the parameter value is actually
* part of the operation’s URL. This does not include the host or base path
* of the API. For example, in /items/{itemId}, the path parameter is
* itemId.
*
* @param name
* The name of the parameter. Parameter names are case sensitive.
* @param description
* A brief description of the parameter.
* @param deprecated
* Specifies that a parameter is deprecated and SHOULD be transitioned out
* of usage.
*/
def pathParameter(
name: String,
description: Option[Doc],
deprecated: Boolean = false,
definition: Option[ReferenceOr[JsonSchema]] = None,
style: PathStyle = Style.Simple,
explode: Boolean = false,
examples: Map[String, ReferenceOr[Example]],
): Parameter = Parameter(
name,
"path",
description,
required = Some(true),
if (deprecated) Some(deprecated) else None,
definition,
if (explode) Some(explode) else None,
examples,
allowReserved = None,
style = Some(style match {
case Style.Matrix => "matrix"
case Style.Label => "label"
case Style.Simple => "simple"
}),
None,
)
/**
* Used to pass a specific cookie value to the API.
*
* @param name
* The name of the parameter. Parameter names are case sensitive.
* @param description
* A brief description of the parameter.
* @param required
* Determines whether this parameter is mandatory.
* @param deprecated
* Specifies that a parameter is deprecated and SHOULD be transitioned out
* of usage.
*/
def cookieParameter(
name: String,
description: Option[Doc],
required: Boolean,
deprecated: Boolean = false,
definition: Option[ReferenceOr[JsonSchema]] = None,
explode: Boolean = false,
examples: Map[String, ReferenceOr[Example]],
): Parameter = Parameter(
name,
"cookie",
description,
if (required) Some(required) else None,
if (deprecated) Some(deprecated) else None,
definition,
if (explode) Some(explode) else None,
examples,
allowReserved = None,
style = Some("form"),
None,
)
}
final case class Header(
description: Option[Doc],
required: Option[Boolean] = None,
deprecated: Option[Boolean] = None,
allowEmptyValue: Option[Boolean] = None,
schema: Option[JsonSchema],
)
object Header {
def apply(
description: Option[Doc],
required: Boolean,
deprecated: Boolean,
allowEmptyValue: Boolean,
schema: Option[JsonSchema],
): Header = Header(
description,
if (required) Some(required) else None,
if (deprecated) Some(deprecated) else None,
if (allowEmptyValue) Some(allowEmptyValue) else None,
schema,
)
implicit val schema: Schema[Header] =
DeriveSchema.gen[Header]
}
/**
* Describes a single request body.
*
* @param description
* A brief description of the request body. This could contain examples of
* use.
* @param content
* The content of the request body. The key is a media type or [media type
* range]appendix-D) and the value describes it. For requests that match
* multiple keys, only the most specific key is applicable.
* @param required
* Determines if the request body is required in the request.
*/
final case class RequestBody(
description: Option[Doc] = None,
content: Map[String, MediaType] = Map.empty,
required: Boolean = false,
)
object RequestBody {
implicit val schema: Schema[RequestBody] =
DeriveSchema.gen[RequestBody]
}
/**
* Each Media Type Object provides schema and examples for the media type
* identified by its key.
*
* @param schema
* The schema defining the content of the request, response, or parameter.
* @param examples
* Examples of the media type. Each example object SHOULD match the media
* type and specified schema if present. If referencing a schema which
* contains an example, the examples value SHALL override the example
* provided by the schema.
* @param encoding
* A map between a property name and its encoding information. The key,
* being the property name, MUST exist in the schema as a property. The
* encoding object SHALL only apply to requestBody objects when the media
* type is multipart or application/x-www-form-urlencoded.
*/
final case class MediaType(
schema: ReferenceOr[JsonSchema],
examples: Map[String, ReferenceOr[Example]] = Map.empty,
encoding: Map[String, Encoding] = Map.empty,
)
object MediaType {
implicit val schema: Schema[MediaType] =
DeriveSchema.gen[MediaType]
}
/**
* A single encoding definition applied to a single schema property.
*
* TODO: default values (https://spec.openapis.org/oas/v3.0.3#encoding-object)
*
* @param contentType
* The Content-Type for encoding a specific property.
* @param headers
* A map allowing additional information to be provided as headers, for
* example Content-Disposition. Content-Type is described separately and
* SHALL be ignored in this section. This property SHALL be ignored if the
* request body media type is not a multipart.
* @param style
* Describes how a specific property value will be serialized depending on
* its type. This property SHALL be ignored if the request body media type
* is not application/x-www-form-urlencoded.
* @param explode
* When this is true, property values of type array or object generate
* separate parameters for each value of the array, or key-value-pair of the
* map.
* @param allowReserved
* Determines whether the parameter value SHOULD allow reserved characters,
* as defined by [RFC3986] to be included without percent-encoding. This
* property SHALL be ignored if the request body media type is not
* application/x-www-form-urlencoded.
*/
final case class Encoding(
contentType: String,
headers: Map[String, ReferenceOr[Header]] = Map.empty,
style: String = "form",
explode: Boolean,
allowReserved: Boolean = false,
)
object Encoding {
implicit val schema: Schema[Encoding] =
DeriveSchema.gen[Encoding]
}
/**
* A container for the expected responses of an operation. The container maps
* a HTTP response code to the expected response. The Responses Object MUST
* contain at least one response code, and it SHOULD be the response for a
* successful operation call.
*/
type Responses = Map[StatusOrDefault, ReferenceOr[Response]]
sealed trait StatusOrDefault extends Product with Serializable {
def text: String
}
object StatusOrDefault {
case class StatusValue(status: Status) extends StatusOrDefault {
override def text: String = status.text
}
object StatusValue {
implicit val schema: Schema[StatusValue] =
zio.schema
.Schema[Status]
.transformOrFail[StatusValue](
s => Right(StatusValue(s)),
p => Right(p.status),
)
}
case object Default extends StatusOrDefault {
implicit val schema: Schema[Default.type] =
zio.schema
.Schema[String]
.transformOrFail[Default.type](
s => if (s == "default") Right(Default) else Left("Invalid default status"),
_ => Right("default"),
)
override def text: String = "default"
}
}
/**
* Describes a single response from an API Operation, including design-time,
* static links to operations based on the response.
*
* @param description
* A short description of the response.
* @param headers
* Maps a header name to its definition. [RFC7230] states header names are
* case insensitive. If a response header is defined with the name
* "Content-Type", it SHALL be ignored.
* @param content
* A map containing descriptions of potential response payloads. The key is
* a media type or [media type range]appendix-D) and the value describes it.
* For responses that match multiple keys, only the most specific key is
* applicable.
* @param links
* A map of operations links that can be followed from the response. The key
* of the map is a short name for the link, following the naming constraints
* of the names for Component Objects.
*/
final case class Response(
description: Option[Doc] = None,
headers: Map[String, ReferenceOr[Header]] = Map.empty,
content: Map[String, MediaType] = Map.empty,
links: Map[String, ReferenceOr[Link]] = Map.empty,
)
object Response {
implicit val schema: Schema[Response] =
DeriveSchema.gen[Response]
}
/**
* A map of possible out-of band callbacks related to the parent operation.
* Each value in the map is a Path Item Object that describes a set of
* requests that may be initiated by the API provider and the expected
* responses. The key value used to identify the path item object is an
* expression, evaluated at runtime, that identifies a URL to use for the
* callback operation.
*
* @param expressions
* A Path Item Object used to define a callback request and expected
* responses.
*/
final case class Callback(expressions: Map[String, PathItem] = Map.empty)
object Callback {
implicit val schema: Schema[Callback] =
DeriveSchema.gen[Callback]
}
/**
* In all cases, the example value is expected to be compatible with the type
* schema of its associated value. Tooling implementations MAY choose to
* validate compatibility automatically, and reject the example value(s) if
* incompatible.
*
* @param summary
* Short description for the example.
* @param description
* Long description for the example.
* @param externalValue
* A URL that points to the literal example. This provides the capability to
* reference examples that cannot easily be included in JSON or YAML
* documents.
*/
// There is currently no API to set the summary, description or externalValue
final case class Example(
value: Json,
summary: Option[String] = None,
description: Option[Doc] = None,
externalValue: Option[URI] = None,
)
object Example {
implicit val schema: Schema[Example] =
DeriveSchema.gen[Example]
}
/**
* The Link object represents a possible design-time link for a response. The
* presence of a link does not guarantee the caller’s ability to successfully
* invoke it, rather it provides a known relationship and traversal mechanism
* between responses and other operations.
*
* Unlike dynamic links (i.e. links provided in the response payload), the OAS
* linking mechanism does not require link information in the runtime
* response.
*
* For computing links, and providing instructions to execute them, a runtime
* expression is used for accessing values in an operation and using them as
* parameters while invoking the linked operation.
*
* @param operationRef
* A relative or absolute URI reference to an OAS operation. This field MUST
* point to an Operation Object. Relative operationRef values MAY be used to
* locate an existing Operation Object in the OpenAPI definition.
* @param parameters
* A map representing parameters to pass to an operation as identified via
* operationRef. The key is the parameter name to be used, whereas the value
* can be a constant or an expression to be evaluated and passed to the
* linked operation. The parameter name can be qualified using the parameter
* location [{in}.]{name} for operations that use the same parameter name in
* different locations (e.g. path.id).
* @param requestBody
* A literal value or {expression} to use as a request body when calling the
* target operation.
* @param description
* A description of the link.
* @param server
* A server object to be used by the target operation.
*/
final case class Link(
operationRef: URI,
parameters: Map[String, LiteralOrExpression] = Map.empty,
requestBody: LiteralOrExpression,
description: Option[Doc],
server: Option[Server],
)
object Link {
implicit val schema: Schema[Link] =
DeriveSchema.gen[Link]
}
sealed trait LiteralOrExpression
object LiteralOrExpression {
implicit val schema: Schema[LiteralOrExpression] =
DeriveSchema.gen[LiteralOrExpression]
final case class NumberLiteral(value: Long) extends LiteralOrExpression
object NumberLiteral {
implicit val schema: Schema[NumberLiteral] =
Schema[Long].transform[NumberLiteral](s => NumberLiteral(s), p => p.value)
}
final case class DecimalLiteral(value: Double) extends LiteralOrExpression
object DecimalLiteral {
implicit val schema: Schema[DecimalLiteral] =
Schema[Double].transform[DecimalLiteral](s => DecimalLiteral(s), p => p.value)
}
final case class StringLiteral(value: String) extends LiteralOrExpression
object StringLiteral {
implicit val schema: Schema[StringLiteral] =
Schema[String].transform[StringLiteral](s => StringLiteral(s), p => p.value)
}
final case class BooleanLiteral(value: Boolean) extends LiteralOrExpression
object BooleanLiteral {
implicit val schema: Schema[BooleanLiteral] =
Schema[Boolean].transform[BooleanLiteral](s => BooleanLiteral(s), p => p.value)
}
case class Expression(value: String) extends LiteralOrExpression
object Expression {
implicit val schema: Schema[Expression] =
Schema[String].transform[Expression](s => Expression.create(s), p => p.value)
private[openapi] def create(value: String): Expression = Expression(value)
}
// TODO: maybe one could make a regex to validate the expression. For now just accept anything
// https://swagger.io/specification/#runtime-expressions
val ExpressionRegex: Regex = """.*""".r
def expression(value: String): Option[LiteralOrExpression] =
value match {
case ExpressionRegex() => Some(Expression.create(value))
case _ => None
}
}
/**
* Adds metadata to a single tag that is used by the Operation Object. It is
* not mandatory to have a Tag Object per tag defined in the Operation Object
* instances.
*
* @param name
* The name of the tag.
* @param description
* A short description for the tag.
* @param externalDocs
* Additional external documentation for this tag.
*/
final case class Tag(name: String, description: Option[Doc], externalDocs: Option[ExternalDoc])
/**
* A simple object to allow referencing other components in the specification,
* internally and externally.
*
* @param ref
* The reference string.
*/
@noDiscriminator
sealed trait ReferenceOr[+T] {
def asJsonSchema(implicit ev: T <:< JsonSchema): JsonSchema = this match {
case ReferenceOr.Reference(ref, summary, description) =>
JsonSchema
.RefSchema(ref)
.description((summary.getOrElse(Doc.empty) + description.getOrElse(Doc.empty)).toCommonMark)
case ReferenceOr.Or(value) => ev(value)
}
}
object ReferenceOr {
implicit def schema[T: Schema]: Schema[ReferenceOr[T]] =
DeriveSchema.gen[ReferenceOr[T]]
@nowarn("msg=possible missing interpolator")
final case class Reference(
@fieldName("$ref") ref: String,
summary: Option[Doc] = None,
description: Option[Doc] = None,
) extends ReferenceOr[Nothing]
object Reference {
implicit val schema: Schema[Reference] =
DeriveSchema.gen[Reference]
}
final case class Or[T](value: T) extends ReferenceOr[T]
object Or {
implicit def schema[T: Schema]: Schema[Or[T]] =
Schema[T].transform(Or(_), _.value)
}
}
/**
* When request bodies or response payloads may be one of a number of
* different schemas, a discriminator object can be used to aid in
* serialization, deserialization, and validation. The discriminator is a
* specific object in a schema which is used to inform the consumer of the
* specification of an alternative schema based on the value associated with
* it.
*
* When using the discriminator, inline schemas will not be considered.
*
* @param propertyName
* The name of the property in the payload that will hold the discriminator
* value.
* @param mapping
* An object to hold mappings between payload values and schema names or
* references.
*/
final case class Discriminator(
propertyName: String,
mapping: Map[String, String] = Map.empty,
)
object Discriminator {
implicit val schema: Schema[Discriminator] =
DeriveSchema.gen[Discriminator]
}
/**
* A metadata object that allows for more fine-tuned XML model definitions.
*
* When using arrays, XML element names are not inferred (for singular/plural
* forms) and the name property SHOULD be used to add that information.
*
* @param name
* Replaces the name of the element/attribute used for the described schema
* property. When defined within items, it will affect the name of the
* individual XML elements within the list. When defined alongside type
* being array (outside the items), it will affect the wrapping element and
* only if wrapped is true. If wrapped is false, it will be ignored.
* @param namespace
* The URI of the namespace definition.
* @param prefix
* The prefix to be used for the name.
* @param attribute
* Declares whether the property definition translates to an attribute
* instead of an element.
* @param wrapped
* MAY be used only for an array definition. Signifies whether the array is
* wrapped (for example,