example generation crashes browser

[tsoestini]

RapiDoc currently generates every possible combination of examples.

Unfortunately, this means if you have an object with 10 fields, each with two examples, you get 1024 examples.

And, if you have a route that returns a left object and a right object of those, then you have 1M examples, crashing the browser.

So, why not just stick to one example?

I'd love to, but RapiDoc auto-generates two examples for every oneOf element that I have.

Maybe the default behavior (or at least an optional behavior) could be to only generate examples for the first choice of any oneOf element?

[tsoestini]

here's an example demonstrating the problem
tennis.v1.zip

[mrin9]

I will look into this, but just so you know, If you do not want RapiDoc to generate examples then you can provide your own (which takes the precedence over auto generated one) for each request/response operation.

modified your spec and provided my own examples -

openapi: 3.0.0
info:
  title: tennis
  version: '1.0'
  contact:
    name: test
  description: |-
    getPlayer -- takes a long time to view example
    getTennisMatch -- crashes when you click on it
servers:
  - url: 'http://localhost:3000'
paths:
  /getPlayer:
    get:
      summary: get player info
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Player'
              examples:
                my-example-hexcode:
                  value: |  
                    {
                      "eyeColor": "#FF0000",
                      "hairColor": "#FF0000",
                      "lipColor": "#FF0000",
                      "mouthColor": "#FF0000",
                      "pantsColor": "#FF0000",
                      "racketColor": "#FF0000",
                      "shirtColor": "#FF0000",
                      "shoeColor": "#FF0000",
                      "skinColor": "#FF0000",
                      "sockColor": "#FF0000"
                    }
                my-example-rgb:
                  value: |  
                    {
                      "eyeColor": { r: 255, g: 0, b: 0 },
                      "hairColor": { r: 255, g: 0, b: 0 },
                      "lipColor": { r: 255, g: 0, b: 0 },
                      "mouthColor": { r: 255, g: 0, b: 0 },
                      "pantsColor": { r: 255, g: 0, b: 0 },
                      "racketColor": { r: 255, g: 0, b: 0 },
                      "shirtColor": { r: 255, g: 0, b: 0 },
                      "shoeColor": { r: 255, g: 0, b: 0 },
                      "skinColor": { r: 255, g: 0, b: 0 },
                      "sockColor":  { r: 255, g: 0, b: 0 }
                    }
      operationId: get-getPlayer
      description: takes a long time to view example
      tags:
        - takes a long time

  /getTennisMatch:
    get:
      summary: gets tennis match info
      tags:
        - will crash
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  leftPlayer:
                    $ref: '#/components/schemas/Player'
                  rightPlayer:
                    $ref: '#/components/schemas/Player'
              examples:
                my-example:
                  value: |
                    {
                      "leftPlayer": {
                        "eyeColor": "#FF0000",
                        "hairColor": "#FF0000",
                        "lipColor": "#FF0000",
                        "mouthColor": "#FF0000",
                        "pantsColor": "#FF0000",
                        "racketColor": "#FF0000",
                        "shirtColor": "#FF0000",
                        "shoeColor": "#FF0000",
                        "skinColor": "#FF0000",
                        "sockColor": "#FF0000"
                      },
                      "rightPlayer": {
                        "eyeColor": "#FF0000",
                        "hairColor": "#FF0000",
                        "lipColor": "#FF0000",
                        "mouthColor": "#FF0000",
                        "pantsColor": "#FF0000",
                        "racketColor": "#FF0000",
                        "shirtColor": "#FF0000",
                        "shoeColor": "#FF0000",
                        "skinColor": "#FF0000",
                        "sockColor": "#FF0000"
                      }
                    }      
      operationId: get-getTennisMatch
      description: crashes when you click on it
    parameters: []
components:
  schemas:
    Color:
      title: Color
      description: ''
      oneOf:
        - type: string
          properties: {}
          description: color code
          example: '#FF0000'
        - type: object
          properties:
            r:
              type: integer
              example: 255
            g:
              type: integer
              example: 0
            b:
              type: integer
              example: 0
          description: RGB color
    Player:
      title: Player
      type: object
      properties:
        eyeColor:
          $ref: '#/components/schemas/Color'
        hairColor:
          $ref: '#/components/schemas/Color'
        lipColor:
          $ref: '#/components/schemas/Color'
        mouthColor:
          $ref: '#/components/schemas/Color'
        pantsColor:
          $ref: '#/components/schemas/Color'
        racketColor:
          $ref: '#/components/schemas/Color'
        shirtColor:
          $ref: '#/components/schemas/Color'
        shoeColor:
          $ref: '#/components/schemas/Color'
        skinColor:
          $ref: '#/components/schemas/Color'
        sockColor:
          $ref: '#/components/schemas/Color'
tags:
  - name: takes a long time
  - name: will crash

[tsoestini]

Thanks, that worked!

I had tried adding my own examples. At first I tried at the property level but that didn't help because it was below the oneOfs. So, I tried at the model level (you can see one on the Color model in the original file above), but no matter which level in the model I tried, RapiDoc was ignoring those (probably because they seem to be non-standard extensions, though my editor recognizes them).

I did not know I could add examples to the route level, but that does work, so I will do that for now. Thanks again!