[ECOMMERCE-509] DOC: Add newly exposed category key to the E-commerce REST category endpoint Created: 21/Mar/22  Updated: 18/Oct/22  Resolved: 30/Mar/22

Status: Closed
Project: E-commerce
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Neutral
Reporter: Adrian Brooks Assignee: Adrian Brooks
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
documentation
documents ECOMMERCE-497 Expose Category Key in request repons... Closed
Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Epic Link: AuthorX Maintenance
Sprint: AuthorX 6
Story Points: 1

 Description   

When all categories or a single category id is requested in postman, the category "key" is now included in the response, for example:

{
    “id”: {
        “definitionName”: “commercetools”,
        “connectionName”: “connection”,
        “itemId”: “5501f9b6-bdef-41e3-adf6-efba6710a294”
    },
    “name”: “Test”,
    “description”: “Testing”,
    “position”: null,
    “level”: null,
    “parentId”: “05005125-3b5b-40df-bd8f-18cf6e2aa0d4”,
    “path”: “Test”,
    “key”: “1234”
}

In the docs, this page:
https://docs.magnolia-cms.com/product-docs/6.2/Connector-Packs/Commerce-Connector-Pack/E-commerce-REST-endpoints/Category-endpoint-API.html

In particular the JSON responses for "Get All categories", "categoryById", "categoryByProductId", and "categoryByParentId" need to include the newly added "key".



 Comments   
Comment by Adrian Brooks [ 30/Mar/22 ]

Reviewed by Andrei, link to release in which the key was exposed added. Merged to master.

Generated at Mon Feb 12 01:44:46 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.