search

open311 / swagger-open311

An swagger definition of Open311 GeoReport API
4 stars 8 forks source link

Add examples #6

Closed kvlahromei closed 9 years ago

kvlahromei commented 9 years ago

Swagger allows to embedd example request payloads: https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#exampleObject

Our spec contains raw JSON/XML examples, so do we want to add them? Does this make sense to mock/simulate the API for clients/servers? https://www.npmjs.com/package/swagger-server

kvlahromei commented 9 years ago

I asked the swagger folks about current integration and it seems that currently the editor / page generators or validators can do an automatically verification using examples. I guess we need to do it manually.