[MGNLREST-543] DOC: Specify endpoint types without Java classes (for DXCore and SaaS) Created: 20/Oct/22  Updated: 30/May/23  Resolved: 24/May/23

Status: Closed
Project: Magnolia REST Framework
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Story Priority: Neutral
Reporter: Martin Drápela Assignee: Martin Drápela
Resolution: Done Votes: 0
Labels: None
Σ Remaining Estimate: Not Specified Remaining Estimate: Not Specified
Σ Time Spent: Not Specified Time Spent: Not Specified
Σ Original Estimate: Not Specified Original Estimate: Not Specified

Issue Links:
documentation
documents MGNLREST-522 Specify Norsu endpoint without Java c... Closed
Sub-Tasks:
Key
Summary
Type
Status
Assignee
MGNLREST-704 DOCSub: Specify endpoint types withou... Sub-task Completed Martin Drápela  
MGNLREST-705 DOCSub: Specify endpoint types withou... Sub-task Closed Oanh Thai Hoang  
Template:
Acceptance criteria:
Empty
Task DoD:
[ ]* Doc/release notes changes? Comment present?
[ ]* Downstream builds green?
[ ]* Solution information and context easily available?
[ ]* Tests
[ ]* FixVersion filled and not yet released
[ ]  Architecture Decision Record (ADR)
Epic Link: SaaS Post-TPR - DevX
Sprint: DevX 38
Story Points: 2
Team: DeveloperX
Work Started:
Approved:
Yes

 Description   

For actual implementation, see MGNLREST-522.

DXCore 6.2

Examples should use $type instead of class.
Be sure that the $type for the delivery endpoint is documented.
https://docs.magnolia-cms.com/product-docs/6.2/Developing/API/Delivery-API.html

For example here: 
https://docs.magnolia-cms.com/product-docs/6.2/Developing/API/Delivery-API.html#_properties

ALSO All examples should have a $type (We made it optional to haave at type or class, but later decided that was a bad idea.

Remove this note: "The property is optional since version 2.2.11 of the REST module."

SaaS

On SaaS docs there shoould not be any reference to java or classes. Only $type syntax shoould be documented:
Also examples should use $type.
https://docs.magnolia-cms.com/saas/developers/api/delivery-endpoint.html



 Comments   
Comment by Martin Drápela [ 18/May/23 ]

Best Practice box added with https://git.magnolia-cms.com/projects/DOCUMENTATION/repos/product-docs/pull-requests/1564/commits/40fd31f68bc0c2a4ccfe5d1754559dec20c2a88a#modules/ROOT/partials/developing/api/r_delivery-endpoint-v2-configuration.adoc?t=34

Generated at Mon Feb 12 07:00:53 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.