search

Chicago / lead-safe-api-docs

http://dev.cityofchicago.org/docs/lead-safe/
1 stars 1 forks source link

Added draft of response codes for #14 #17

Closed tomschenkjr closed 6 years ago

tomschenkjr commented 6 years ago

Per our discussion from #14, I've drafted response codes for the API. The response codes align with typical HTTP status codes. Some errors map to the same error codes, namely, the 400 code is often used for various syntax errors. Below is a screenshot of how the specification is rendered and here is a link to that section.

image

While each error code has a broad explanation, we should pass the full error message back to the user. If we encounter an error message and unsure of the appropriate error code, we can discuss and modify the spec as needed.

@potash - Please review these and accept the pull request if this is fine. If accepted, we should begin programming to align to the proposed specifications.

I've versioned this pull request as v0.5.0-alpha3.

tomschenkjr commented 6 years ago

Small note - I've updated dev with some changes related to #16. I've rebased issue14 with those changes; namely, to update the left-side navigation and also iterated the proposed version to alpha4.

tomschenkjr commented 6 years ago

After our discussion on Friday, reassigning the review to Avishek since it impacts the runner code.

geneorama commented 6 years ago

@tomschenkjr mind if we delete branch issue14 and close the related issue?