[ECOMMERCE-469] DEV DOC: Review and test endpoint docs for Magento/Adobe Created: 20/Sep/21  Updated: 19/Oct/21  Resolved: 19/Oct/21

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

Type: Task Priority: Neutral
Reporter: Julie Legendre Assignee: Oanh Thai Hoang
Resolution: Fixed Votes: 0
Labels: VN-Testing
Remaining Estimate: Not Specified
Time Spent: 1d 2.5h
Original Estimate: Not Specified

Issue Links:
Cloners
clones ECOMMERCE-468 DEV DOC: Review and test endpoint doc... Closed
is cloned by ECOMMERCE-470 DEV DOC: Review and test endpoint doc... Closed
Relates
relates to ECOMMERCE-453 DOC: Fix endpoint docs Closed
Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Documentation update required:
Yes
Date of First Response:
Epic Link: Endpoint dev doc review
Sprint: Content Mngmt 14, Content Mngmt 15
Story Points: 3

 Description   
  • Julie publishes the updated docs with the new tabbed layout (one per connector) with a warning for customers that the page is under review.
  • A developer tests the endpoint works as documented and makes any changes required directly in the docs:
    • Are there any prerequisites specific to the connector that the user must fulfill before using the endpoints?
    • Are all the parameters correctly documented? (any missing, required/optional, type, etc.)
    • Are some parameters mentioned unnecessary for this connector?
    • Are there any parameter defaults that can be added?
  • Julie reviews the developer's changes and publishes any updates.

Pages:

https://docs.magnolia-cms.com/product-docs/6.2/Connector-Packs/Commerce-Connector-Pack/E-commerce-REST-endpoints.html

 NB. Do not include the User endpoint which is specific to SAP.

Update: 

PR: https://git.magnolia-cms.com/projects/DOCUMENTATION/repos/product-docs/pull-requests/657/overview

Postman sample: https://wiki.magnolia-cms.com/display/Addon/Sample+Ecommerce+Endpoint+postman+for+all+connectors

 



 Comments   
Comment by Oanh Thai Hoang [ 11/Oct/21 ]

After reviewing, I create a bug for checkout in case of authenticate user. But just need to fix in code, docu don't need to change. See https://jira.magnolia-cms.com/browse/ECOMMERCE-482

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