Closed Bug 1158386 Opened 8 years ago Closed 4 years ago
"API Documentation" is not documenting the expected format of parameters
53 bytes, text/x-github-pull-request
|Details | Review|
Every time I try to work with the API, I run into the issue of going to https://crash-stats.mozilla.com/api/ ("API Documentation") to find out about something, only to find out that it's missing the actual documentation of what format the parameters of the API expect. Concrete example right now: /api/Bugs/ says to have a "signatures" parameter, which sounds like it could retrieve bugs for multiple signatures, but there is no documentation of how to specify multiple ones.
(Also, in this concrete case, it's confusing as to why the output for e.g. https://crash-stats.mozilla.com/api/Bugs/?signatures=EnterBaseline would return entries of different signatures as well - I'd expect explanations like that at least linked when something calls itself "API Documentation".)
When we're done with our death-to-middleware we should make sure our new API thing works according the points KaiRo makes here.
Assignee: nobody → willkg
Status: NEW → ASSIGNED
Commits pushed to master at https://github.com/mozilla-services/socorro https://github.com/mozilla-services/socorro/commit/e9f1960ca0971c01ec5b4c1fc5e6914808c0e842 fix bug 1158386: add help text for all public API endpoints https://github.com/mozilla-services/socorro/commit/3f05e1c7abd6f095fccb86a3af8ad718d0e70a0c Merge pull request #4785 from willkg/1158386-api-docs fix bug 1158386: add help text for all public API endpoints
Status: ASSIGNED → RESOLVED
Closed: 4 years ago
Resolution: --- → FIXED
You need to log in before you can comment on or make changes to this bug.