Closed Bug 1030901 Opened 7 years ago Closed 7 years ago

document new Input API for getting responses

Categories

(Input :: General, defect)

defect
Not set
normal

Tracking

(Not tracked)

RESOLVED FIXED

People

(Reporter: willkg, Assigned: willkg, Mentored)

References

Details

(Whiteboard: u=user c=api p=1 s=input.2014q3)

I threw together an Input API for getting responses. This needs to be documented.

The code is in fjord/feedback/api_views.py in PublicFeedbackAPI class.
Marking this as mentored and also a good first bug.

The API is pretty straight-forward. It's entirely driven by querystring parameters. The documentation should list the API endpoint (/api/v1/feedback/), the method required (GET) and the parameters that can be used and what they do.

It'd be nice to have some examples of usage.

Documentation for Fjord API stuff is located in docs/api.rst . I think these new docs should go in there, too.

If you're interested in working on this bug, either reply in this bug's comments or ping me on IRC (I'm willkg).
Mentor: willkg
Whiteboard: [good first bug]
This should block the Dashboards for Everyone project tracker bug.
Blocks: 1040773
No one took this, so I'm grabbing this now.
Assignee: nobody → willkg
Whiteboard: [good first bug] → u=user c=api p=1 s=input.2014q3
Landed in https://github.com/mozilla/fjord/commit/aad961dc133139773dd23c57769e987adac38d0a

This doesn't need to be pushed anywhere, so I'm just going to mark it as FIXED.
Status: NEW → RESOLVED
Closed: 7 years ago
Resolution: --- → FIXED
You need to log in before you can comment on or make changes to this bug.