swagger-enumeratum-module's Introduction

swagger-enumeratum-module

Enumeratum support for swagger.

The echoenumeratum example in https://github.com/pjfanning/swagger-akka-http-sample demonstrates the use of this module with Akka-Http.

swagger-enumeratum-module v2.2.0 and above supports jakarta namespace. If you want javax namespace support, use v2.1.1

swagger-enumeratum-module's People

Contributors

Stargazers

Watchers

swagger-enumeratum-module's Issues

Enumeration schema inlined in OpenAPI YAML instead of declared and referenced

I have a simple enumeration like this:

sealed trait Outcome extends EnumEntry with Uppercase 

object Outcome extends Enum[Outcome] {
  case object Approved extends Outcome
  case object Denied extends Outcome
  case object Review extends Outcome
  case object Cancelled extends Outcome

  override val values: IndexedSeq[Outcome] = findValues

  def apply(name: String): Outcome = withNameInsensitive(name)

  implicit val decoder: Decoder[Outcome] = Decoder.decodeString map withNameInsensitive
  implicit val encoder: Encoder[Outcome] = Encoder.encodeString contramap (_.entryName)
}

In the generated OpenAPI document, the type is inlined as follows:

components:
  schemas:
    Activity:
      type: object
      properties:
        code:
          type: string
        decision:
          type: string
          enum:
          - APPROVED
          - DENIED
          - REVIEW
          - CANCELLED
    LogEntry:
      required:
      - decision
      - user
      type: object
      properties:
        user:
          type: string
        decision:
          type: string
          enum:
          - APPROVED
          - DENIED
          - REVIEW
          - CANCELLED

How can I instead make it its own type, as follows, without wrapping it in another case class?

components:
  schemas:
    Outcome:
      type: string
      enum:
        - APPROVED
        - DENIED
        - REVIEW
        - CANCELLED
    Activity:
      type: object
      properties:
        code:
          type: string
        decision:
          $ref: '#/components/schemas/Outcome'
    LogEntry:
      required:
      - decision
      - user
      type: object
      properties:
        user:
          type: string
        decision:
          $ref: '#/components/schemas/Outcome'