Multiple examples under example

[mcupak]

For some properties, there are multiple examples under a single example field, which is misleading. examples should be used instead.

[mcupak]

I'm reopening this issue as this wasn't solved correctly in #189. Examples should be listed separately, not as a string containing "or". Such a string is still just a single example.

[mcupak]

To clarify, it should look like this:

examples:
  foobar:
    value:
      id: foo
      name: bar

[mcupak]

This is actually a blocker for the release - the current content is not valid and breaks the build.

[sdelatorrep]

As noted by @juhtornr , examplescannot be used for schemas and properties (see here). So, we can fix the examples provided in the variantType parameter (see here) but the others cases (e.g. this one) will remain as they are (example with multiple examples specified in the string).

[sdelatorrep]

Hi guys,
It seems that swagger-ui cannot render examples yet (see this). I suggest keeping the "Examples" within the description string so they can still be seen in the UI.

        - name: variantType
          description: |
            The `variantType` is used to denote e.g. structural variants. 
            
            Examples:
            * DUP: duplication of sequence following `start`; not necessarily in
            situ
            * DEL: deletion of sequence following `start`
            
            Optional: either `alternateBases` or `variantType` is required.
          in: query
          required: false
          schema:
            type: string
          examples:
            dup:
              value: DUP
              summary: duplication of sequence following `start`; not necessarily in
            del:
              value: DEL
              summary: deletion of sequence following `start`

WDYT?

[mbaudis]

@sdelatorrep +1 for keeping it in description (if this works in general).