Permalink
Find file
Fetching contributors…
Cannot retrieve contributors at this time
178 lines (124 sloc) 6.62 KB

Reviews

Note

These APIs are experimental and are currently being worked on. Endpoints may change without warning. The only authentication method available at the moment is :ref:`the internal one<api-auth-internal>`.

List reviews

This endpoint allows you to fetch reviews for a given add-on or user. Either addon or user query parameters are required, and they can be combined together.

By default, the review list API will only return not-deleted reviews. You can change that with the filter=with_deleted query parameter, which requires the Addons:Edit permission.

Detail

This endpoint allows you to fetch a review by its id.

Post

This endpoint allows you to post a new review for a given add-on and version. If successful a :ref:`review object <review-detail-object>` is returned.

Note

Requires authentication.

Edit

This endpoint allows you to edit an existing review by its id. If successful a :ref:`review object <review-detail-object>` is returned.

Note

Requires authentication and Addons:Edit permissions or the user account that posted the review.

Only body, title and rating are allowed for modification.

Delete

This endpoint allows you to delete an existing review by its id.

Note

Requires authentication and Addons:Edit permission or the user account that posted the review. Even with the right permission, users can not delete a review from somebody else if it was posted on an add-on they are listed as a developer of.

Reply

This endpoint allows you to reply to an existing user review. If successful a :ref:`review reply object <review-detail-object>` is returned.

Note

Requires authentication and either Addons:Edit permission or a user account listed as a developer of the add-on.

Flag

This endpoint allows you to flag an existing user review, to let a moderator know that something may be wrong with it.

An empty response will be returned on success.

Note

Requires authentication and a user account different from the one that posted the review.

Available constants for the flag property:

Constant Description
review_flag_reason_spam Spam or otherwise non-review content
review_flag_reason_language Inappropriate language/dialog
review_flag_reason_bug_support Misplaced bug report or support request
review_flag_reason_other Other (please specify)