Skip to content

Commit

Permalink
Add description annotation content to docs for open API (#2722) (#2914
Browse files Browse the repository at this point in the history 
)
  • Loading branch information
@987Nabil
987Nabil authored Jun 18, 2024
1 parent 554660c commit cf9467e
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 61 deletions.
96 changes: 35 additions & 61 deletions zio-http/jvm/src/test/scala/zio/http/endpoint/openapi/OpenAPIGenSpec.scala
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import zio.json.ast.Json
import zio.test._
import zio.{Scope, ZIO}

import zio.schema.annotation.{caseName, discriminatorName, noDiscriminator, optionalField, transientField}
import zio.schema.annotation._
import zio.schema.{DeriveSchema, Schema}

import zio.http.Method.{GET, POST}
Expand Down Expand Up @@ -113,6 +113,7 @@ object OpenAPIGenSpec extends ZIOSpecDefault {
case class NestedThree(name: String) extends SimpleNestedSealedTrait
}

@description("A simple payload")
case class Payload(content: String)

object Payload {
Expand Down Expand Up @@ -2251,36 +2252,29 @@ object OpenAPIGenSpec extends ZIOSpecDefault {
| "/root/{name}" : {
| "get" : {
| "parameters" : [
|
| {
| {
| "name" : "name",
| "in" : "path",
| "required" : true,
| "schema" :
| {
| "type" :
| "string"
| "schema" : {
| "type" : "string"
| },
| "examples" : {
| "hi" :
| {
| "hi" : {
| "value" : "name_value"
| }
| },
| "style" : "simple"
| }
| ],
| "requestBody" :
| {
| "requestBody" : {
| "content" : {
| "application/json" : {
| "schema" :
| {
| "schema" : {
| "$ref" : "#/components/schemas/Payload"
| },
| "examples" : {
| "hi" :
| {
| "hi" : {
| "value" : {
| "content" : "input"
| }
Expand All @@ -2291,14 +2285,11 @@ object OpenAPIGenSpec extends ZIOSpecDefault {
| "required" : true
| },
| "responses" : {
| "200" :
| {
| "200" : {
| "content" : {
| "application/json" : {
| "schema" :
| {
| "type" :
| "string"
| "schema" : {
| "type" : "string"
| }
| }
| }
Expand All @@ -2309,19 +2300,17 @@ object OpenAPIGenSpec extends ZIOSpecDefault {
| },
| "components" : {
| "schemas" : {
| "Payload" :
| {
| "type" :
| "object",
| "Payload" : {
| "type" : "object",
| "properties" : {
| "content" : {
| "type" :
| "string"
| "type" : "string"
| }
| },
| "required" : [
| "content"
| ]
| ],
| "description" : "A simple payload"
| }
| }
| }
Expand Down Expand Up @@ -2351,55 +2340,45 @@ object OpenAPIGenSpec extends ZIOSpecDefault {
| "/root/{name}" : {
| "get" : {
| "parameters" : [
|
| {
| {
| "name" : "name",
| "in" : "path",
| "required" : true,
| "schema" :
| {
| "type" :
| "string"
| "schema" : {
| "type" : "string"
| },
| "examples" : {
| "hi" :
| {
| "hi" : {
| "value" : "name_value"
| },
| "ho" :
| {
| "ho" : {
| "value" : "name_value2"
| }
| },
| "style" : "simple"
| }
| ],
| "requestBody" :
| {
| "requestBody" : {
| "content" : {
| "application/json" : {
| "schema" :
| {
| "schema" : {
| "anyOf" : [
| {
| "$ref" : "#/components/schemas/Payload"
| },
| {
| "type" :
| "string"
| "type" : "string"
| }
| ],
| "description" : ""
| },
| "examples" : {
| "hi" :
| {
| "hi" : {
| "value" : {
| "content" : "input"
| }
| },
| "ho" :
| {
| "ho" : {
| "value" : "input"
| }
| }
Expand All @@ -2408,14 +2387,11 @@ object OpenAPIGenSpec extends ZIOSpecDefault {
| "required" : true
| },
| "responses" : {
| "200" :
| {
| "200" : {
| "content" : {
| "application/json" : {
| "schema" :
| {
| "type" :
| "string"
| "schema" : {
| "type" : "string"
| }
| }
| }
Expand All @@ -2426,19 +2402,17 @@ object OpenAPIGenSpec extends ZIOSpecDefault {
| },
| "components" : {
| "schemas" : {
| "Payload" :
| {
| "type" :
| "object",
| "Payload" : {
| "type" : "object",
| "properties" : {
| "content" : {
| "type" :
| "string"
| "type" : "string"
| }
| },
| "required" : [
| "content"
| ]
| ],
| "description" : "A simple payload"
| }
| }
| }
Expand Down
1 change: 1 addition & 0 deletions zio-http/shared/src/main/scala/zio/http/endpoint/openapi/JsonSchema.scala
View file
Original file line number Diff line number Diff line change
Expand Up @@ -523,6 +523,7 @@ object JsonSchema {
.map(_.name),
)
.deprecated(deprecated(record))
.description(record.annotations.collectFirst { case description(value) => value })
case collection: Schema.Collection[_, _] =>
collection match {
case Schema.Sequence(elementSchema, _, _, _, _) =>
Expand Down

0 comments on commit cf9467e

Please sign in to comment.