Forum Discussion

mayurw's avatar
mayurw
New Member
5 years ago

How to set Example values to API request Fields with description?

For Example i have sample api given below  { "header": { "apiversion": "string", "clientID": "string", "timeStamp": "string" }, "request": {} }   I need to add a description to fields. Supp...
HKosova's avatar
HKosova
SmartBear Alumni (Retired)
5 years ago

Hi mayurw,

 

Use the description keyword to specify property descriptions, and the example keyword to specify example values.

type: object
properties:
  header:
    type: object
    properties:
      apiversion:
        type: string
        description: Please provide API version here   # <-----
        example: '2'          # <-----
      clientId:
        type: string
        example: abcde12345   # <-----
      timeStamp:
        type: string
  request:
    type: object