swagger-api/swagger-codegen

[Java] Support enums in query params

Open

#1,347 opened on Oct 7, 2015

View on GitHub
 (13 comments) (8 reactions) (0 assignees)HTML (12,701 stars) (5,474 forks)batch import
Client: JavaEnhancement: Generalhelp wanted

Description

In Java generation, enums are generated when they are part of a definition object but not when they are a direct method property. For instance:

"/pet/findByStatus": {
      "get": {
        "tags": [
          "pet"
        ],
        "summary": "Finds Pets by status",
        "description": "Finds Pets by status",
        "operationId": "findPetsByStatus",
        "produces": [
          "application/json",
          "application/xml"
        ],
        "parameters": [
          {
            "name": "status",
            "in": "query",
            "description": "Status value that for filter",
             "type": "string",
             "enum": ["available", "pending", "sold"]
            }
         ],
        "responses": {
          "200": {
            "description": "successful operation",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/Pet"
              }
            }
          }
        }

Generates "status" as a String not as an enum.

Contributor guide

Tech stack
java
Domain
apibackendtooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
JavaOpenAPIswagger codegenMustache templating
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Review the Java generation templates in the codebase, specifically how enum types are handled for definition objects versus inline parameters. The issue provides an example where 'status' in query parameters should be generated as an enum type. Look at the Mustache templates for parameter handling and consider creating an enum class for inline enums. Check the issue comments for any suggested approaches.