open311 / swagger-open311

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

more formal definitions #8

Open kvlahromei opened 9 years ago

kvlahromei commented 9 years ago

If we want to get good formal definitions (see #7 ) we might also bring some more logic into datastructures, so validation might be easier. This includes esp.:

This might also result in discussions (e.g. do we consider IDs always to be strings (e.g. hashes, hex numbers, ...) or just positive integers, ...)?

philipashlock commented 9 years ago

It doesn't look like this is properly covered in the documentation, but I think everything (other than hashes/arrays) should be a string.

kvlahromei commented 9 years ago

Ok a string. This excludes any special characters that might corrupt any marshelling/serializers or the use within URLs, right? So just an alphanum string?