Forum Discussion

swilko's avatar
swilko
New Contributor
6 years ago

Mock API Generation does not use data/date-time spec examples

I have an open API 3.0 spec which uses date and date time fields. 

 

I've found the API mocking integration does not use the example values in my specification.

 

For dates, the value is always 

2015-07-20

For date time it is always

2015-07-20T15:49:04-07:00

I've created a sample API which demonstrates the issue.

Below is the mocking endpoint

https://virtserver.swaggerhub.com/swilko/TestPetStoreAPI/1.0.0/store/order/1

Below is the spec examples which are specified in the spec for the Order schema, which are not returned by the mock.

 

shipDate:
type: string
format: date-time
example: "2017-07-21T17:32:28Z"
otherDate:
type: string
format: date
example: "2017-07-21"

Date
example
mock
  • HKosova's avatar
    HKosova
    SmartBear Alumni (Retired)
    6 years ago

    Hi swilko,

     

    Thanks for the details! I have reproduced the issue and forwarded it to our developers.

     

    As a workaround, please add a schema-level example for the whole object - in this case the mock will use the correct date/time examples:

        Order:
      type: object
      properties:
        ...
      example:
        id: 1
        petId: 12
        qualtity: 1
        shipDate: '2017-07-21T17:32:28Z'  # <------
        otherDate: '2017-07-21'           # <------
        status: delivered
        complete: true
    • swilko's avatar
      swilko
      New Contributor
      6 years ago

      Thanks for the reply, confirming the schema level example worked.