Closed Bug 1081177 Opened 10 years ago Closed 9 years ago

name API endpoints and carry new naming through all docs and bugs

Categories

(Input Graveyard :: Backend, defect, P3)

Product:
Input Graveyard
Component:
Backend
Type:
defect

Tracking

(Not tracked)

Status:
RESOLVED FIXED

People

(Reporter: willkg, Assigned: willkg)

Details

(Whiteboard: u=dev c=api p=1 s=input.2015q1) 

We expanded the Input API beyond just "posting feedback" and now have a variety of API endpoints. The problem is that I'm still using "Input API" to talk about some of them and that's causing confusion (and rightfully so).

This bug covers figuring out a naming scheme for the endpoints that's not ambiguous, documenting it with the API docs and then going through the documentation and bugs and updating the language.
Bumping to 2015q1 because we're out of time for 2014q4.
Whiteboard: u=dev c=api p= s=input.2014q4 → u=dev c=api p= s=input.2015q1
Bumping this to P3 since it's not super important to get done.
Priority: P1 → P3
Pushing off to next quarter.
Whiteboard: u=dev c=api p= s=input.2015q1 → u=dev c=api p= s=input.2015q2
I'm naming it "Feedback API". The other API endpoints have their names already: Alerts API, Events API and Heartbeat API.

I went through the docs and updated them. I also removed the docs for the Heartbeat v1 API (which is now defunct) and moved the Events API into its own page.

https://github.com/mozilla/fjord/commit/1cac1667a776bf31f3e612760d6810e8001294b5

This is just docs work, so I'm making it a 1 pointer, moving it back to the 2015q1 quarter and marking it RESOLVED.
Assignee: nobody → willkg
Status: NEW → RESOLVED
Closed: 9 years ago
Resolution: --- → FIXED
Whiteboard: u=dev c=api p= s=input.2015q2 → u=dev c=api p=1 s=input.2015q1
Product: Input → Input Graveyard
You need to log in before you can comment on or make changes to this bug.