KaiZen-OpenAPI-Editor icon indicating copy to clipboard operation
KaiZen-OpenAPI-Editor copied to clipboard

In QuickOutline, object array elements can appear without label

Open tedepstein opened this issue 9 years ago • 0 comments

The following screenshot shows an array of objects contained within the Examples section of the "Pet Store with Examples" Swagger spec:

image

Objects in an array are supposed to be labeled according to the following rule, from the spec in #40:

  • For an object array element, we should also use the [name] label with a [type] annotation.
    • The type annotation should be derived from the schema in the same manner as with a single-valued object property, described above.
    • The name label should be taken from the name property, if there is one. For example, each parameter object in the parameters array (within a method object) has a required name property. In this case, the name will appear twice: once as the primary label of the object, and again as the value of the name property within the object.
    • If no name property is provided, use "(unnamed object)" as the label. We will try to avoid these situations, and possibly implement other rules for these cases.

tedepstein avatar Sep 08 '16 12:09 tedepstein