Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Product reviews API #8772

Merged
merged 24 commits into from
Jan 5, 2018
Merged

Product reviews API #8772

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
0f6966a
[Product Reviews API] - add API for product reviews
paulstoicareea Oct 4, 2017
c660fa9
[Documentation][API] - add product reviews api docs
paulstoicareea Oct 4, 2017
fb337a6
[Product Reviews API]: accept/reject endpoints with state machine
paulstoicareea Oct 5, 2017
0e2ccc9
[Unit Testing]: ProductReviewApi Controller
paulstoicareea Oct 5, 2017
0151d20
[Documentation]: add in toctree and map Product Reviews API
paulstoicareea Oct 5, 2017
9785c0e
[Documentation]: minor changes
paulstoicareea Oct 9, 2017
4aa26f9
[Product Reviews API] - minor changes
paulstoicareea Oct 9, 2017
de75e27
[Documentation]: fix malformed tables Product reviews API
paulstoicareea Oct 9, 2017
ca4a90a
[Product Reviews API] - minor changes for tests
paulstoicareea Oct 9, 2017
3c1048f
[Product Reviews API] - add API for product reviews
paulstoicareea Oct 4, 2017
bc07098
[Documentation][API] - add product reviews api docs
paulstoicareea Oct 4, 2017
5e41ae6
[Product Reviews API]: accept/reject endpoints with state machine
paulstoicareea Oct 5, 2017
e998b59
[Unit Testing]: ProductReviewApi Controller
paulstoicareea Oct 5, 2017
dd37af3
[Documentation]: add in toctree and map Product Reviews API
paulstoicareea Oct 5, 2017
0228602
[Documentation]: minor changes
paulstoicareea Oct 9, 2017
d571b9c
[Product Reviews API] - minor changes
paulstoicareea Oct 9, 2017
3933ed2
[Documentation]: fix malformed tables Product reviews API
paulstoicareea Oct 9, 2017
3cf247a
[Product Reviews API] - minor changes for tests
paulstoicareea Oct 9, 2017
859021c
[Documentation]: texts improvments Product reviews API
paulstoicareea Nov 17, 2017
ca795cb
Product review API syntax improvments
paulstoicareea Nov 17, 2017
78d2c96
Product Review API tests: review creation real inputs
paulstoicareea Nov 18, 2017
aca53a4
[Product Reviews API] - add API for product reviews
paulstoicareea Oct 4, 2017
27086bd
fix product reviews api test methods names, expected response
paulstoicareea Dec 5, 2017
e386f37
product reviews api test remove author, fix indentation
paulstoicareea Jan 4, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
[Documentation]: minor changes
  • Loading branch information
@paulstoicareea
paulstoicareea committed Oct 9, 2017
commit 9785c0e5ad815e7d0cd76cbfefb064568e84169e
2 changes: 1 addition & 1 deletion docs/api/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ The REST API Reference
payments
product_attributes
product_options
product_variants
product_reviews
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess that product_reviews should be before product_variants to keep alphabetical order

product_variants
products
promotion_coupons
promotions
Expand Down
2 changes: 1 addition & 1 deletion docs/api/map.rst.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@
* :doc:`/api/payments`
* :doc:`/api/product_attributes`
* :doc:`/api/product_options`
* :doc:`/api/product_variants`
* :doc:`/api/product_reviews`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess that product_reviews should be before product_variants to keep alphabetical order

* :doc:`/api/product_variants`
* :doc:`/api/products`
* :doc:`/api/promotion_coupons`
* :doc:`/api/promotions`
Expand Down
8 changes: 3 additions & 5 deletions docs/api/product_reviews.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ When you get a collection of resources, you will receive objects with the follow
| author | Customer author for product review (This is customer that added the |
| | product review; this will contain customer resource information) |
+------------------+------------------------------------------------------------------------------------------------+
| status | Status of product review(New, Accepted, Rejected) |
| status | Status of product review (New, Accepted, Rejected) |
+------------------+------------------------------------------------------------------------------------------------+
| reviewSubject | This is the review subject for the product review. For this case of the product review, this |
| | will contains a product resource |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this contains... or this will contain...

Expand Down Expand Up @@ -53,7 +53,7 @@ Definition
+---------------+----------------+----------------------------------------------------------+
| comment | request | Product review comment |
+---------------+----------------+----------------------------------------------------------+
| rating | request | Product review rating(1..5) |
| rating | request | Product review rating (1..5) |
+---------------+----------------+----------------------------------------------------------+
| author | request | Product review author |
+---------------+----------------+----------------------------------------------------------+
Expand Down Expand Up @@ -117,7 +117,6 @@ Exemplary Response
}
}


.. warning::

If you try to create a resource without title, rating, comment or author, you will receive a ``400 Bad Request`` error.
Expand Down Expand Up @@ -181,7 +180,6 @@ Exemplary Response
}
}


Getting a Single Product Review
--------------------------------

Expand Down Expand Up @@ -438,7 +436,7 @@ Definition
+---------------+----------------+----------------------------------------------------------+
| comment | request | Product review comment |
+---------------+----------------+----------------------------------------------------------+
| rating | request | Product review rating(1..5) |
| rating | request | Product review rating (1..5) |
+---------------+----------------+----------------------------------------------------------+

Example
Expand Down