1548830 - Token page has incorrect usage example

Status: RESOLVED FIXED

(Socorro :: Webapp, defect)

Description

[John Whitlock [:jwhitlock]]

On https://crash-stats.mozilla.com/api/tokens/ (login required), there is an example of token usage:

curl -H "Auth-Token: 58af2acef8a74dbca9580e2bb8ba9c9a" https://crash-stats.mozilla.com/api/RawCrash/?uuid=fb27d0f3-db8e-4835-9311-288bb0170829

The query parameter should be crash_id, not uuid:

curl -H "Auth-Token: 58af2acef8a74dbca9580e2bb8ba9c9a" https://crash-stats.mozilla.com/api/RawCrash/?crash_id=fb27d0f3-db8e-4835-9311-288bb0170829

The Python example has a similar issue. It also uses an 'x' in the token, to ensure it is not a legitimate hexadecimal string.

A stretch goal would be to make it a working rather than sample example, using the user's token with "View Raw Dumps" and a valid crashid, using jQuery to hide the examples by default. This probably makes the fix more complex than needed.

Comment 1

[John Whitlock [:jwhitlock]]

Attachment: pr 4926: bug 1548830: Fix API token examples

The initial PR is the minimal version of the fix, just uuid → crash_id.

Comment 2

[John Whitlock [:jwhitlock]]

jwhitlock merged PR #4926: "bug 1548830: Fix API token examples" in 61b6236.

Comment 3

[Will Kahn-Greene [:willkg] ET needinfo? me]

I just pushed this to prod and verified it's correct there now. Marking as FIXED.