Jakarta RESTful Web Services: API docs

[spericas]

Signed-off-by: Santiago Pericas-Geertsen santiago.pericasgeertsen@oracle.com

Specification PR template

Include the following:

• A directory in the form wombat/x.y containing the following.
• Specification PDF in the form of wombat_x.y.pdf
• Specification HTML in the form of wombat_x.y.html
• Specification JavaDoc in the apidocs directory.
• A specification page named _index.md following the template at:
  https://github.com/jakartaee/specification-committee/blob/master/spec_page_template.md
• For a Progress Review, that sufficient progress has been made on
  a Compatible Implementation and TCK, to ensure that the spec is
  implementable and testable.
• For a Release Review, a summary that a Compatible Implementation
  is complete, passes the TCK, and that the TCK includes sufficient
  coverage of the specification. The TCK users guide MUST include
  the instructions to run the compatible implementations used to
  validate the release. Instructions MAY be by reference.
• The URL of the OSSRH staging repository for the api, javadoc:
  

[bshannon]

Not a serious issue, but META-INF/MANIFEST.MF isn't needed here.

I see a reference to the license on the index page but it's missing from the footer of every page.

[spericas]

Not a serious issue, but META-INF/MANIFEST.MF isn't needed here.

I see a reference to the license on the index page but it's missing from the footer of every page.

Javadocs updated.

[tomjenkinson]

I noted that the Javadocs seem to have "@SInCE 2.0" and I was expecting these to be "@SInCE JAX-RS 2.0" or similar based on https://www.eclipse.org/lists/ee4j-pmc/msg02056.html but perhaps as the JAX-RS element was not removed for this release (I assume, based on e.g. this file) then it might not be required to actively add this clarification?

[spericas]

I noted that the Javadocs seem to have "@SInCE 2.0" and I was expecting these to be "@SInCE JAX-RS 2.0" or similar based on https://www.eclipse.org/lists/ee4j-pmc/msg02056.html

Frankly, we have made most of the API changes before some of those discussions started (or settled). Moreover, we went through the process of eliminating all the "JAX-RS" instances in our docs, so adding those seemed odd at the time; however, if the consensus is to use old acronyms with @since, we can make the change.

but perhaps as the JAX-RS element was not removed for this release (I assume, based on e.g. this file)

Can you elaborate this? I'm not sure which part of that file you're referring to.

[bshannon]

Fixing the @SInCE entries is not critical for this release.

[dblevins]

Not sure if this is a showstopper, but there are some "Java EE" references we might want to convert:

restful-web-services/2.1/apidocs/javax/ws/rs/client/ClientBuilder.html:620: When running in a Java EE container, implementations are required to use the container-managed
restful-web-services/2.1/apidocs/javax/ws/rs/client/ClientBuilder.html:648: When running in a Java EE container, implementations are required to use the container-managed

[spericas]

Not sure if this is a showstopper, but there are some "Java EE" references we might want to convert:

restful-web-services/2.1/apidocs/javax/ws/rs/client/ClientBuilder.html:620: When running in a Java EE container, implementations are required to use the container-managed
restful-web-services/2.1/apidocs/javax/ws/rs/client/ClientBuilder.html:648: When running in a Java EE container, implementations are required to use the container-managed

I've changed it to Jakarta EE.

[bshannon]

This looks good to me, I'm removing the Draft label.
Obviously this still needs to wait for PR #7.

[dblevins]

This spec is due for review and promotion to vote August 16th. Can you review this checklist and ensure all requirements are met:
https://github.com/jakartaee/specification-committee/blob/master/spec_review_checklist.md

[spericas]

This spec is due for review and promotion to vote August 16th. Can you review this checklist and ensure all requirements are met:
https://github.com/jakartaee/specification-committee/blob/master/spec_review_checklist.md

We are working on it and making progress. We should be done in time.

[spericas]

@kwsutter It was brought to my attention that the directory name used in this PR is inconsistent with that in #7. I will submit another PR shortly to fix this inconsistency.

[spericas]

@kwsutter @bshannon #99