swagger-api / swagger-api/swagger-codegen

[JavaScript] returnType = null when used with "allOf"

Open
#8,404 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Mustache
Stars
17.8k
Forks
6k
PR merge metrics
No merged PRs in 30d

Description

Hi,

Description

Using JavaScript codegen I got null data when endpoint response definition has allOf.

Swagger-codegen version

2.3.1

Swagger declaration file content or url
"/item-categories": {
      "get": {
        "operationId": "findItemCategories",
        "responses": {
          "200": {
            "description": "",
            "schema": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "results": {
                      "type": "array",
                      "items": {
                        "$ref": "#/definitions/item-category-output"
                      }
                    }
                  },
                  "required": [
                    "results"
                  ]
                },
                {
                  "$ref": "./common.oas2.yml#/definitions/standard-list-result"
                }
              ]
            }
          }
        }
      }
Suggest a fix/enhancement

I see that generated code has following part causing this for those endpoints:

var returnType = BackgroundOutputDetailed;

Thanks,

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the JavaScript code generated for the supplied /item-categories response and inspect how the allOf schema is converted into the returnType assignment. Reproduce the null return type with the shown Swagger declaration, then verify that a suitable non-null response type is generated for this endpoint.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
api, devtools
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.