Communication¶

API for communication between reviewers and developers

Note

Under development.

App¶

GET /api/v2/comm/app/(int:id|string:slug)/¶

Note

Requires authentication.

Returns all threads for the app.

Request

Takes an app slug.

The standard Listing query params.

Response

Status Codes:	200 OK – successfully completed. 403 Forbidden – not allowed to access this app. 404 Not Found – app not found.
Parameters:	meta (object) – Listing response meta. objects (array) – A listing of threads.

?serializer=simple

If you pass simple as a value to the serializer GET parameter, the deserialized threads will consist only of the thread ID and the version number for the app it is representing.

Example:

{
    "objects": [
        {
            "id": 12345,
            "version": {
                "id": 444,
                "version": "1.2"
            }
        },
        {
            "id": 12348,
            "version": {
                "id": 474,
                "version": "1.3"
            }
        }
    ],
}

Thread¶

GET /api/v2/comm/thread/¶

Note

Requires authentication.

Returns a list of threads in which the user is involved in.

Request

The standard Listing query params.

Response

Parameters:	meta (object) – Listing response meta. objects (array) – A listing of threads.

GET /api/v2/comm/thread/(int: id)/¶

Note

Requires authentication.

View a thread object.

Response

A thread object, see below for example.

Status Codes:	200 OK – successfully completed. 403 Forbidden – not allowed to access this object. 404 Not Found – not found.

Example:

{
    "app": {
        "app_slug": "app-3",
        "id": 5,
        "name": "Test App (kinkajou3969)",
        "review_url": "/reviewers/apps/review/test-app-kinkajou3969/",
        "thumbnail_url": "/tmp/uploads/previews/thumbs/0/37.png?modified=1362762723",
        "url": "/app/test-app-kinkajou3969/"
    },
    "created": "2013-06-14T11:54:24",
    "id": 2,
    "modified": "2013-06-24T22:01:37",
    "notes_count": 47,
    "version": {
        "id": 45,
        "version": "1.6",
        "deleted": false
    }
}

Notes on the response.

Parameters:	version.version (string) – Version number noted from the app manifest. version.deleted (boolean) – whether the version of the app of the note is out-of-date.

POST /api/v2/comm/thread/¶

Note

Requires authentication.

Create a thread from a new note for a version of an app.

Request

Parameters:	app (int\|string) – id or slug of the app to filter the threads by. version (string) – version number for the thread’s version (e.g. 1.2). note_type (int) – a note type label. body (string) – contents of the note.

Response

A note object.

Note¶

GET /api/v2/comm/thread/(int: thread_id)/note/¶

Note

Requires authentication.

Returns the list of notes that a thread contains.

Request

The standard Listing query params.

For ordering params, see List ordering params.

In addition to above, there is another query param:

Parameters:	show_read (boolean) – Filter notes by read status. Pass true to list read notes and false for unread notes.

Response

Parameters:	meta – Listing response meta. objects – A listing of notes.

GET /api/v2/comm/thread/(int: thread_id)/note/(int: id)/¶

Note

Requires authentication.

View a note.

Request

The standard Listing query params.

Response

A note object, see below for example.

Status Codes:	200 OK – successfully completed. 403 Forbidden – not allowed to access this object. 404 Not Found – thread or note not found.

{
    "attachments": [{
        "id": 1,
        "created": "2013-06-14T11:54:48",
        "display_name": "Screenshot of my app.",
        "url": "http://marketplace.cdn.mozilla.net/someImage.jpg",
    }],
    "author": 1,
    "author_meta": {
        "name": "Admin"
    },
    "body": "hi there",
    "created": "2013-06-14T11:54:48",
    "id": 2,
    "note_type": 0,
    "thread": 2,
}

Notes on the response.

Parameters:	attachments (array) – files attached to the note (often images). note_type (int) – type of action taken with the note.

Only “No Action”, “Reviewer Comment”, and “Developer Comment” note types can be created through the Note API. Further, one must be a reviewer to make a “Reviewer Comment”. And one must be a developer of an app to make a “Developer Comment” on an app’s thread.

All note types are listed in the code

POST /api/v2/comm/thread/(int: thread_id)/note/¶

Note

Requires authentication.

Create a note on a thread.

Request

Parameters:	author (int) – the id of the author. thread (int) – the id of the thread to post to. note_type (int) – the type of note to create. See supported types. body (string) – the comment text to be attached with the note.

Response

Param:	A note.
Status:	201 successfully created.
Status:	400 bad request.
Status:	404 thread not found.

List ordering params¶

Order results by created or modified times, by using ordering param.

created - Earliest created notes first.
-created - Latest created notes first.
modified - Earliest modified notes first.
-modified - Latest modified notes first.

Attachment¶

POST /api/v2/comm/note/(int: note_id)/attachment¶

Note

Requires authentication and the user to be the author of the note.

Create attachment(s) on a note.

Request

The request must be sent and encoded with the multipart/form-data Content-Type.

Parameters:

form-0-attachment (multipart/form-data encoded file stream) – the first attachment file encoded with multipart/form-data.
form-0-description (string) – description of the first attachment.
form-N-attachment (multipart/form-data encoded file stream) – If sending multiple attachments, replace N with the number of the n-th attachment.
form-N-description (string) – description of the n-th attachment.

Response

Param:	The note the attachment was attached to.
Status:	201 successfully created.
Status:	400 bad request (e.g. no attachments, more than 10 attachments).
Status:	403 permission denied if user isn’t the author of the note.