search

GSA / api-documentation-template

Other
10 stars 29 forks source link

Example API Calls Should Denote Data Response Formats #33

Closed mvogelgesang closed 7 years ago

mvogelgesang commented 7 years ago

The first example on https://gsa.github.io/api-documentation-template/api-docs/console/ shows that you can call https://api.consumerfinance.gov:443/data. However, it does not tell you if you can request xml or json (both are supported). There should be a standard convention either in the summary of an API or on each request that identifies that data format.

Ryandaydev commented 7 years ago

These pages were replaced with a newer version. However I added a note about the type of response supported (JSON in this case).