Skip to content

Commit

Permalink
fix the out-of-date version reference (#522)
Browse files Browse the repository at this point in the history
  • Loading branch information
Emily-Jiang committed Mar 23, 2022
1 parent 855a4f0 commit 549f7e8
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
9 changes: 5 additions & 4 deletions spec/src/main/asciidoc/microprofile-openapi-spec.asciidoc
Expand Up @@ -48,7 +48,7 @@ clear and complete contract. Similar to the WSDL contract for legacy Web Servic
the https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md[OpenAPI v3] specification is the contract for
RESTful Services.

This MicroProfile specification, called OpenAPI 1.0, aims to provide a set of Java
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.

Expand Down Expand Up @@ -739,7 +739,7 @@ add that context root (`/myApp`) to every `pathItem` defined in that application

=== Multiple applications

The 1.0 version of the MicroProfile OpenAPI specification does not define how
The MicroProfile OpenAPI specification does not define how
the `/openapi` endpoint may be partitioned in the event that the MicroProfile
runtime supports deployment of multiple applications. If an implementation wishes
to support multiple applications within a MicroProfile runtime, the semantics of
Expand All @@ -762,7 +762,7 @@ Therefore, vendors are required to exclude from the final OAS3 document any inte
== Limitations

=== Internationalization
The 1.0 version of the MicroProfile OpenAPI spec does not require vendors to
The MicroProfile OpenAPI spec does not require vendors to
support multiple languages based on the `Accept-Language`. One reasonable
approach is for vendors to support unique keys (instead of hardcoded text) via
the various <<Documentation Mechanisms>>, so that the implementing framework can
Expand All @@ -772,7 +772,7 @@ processed languages can be kept to improve performance.

=== Validation

The MP OpenAPI 1.0 specification does not mandate vendors to validate the resulting
The MP OpenAPI specification does not mandate vendors to validate the resulting
OpenAPI v3 model (after processing the 5 steps previously mentioned), which means
that the behavior of invalid models is vendor specific (i.e. vendors may choose to
ignore, reject, or pass-through invalid inputs).
Expand All @@ -783,4 +783,5 @@ The MP OpenAPI specification does not mandate but recommends vendors support htt
for the `/openapi` endpoint. Without CORS support, tools such as Swagger-UI might experience some errors.
However, the behavior of CORS requests is implementation dependent.


include::release_notes.asciidoc[]
2 changes: 1 addition & 1 deletion spec/src/main/asciidoc/release_notes.asciidoc
Expand Up @@ -16,7 +16,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.

[[release_notes_20]]
[[release_notes_30]]
== Release Notes for Microprofile OpenAPI 3.0

A full list of changes delivered in the 3.0 release can be found at link:https://github.com/eclipse/microprofile-open-api/milestone/4?closed=1[MicroProfile OpenAPI 3.0 Milestone].
Expand Down

0 comments on commit 549f7e8

Please sign in to comment.