eclipse-ee4j / eclipse-ee4j/jersey
WADL documentation has syntax and semantic errors
- Dominant language
- Java
- Stars
- 730
- Forks
- 382
- PR merge metrics
- No merged PRs in 30d
Description
There is a documentation problem: 2 paragraphs have missing/wrong text which makes it not understandable.
in: [https://jersey.java.net/documentation/latest/wadl.html](https://jersey.java.net/documentation/latest/wadl.html)
section 17.1\. "WADL introduction"
after the code example "Example 17.2."
This is the copied/pasted text referred:
> Second resource with a path "application.wadl" has, again, similar OPTIONS methods and one GET method which return this WADL. There is also a sub-resource with a path defined by path param
>
> Unknown macro: {path}
>
> . This means that you can request a resource on the URI [http://localhost:9998/application.wadl/something](http://localhost:9998/application.wadl/something). This is used only to return an external grammar if there is any attached. Such a external grammar can be for example an XSD schema of the response entity which if the response entity is a JAXB bean. An external grammar support via Jersey extended WADL support is described in sections below.
>
> All resource that were added in this second example into the WADL contains element extended. This means that this resource is not a part of a core RESTful API and is rather a helper resource. If you need to mark any your own resource are extended, annotate is with @ExtendedResource. Note that there might be methods visible in the default simple WADL even the user has not added them. This is for example the case of MVC added methods which were added byModelProcessor but are still intended to be used by the client to achieve their primary use case of getting formatted data.
Contributor guide
Assessment
This issue has not been assessed yet.