Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Requiredness of body parameter lost

See original GitHub issue

Input

{
  "name": "indexer",
  "in": "body",
  "required": true,
  "schema": {
    "$ref": "#/definitions/Indexer"
  },
  "description": "The definition of the indexer to create or update."
}

Output

"requestBody": {
  "content": {
    "application/json": {
      "description": "The definition of the indexer to create or update.",
      "schema": {
        "$ref": "#/components/schemas/Indexer"
      }
    }
  }
}

Expected

"requestBody": {
  "content": {
    "application/json": {
      "description": "The definition of the indexer to create or update.",
      "schema": {
        "$ref": "#/components/schemas/Indexer"
      }
    }
  },
  "required": true
}

Detail

According to https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md#request-body-object, required defaults to false, so it needs to be set to true explicitly 🙂

Issue Analytics

State:
Created 6 years ago
Comments:5 (3 by maintainers)

Top GitHub Comments

1reaction

MikeRalphsoncommented, Jun 7, 2017

I’m consuming the npm package.

v2.2.1 just published.

1reaction

MikeRalphsoncommented, Jun 7, 2017

whoops, saw your comment only now, but didn’t take much time to fix (in case the fix is okay, haven’t spent too much time following the code) 🙂 awesome project!

No, @olydis that’s cool - the fix is correct and helped me decide which branch to apply it to. (Let me know if you’re using the npm package and/or the web front-end and I will do a proper release).

Have applied a similar fix for 2.0 in: file parameters.

Thanks again for spotting the issue, and for the PR and kind comments.