Sample values in request body on developer portal SmartDocs

I am wondering if/how the request body can list sample values on developer portal SmartDocs.

I have a POST method with a body parameter that is defined in YAML as follows:

- name: body
  in: body
  description: Sample description
  schema:
    $ref: '#/definitions/sampleDefs'

At the bottom in the definitions I have:

definitions:
  sampleDefs:
    type: object
    properties:
      dateOfBirth:
        type: string
        default: 01-01-1900
      gender:
        type: string
        default: female
      maritalStatus:
        type: string
        default: single

When I import and render on the portal, the request body correctly lists the properties from the YAML definitions, but not the sample values. Instead it lists the default value for that type of property. Is it possible to specify those values in the YAML file and have them display when rendered on the portal?

The only workaround I have found is removing the schema and adding "body sample" through the UI editor.

1 2 624
2 REPLIES 2

I don't believe this is supported at this time.