diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/Components.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/Components.java index d7ffd3bd..868d202b 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/Components.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/Components.java @@ -36,7 +36,7 @@ * Describes the Components object that holds various reusable objects for different aspects of the OpenAPI * Specification (OAS). * - * @see OpenAPI + * @see OpenAPI * Specification Components Object */ @Target({}) diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/ExternalDocumentation.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/ExternalDocumentation.java index c139e5f3..70178680 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/ExternalDocumentation.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/ExternalDocumentation.java @@ -36,7 +36,7 @@ * externalDocs field of the OpenAPIDefinition annotation is supplied the results are not defined. * * @see OpenAPI + * "https://spec.openapis.org/oas/v3.1.0.html##external-documentation-object">OpenAPI * Specification External Documentation Object **/ @Target({ElementType.METHOD, ElementType.TYPE}) diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/OpenAPIDefinition.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/OpenAPIDefinition.java index 873282c1..dbcbce2a 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/OpenAPIDefinition.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/OpenAPIDefinition.java @@ -35,7 +35,7 @@ *

* This is the root document object of the OpenAPI document. It contains required and optional fields. * - * @see OpenAPI + * @see OpenAPI * Specification OpenAPI Object */ diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/Operation.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/Operation.java index efc7ce27..4e966eca 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/Operation.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/Operation.java @@ -28,7 +28,7 @@ /** * Describes a single API operation on a path. * - * @see OpenAPI + * @see OpenAPI * Specification Operation Object **/ @Target({ElementType.METHOD}) diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/callbacks/Callback.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/callbacks/Callback.java index 7e6e4ae4..0a22f73a 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/callbacks/Callback.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/callbacks/Callback.java @@ -29,7 +29,7 @@ /** * This object represents a callback URL that will be invoked. * - * @see OpenAPI + * @see OpenAPI * Specification Callback Object **/ @Target({ElementType.METHOD, ElementType.TYPE}) diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/callbacks/CallbackOperation.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/callbacks/CallbackOperation.java index 6806d64d..8e251fbd 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/callbacks/CallbackOperation.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/callbacks/CallbackOperation.java @@ -33,7 +33,7 @@ /** * Describes a single API callback operation. * - * @see OpenAPI + * @see OpenAPI * Specification Operation Object **/ @Target({}) diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/callbacks/Callbacks.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/callbacks/Callbacks.java index 0952fc2b..38fea749 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/callbacks/Callbacks.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/callbacks/Callbacks.java @@ -26,7 +26,7 @@ /** * This object represents an array of Callback URLs that can be invoked. * - * @see OpenAPI + * @see OpenAPI * Specification Callback Object **/ @Target({ElementType.METHOD}) diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/headers/Header.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/headers/Header.java index e3ff7834..55af7b0f 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/headers/Header.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/headers/Header.java @@ -28,7 +28,7 @@ /** * Describes a single header object * - * @see OpenAPI + * @see OpenAPI * Specification Header Object **/ @Target({}) diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/info/Contact.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/info/Contact.java index 6da46dde..6f0b8e12 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/info/Contact.java +++ b/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/main/versions/3.1.0.md#contact-object" + * @see "https://spec.openapis.org/oas/v3.1.0.html##contact-object" **/ @Target({}) @Retention(RetentionPolicy.RUNTIME) diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/info/Info.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/info/Info.java index cff79767..81d67c3e 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/info/Info.java +++ b/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/main/versions/3.1.0.md#info-object" + * @see "https://spec.openapis.org/oas/v3.1.0.html##info-object" **/ @Target({}) @Retention(RetentionPolicy.RUNTIME) diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/info/License.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/info/License.java index c1515196..59589bb0 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/info/License.java +++ b/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/main/versions/3.1.0.md#license-object" + * @see "https://spec.openapis.org/oas/v3.1.0.html##license-object" **/ @Target({}) @Retention(RetentionPolicy.RUNTIME) diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/links/Link.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/links/Link.java index 5c9e78d0..9dd14bcd 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/links/Link.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/links/Link.java @@ -30,7 +30,7 @@ * caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between * responses and other operations. * - * @see OpenAPI + * @see OpenAPI * Specification Link Object **/ @Target({}) diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/media/Content.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/media/Content.java index 233c8c24..faf019fb 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/media/Content.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/media/Content.java @@ -27,7 +27,7 @@ /** * This object provides schema and examples for a particular media type. * - * @see OpenAPI + * @see OpenAPI * Specification Media Type Object **/ @Target({}) diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/media/DiscriminatorMapping.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/media/DiscriminatorMapping.java index 12485897..cf001d8d 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/media/DiscriminatorMapping.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/media/DiscriminatorMapping.java @@ -26,7 +26,7 @@ * This object maps payload values to a particular Schema. * * @see OpenAPI + * "https://spec.openapis.org/oas/v3.1.0.html##discriminator-object">OpenAPI * Specification Discriminator Object **/ @Target({}) diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/media/Encoding.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/media/Encoding.java index 57720b0b..d9e462fe 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/media/Encoding.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/media/Encoding.java @@ -28,7 +28,7 @@ /** * Single encoding definition to be applied to single Schema Object * - * @see Encoding + * @see Encoding * Object **/ diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/media/ExampleObject.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/media/ExampleObject.java index 0d0995e9..99dd4a80 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/media/ExampleObject.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/media/ExampleObject.java @@ -27,7 +27,7 @@ /** * This object illustrates an example of a particular content * - * @see OpenAPI + * @see OpenAPI * Specification Example Object **/ @Target({}) diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/media/Schema.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/media/Schema.java index 4805c05e..21431af2 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/media/Schema.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/media/Schema.java @@ -31,7 +31,7 @@ * The Schema Object allows the definition of input and output data types. These types can be objects, but also * primitives and arrays. This object is an extended subset of the JSON Schema Specification Wright Draft 00. * - * @see OpenAPI + * @see OpenAPI * Specification Schema Object **/ @Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, ElementType.TYPE}) diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/media/SchemaProperty.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/media/SchemaProperty.java index bbf3c967..9dde9196 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/media/SchemaProperty.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/media/SchemaProperty.java @@ -31,7 +31,7 @@ * * This object is an extended subset of the JSON Schema Specification Wright Draft 00. * - * @see OpenAPI + * @see OpenAPI * Specification Schema Object * * @since 2.0 diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/parameters/Parameter.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/parameters/Parameter.java index ef6f409f..0c387581 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/parameters/Parameter.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/parameters/Parameter.java @@ -35,7 +35,7 @@ /** * Describes a single operation parameter * - * @see OpenAPI + * @see OpenAPI * Specification Parameter Object **/ @Target({ElementType.PARAMETER, ElementType.METHOD, ElementType.FIELD}) diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/parameters/Parameters.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/parameters/Parameters.java index bd934ec8..65d15c2e 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/parameters/Parameters.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/parameters/Parameters.java @@ -26,7 +26,7 @@ /** * This object encapsulates input parameters * - * @see OpenAPI + * @see OpenAPI * Specification Parameter Object */ @Retention(RetentionPolicy.RUNTIME) diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/parameters/RequestBody.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/parameters/RequestBody.java index b080d777..bef84428 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/parameters/RequestBody.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/parameters/RequestBody.java @@ -30,7 +30,7 @@ * Describes a single request body. * * @see RequestBody + * "https://spec.openapis.org/oas/v3.1.0.html##request-body-object">RequestBody * Object **/ @Target({ElementType.PARAMETER, ElementType.METHOD}) diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/parameters/RequestBodySchema.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/parameters/RequestBodySchema.java index a604aefa..6cf06326 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/parameters/RequestBodySchema.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/parameters/RequestBodySchema.java @@ -58,7 +58,7 @@ * * * @see RequestBody - * @see OpenAPI + * @see OpenAPI * requestBody Object **/ @Target({ElementType.PARAMETER, ElementType.METHOD}) diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/responses/APIResponse.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/responses/APIResponse.java index e52a9e29..05c9493b 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/responses/APIResponse.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/responses/APIResponse.java @@ -69,7 +69,7 @@ * } * * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#response-object" + * @see "https://spec.openapis.org/oas/v3.1.0.html##response-object" * **/ @Target({ElementType.METHOD, ElementType.TYPE}) diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/responses/APIResponseSchema.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/responses/APIResponseSchema.java index 31f9c105..3b67d5b5 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/responses/APIResponseSchema.java +++ b/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/main/versions/3.1.0.md#response-object" + * @see "https://spec.openapis.org/oas/v3.1.0.html##response-object" * **/ @Target({ElementType.METHOD}) diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/responses/APIResponses.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/responses/APIResponses.java index c6170167..4371e9ab 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/responses/APIResponses.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/responses/APIResponses.java @@ -28,7 +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 Responses + * @see Responses * Object **/ @Target({ElementType.METHOD, ElementType.TYPE}) diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/security/OAuthFlow.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/security/OAuthFlow.java index f9cb69e0..4119c6ce 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/security/OAuthFlow.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/security/OAuthFlow.java @@ -27,7 +27,7 @@ /** * Configuration details for a supported OAuth Flow. * - * @see OAuthFlow + * @see OAuthFlow * Object **/ @Target({}) diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/security/OAuthFlows.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/security/OAuthFlows.java index 8cfe8d48..cb566681 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/security/OAuthFlows.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/security/OAuthFlows.java @@ -27,7 +27,7 @@ /** * Allows configuration of the supported OAuth Flows. * - * @see OAuthFlows + * @see OAuthFlows * Object **/ @Target({}) diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/security/OAuthScope.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/security/OAuthScope.java index 5bdf2b26..cc654d5c 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/security/OAuthScope.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/security/OAuthScope.java @@ -25,7 +25,7 @@ /** * Represents an OAuth scope. * - * @see OAuthFlow + * @see OAuthFlow * Object **/ @Target({}) diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/security/SecurityRequirement.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/security/SecurityRequirement.java index 595da6dc..b5e4511f 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/security/SecurityRequirement.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/security/SecurityRequirement.java @@ -31,7 +31,7 @@ * containing only this annotation. * * @see SecuirtyRequirement + * "https://spec.openapis.org/oas/v3.1.0.html##security-requirement-object">SecuirtyRequirement * Object **/ @Target({ElementType.METHOD, ElementType.TYPE}) diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/security/SecurityRequirements.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/security/SecurityRequirements.java index 79fd44c7..0571db9c 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/security/SecurityRequirements.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/security/SecurityRequirements.java @@ -36,7 +36,7 @@ * * * @see -security-requirement + * "https://spec.openapis.org/oas/v3.1.0.html##security-requirement-object">-security-requirement * Object **/ @Target({ElementType.METHOD, ElementType.TYPE}) diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/security/SecurityRequirementsSet.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/security/SecurityRequirementsSet.java index cef97d8d..b7a77916 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/security/SecurityRequirementsSet.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/security/SecurityRequirementsSet.java @@ -54,7 +54,7 @@ * * * @see -security-requirement + * "https://spec.openapis.org/oas/v3.1.0.html##security-requirement-object">-security-requirement * Object **/ @Target({ElementType.METHOD, ElementType.TYPE}) diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/security/SecurityRequirementsSets.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/security/SecurityRequirementsSets.java index 30feab00..de122e60 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/security/SecurityRequirementsSets.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/security/SecurityRequirementsSets.java @@ -50,7 +50,7 @@ * * * @see -security-requirement + * "https://spec.openapis.org/oas/v3.1.0.html##security-requirement-object">-security-requirement * Object **/ @Retention(RUNTIME) diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/security/SecurityScheme.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/security/SecurityScheme.java index 890e4941..24ad98da 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/security/SecurityScheme.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/security/SecurityScheme.java @@ -33,7 +33,7 @@ * (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/main/versions/3.1.0.md#security-scheme-object" + * @see "https://spec.openapis.org/oas/v3.1.0.html##security-scheme-object" **/ @Target({ElementType.METHOD, ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/security/SecuritySchemes.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/security/SecuritySchemes.java index 54c798ce..6d07e6fa 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/security/SecuritySchemes.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/security/SecuritySchemes.java @@ -25,7 +25,7 @@ /** * This object represents an array of SecurityScheme annotations that can be specified at the definition level. * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#security-scheme-object" + * @see "https://spec.openapis.org/oas/v3.1.0.html##security-scheme-object" **/ @Target({ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/servers/Server.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/servers/Server.java index 02c3d88b..7af618df 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/servers/Server.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/servers/Server.java @@ -42,7 +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 OpenAPI + * @see OpenAPI * Specification Server Object **/ @Target({ElementType.TYPE, ElementType.METHOD}) diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/servers/ServerVariable.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/servers/ServerVariable.java index ca1a14f7..1bd50231 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/servers/ServerVariable.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/servers/ServerVariable.java @@ -28,7 +28,7 @@ * An object representing a Server Variable for server URL template substitution. * * @see ServerVariable + * "https://spec.openapis.org/oas/v3.1.0.html##server-variable-object">ServerVariable * Object **/ @Target({}) diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/servers/Servers.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/servers/Servers.java index f4819200..11365f58 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/servers/Servers.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/servers/Servers.java @@ -31,7 +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 Server + * @see Server * Object * */ diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/tags/Tag.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/tags/Tag.java index 57d90717..78b3ebc1 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/tags/Tag.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/tags/Tag.java @@ -68,7 +68,7 @@ * } * * - * @see OpenAPI + * @see OpenAPI * Specification Tag Object */ @Target({ElementType.TYPE, ElementType.METHOD}) diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/tags/Tags.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/tags/Tags.java index 7772164b..0790b62a 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/tags/Tags.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/tags/Tags.java @@ -31,7 +31,7 @@ * {@link org.eclipse.microprofile.openapi.annotations.tags.Tags Tags} annotations are specified on the same * method/class, then both tag definitions should be applied to method/class. * - * @see OpenAPI + * @see OpenAPI * Specification Tag Object * */ diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/models/Components.java b/api/src/main/java/org/eclipse/microprofile/openapi/models/Components.java index b0224436..a9777c5c 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/models/Components.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/models/Components.java @@ -47,7 +47,7 @@ *

  • my.org.User
    • * * - * @see OpenAPI + * @see OpenAPI * Specification Components Object */ public interface Components extends Constructible, Extensible { diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/models/ExternalDocumentation.java b/api/src/main/java/org/eclipse/microprofile/openapi/models/ExternalDocumentation.java index fd1df783..facae619 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/models/ExternalDocumentation.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/models/ExternalDocumentation.java @@ -24,7 +24,7 @@ *

    * * @see OpenAPI + * "https://spec.openapis.org/oas/v3.1.0.html##external-documentation-object">OpenAPI * Specification External Documentation Object */ public interface ExternalDocumentation extends Constructible, Extensible { diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/models/OpenAPI.java b/api/src/main/java/org/eclipse/microprofile/openapi/models/OpenAPI.java index ca3f92d2..828833a9 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/models/OpenAPI.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/models/OpenAPI.java @@ -29,7 +29,7 @@ *

    * This is the root document object of the OpenAPI document. It contains required and optional fields. * - * @see OpenAPI + * @see OpenAPI * Specification OpenAPI Object */ public interface OpenAPI extends Constructible, Extensible { diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/models/Operation.java b/api/src/main/java/org/eclipse/microprofile/openapi/models/Operation.java index f8830f87..b95b423c 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/models/Operation.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/models/Operation.java @@ -33,7 +33,7 @@ * Describes a single API operation on a path. *

    * - * @see OpenAPI + * @see OpenAPI * Specification Operation Object */ public interface Operation extends Constructible, Extensible { diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/models/PathItem.java b/api/src/main/java/org/eclipse/microprofile/openapi/models/PathItem.java index dfcaa7bf..5fac475c 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/models/PathItem.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/models/PathItem.java @@ -27,12 +27,12 @@ * PathItem *

    * Describes the operations available on a single path. A Path Item MAY be empty, due to - * security + * security * constraints. In that case the path itself is still exposed to the documentation viewer but you will not know * which operations and parameters are available. *

    * - * @see OpenAPI + * @see OpenAPI * Specification Path Item Object */ public interface PathItem extends Constructible, Extensible, Reference { diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/models/Paths.java b/api/src/main/java/org/eclipse/microprofile/openapi/models/Paths.java index 403664d2..ee53287a 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/models/Paths.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/models/Paths.java @@ -24,11 +24,11 @@ *

    * Holds the relative paths to the individual endpoints and their operations. The path is appended to the URL from the * Server Object in order to construct the full URL. The Paths MAY be empty, due to - * security + * security * constraints. *

    * - * @see OpenAPI + * @see OpenAPI * Specification Paths Object */ public interface Paths extends Constructible, Extensible { diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/models/callbacks/Callback.java b/api/src/main/java/org/eclipse/microprofile/openapi/models/callbacks/Callback.java index 55dc763d..deb8b964 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/models/callbacks/Callback.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/models/callbacks/Callback.java @@ -32,7 +32,7 @@ * used to identify the callback object is an expression, evaluated at runtime, that identifies a URL to use for the * callback operation. * - * @see OpenAPI + * @see OpenAPI * Specification Callback Object */ public interface Callback extends Constructible, Extensible, Reference { diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/models/examples/Example.java b/api/src/main/java/org/eclipse/microprofile/openapi/models/examples/Example.java index 3273f4d1..eb9c4535 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/models/examples/Example.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/models/examples/Example.java @@ -29,7 +29,7 @@ * In all cases, the example value is expected to be compatible with the type schema of its associated value. Tooling * implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible. * - * @see OpenAPI + * @see OpenAPI * Specification Example Object */ public interface Example extends Constructible, Extensible, Reference { diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/models/headers/Header.java b/api/src/main/java/org/eclipse/microprofile/openapi/models/headers/Header.java index ea7db754..6ac9bc40 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/models/headers/Header.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/models/headers/Header.java @@ -32,7 +32,7 @@ * Describes a single header parameter for an operation. *

    * - * @see OpenAPI + * @see OpenAPI * Specification Header Object */ public interface Header extends Constructible, Extensible

    , Reference
    { diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/models/info/Contact.java b/api/src/main/java/org/eclipse/microprofile/openapi/models/info/Contact.java index 7e3ae2a8..62e9dda2 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/models/info/Contact.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/models/info/Contact.java @@ -23,7 +23,7 @@ /** * This interface represents the Contact information for the exposed API. * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#contact-object" + * @see "https://spec.openapis.org/oas/v3.1.0.html##contact-object" */ public interface Contact extends Constructible, Extensible { diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/models/info/Info.java b/api/src/main/java/org/eclipse/microprofile/openapi/models/info/Info.java index fb58e86b..fcb52ec7 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/models/info/Info.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/models/info/Info.java @@ -24,7 +24,7 @@ * This interface represents all the metadata about the API. The metadata may be used by clients if needed, and may be * presented in editing or documentation tools. * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#info-object" + * @see "https://spec.openapis.org/oas/v3.1.0.html##info-object" */ public interface Info extends Constructible, Extensible { diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/models/info/License.java b/api/src/main/java/org/eclipse/microprofile/openapi/models/info/License.java index 09ab1a3c..376bf1f7 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/models/info/License.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/models/info/License.java @@ -23,7 +23,7 @@ /** * This interface represents the License information for the exposed API. * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#license-object" + * @see "https://spec.openapis.org/oas/v3.1.0.html##license-object" */ public interface License extends Constructible, Extensible { diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/models/links/Link.java b/api/src/main/java/org/eclipse/microprofile/openapi/models/links/Link.java index 06ce0a70..0f6d1b28 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/models/links/Link.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/models/links/Link.java @@ -39,7 +39,7 @@ * operationRef syntax is preferred for specifications with external references. *

    * - * @see OpenAPI + * @see OpenAPI * Specification Link Object */ public interface Link extends Constructible, Extensible, Reference { diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/models/media/Discriminator.java b/api/src/main/java/org/eclipse/microprofile/openapi/models/media/Discriminator.java index f62b2908..dade17c3 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/models/media/Discriminator.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/models/media/Discriminator.java @@ -31,7 +31,7 @@ *

    * * @see OpenAPI + * "https://spec.openapis.org/oas/v3.1.0.html##discriminator-object">OpenAPI * Specification Discriminator Object */ public interface Discriminator extends Constructible { diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/models/media/Encoding.java b/api/src/main/java/org/eclipse/microprofile/openapi/models/media/Encoding.java index 59f744eb..ff3a17aa 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/models/media/Encoding.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/models/media/Encoding.java @@ -26,7 +26,7 @@ /** * Encoding * - * @see Encoding + * @see Encoding * Object */ public interface Encoding extends Constructible, Extensible { diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/models/media/MediaType.java b/api/src/main/java/org/eclipse/microprofile/openapi/models/media/MediaType.java index 3af415c2..109d162a 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/models/media/MediaType.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/models/media/MediaType.java @@ -29,7 +29,7 @@ * Each Media Type Object provides a schema and examples for the media type identified by its key. *

    * - * @see OpenAPI + * @see OpenAPI * Specification Media Type Object */ public interface MediaType extends Constructible, Extensible { diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/models/media/Schema.java b/api/src/main/java/org/eclipse/microprofile/openapi/models/media/Schema.java index 329e82d5..6938ee34 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/models/media/Schema.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/models/media/Schema.java @@ -39,7 +39,7 @@ * Any time a Schema Object can be used, a Reference Object can be used in its place. This allows referencing an * existing definition instead of defining the same Schema again. * - * @see OpenAPI + * @see OpenAPI * Specification Schema Object */ public interface Schema extends Extensible, Constructible, Reference { diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/models/media/XML.java b/api/src/main/java/org/eclipse/microprofile/openapi/models/media/XML.java index 98886f0a..1adc7081 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/models/media/XML.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/models/media/XML.java @@ -24,7 +24,7 @@ * A metadata object that allows for more fine-tuned XML model definitions. When using arrays, XML element names are not * inferred (for singular/plural forms) and the name property SHOULD be used to add that information. * - * @see XMLObject + * @see XMLObject */ public interface XML extends Constructible, Extensible { diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/models/parameters/Parameter.java b/api/src/main/java/org/eclipse/microprofile/openapi/models/parameters/Parameter.java index 77c14295..b4367682 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/models/parameters/Parameter.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/models/parameters/Parameter.java @@ -49,7 +49,7 @@ * For more complex scenarios, the content property can define the media type and schema of the parameter. A parameter * must contain either a schema property, or a content property, but not both. * - * @see OpenAPI + * @see OpenAPI * Specification Parameter Object */ public interface Parameter extends Constructible, Extensible, Reference { diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/models/parameters/RequestBody.java b/api/src/main/java/org/eclipse/microprofile/openapi/models/parameters/RequestBody.java index 28d3149a..4861ec4b 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/models/parameters/RequestBody.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/models/parameters/RequestBody.java @@ -26,7 +26,7 @@ * This interface represents the request body of an operation in which body parameters can be specified. * * @see RequestBody + * "https://spec.openapis.org/oas/v3.1.0.html##request-body-object">RequestBody * Object */ public interface RequestBody extends Constructible, Extensible, Reference { diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/models/responses/APIResponse.java b/api/src/main/java/org/eclipse/microprofile/openapi/models/responses/APIResponse.java index 4bda0729..9eb72ea8 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/models/responses/APIResponse.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/models/responses/APIResponse.java @@ -30,7 +30,7 @@ * This interface represents a single response from an API Operation, including design-time, static links to operations * based on the response. * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#response-object" + * @see "https://spec.openapis.org/oas/v3.1.0.html##response-object" */ public interface APIResponse extends Constructible, Extensible, Reference { diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/models/responses/APIResponses.java b/api/src/main/java/org/eclipse/microprofile/openapi/models/responses/APIResponses.java index 10c61b94..0beb238f 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/models/responses/APIResponses.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/models/responses/APIResponses.java @@ -26,7 +26,7 @@ * This interface represents the container for the expected responses of an operation. The container maps a HTTP * response code to the expected response. * - * @see Responses + * @see Responses * Object */ public interface APIResponses extends Constructible, Extensible { diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/models/security/OAuthFlow.java b/api/src/main/java/org/eclipse/microprofile/openapi/models/security/OAuthFlow.java index 735b393e..398b222f 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/models/security/OAuthFlow.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/models/security/OAuthFlow.java @@ -25,7 +25,7 @@ /** * Configuration details for a supportde OAuthFlow * - * @see OAuthFlow + * @see OAuthFlow * Object */ public interface OAuthFlow extends Constructible, Extensible { diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/models/security/OAuthFlows.java b/api/src/main/java/org/eclipse/microprofile/openapi/models/security/OAuthFlows.java index 295ccbbb..b794ee22 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/models/security/OAuthFlows.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/models/security/OAuthFlows.java @@ -23,7 +23,7 @@ /** * Configuration of the supported OAuthFlows * - * @see OAuthFlows + * @see OAuthFlows * Object */ public interface OAuthFlows extends Constructible, Extensible { diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/models/security/SecurityRequirement.java b/api/src/main/java/org/eclipse/microprofile/openapi/models/security/SecurityRequirement.java index 23e9b841..25663ae3 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/models/security/SecurityRequirement.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/models/security/SecurityRequirement.java @@ -26,7 +26,7 @@ * SecurityRequirement * * @see -security-requirement + * "https://spec.openapis.org/oas/v3.1.0.html##security-requirement-object">-security-requirement * Object */ public interface SecurityRequirement extends Constructible { diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/models/security/SecurityScheme.java b/api/src/main/java/org/eclipse/microprofile/openapi/models/security/SecurityScheme.java index 27ed49c5..1334f8a7 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/models/security/SecurityScheme.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/models/security/SecurityScheme.java @@ -24,7 +24,7 @@ /** * SecurityScheme * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#security-scheme-object" + * @see "https://spec.openapis.org/oas/v3.1.0.html##security-scheme-object" */ public interface SecurityScheme extends Constructible, Extensible, Reference { diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/models/servers/Server.java b/api/src/main/java/org/eclipse/microprofile/openapi/models/servers/Server.java index 84aec4e9..a2b9211e 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/models/servers/Server.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/models/servers/Server.java @@ -25,7 +25,7 @@ /** * An object representing a server. * - * @see Server + * @see Server * Object */ public interface Server extends Constructible, Extensible { diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/models/servers/ServerVariable.java b/api/src/main/java/org/eclipse/microprofile/openapi/models/servers/ServerVariable.java index 06963b16..c606aac5 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/models/servers/ServerVariable.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/models/servers/ServerVariable.java @@ -26,7 +26,7 @@ * An object representing a Server Variable for server URL template substitution. * * @see ServerVariable + * "https://spec.openapis.org/oas/v3.1.0.html##server-variable-object">ServerVariable * Object */ public interface ServerVariable extends Constructible, Extensible { diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/models/tags/Tag.java b/api/src/main/java/org/eclipse/microprofile/openapi/models/tags/Tag.java index 7fd34732..758cb0a8 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/models/tags/Tag.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/models/tags/Tag.java @@ -26,7 +26,7 @@ *

    * An object to store metadata to be available in the OpenAPI document. * - * @see OpenAPI + * @see OpenAPI * Specification Tag Object */ public interface Tag extends Constructible, Extensible { diff --git a/spec/src/main/asciidoc/microprofile-openapi-spec.asciidoc b/spec/src/main/asciidoc/microprofile-openapi-spec.asciidoc index 75597f47..898c0c00 100644 --- a/spec/src/main/asciidoc/microprofile-openapi-spec.asciidoc +++ b/spec/src/main/asciidoc/microprofile-openapi-spec.asciidoc @@ -45,7 +45,7 @@ anywhere: on-premises, private cloud, public cloud, etc. For the clients and providers of these services to connect there needs to be a clear and complete contract. Similar to the WSDL contract for legacy Web Services, -the https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md[OpenAPI v3.1] specification is the contract for +the https://spec.openapis.org/oas/3.1.0.md[OpenAPI v3.1] specification is the contract for RESTful Services. This MicroProfile specification, called OpenAPI, aims to provide a set of Java @@ -787,8 +787,8 @@ where the value can be either `JSON` or `YAML`, to facilitate the toggle between the default `YAML` format and `JSON` format. === Context root behavior -Vendors are required to ensure that the combination of each global https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#server-object[server] -element and https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#path-item-object[path-item] element resolve to the absolute backend URL of that +Vendors are required to ensure that the combination of each global https://spec.openapis.org/oas/v3.1.0.html##server-object[server] +element and https://spec.openapis.org/oas/v3.1.0.html##path-item-object[path-item] element resolve to the absolute backend URL of that particular path. If that `pathItem` contains a `servers` element , then this list of operation-level `server` elements replaces the global list of servers for that particular `pathItem`.