swagger-api/swagger-ui

Format:date with example renders time in addition to date

Open

#5,215 建立於 2019年3月4日

在 GitHub 查看
 (3 留言) (0 反應) (0 負責人)JavaScript (8,801 fork)batch import
HacktoberfestP2type: bug

倉庫指標

Star
 (25,447 star)
PR 合併指標
 (平均合併 20小時 34分鐘) (30 天內合併 14 個 PR)

描述

Q&A (please complete the following information)

  • OS: Windows
  • Browser: Chrome
  • Version: 72
  • Method of installation: visual studio code extension (openapi-designer)
  • Swagger-UI version: [e.g. 3.21.0]
  • Swagger/OpenAPI version: OpenAPI 3.0

Content & configuration

I use a visual studio extension to render things on the fly (openapi-designer) and have checked that it uses the latest version of swagger-ui

Example Swagger/OpenAPI definition:

startDate:
   type: string
   format: date
   example: 2018-12-25

Describe the bug you're encountering

There was recently a pull request to make automatic example if it is not present. That works fine, but when I have my own example, then the rendered date for some reason includes timestamp as well:

"startDate": "2018-12-25T00:00:00.000Z",

To reproduce...

  1. Render YAML with type: string and format: date
  2. Open an example value in the browser

Expected behavior

Expected to see only date in example

"startDate": "2018-12-25",

貢獻者指南