search

GSA / api-documentation-template

Other
10 stars 29 forks source link

Update formatting of JSON Response Bodies in Documentation #32

Closed mvogelgesang closed 7 years ago

mvogelgesang commented 7 years ago

Currently the response bodies do not wrap and are all contained on a single line. This makes reading the documentation difficult. Instead, the responses should be formatted across multiple lines so they are quick and easy to read for devs. Example below

{
  name: "response",
  createdDate: "2017-01-20",
  modifiedDate: "2017-01-22",
  tags: [
    "tag1",
    "tag2",
    "tag3"
  ]
}
Ryandaydev commented 7 years ago

First: thanks for reviewing and commenting.

Next question: which page is this issue referring to?