Interpret OpenAPI examples and example fields

[adrien1212]

Does Thunder interpret examples and example fields ?
For example, in the specification of OpenAPI we can define examples for body request/response
SwaggerUI interpret it but I don't think Thunder do it.

Example :

   post:
      operationId: create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DDClient'
            example:
              clientId: "un id"
              name: "un name"

So SwaggerUI interpret the example and add it automatically in the request

But in Thunder there is only the schema without being completed with the example

So the user must fill it in by hand

[rangav]

Hi @adrien1212 can you share sample openAPI file, will verify it.

[adrien1212]

Hi @rangav
Thank you, please find a Minimal reproducible example

openapi: 3.0.0
info:
  description: Api to handle client in daily database
  title: Client api
  version: "1.0"
servers:
- url: /
tags:
- name: client
paths:
  /clients:
    post:
      operationId: create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClientSearchCriteria'
            examples:
              default:
                $ref: '#/components/examples/defaultListRequest'
      responses:
        default:
          content:
            application/json:
              examples:
                default:
                  $ref: '#/components/examples/defaultListResponse'
              schema:
                items:
                  $ref: '#/components/schemas/ClientSearchCriteria'
                type: array
          description: default response

components:
  schemas:
    ClientSearchCriteria:
      properties:
        clientId:
          type:
            string
        name:
          type:
            string
      type: object
    
  examples:
    defaultListRequest:
      value:
        cliendId: "clientId body request"
        name: "name body request"
    defaultListResponse:
      value:
        cliendId: "clientId response"
        name: "name response"

Thunder interpretation

It could be good to have instead

{
  "clientId": "clientId body request",
  "name": "name body request"
}

[rangav]

Thanks for sharing will add to roadmap.

[rangav]

I have created a new feature request for this.
#1083