[MGNLREST-529] DOC: How to collectively refer to Delivery API in v 3.x of REST module Created: 19/Oct/22 Updated: 27/Feb/23 Resolved: 27/Feb/23 |
|
| Status: | Closed |
| Project: | Magnolia REST Framework |
| Component/s: | None |
| Affects Version/s: | None |
| Fix Version/s: | None |
| Type: | Task | Priority: | Neutral |
| Reporter: | Martin Drápela | Assignee: | Martin Drápela |
| Resolution: | Obsolete | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Attachments: |
|
||||||||
| Issue Links: |
|
||||||||
| Template: |
|
||||||||
| Acceptance criteria: |
Empty
|
||||||||
| Task DoR: |
Empty
|
||||||||
| Date of First Response: | |||||||||
| Epic Link: | NorsuDocs: Endpoint documentation phase 1 | ||||||||
| Story Points: | 1 | ||||||||
| Team: | |||||||||
| Description |
|
A bit of history about the collective name:
In the 6.2 docs, we now only have v2 and refer to it like that:
How to proceed after module version 3.0.0 is released? Possibility A: For module v 3.x+, I ve temporarily started using v3 for the docs update: Pros: Everybody will easily remember that v3 of the Delivery API can handle both, JCR + Norsu deliveries, whereas v2 can do only JCR. Possibility B: Cons: Breaks away from what we've been doing until now. Pros: Avoids that v2(JCR) / <????>(Norsu) referencing issue using v<number>.
|
| Comments |
| Comment by Christopher Zimmermann [ 19/Oct/22 ] |
|
I dont think the current changes indicate a jcrDeliveryEndpont_v3. A new major version would indicate to me that it is either incompatible with v2 functionaallity, that is it brings breaking changes, or that it brings major new functionality. It does not do either of these things so I would keep it as jcrDeliveryEndpoint_v2 I would not link the module version to the REST delivery endpoint version. For the new norsu delivery endpoint, the users must specify a different class or `$type` to use it - ie "norsuDeliveryEndpoint".
|
| Comment by Christopher Zimmermann [ 19/Oct/22 ] |
|
Developers must specify the version of the endpoint. If they do not then when a new version comes with breaking changes it will break their projects. |