[DOCU-2595] Note about naming the paths on the class and the method levels Created: 24/Oct/22  Updated: 24/Oct/22  Resolved: 24/Oct/22

Status: Closed
Project: Documentation
Component/s: None
Affects Version/s: None
Fix Version/s: None

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

Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Team: Documentation

 Description   

Add a note to https://docs.magnolia-cms.com/product-docs/6.2/Developing/Development-how-tos/How-to-create-a-custom-Java-based-REST-endpoint.html about naming the path on the class and the method levels.

Problem

if you name your class path (CP) to begin with same string as your method path (MP), for example,

(CP) /hello/v1

(MP) /hello

the endpoint will not work and the Could not find resource for full path: ... error message is generated.

The note

The note should give a hint that the class path should not begin with the same string as the method path. 


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