Merge pull request #607 from benjamin-confino/606-update-version-spec

update version number in spec and references to spec

README.adoc

@@ -21,7 +21,7 @@
 
 image:https://github.com/eclipse/microprofile-open-api/workflows/Build/badge.svg?branch=master[link=https://github.com/eclipse/microprofile-open-api/actions]
 
-This MicroProfile specification aims at providing a unified Java API for the link:++https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md++[OpenAPI v3 specification],
+This MicroProfile specification aims at providing a unified Java API for the link:++https://spec.openapis.org/oas/v3.1.0.html++[OpenAPI v3.1 specification],
 that all application developers can use to expose their API documentation.
 
 * The link:++https://github.com/eclipse/microprofile-open-api/tree/master/api/src/main/java/org/eclipse/microprofile/openapi++[spec APIs] are composed of annotations, models, and programming interfaces.

api/src/main/java/org/eclipse/microprofile/openapi/annotations/Components.java

@@ -36,8 +36,8 @@
  * Describes the Components object that holds various reusable objects for different aspects of the OpenAPI
  * Specification (OAS).
  *
- * @see <a href= "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#componentsObject"> OpenAPI
- *      Specification Components Object</a>
+ * @see <a href= "https://spec.openapis.org/oas/v3.1.0.html#components-object"> OpenAPI Specification Components
+ *      Object</a>
  */
 @Target({})
 @Retention(RetentionPolicy.RUNTIME)

api/src/main/java/org/eclipse/microprofile/openapi/annotations/ExternalDocumentation.java

@@ -35,9 +35,8 @@
  * OpenAPI document root. If more than one non-empty annotation is applied to a type in the application or if the
  * externalDocs field of the OpenAPIDefinition annotation is supplied the results are not defined.
  *
- * @see <a href=
- *      "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#externalDocumentationObject">OpenAPI
- *      Specification External Documentation Object</a>
+ * @see <a href= "https://spec.openapis.org/oas/v3.1.0.html#external-documentation-object">OpenAPI Specification
+ *      External Documentation Object</a>
  **/
 @Target({ElementType.METHOD, ElementType.TYPE})
 @Retention(RetentionPolicy.RUNTIME)

api/src/main/java/org/eclipse/microprofile/openapi/annotations/OpenAPIDefinition.java

@@ -35,8 +35,7 @@
  * <p>
  * This is the root document object of the OpenAPI document. It contains required and optional fields.
  *
- * @see <a href= "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#openapi-object">OpenAPI
- *      Specification OpenAPI Object</a>
+ * @see <a href= "https://spec.openapis.org/oas/v3.1.0.html#openapi-object">OpenAPI Specification OpenAPI Object</a>
  */
 
 @Target({ElementType.TYPE, ElementType.PACKAGE})

api/src/main/java/org/eclipse/microprofile/openapi/annotations/Operation.java

@@ -28,8 +28,7 @@
 /**
  * Describes a single API operation on a path.
  *
- * @see <a href= "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#operationObject">OpenAPI
- *      Specification Operation Object</a>
+ * @see <a href= "https://spec.openapis.org/oas/v3.1.0.html#operation-object">OpenAPI Specification Operation Object</a>
  **/
 @Target({ElementType.METHOD})
 @Retention(RetentionPolicy.RUNTIME)

api/src/main/java/org/eclipse/microprofile/openapi/annotations/callbacks/Callback.java

@@ -29,8 +29,7 @@
 /**
  * This object represents a callback URL that will be invoked.
  *
- * @see <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#callbackObject">OpenAPI
- *      Specification Callback Object</a>
+ * @see <a href="https://spec.openapis.org/oas/v3.1.0.html#callback-object">OpenAPI Specification Callback Object</a>
  **/
 @Target({ElementType.METHOD, ElementType.TYPE})
 @Retention(RetentionPolicy.RUNTIME)

api/src/main/java/org/eclipse/microprofile/openapi/annotations/callbacks/CallbackOperation.java

@@ -33,8 +33,7 @@
 /**
  * Describes a single API callback operation.
  *
- * @see <a href= "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#operationObject">OpenAPI
- *      Specification Operation Object</a>
+ * @see <a href= "https://spec.openapis.org/oas/v3.1.0.html#operation-object">OpenAPI Specification Operation Object</a>
  **/
 @Target({})
 @Retention(RetentionPolicy.RUNTIME)

api/src/main/java/org/eclipse/microprofile/openapi/annotations/callbacks/Callbacks.java

@@ -26,8 +26,7 @@
 /**
  * This object represents an array of Callback URLs that can be invoked.
  *
- * @see <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#callbackObject">OpenAPI
- *      Specification Callback Object</a>
+ * @see <a href="https://spec.openapis.org/oas/v3.1.0.html#callback-object">OpenAPI Specification Callback Object</a>
  **/
 @Target({ElementType.METHOD})
 @Retention(RetentionPolicy.RUNTIME)

api/src/main/java/org/eclipse/microprofile/openapi/annotations/headers/Header.java

@@ -28,8 +28,7 @@
 /**
  * Describes a single header object
  *
- * @see <a href= "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#header-object">OpenAPI
- *      Specification Header Object</a>
+ * @see <a href= "https://spec.openapis.org/oas/v3.1.0.html#header-object">OpenAPI Specification Header Object</a>
  **/
 @Target({})
 @Retention(RetentionPolicy.RUNTIME)

api/src/main/java/org/eclipse/microprofile/openapi/annotations/info/Contact.java

@@ -27,7 +27,7 @@
 /**
  * Contact information for the exposed API.
  *
- * @see "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#contactObject"
+ * @see <a href="https://spec.openapis.org/oas/v3.1.0.html#contact-object">OpenAPI Specification Contact Object</a>
  **/
 @Target({})
 @Retention(RetentionPolicy.RUNTIME)

api/src/main/java/org/eclipse/microprofile/openapi/annotations/info/Info.java

@@ -27,7 +27,7 @@
 /**
  * This annotation provides metadata about the API, and maps to the Info object in OpenAPI Specification 3.
  *
- * @see "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#infoObject"
+ * @see <a href="https://spec.openapis.org/oas/v3.1.0.html#info-object">OpenAPI Specification Info Object</a>
  **/
 @Target({})
 @Retention(RetentionPolicy.RUNTIME)

api/src/main/java/org/eclipse/microprofile/openapi/annotations/info/License.java

@@ -27,7 +27,7 @@
 /**
  * License information for the exposed API.
  *
- * @see "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#licenseObject"
+ * @see <a href="https://spec.openapis.org/oas/v3.1.0.html#license-object">OpenAPI Specification License Object</a>
  **/
 @Target({})
 @Retention(RetentionPolicy.RUNTIME)

api/src/main/java/org/eclipse/microprofile/openapi/annotations/links/Link.java

@@ -30,8 +30,7 @@
  * caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between
  * responses and other operations.
  *
- * @see <a href= "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#linkObject"> OpenAPI
- *      Specification Link Object</a>
+ * @see <a href= "https://spec.openapis.org/oas/v3.1.0.html#link-object"> OpenAPI Specification Link Object</a>
  **/
 @Target({})
 @Retention(RetentionPolicy.RUNTIME)

api/src/main/java/org/eclipse/microprofile/openapi/annotations/media/Content.java

@@ -27,8 +27,8 @@
 /**
  * This object provides schema and examples for a particular media type.
  *
- * @see <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#mediaTypeObject">OpenAPI
- *      Specification Media Type Object</a>
+ * @see <a href="https://spec.openapis.org/oas/v3.1.0.html#media-type-object">OpenAPI Specification Media Type
+ *      Object</a>
  **/
 @Target({})
 @Retention(RetentionPolicy.RUNTIME)

api/src/main/java/org/eclipse/microprofile/openapi/annotations/media/DiscriminatorMapping.java

@@ -25,9 +25,8 @@
 /**
  * This object maps payload values to a particular Schema.
  *
- * @see <a href=
- *      "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#discriminator-object">OpenAPI
- *      Specification Discriminator Object</a>
+ * @see <a href= "https://spec.openapis.org/oas/v3.1.0.html#discriminator-object">OpenAPI Specification Discriminator
+ *      Object</a>
  **/
 @Target({})
 @Retention(RetentionPolicy.RUNTIME)

api/src/main/java/org/eclipse/microprofile/openapi/annotations/media/Encoding.java

@@ -28,8 +28,7 @@
 /**
  * Single encoding definition to be applied to single Schema Object
  *
- * @see <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#encodingObject">Encoding
- *      Object</a>
+ * @see <a href="https://spec.openapis.org/oas/v3.1.0.html#encoding-object">OpenAPI Specification Encoding Object</a>
  **/
 
 @Target({})

api/src/main/java/org/eclipse/microprofile/openapi/annotations/media/ExampleObject.java

@@ -27,8 +27,7 @@
 /**
  * This object illustrates an example of a particular content
  *
- * @see <a href= "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#exampleObject">OpenAPI
- *      Specification Example Object</a>
+ * @see <a href= "https://spec.openapis.org/oas/v3.1.0.html#example-object">OpenAPI Specification Example Object</a>
  **/
 @Target({})
 @Retention(RetentionPolicy.RUNTIME)

api/src/main/java/org/eclipse/microprofile/openapi/annotations/media/Schema.java

@@ -45,8 +45,7 @@
  * <li>{@link Void} to indicate that the schema should not be included at all (this is the default for most parameters)
  * </ul>
  *
- * @see <a href= "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#schemaObject">OpenAPI
- *      Specification Schema Object</a>
+ * @see <a href= "https://spec.openapis.org/oas/v3.1.0.html#schema-object">OpenAPI Specification Schema Object</a>
  **/
 @Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, ElementType.TYPE})
 @Retention(RetentionPolicy.RUNTIME)

api/src/main/java/org/eclipse/microprofile/openapi/annotations/media/SchemaProperty.java

@@ -33,8 +33,7 @@
  *
  * This object is an extended subset of the JSON Schema draft specification 2020-12.
  *
- * @see <a href= "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#schemaObject">OpenAPI
- *      Specification Schema Object</a>
+ * @see <a href= "https://spec.openapis.org/oas/v3.1.0.html#schema-object">OpenAPI Specification Schema Object</a>
  *
  * @since 2.0
  **/

api/src/main/java/org/eclipse/microprofile/openapi/annotations/parameters/Parameter.java

@@ -35,8 +35,7 @@
 /**
  * Describes a single operation parameter
  *
- * @see <a href= "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#parameterObject">OpenAPI
- *      Specification Parameter Object</a>
+ * @see <a href= "https://spec.openapis.org/oas/v3.1.0.html#parameter-object">OpenAPI Specification Parameter Object</a>
  **/
 @Target({ElementType.PARAMETER, ElementType.METHOD, ElementType.FIELD})
 @Retention(RetentionPolicy.RUNTIME)

api/src/main/java/org/eclipse/microprofile/openapi/annotations/parameters/Parameters.java

@@ -26,8 +26,7 @@
 /**
  * This object encapsulates input parameters
  *
- * @see <a href= "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#parameterObject">OpenAPI
- *      Specification Parameter Object</a>
+ * @see <a href= "https://spec.openapis.org/oas/v3.1.0.html#parameter-object">OpenAPI Specification Parameter Object</a>
  */
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ElementType.METHOD})

api/src/main/java/org/eclipse/microprofile/openapi/annotations/parameters/RequestBody.java

@@ -29,8 +29,7 @@
 /**
  * Describes a single request body.
  *
- * @see <a href=
- *      "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#requestBodyObject">requestBody
+ * @see <a href= "https://spec.openapis.org/oas/v3.1.0.html#request-body-object">OpenAPI Specification Request Body
  *      Object</a>
  **/
 @Target({ElementType.PARAMETER, ElementType.METHOD})

api/src/main/java/org/eclipse/microprofile/openapi/annotations/parameters/RequestBodySchema.java

@@ -58,8 +58,8 @@
  * </pre>
  *
  * @see RequestBody
- * @see <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#requestBodyObject">OpenAPI
- *      requestBody Object</a>
+ * @see <a href="https://spec.openapis.org/oas/v3.1.0.html#request-body-object">OpenAPI Specification Request Body
+ *      Object</a>
  **/
 @Target({ElementType.PARAMETER, ElementType.METHOD})
 @Retention(RetentionPolicy.RUNTIME)

api/src/main/java/org/eclipse/microprofile/openapi/annotations/responses/APIResponse.java

@@ -69,7 +69,7 @@
  * }
  * </pre>
  *
- * @see "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#responseObject"
+ * @see <a href="https://spec.openapis.org/oas/v3.1.0.html#response-object">OpenAPI Specification Response Object</a>
  *
  **/
 @Target({ElementType.METHOD, ElementType.TYPE})

api/src/main/java/org/eclipse/microprofile/openapi/annotations/responses/APIResponseSchema.java

@@ -58,7 +58,7 @@
  *
  * @since 2.0
  * @see APIResponse
- * @see "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#responseObject"
+ * @see <a href="https://spec.openapis.org/oas/v3.1.0.html#response-object">OpenAPI Specification Response Object</a>
  *
  **/
 @Target({ElementType.METHOD})

api/src/main/java/org/eclipse/microprofile/openapi/annotations/responses/APIResponses.java

@@ -28,8 +28,7 @@
  * The ApiResponses annotation is a container for @ApiResponse annotations. When used on a method it is treated as if
  * each ApiResponse annotation were applied individually.
  *
- * @see <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#responses-object">Responses
- *      Object</a>
+ * @see <a href="https://spec.openapis.org/oas/v3.1.0.html#responses-object">OpenAPI Specification Responses Object</a>
  **/
 @Target({ElementType.METHOD, ElementType.TYPE})
 @Retention(RetentionPolicy.RUNTIME)

api/src/main/java/org/eclipse/microprofile/openapi/annotations/security/OAuthFlow.java

@@ -27,7 +27,7 @@
 /**
  * Configuration details for a supported OAuth Flow.
  *
- * @see <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#oauthFlowObject"> OAuth Flow
+ * @see <a href="https://spec.openapis.org/oas/v3.1.0.html#oauth-flow-object">OpenAPI Specification OAuth Flow
  *      Object</a>
  **/
 @Target({})

api/src/main/java/org/eclipse/microprofile/openapi/annotations/security/OAuthFlows.java

@@ -27,7 +27,7 @@
 /**
  * Allows configuration of the supported OAuth Flows.
  *
- * @see <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#oauthFlowsObject">OAuthFlows
+ * @see <a href="https://spec.openapis.org/oas/v3.1.0.html#oauth-flows-object">OpenAPI Specification OAuth Flows
  *      Object</a>
  **/
 @Target({})

api/src/main/java/org/eclipse/microprofile/openapi/annotations/security/OAuthScope.java

@@ -25,7 +25,7 @@
 /**
  * Represents an OAuth scope.
  *
- * @see <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#oauthFlowObject">OAuthFlow
+ * @see <a href="https://spec.openapis.org/oas/v3.1.0.html#oauth-flow-object">OpenAPI Specification OAuth Flow
  *      Object</a>
  **/
 @Target({})

api/src/main/java/org/eclipse/microprofile/openapi/annotations/security/SecurityRequirement.java

@@ -30,9 +30,8 @@
  * Applying this annotation to a method or class is equivalent to applying a {@link SecurityRequirementsSet} annotation
  * containing only this annotation.
  *
- * @see <a href=
- *      "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#security-requirement-object">SecuirtyRequirement
- *      Object</a>
+ * @see <a href= "https://spec.openapis.org/oas/v3.1.0.html#security-requirement-object">OpenAPI Specification Security
+ *      Requirement Object</a>
  **/
 @Target({ElementType.METHOD, ElementType.TYPE})
 @Retention(RetentionPolicy.RUNTIME)

api/src/main/java/org/eclipse/microprofile/openapi/annotations/security/SecurityRequirements.java

@@ -35,9 +35,8 @@
  *   - api_secret: []
  * </pre>
  *
- * @see <a href=
- *      "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#security-requirement-object">SecurityRequirement
- *      Object</a>
+ * @see <a href= "https://spec.openapis.org/oas/v3.1.0.html#security-requirement-object">OpenAPI Specification Security
+ *      Requirement Object</a>
  **/
 @Target({ElementType.METHOD, ElementType.TYPE})
 @Retention(RetentionPolicy.RUNTIME)

api/src/main/java/org/eclipse/microprofile/openapi/annotations/security/SecurityRequirementsSet.java

@@ -53,9 +53,8 @@
  *    oauth_implicit: []
  * </pre>
  *
- * @see <a href=
- *      "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#security-requirement-object">SecurityRequirement
- *      Object</a>
+ * @see <a href= "https://spec.openapis.org/oas/v3.1.0.html#security-requirement-object">OpenAPI Specification Security
+ *      Requirement Object</a>
  **/
 @Target({ElementType.METHOD, ElementType.TYPE})
 @Retention(RetentionPolicy.RUNTIME)

api/src/main/java/org/eclipse/microprofile/openapi/annotations/security/SecurityRequirementsSets.java

@@ -49,9 +49,8 @@
  *   - api_secret: []
  * </pre>
  *
- * @see <a href=
- *      "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#security-requirement-object">SecurityRequirement
- *      Object</a>
+ * @see <a href= "https://spec.openapis.org/oas/v3.1.0.html#security-requirement-object">OpenAPI Specification Security
+ *      Requirement Object</a>
  **/
 @Retention(RUNTIME)
 @Target({TYPE, METHOD})

api/src/main/java/org/eclipse/microprofile/openapi/annotations/security/SecurityScheme.java

@@ -33,7 +33,8 @@
  * (either as a header or as a query parameter), OAuth2's common flows (implicit, password, application and access code)
  * as defined in RFC6749, and OpenID Connect Discovery.
  *
- * @see "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#security-scheme-object"
+ * @see <a href="https://spec.openapis.org/oas/v3.1.0.html#security-scheme-object">OpenAPI Specification Security Scheme
+ *      Object</a>
  **/
 @Target({ElementType.METHOD, ElementType.TYPE})
 @Retention(RetentionPolicy.RUNTIME)

api/src/main/java/org/eclipse/microprofile/openapi/annotations/security/SecuritySchemes.java

@@ -25,7 +25,8 @@
 /**
  * This object represents an array of SecurityScheme annotations that can be specified at the definition level.
  *
- * @see "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#security-scheme-object"
+ * @see <a href="https://spec.openapis.org/oas/v3.1.0.html#security-scheme-object">OpenAPI Specification Security Scheme
+ *      Object</a>
  **/
 @Target({ElementType.TYPE})
 @Retention(RetentionPolicy.RUNTIME)

api/src/main/java/org/eclipse/microprofile/openapi/annotations/servers/Server.java

@@ -42,8 +42,7 @@
  * {@link org.eclipse.microprofile.openapi.annotations.servers.Servers Servers} annotation are specified on the same
  * type, the server definitions will be combined.
  *
- * @see <a href= "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#server-object"> OpenAPI
- *      Specification Server Object</a>
+ * @see <a href= "https://spec.openapis.org/oas/v3.1.0.html#server-object"> OpenAPI Specification Server Object</a>
  **/
 @Target({ElementType.TYPE, ElementType.METHOD})
 @Retention(RetentionPolicy.RUNTIME)

api/src/main/java/org/eclipse/microprofile/openapi/annotations/servers/ServerVariable.java

@@ -27,9 +27,8 @@
 /**
  * An object representing a Server Variable for server URL template substitution.
  *
- * @see <a href=
- *      "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#server-variable-object">ServerVariable
- *      Object</a>
+ * @see <a href= "https://spec.openapis.org/oas/v3.1.0.html#server-variable-object">OpenAPI Specification Server
+ *      Variable Object</a>
  **/
 @Target({})
 @Retention(RetentionPolicy.RUNTIME)

api/src/main/java/org/eclipse/microprofile/openapi/annotations/servers/Servers.java

@@ -31,8 +31,7 @@
  * {@link org.eclipse.microprofile.openapi.annotations.servers.Servers Servers} annotation are specified on the same
  * type, the server definitions will be combined.
  *
- * @see <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#serverObject">Server
- *      Object</a>
+ * @see <a href="https://spec.openapis.org/oas/v3.1.0.html#server-object">OpenAPI Specification Server Object</a>
  *
  */
 @Target({ElementType.TYPE, ElementType.METHOD})

api/src/main/java/org/eclipse/microprofile/openapi/annotations/tags/Tag.java

@@ -68,8 +68,7 @@
  * }
  * </pre>
  *
- * @see <a href= "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#tagObject"> OpenAPI
- *      Specification Tag Object</a>
+ * @see <a href= "https://spec.openapis.org/oas/v3.1.0.html#tag-object"> OpenAPI Specification Tag Object</a>
  */
 @Target({ElementType.TYPE, ElementType.METHOD})
 @Retention(RetentionPolicy.RUNTIME)