Order add comment functionality in REST API

[elidrissidev]

Description (*)

This is the first out of many coming PRs where I will be adding some missing endpoints to the REST Api, this one will add the functionality for adding and retrieving order comments as an authenticated Admin user, as well as the ACL permissions.

I chose to target the 20.0 branch with these new features, but It's subject to change if there's demand. For people interested that can't use v20 yet, I made an extension where I'll be porting the same changes for use with v19 (we'll be using it in production in the next few weeks).

Manual testing scenarios (*)

After applying this patch, you should be able to perform the following actions as Admin user:

• Retrieve a single comment: GET /api/rest/orders/comments/<comment_id>
• Add comment to an order (although all the fields in the body are optional, you can't omit all of them):

POST /api/rest/orders/<order_id>/comments HTTP/1.1
Host: <magento_host>
Accept: application/json
Content-Type: application/json
Authorization: ...

{
    "status": "pending", // defaults to false (current order status)
    "comment": "Test adding comment from REST API", // optional, defaults to an empty string
    "is_customer_notified": 0, // defaults to false (use null for non-applicable notification)
    "is_visible_on_front": 0 // defaults to 0
}

Questions or comments

Testing is encouraged for people using OAuth as I didn't test with it.

Contribution checklist (*)

• Pull request has a meaningful description of its purpose
• All commits are accompanied by meaningful commit messages
• All automated tests passed successfully (all builds are green)
• Add yourself to contributors list

[github-actions]

Unit Test Results

0 files  ±0  0 suites  ±0   0s ⏱️ ±0s
0 tests ±0  0 ✔️ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit 1837f74. ± Comparison against base commit b2e2960.