sfbrigade / datasci-sba

Solving problems with the Small Business Administration
10 stars 18 forks source link

Adding spec for API Design #41

Closed VincentLa14 closed 7 years ago

VincentLa14 commented 7 years ago

Added a spec for the work we want to do for API Design as we talked about on 2017-08-16.

makfan64 commented 7 years ago

I don't know why I can't checkout to your specs branch, or I'd make some edits in git.

I think I'd change the wording in a few places to be more consistent in using region instead of zip. Zip is one type of region (the default type) and the first one we will support, but we are planning to build it such that the other region types can be supported as soon as we have the technical details ironed out.

I think the rest looks good.

Thanks for taking the lead on this.

makfan64 commented 7 years ago

I pushed my suggested edits to this branch.

VincentLa14 commented 7 years ago

@makfan64 looks like you solved it, but I think the problem was you need to git pull to be up-to-date.

Also agree with your wording about region vs zip!