Fixes v2 examples serialization in a response object

[MaggieKimani1]

• Retains examples present in a media type object by adding serialization logic of the examples map to x-examples during down-casting from v3 to v2
• Adds logic to cater for the round trip i.e. serializing x-examples in a v2 document to examples in the resulting v3 document during upcasting
• Fixes Examples are missing after converting V3 swagger to V2 #1430

Snippets

openapi: 3.0.1
info:
  title: Pet Store API
  version: 1.0.0
paths:
  /pets:
    get:
      summary: Get all pets
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    name:
                      type: string
                    age:
                      type: integer
              examples:
                example1:
                  summary: Example - List of Pets
                  value:
                    - name: "Buddy"
                      age: 2
                    - name: "Whiskers"
                      age: 1
               example2:
                  summary: Example - Playful Cat
                  value:
                    name: "Whiskers"
                    age: 1

Results to:

swagger: '2.0'
info:
  title: Pet Store API
  version: 1.0.0
paths:
  /pets:
    get:
      summary: Get all pets
      produces:
        - application/json
      responses:
        '200':
          description: Successful response
          schema:
            type: array
            items:
              type: object
              properties:
                name:
                  type: string
                age:
                  type: integer
          x-examples:
            example1:
              summary: Example - List of Pets
              value:
                - name: "Buddy"
                  age: 2
                - name: "Whiskers"
                  age: 1
           example2:
              summary: Example - Playful Cat
              value:
                name: "Whiskers"
                age: 1

And the reverse is also true.

[baywet]

Thanks for making the changes!

[sonarqubecloud]

Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
81.6% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud