{"action":"created","issue":{"url":"https://api.github.com/repos/cfpb/hmda-platform/issues/261","repository_url":"https://api.github.com/repos/cfpb/hmda-platform","labels_url":"https://api.github.com/repos/cfpb/hmda-platform/issues/261/labels{/name}","comments_url":"https://api.github.com/repos/cfpb/hmda-platform/issues/261/comments","events_url":"https://api.github.com/repos/cfpb/hmda-platform/issues/261/events","html_url":"https://github.com/cfpb/hmda-platform/issues/261","id":142976036,"number":261,"title":"Define public API","user":{"login":"jmarin","id":438146,"avatar_url":"https://avatars.githubusercontent.com/u/438146?v=3","gravatar_id":"","url":"https://api.github.com/users/jmarin","html_url":"https://github.com/jmarin","followers_url":"https://api.github.com/users/jmarin/followers","following_url":"https://api.github.com/users/jmarin/following{/other_user}","gists_url":"https://api.github.com/users/jmarin/gists{/gist_id}","starred_url":"https://api.github.com/users/jmarin/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jmarin/subscriptions","organizations_url":"https://api.github.com/users/jmarin/orgs","repos_url":"https://api.github.com/users/jmarin/repos","events_url":"https://api.github.com/users/jmarin/events{/privacy}","received_events_url":"https://api.github.com/users/jmarin/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/cfpb/hmda-platform/labels/File%20Submission","name":"File Submission","color":"5319e7"}],"state":"open","locked":false,"assignee":{"login":"jmarin","id":438146,"avatar_url":"https://avatars.githubusercontent.com/u/438146?v=3","gravatar_id":"","url":"https://api.github.com/users/jmarin","html_url":"https://github.com/jmarin","followers_url":"https://api.github.com/users/jmarin/followers","following_url":"https://api.github.com/users/jmarin/following{/other_user}","gists_url":"https://api.github.com/users/jmarin/gists{/gist_id}","starred_url":"https://api.github.com/users/jmarin/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jmarin/subscriptions","organizations_url":"https://api.github.com/users/jmarin/orgs","repos_url":"https://api.github.com/users/jmarin/repos","events_url":"https://api.github.com/users/jmarin/events{/privacy}","received_events_url":"https://api.github.com/users/jmarin/received_events","type":"User","site_admin":false},"milestone":{"url":"https://api.github.com/repos/cfpb/hmda-platform/milestones/8","html_url":"https://github.com/cfpb/hmda-platform/milestones/Sprint%207","labels_url":"https://api.github.com/repos/cfpb/hmda-platform/milestones/8/labels","id":1693820,"number":8,"title":"Sprint 7","description":"","creator":{"login":"Kibrael","id":8459164,"avatar_url":"https://avatars.githubusercontent.com/u/8459164?v=3","gravatar_id":"","url":"https://api.github.com/users/Kibrael","html_url":"https://github.com/Kibrael","followers_url":"https://api.github.com/users/Kibrael/followers","following_url":"https://api.github.com/users/Kibrael/following{/other_user}","gists_url":"https://api.github.com/users/Kibrael/gists{/gist_id}","starred_url":"https://api.github.com/users/Kibrael/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Kibrael/subscriptions","organizations_url":"https://api.github.com/users/Kibrael/orgs","repos_url":"https://api.github.com/users/Kibrael/repos","events_url":"https://api.github.com/users/Kibrael/events{/privacy}","received_events_url":"https://api.github.com/users/Kibrael/received_events","type":"User","site_admin":false},"open_issues":5,"closed_issues":0,"state":"open","created_at":"2016-04-08T16:31:17Z","updated_at":"2016-04-25T13:48:07Z","due_on":"2016-05-08T04:00:00Z","closed_at":null},"comments":2,"created_at":"2016-03-23T14:34:10Z","updated_at":"2016-04-26T17:15:18Z","closed_at":null,"body":"See discussion and possible endpoints [here](https://github.com/cfpb/hmda-platform-ui/issues/37)"},"comment":{"url":"https://api.github.com/repos/cfpb/hmda-platform/issues/comments/214815824","html_url":"https://github.com/cfpb/hmda-platform/issues/261#issuecomment-214815824","issue_url":"https://api.github.com/repos/cfpb/hmda-platform/issues/261","id":214815824,"user":{"login":"wpears","id":1558033,"avatar_url":"https://avatars.githubusercontent.com/u/1558033?v=3","gravatar_id":"","url":"https://api.github.com/users/wpears","html_url":"https://github.com/wpears","followers_url":"https://api.github.com/users/wpears/followers","following_url":"https://api.github.com/users/wpears/following{/other_user}","gists_url":"https://api.github.com/users/wpears/gists{/gist_id}","starred_url":"https://api.github.com/users/wpears/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/wpears/subscriptions","organizations_url":"https://api.github.com/users/wpears/orgs","repos_url":"https://api.github.com/users/wpears/repos","events_url":"https://api.github.com/users/wpears/events{/privacy}","received_events_url":"https://api.github.com/users/wpears/received_events","type":"User","site_admin":false},"created_at":"2016-04-26T17:15:18Z","updated_at":"2016-04-26T17:15:18Z","body":"Good stuff Hans.\r\n\r\nOriginally I had the structure a bit more hierarchical but changed to more stuff in the querystring because I thought it make the endpoints clearer at a glance (`/edits/row?...` is clearly most concerned with row-aggregated edits). That said, I am completely okay with the hierarchical approach, especially if it makes defining certain rules easier.\r\n\r\nSome other thoughts:\r\n\r\n- `filings` could just be `year` if the quarter is in its own path separator (ie `year/2018/q1/...`). Makes less sense if the quarter is incorporated in the name (`2018-q1`). Also, it almost seems quarter should have it's own collection descriptor in the URI (`/year/2018/quarter/q1`). This seems a shame because the quarters will always be the same and there are only four, but if the quarter is going in the path of the URI, I think it may be necessary. Also, we'll have to make sure that the quarter part of the URI can be ignored by FIs that don't file quarterly, eg\r\n`/institutions/12345678/filings/2018/quarter/q1/1/sign` and `/institutions/12345678/filings/2018/1/sign` are both valid. The quarter could also go in the querystring ^^;\r\n\r\n- POSTing to /institutions/12345678/filings/2018/<quarter somehow>` for the file submission is pretty cool, :+1:\r\n\r\n-  I think a per edit query is fine/could be useful/makes since in a hierarchical URI structure. Do not that many rows may be returned that all fail this edit.\r\n\r\n- We'll need a row-based way to query edits, maybe `/institutions/12345678/filings/2018/rows` and `/institutions/12345678/filings/2018/rows/1`. Is it clear that this URI points to edits (of all types) at a given row/LAR? Should we prefer  `/institutions/12345678/filings/2018/lars`?\r\n\r\n- Do we want a way to isolate a given row/LAR for a given edit? Doesn't really fit the `/edits/` `/rows` paradigm as they seem like separate structures. If we don't need this, though, then no worries.\r\n\r\n"}}