Skip to content

Commit

Permalink
Use full spec name once for JAX-RS
Browse files Browse the repository at this point in the history
The full spec name is Jakarta RESTful Web Services. We should use the
full name at least once and then abbreviate it to JAX-RS (which is the
name everyone knows).

Also remove a reference specifically to JAX-RS 2.0.
  • Loading branch information
Azquelt committed Apr 20, 2023
1 parent d70799d commit 8900fa6
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions spec/src/main/asciidoc/microprofile-openapi-spec.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,8 @@ RESTful Services.

This MicroProfile specification, called OpenAPI, aims to provide a set of Java
interfaces and programming models which allow Java developers to natively produce
OpenAPI v3 documents from their JAX-RS applications.
OpenAPI v3 documents from their applications written using Jakarta RESTful Web
Services (JAX-RS).

== Architecture

Expand Down Expand Up @@ -176,7 +177,7 @@ There are many different ways to provide input for the generation of the resulti
OpenAPI document.

The MP OpenAPI specification requires vendors to produce a valid OpenAPI document
from pure JAX-RS 2.0 applications. This means that vendors must process all the
from pure JAX-RS applications. This means that vendors must process all the
relevant JAX-RS annotations (such as `@Path` and `@Consumes`) as well as Java objects
(POJOs) used as input or output to JAX-RS operations. This is a good place to
start for application developers that are new to OpenAPI: just deploy your existing
Expand Down

0 comments on commit 8900fa6

Please sign in to comment.