Skip to content

Option to render all inherited parameters (when using 'allOf') #38

@msh321

Description

@msh321

Consider the following Swagger Spec snippet:

"definitions" : {
    "AAA" : {
      "allOf" : [ {
        "$ref" : "#/definitions/BBB"
      }, {
        "type" : "object",
        "properties" : {
          "ttt" : {
            "type" : "string"
          }
        }
      } ]
    },
    "BBB" : {
      "allOf" : [ {
        "$ref" : "#/definitions/CCC"
      }, {
        "type" : "object",
        "properties" : {
          "vvv" : {
            "type" : "string"
          }
        }
      } ]
    },
    "CCC" : {
      "type" : "object",
      "properties" : {
        "uuu" : {
          "type" : "string"
        },
        "ppp" : {
          "type" : "string"
        }
      }
    }
  }

When you using "bootprint swagger" to generate HTML, then the object AAA only displays the property ttt (in addition, you can see that AAA inherits from BBB). So, in order to see all properties, you need to click on the BBB object and then on the CCC object (because BBB inherits from CCC).


It would be really cool if the generator had an option that would render all the inherited properties (directly in AAA), so that it becomes easier to see which properties are part of the definition of AAA.

I have created mock-up screenshots of how this could look:

Here the "INHERITED PROPERTIES" section is collapsed:
bp1

And here it is expanded:
bp2

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions