From 37aa2eaac4653f8d34b510591a0ca00870202c3d Mon Sep 17 00:00:00 2001 From: Michael Edgar Date: Wed, 7 Jun 2023 11:24:13 -0400 Subject: [PATCH 1/3] Bump microprofile-parent from 2.6 to 2.7 Signed-off-by: Michael Edgar --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index f5266c17..e20c5df0 100644 --- a/pom.xml +++ b/pom.xml @@ -19,7 +19,7 @@ org.eclipse.microprofile microprofile-parent - 2.6 + 2.7 org.eclipse.microprofile.openapi microprofile-openapi-parent From bfdc2b71da293e56e57ca868043e481ec1037473 Mon Sep 17 00:00:00 2001 From: Michael Edgar Date: Fri, 30 Jun 2023 13:37:09 -0400 Subject: [PATCH 2/3] Remove JDK 8 from Build workflow Signed-off-by: Michael Edgar --- .github/workflows/build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index ec52d605..f4059d83 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -8,7 +8,7 @@ jobs: runs-on: ubuntu-latest strategy: matrix: - java: [8, 11, 17] + java: [11, 17] name: build with jdk ${{matrix.java}} steps: From 83cbec3c2d13698093ab1ea3fced9c5ddb8b72b1 Mon Sep 17 00:00:00 2001 From: Michael Edgar Date: Fri, 30 Jun 2023 13:50:37 -0400 Subject: [PATCH 3/3] Auto formatter whitespace removal Signed-off-by: Michael Edgar --- .../microprofile/openapi/OASConfig.java | 24 ++--- .../microprofile/openapi/OASFactory.java | 10 +- .../microprofile/openapi/OASFilter.java | 30 +++--- .../microprofile/openapi/OASModelReader.java | 4 +- .../openapi/annotations/Components.java | 4 +- .../annotations/ExternalDocumentation.java | 8 +- .../annotations/OpenAPIDefinition.java | 8 +- .../openapi/annotations/Operation.java | 10 +- .../annotations/callbacks/Callback.java | 12 +-- .../callbacks/CallbackOperation.java | 12 +-- .../annotations/callbacks/Callbacks.java | 2 +- .../annotations/callbacks/package-info.java | 2 +- .../annotations/extensions/Extension.java | 20 ++-- .../openapi/annotations/headers/Header.java | 8 +- .../annotations/headers/package-info.java | 2 +- .../openapi/annotations/info/Contact.java | 10 +- .../openapi/annotations/info/Info.java | 16 ++-- .../openapi/annotations/info/License.java | 8 +- .../annotations/info/package-info.java | 6 +- .../openapi/annotations/links/Link.java | 18 ++-- .../annotations/links/LinkParameter.java | 4 +- .../annotations/links/package-info.java | 2 +- .../openapi/annotations/media/Content.java | 6 +- .../media/DiscriminatorMapping.java | 6 +- .../openapi/annotations/media/Encoding.java | 16 ++-- .../annotations/media/ExampleObject.java | 14 +-- .../openapi/annotations/media/Schema.java | 96 +++++++++---------- .../annotations/media/SchemaProperty.java | 20 ++-- .../annotations/media/package-info.java | 4 +- .../openapi/annotations/package-info.java | 4 +- .../annotations/parameters/Parameter.java | 32 +++---- .../annotations/parameters/Parameters.java | 2 +- .../annotations/parameters/RequestBody.java | 12 +-- .../annotations/parameters/package-info.java | 2 +- .../annotations/responses/APIResponse.java | 24 ++--- .../responses/APIResponseSchema.java | 2 +- .../annotations/responses/APIResponses.java | 4 +- .../annotations/responses/package-info.java | 2 +- .../annotations/security/OAuthFlow.java | 12 +-- .../annotations/security/OAuthFlows.java | 12 +-- .../annotations/security/OAuthScope.java | 6 +- .../security/SecurityRequirement.java | 6 +- .../security/SecurityRequirements.java | 8 +- .../security/SecurityRequirementsSet.java | 8 +- .../security/SecurityRequirementsSets.java | 8 +- .../annotations/security/SecurityScheme.java | 22 ++--- .../annotations/security/SecuritySchemes.java | 2 +- .../annotations/security/package-info.java | 4 +- .../openapi/annotations/servers/Server.java | 10 +- .../annotations/servers/ServerVariable.java | 12 +-- .../openapi/annotations/servers/Servers.java | 4 +- .../annotations/servers/package-info.java | 2 +- .../openapi/annotations/tags/Tag.java | 8 +- .../openapi/annotations/tags/Tags.java | 2 +- .../annotations/tags/package-info.java | 2 +- .../openapi/models/Components.java | 6 +- .../openapi/models/Constructible.java | 2 +- .../openapi/models/Extensible.java | 2 +- .../openapi/models/ExternalDocumentation.java | 2 +- .../microprofile/openapi/models/OpenAPI.java | 2 +- .../openapi/models/Operation.java | 2 +- .../microprofile/openapi/models/PathItem.java | 6 +- .../microprofile/openapi/models/Paths.java | 14 +-- .../openapi/models/Reference.java | 8 +- .../openapi/models/callbacks/Callback.java | 14 +-- .../openapi/models/examples/Example.java | 2 +- .../openapi/models/examples/package-info.java | 2 +- .../openapi/models/headers/Header.java | 2 +- .../openapi/models/headers/package-info.java | 2 +- .../openapi/models/info/package-info.java | 2 +- .../openapi/models/links/Link.java | 2 +- .../openapi/models/links/package-info.java | 2 +- .../openapi/models/media/Content.java | 12 +-- .../openapi/models/media/Discriminator.java | 6 +- .../openapi/models/media/Encoding.java | 30 +++--- .../openapi/models/media/MediaType.java | 2 +- .../openapi/models/media/Schema.java | 30 +++--- .../openapi/models/media/XML.java | 32 +++---- .../openapi/models/media/package-info.java | 2 +- .../openapi/models/package-info.java | 2 +- .../openapi/models/parameters/Parameter.java | 2 +- .../models/parameters/package-info.java | 2 +- .../models/responses/APIResponses.java | 18 ++-- .../models/responses/package-info.java | 2 +- .../openapi/models/security/OAuthFlow.java | 26 ++--- .../openapi/models/security/OAuthFlows.java | 24 ++--- .../models/security/SecurityRequirement.java | 16 ++-- .../models/security/SecurityScheme.java | 48 +++++----- .../openapi/models/security/package-info.java | 2 +- .../openapi/models/servers/Server.java | 20 ++-- .../models/servers/ServerVariable.java | 22 ++--- .../openapi/models/servers/package-info.java | 2 +- .../microprofile/openapi/models/tags/Tag.java | 14 +-- .../openapi/models/tags/package-info.java | 2 +- .../openapi/spi/OASFactoryResolver.java | 8 +- .../openapi/spi/OASFactoryResolver.java | 8 +- .../openapi/apps/airlines/model/Review.java | 22 ++--- .../openapi/apps/airlines/model/User.java | 42 ++++---- .../apps/airlines/resources/UserResource.java | 2 +- .../microprofile/openapi/tck/AppTestBase.java | 12 +-- .../beanvalidation/BeanValidationTest.java | 2 +- .../openapi/tck/utils/ConfigAsset.java | 2 +- 102 files changed, 540 insertions(+), 540 deletions(-) diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/OASConfig.java b/api/src/main/java/org/eclipse/microprofile/openapi/OASConfig.java index 5098b0a2..d8687326 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/OASConfig.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/OASConfig.java @@ -25,45 +25,45 @@ private OASConfig() { /** * Configuration property to specify the fully qualified name of the OASModelReader implementation. - * + * * @see org.eclipse.microprofile.openapi.OASModelReader */ public static final String MODEL_READER = "mp.openapi.model.reader"; /** * Configuration property to specify the fully qualified name of the OASFilter implementation. - * + * * @see org.eclipse.microprofile.openapi.OASFilter */ public static final String FILTER = "mp.openapi.filter"; /** * Configuration property to disable annotation scanning. - * + * */ public static final String SCAN_DISABLE = "mp.openapi.scan.disable"; /** * Configuration property to specify the list of packages to scan. - * + * */ public static final String SCAN_PACKAGES = "mp.openapi.scan.packages"; /** * Configuration property to specify the list of classes to scan. - * + * */ public static final String SCAN_CLASSES = "mp.openapi.scan.classes"; /** * Configuration property to specify the list of packages to exclude from scans. - * + * */ public static final String SCAN_EXCLUDE_PACKAGES = "mp.openapi.scan.exclude.packages"; /** * Configuration property to specify the list of classes to exclude from scans. - * + * */ public static final String SCAN_EXCLUDE_CLASSES = "mp.openapi.scan.exclude.classes"; @@ -74,32 +74,32 @@ private OASConfig() { /** * Configuration property to specify the list of global servers that provide connectivity information. - * + * */ public static final String SERVERS = "mp.openapi.servers"; /** * Prefix of the configuration property to specify an alternative list of servers to service all operations in a * path. - * + * */ public static final String SERVERS_PATH_PREFIX = "mp.openapi.servers.path."; /** * Prefix of the configuration property to specify an alternative list of servers to service an operation. - * + * */ public static final String SERVERS_OPERATION_PREFIX = "mp.openapi.servers.operation."; /** * Prefix of the configuration property to specify a schema for a specific class, in JSON format. - * + * */ public static final String SCHEMA_PREFIX = "mp.openapi.schema."; /** * Recommended prefix for vendor specific configuration properties. - * + * */ public static final String EXTENSIONS_PREFIX = "mp.openapi.extensions."; diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/OASFactory.java b/api/src/main/java/org/eclipse/microprofile/openapi/OASFactory.java index c7590a6a..0cd23e37 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/OASFactory.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/OASFactory.java @@ -51,12 +51,12 @@ /** * This class allows application developers to build new OpenAPI model elements. - * + * *
*
* For example, to start a new top-level OpenAPI element with an ExternalDocument inside of it an application developer * would write: - * + * *
  * OASFactory.createObject(OpenAPI.class)
  *          .setExternalDocs(OASFactory.createObject(ExternalDocumentation.class).url("http://myDoc"));
@@ -73,12 +73,12 @@ private OASFactory() {
      * 
*
* Example: - * + * *
      * OASFactory.createObject(Info.class).title("Airlines").description("Airlines APIs").version("1.0.0");
      * 
      * 
- * + * * @param * describes the type parameter * @param clazz @@ -86,7 +86,7 @@ private OASFactory() { * interface * * @return a new instance of the requested model class - * + * * @throws NullPointerException * if the specified class is null * @throws IllegalArgumentException diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/OASFilter.java b/api/src/main/java/org/eclipse/microprofile/openapi/OASFilter.java index fb63442c..ba746cea 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/OASFilter.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/OASFilter.java @@ -31,10 +31,10 @@ /** * This interface allows application developers to filter different parts of the OpenAPI model tree. - * + * * A common scenario is to dynamically augment (update or remove) OpenAPI elements based on the environment that the * application is currently in. - * + * * The registration of this filter is controlled by setting the key mp.openapi.filter using one of the * configuration sources specified in MicroProfile Config. * The value is the fully qualified name of the filter implementation, which needs to be visible to the application's @@ -46,7 +46,7 @@ public interface OASFilter { /** * Allows filtering of a particular PathItem. Implementers of this method can choose to update the given PathItem, * pass it back as-is, or return null if removing this PathItem. - * + * * @param pathItem * the current PathItem element * @return the PathItem to be used or null @@ -58,7 +58,7 @@ default PathItem filterPathItem(PathItem pathItem) { /** * Allows filtering of a particular Operation. Implementers of this method can choose to update the given Operation, * pass it back as-is, or return null if removing this Operation. - * + * * @param operation * the current Operation element * @return the Operation to be used or null @@ -70,7 +70,7 @@ default Operation filterOperation(Operation operation) { /** * Allows filtering of a particular Parameter. Implementers of this method can choose to update the given Parameter, * pass it back as-is, or return null if removing this Parameter. - * + * * @param parameter * the current Parameter element * @return the Parameter to be used or null @@ -82,7 +82,7 @@ default Parameter filterParameter(Parameter parameter) { /** * Allows filtering of a particular Header. Implementers of this method can choose to update the given Header, pass * it back as-is, or return null if removing this Header. - * + * * @param header * the current Header element * @return the Header to be used or null @@ -94,7 +94,7 @@ default Header filterHeader(Header header) { /** * Allows filtering of a particular RequestBody. Implementers of this method can choose to update the given * RequestBody, pass it back as-is, or return null if removing this RequestBody. - * + * * @param requestBody * the current RequestBody element * @return the RequestBody to be used or null @@ -106,7 +106,7 @@ default RequestBody filterRequestBody(RequestBody requestBody) { /** * Allows filtering of a particular APIResponse. Implementers of this method can choose to update the given * APIResponse, pass it back as-is, or return null if removing this APIResponse. - * + * * @param apiResponse * the current APIResponse element * @return the APIResponse to be used or null @@ -118,7 +118,7 @@ default APIResponse filterAPIResponse(APIResponse apiResponse) { /** * Allows filtering of a particular Schema. Implementers of this method can choose to update the given Schema, pass * it back as-is, or return null if removing this Schema. - * + * * @param schema * the current Schema element * @return the Schema to be used or null @@ -130,7 +130,7 @@ default Schema filterSchema(Schema schema) { /** * Allows filtering of a particular SecurityScheme. Implementers of this method can choose to update the given * SecurityScheme, pass it back as-is, or return null if removing this SecurityScheme. - * + * * @param securityScheme * the current SecurityScheme element * @return the SecurityScheme to be used or null @@ -142,7 +142,7 @@ default SecurityScheme filterSecurityScheme(SecurityScheme securityScheme) { /** * Allows filtering of a particular Server. Implementers of this method can choose to update the given Server, pass * it back as-is, or return null if removing this Server. - * + * * @param server * the current Server element * @return the Server to be used or null @@ -154,7 +154,7 @@ default Server filterServer(Server server) { /** * Allows filtering of a particular Tag. Implementers of this method can choose to update the given Tag, pass it * back as-is, or return null if removing this Tag. - * + * * @param tag * the current Tag element * @return the Tag to be used or null @@ -166,7 +166,7 @@ default Tag filterTag(Tag tag) { /** * Allows filtering of a particular Link. Implementers of this method can choose to update the given Link, pass it * back as-is, or return null if removing this Link. - * + * * @param link * the current Link element * @return the Link to be used or null @@ -178,7 +178,7 @@ default Link filterLink(Link link) { /** * Allows filtering of a particular Callback. Implementers of this method can choose to update the given Callback, * pass it back as-is, or return null if removing this Callback. - * + * * @param callback * the current Callback element * @return the Callback to be used or null @@ -192,7 +192,7 @@ default Callback filterCallback(Callback callback) { * or do nothing if no change is required. Note that one cannot remove this element from the model tree, hence the * return type of void. This is the last method called for a given filter, therefore it symbolizes the end of * processing by the vendor framework. - * + * * @param openAPI * the current OpenAPI element */ diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/OASModelReader.java b/api/src/main/java/org/eclipse/microprofile/openapi/OASModelReader.java index 88304926..6d024744 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/OASModelReader.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/OASModelReader.java @@ -19,7 +19,7 @@ /** * This interface allows application developers to programmatically contribute an OpenAPI model tree. - * + * * In this scenario the developer can choose whether to provide the entire OpenAPI model while disabling annotation * scanning, or they can provide a starting OpenAPI model to be augmented with the application annotations. * @@ -34,7 +34,7 @@ public interface OASModelReader { * This method is called by the vendor's OpenAPI processing framework. It can be a fully complete and valid OpenAPI * model tree, or a partial base model tree that will be augmented by either annotations or pre-generated OpenAPI * documents. - * + * * @return the OpenAPI model to be used by the vendor */ OpenAPI buildModel(); 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 c1eeacd8..a3f9ae0e 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 @@ -35,7 +35,7 @@ /** * Describes the Components object that holds various reusable objects for different aspects of the OpenAPI * Specification (OAS). - * + * * @see OpenAPI * Specification Components Object */ @@ -112,7 +112,7 @@ * corresponding to the containing annotation. * * @return array of extensions - * + * * @since 3.1 */ Extension[] extensions() default {}; 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 6b1fff0c..7a833649 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 @@ -34,7 +34,7 @@ * When it is applied to a type and one or more of the fields are not empty strings the annotation value is added to the * 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 OpenAPI * Specification External Documentation Object @@ -46,14 +46,14 @@ /** * A short description of the target documentation. - * + * * @return the documentation description **/ String description() default ""; /** * The URL for the target documentation. Value must be in the format of a URL. - * + * * @return the documentation URL **/ String url() default ""; @@ -63,7 +63,7 @@ * ExternalDocumentation} model corresponding to the containing annotation. * * @return array of extensions - * + * * @since 3.1 */ Extension[] extensions() default {}; 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 166f3eeb..345c979b 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 @@ -34,7 +34,7 @@ * OpenAPI *

* This is the root document object of the OpenAPI document. It contains required and optional fields. - * + * * @see OpenAPI * Specification OpenAPI Object */ @@ -71,7 +71,7 @@ *

* Adding a {@code SecurityRequirement} to this array is equivalent to adding a {@code SecurityRequirementsSet} * containing a single {@code SecurityRequirement} to {@link #securitySets()}. - * + * * @return the array of security requirements for this API */ SecurityRequirement[] security() default {}; @@ -82,7 +82,7 @@ * All of the security requirements within any one of the sets must be satisfied to authorize a request. *

* Including an empty set within this list indicates that the other requirements are optional. - * + * * @return the array of security requirement sets for this API */ SecurityRequirementsSet[] securitySets() default {}; @@ -109,7 +109,7 @@ * corresponding to the containing annotation. * * @return array of extensions - * + * * @since 3.1 */ Extension[] extensions() default {}; 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 a3d8297f..e587bd0f 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 @@ -27,7 +27,7 @@ /** * Describes a single API operation on a path. - * + * * @see OpenAPI * Specification Operation Object **/ @@ -56,7 +56,7 @@ * Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to * follow common programming naming conventions. *

- * + * * @return the ID of this operation **/ String operationId() default ""; @@ -66,14 +66,14 @@ *

* Consumers SHOULD refrain from usage of a deprecated operation. *

- * + * * @return whether or not this operation is deprecated **/ boolean deprecated() default false; /** * Allows this operation to be marked as hidden - * + * * @return whether or not this operation is hidden */ boolean hidden() default false; @@ -83,7 +83,7 @@ * corresponding to the containing annotation. * * @return array of extensions - * + * * @since 3.1 */ Extension[] extensions() default {}; 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 0a09d7cf..26064b76 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 @@ -28,7 +28,7 @@ /** * This object represents a callback URL that will be invoked. - * + * * @see OpenAPI * Specification Callback Object **/ @@ -45,7 +45,7 @@ * {@link org.eclipse.microprofile.openapi.annotations.Components}. The name will be used as the key to add this * callback to the 'callbacks' map for reuse. *

- * + * * @return the name of this callback **/ String name() default ""; @@ -55,14 +55,14 @@ *

* It is a REQUIRED property unless this is only a reference to a callback instance. *

- * + * * @return the callback URL */ String callbackUrlExpression() default ""; /** * The array of operations that will be called out-of band - * + * * @return the callback operations **/ CallbackOperation[] operations() default {}; @@ -72,7 +72,7 @@ *

* This property provides a reference to an object defined elsewhere. This property and all other properties are * mutually exclusive. If other properties are defined in addition to the ref property then the result is undefined. - * + * * @return reference to a callback object definition **/ String ref() default ""; @@ -82,7 +82,7 @@ * model corresponding to the containing annotation. * * @return array of extensions - * + * * @since 3.1 */ Extension[] extensions() default {}; 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 7c8b23a9..41cdf533 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 @@ -32,7 +32,7 @@ /** * Describes a single API callback operation. - * + * * @see OpenAPI * Specification Operation Object **/ @@ -76,7 +76,7 @@ * The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and * location. *

- * + * * @return the list of parameters for this callback operation **/ Parameter[] parameters() default {}; @@ -93,7 +93,7 @@ *

* The list of possible responses as they are returned from executing this callback operation. *

- * + * * @return the list of responses for this callback operation **/ APIResponse[] responses() default {}; @@ -107,7 +107,7 @@ *

* This definition overrides any declared top-level security. To remove a top-level security declaration, an empty * array can be used. - * + * * @return the list of security mechanisms for this callback operation */ SecurityRequirement[] security() default {}; @@ -120,7 +120,7 @@ * array can be used. *

* Including an empty set within this list indicates that the other requirements are optional. - * + * * @return the list of security mechanisms for this callback operation */ SecurityRequirementsSet[] securitySets() default {}; @@ -130,7 +130,7 @@ * corresponding to the containing annotation. * * @return array of extensions - * + * * @since 3.1 */ Extension[] extensions() default {}; 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 b113d7ec..c41e93a1 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 @@ -25,7 +25,7 @@ /** * This object represents an array of Callback URLs that can be invoked. - * + * * @see OpenAPI * Specification Callback Object **/ diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/callbacks/package-info.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/callbacks/package-info.java index e405149b..fcb926f5 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/callbacks/package-info.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/callbacks/package-info.java @@ -16,7 +16,7 @@ * particular HTTP operation as well as the HTTP operation that will be invoked with the callback. *

* Example annotation: - * + * *

  * {@literal @}POST
     {@literal @}Callbacks(
diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/extensions/Extension.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/extensions/Extension.java
index 691ffd8c..c8a138b2 100644
--- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/extensions/Extension.java
+++ b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/extensions/Extension.java
@@ -26,21 +26,21 @@
 /**
  * A named extension that should be added to the OpenAPI definition. The names of all extensions MUST begin with
  * {@code x-} or else an invalid document will potentially be created.
- * 
+ *
  * 

* Although this annotation may currently be placed directly on a Java language element target, application developers * should instead utilize the {@code extensions} property of the particular annotation that corresponds to the model * being extended. Use of the annotation directly on a Java element is often ambiguous and it may result in the * extension being added to an incorrect location in the OpenAPI model. Future releases of MicroProfile OpenAPI may * remove the capability of placing this annotation directly on a Java element. - * + * *

* When {@code @Extension} annotations are used both directly on a Java element as well as within another annotation * that targets the same Java element, implementations will apply only the nested extensions to the resulting model. - * + * *

* Example of preferred use with {@code @Extension} nested within an {@code @Schema} annotation: - * + * *

  * class MyPojo {
  *
@@ -50,14 +50,14 @@
  *             name = "x-custom-property",
  *             value = "custom-value")
  *     String property1;
- * 
+ *
  * }
  * 
- * + * *

* Example of deprecated use with {@code @Extension} placed directly on a field implied to be a schema * property: - * + * *

  * class MyPojo {
  *
@@ -68,7 +68,7 @@
  *
  * }
  * 
- * + * */ @Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) @@ -86,7 +86,7 @@ /** * The extension value. If the value should be parsed into an object or array, then the value should be stringified * JSON suitable for parsing by a standard JSON parser. - * + * * @return the actual extension value */ String value(); @@ -100,7 +100,7 @@ *
  • number
  • *
  • boolean
  • * - * + * * @return true if the value should be parsed */ boolean parseValue() default false; 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 c142c552..97cb031a 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 @@ -27,7 +27,7 @@ /** * Describes a single header object - * + * * @see OpenAPI * Specification Header Object **/ @@ -42,7 +42,7 @@ *

    * When the header is defined within {@link org.eclipse.microprofile.openapi.annotations.Components}, the name will * be used as the key to add this header to the 'headers' map for reuse. - * + * * @return this header's name **/ String name() default ""; @@ -88,7 +88,7 @@ *

    * This property provides a reference to an object defined elsewhere. This property and all other properties are * mutually exclusive. If other properties are defined in addition to the ref property then the result is undefined. - * + * * @return reference to a header **/ String ref() default ""; @@ -98,7 +98,7 @@ * corresponding to the containing annotation. * * @return array of extensions - * + * * @since 3.1 */ Extension[] extensions() default {}; diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/headers/package-info.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/headers/package-info.java index 5a5af99d..0674dad8 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/headers/package-info.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/headers/package-info.java @@ -15,7 +15,7 @@ * An annotation to describe a single header object. *

    * Example usage: - * + * *

      * {@literal @}GET
      * {@literal @}APIResponse(
    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 490b0cd3..4e59d6c1 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
    @@ -26,7 +26,7 @@
     
     /**
      * Contact information for the exposed API.
    - * 
    + *
      * @see "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#contactObject"
      **/
     @Target({})
    @@ -35,21 +35,21 @@
     public @interface Contact {
         /**
          * The identifying name of the contact person/organization.
    -     * 
    +     *
          * @return the name of the contact
          **/
         String name() default "";
     
         /**
          * The URL pointing to the contact information. Must be in the format of a URL.
    -     * 
    +     *
          * @return the URL of the contact
          **/
         String url() default "";
     
         /**
          * The email address of the contact person/organization. Must be in the format of an email address.
    -     * 
    +     *
          * @return the email address of the contact
          **/
         String email() default "";
    @@ -59,7 +59,7 @@
          * corresponding to the containing annotation.
          *
          * @return array of extensions
    -     * 
    +     *
          * @since 3.1
          */
         Extension[] extensions() default {};
    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 5bc0db26..5473efa2 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
    @@ -26,7 +26,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"
      **/
     @Target({})
    @@ -35,42 +35,42 @@
     public @interface Info {
         /**
          * The title of the application.
    -     * 
    +     *
          * @return the application's title
          **/
         String title();
     
         /**
          * A short description of the application. CommonMark syntax can be used for rich text representation.
    -     * 
    +     *
          * @return the application's description
          **/
         String description() default "";
     
         /**
          * A URL to the Terms of Service for the API. Must be in the format of a URL.
    -     * 
    +     *
          * @return the application's terms of service
          **/
         String termsOfService() default "";
     
         /**
          * The contact information for the exposed API.
    -     * 
    +     *
          * @return a contact for the application
          **/
         Contact contact() default @Contact();
     
         /**
          * The license information for the exposed API.
    -     * 
    +     *
          * @return the license of the application
          **/
         License license() default @License(name = "");
     
         /**
          * The version of the API definition.
    -     * 
    +     *
          * @return the application's version
          **/
         String version();
    @@ -80,7 +80,7 @@
          * corresponding to the containing annotation.
          *
          * @return array of extensions
    -     * 
    +     *
          * @since 3.1
          */
         Extension[] extensions() default {};
    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 1c81086d..99c3f561 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
    @@ -26,7 +26,7 @@
     
     /**
      * License information for the exposed API.
    - * 
    + *
      * @see "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#licenseObject"
      **/
     @Target({})
    @@ -35,14 +35,14 @@
     public @interface License {
         /**
          * The license name used for the API.
    -     * 
    +     *
          * @return the name of the license
          **/
         String name();
     
         /**
          * A URL to the license used for the API. MUST be in the format of a URL.
    -     * 
    +     *
          * @return the URL of the license
          **/
         String url() default "";
    @@ -52,7 +52,7 @@
          * corresponding to the containing annotation.
          *
          * @return array of extensions
    -     * 
    +     *
          * @since 3.1
          */
         Extension[] extensions() default {};
    diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/info/package-info.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/info/package-info.java
    index 741338fe..0eee9c53 100644
    --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/info/package-info.java
    +++ b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/info/package-info.java
    @@ -16,14 +16,14 @@
      * the exposed API.
      * 

    * Example usage: - * + * *

      * {@literal @}ApplicationPath("/")
        {@literal @}OpenAPIDefinition(
         info = {@literal @}Info(
    -        title="AirlinesRatingApp API", 
    +        title="AirlinesRatingApp API",
             version = "1.0",
    -        termsOfService = "http://airlinesratingapp.com/terms", 
    +        termsOfService = "http://airlinesratingapp.com/terms",
             contact = {@literal @}Contact(
                 name = "AirlinesRatingApp API Support",
                 url = "http://exampleurl.com/contact",
    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 24c864b5..456bf55a 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
    @@ -29,7 +29,7 @@
      * The Link object represents a possible design-time link for a response. The presence of a link does not guarantee the
      * caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between
      * responses and other operations.
    - * 
    + *
      * @see  OpenAPI
      *      Specification Link Object
      **/
    @@ -44,7 +44,7 @@
          * {@link org.eclipse.microprofile.openapi.annotations.Components}. The name will be used as the key to add this
          * link to the 'links' map for reuse.
          * 

    - * + * * @return the link's name **/ String name() default ""; @@ -53,7 +53,7 @@ * A relative or absolute reference to an OAS operation. This field is mutually exclusive of the operationId field, * and must point to an Operation Object. Relative operationRef values may be used to locate an existing Operation * Object in the OpenAPI definition. Ignored if the operationId property is specified. - * + * * @return an operation reference **/ String operationRef() default ""; @@ -61,35 +61,35 @@ /** * The name of an existing, resolvable OAS operation, as defined with a unique operationId. This field is mutually * exclusive of the operationRef field. - * + * * @return an operation ID **/ String operationId() default ""; /** * Array of parameters to pass to an operation as specified with operationId or identified via operationRef. - * + * * @return the list of parameters for this link **/ LinkParameter[] parameters() default {}; /** * A description of the link. CommonMark syntax may be used for rich text representation. - * + * * @return the link's description **/ String description() default ""; /** * A literal value or {expression} to use as a request body when calling the target operation. - * + * * @return the request body of this link **/ String requestBody() default ""; /** * An alternative server to service this operation. - * + * * @return the server associated to this link **/ Server server() default @Server; @@ -109,7 +109,7 @@ * corresponding to the containing annotation. * * @return array of extensions - * + * * @since 3.1 */ Extension[] extensions() default {}; diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/links/LinkParameter.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/links/LinkParameter.java index 697c8e0c..cd470f1c 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/links/LinkParameter.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/links/LinkParameter.java @@ -31,14 +31,14 @@ public @interface LinkParameter { /** * The name of this link parameter. - * + * * @return the parameter's name **/ String name() default ""; /** * A constant or an expression to be evaluated and passed to the linked operation. - * + * * @return the parameter's literal value or expression **/ String expression() default ""; diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/links/package-info.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/links/package-info.java index a768ee63..a58fbdac 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/links/package-info.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/links/package-info.java @@ -16,7 +16,7 @@ * operation. *

    * Example usage: - * + * *

      *  {@literal @}APIResponse(
      *      responseCode="201",
    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 e46e899b..7d09b708 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
    @@ -26,7 +26,7 @@
     
     /**
      * This object provides schema and examples for a particular media type.
    - * 
    + *
      * @see OpenAPI
      *      Specification Media Type Object
      **/
    @@ -69,7 +69,7 @@
          * The encoding object SHALL only apply to requestBody objects when the media type is multipart or
          * application/x-www-form-urlencoded.
          * 

    - * + * * @return the array of encodings */ Encoding[] encoding() default {}; @@ -79,7 +79,7 @@ * model corresponding to the containing annotation. * * @return array of extensions - * + * * @since 3.1 */ Extension[] extensions() default {}; 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 a4b0dd65..749fc5eb 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 @@ -24,7 +24,7 @@ /** * This object maps payload values to a particular Schema. - * + * * @see OpenAPI * Specification Discriminator Object @@ -36,14 +36,14 @@ /** * The property value that will be mapped to a Schema - * + * * @return the property value **/ String value() default ""; /** * The schema that is being mapped to a property value - * + * * @return the Schema reference **/ Class schema() default Void.class; 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 8f18d4c0..036e3ce5 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 @@ -27,7 +27,7 @@ /** * Single encoding definition to be applied to single Schema Object - * + * * @see Encoding * Object **/ @@ -40,7 +40,7 @@ /** * The name of this encoding object instance. This property is a key in an encoding map of a MediaType object and * MUST exist in a schema as a property. - * + * * @return the name of this encoding instance **/ String name() default ""; @@ -52,7 +52,7 @@ * object - application/json. The value can be a specific media type (e.g. application/json), a wildcard media type * (e.g. image/*), or a comma-separated list of the two types. *

    - * + * * @return the contentType property of this encoding instance **/ String contentType() default ""; @@ -63,7 +63,7 @@ *

    * Default values include: form, spaceDelimited, pipeDelimited, and deepObject. *

    - * + * * @return the style of this encoding instance **/ String style() default ""; @@ -75,7 +75,7 @@ * For other types of properties this property has no effect. When style is form, the default value is true. *

    * For all other styles, the default value is false. - * + * * @return whether or not this array type encoding will have separate parameters generated for each array value **/ boolean explode() default false; @@ -86,7 +86,7 @@ *

    * See RFC3986 for full definition of reserved characters. *

    - * + * * @return whether or not this encoding instance allows reserved characters **/ boolean allowReserved() default false; @@ -99,7 +99,7 @@ *

    * Content-Type is described separately and SHALL be ignored in this section. This property SHALL be ignored if the * request body media type is not a multipart. - * + * * @return the array of headers for this encoding instance */ Header[] headers() default {}; @@ -109,7 +109,7 @@ * model corresponding to the containing annotation. * * @return array of extensions - * + * * @since 3.1 */ Extension[] extensions() default {}; 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 1197d3a4..fda821c9 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 @@ -26,7 +26,7 @@ /** * This object illustrates an example of a particular content - * + * * @see OpenAPI * Specification Example Object **/ @@ -41,21 +41,21 @@ * {@link org.eclipse.microprofile.openapi.annotations.Components}. The name will be used as the key to add this * example to the 'examples' map for reuse. *

    - * + * * @return the name of this example **/ String name() default ""; /** * A brief summary of the purpose or context of the example - * + * * @return a summary of this example **/ String summary() default ""; /** * Long description for the example. CommonMark syntax MAY be used for rich text representation. - * + * * @return a description of this example **/ String description() default ""; @@ -67,7 +67,7 @@ * specified. *

    * If the media type associated with the example allows parsing into an object, it may be converted from a string. - * + * * @return the value of the example **/ String value() default ""; @@ -78,7 +78,7 @@ *

    * This is mutually exclusive with the value property. *

    - * + * * @return an external URL of the example **/ String externalValue() default ""; @@ -98,7 +98,7 @@ * model corresponding to the containing annotation. * * @return array of extensions - * + * * @since 3.1 */ Extension[] extensions() default {}; 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 f6c6b455..d5533585 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 @@ -30,7 +30,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 * Specification Schema Object **/ @@ -44,7 +44,7 @@ * schema's {@link org.eclipse.microprofile.openapi.models.media.Schema#setAdditionalPropertiesBoolean(Boolean) * additionalPropertiesBoolean} value is to be set to boolean {@code true}. The value {@code true} declares that any * properties in addition to those defined by the {@code properties} attribute of the same schema are valid. - * + * * @since 3.1 */ public final class True { @@ -57,7 +57,7 @@ private True() { * schema's {@link org.eclipse.microprofile.openapi.models.media.Schema#setAdditionalPropertiesBoolean(Boolean) * additionalPropertiesBoolean} value is to be set to boolean {@code false}. The value {@code false} declares that * no property in addition to those defined by the {@code properties} attribute of the same schema is valid. - * + * * @since 3.1 */ public final class False { @@ -68,7 +68,7 @@ private False() { /** * Provides a java class as implementation for this schema. When provided, additional information in the Schema * annotation (except for type information) will augment the java class after introspection. - * + * * @return a class that implements this schema **/ Class implementation() default Void.class; @@ -76,7 +76,7 @@ private False() { /** * Provides a java class to be used to disallow matching properties. Inline or referenced schema MUST be of a Schema * Object and not a standard JSON Schema. - * + * * @return a class with disallowed properties **/ Class not() default Void.class; @@ -87,7 +87,7 @@ private False() { *

    * Inline or referenced schema MUST be of a Schema Object and not a standard JSON Schema. *

    - * + * * @return the list of possible classes for a single match **/ Class[] oneOf() default {}; @@ -98,7 +98,7 @@ private False() { *

    * Inline or referenced schema MUST be of a Schema Object and not a standard JSON Schema. *

    - * + * * @return the list of possible class matches **/ Class[] anyOf() default {}; @@ -109,7 +109,7 @@ private False() { *

    * Inline or referenced schema MUST be of a Schema Object and not a standard JSON Schema. *

    - * + * * @return the list of classes to match **/ Class[] allOf() default {}; @@ -121,14 +121,14 @@ private False() { * {@link org.eclipse.microprofile.openapi.annotations.Components}. The name will be used as the key to add this * schema to the 'schemas' map for reuse. *

    - * + * * @return the name of the schema **/ String name() default ""; /** * A title to explain the purpose of the schema. - * + * * @return the title of the schema **/ String title() default ""; @@ -136,7 +136,7 @@ private False() { /** * Constrains a value such that when divided by the multipleOf, the remainder must be an integer. Ignored if the * value is 0. - * + * * @return the multiplier constraint of the schema **/ double multipleOf() default 0; @@ -144,14 +144,14 @@ private False() { /** * Sets the maximum numeric value for a property. Value must be a valid number. Ignored if the value is an empty * string or not a number. - * + * * @return the maximum value for this schema **/ String maximum() default ""; /** * If true, makes the maximum value exclusive, or a less-than criteria. - * + * * @return the exclusive maximum value for this schema **/ boolean exclusiveMaximum() default false; @@ -159,70 +159,70 @@ private False() { /** * Sets the minimum numeric value for a property. Value must be a valid number. Ignored if the value is an empty * string or not a number. - * + * * @return the minimum value for this schema **/ String minimum() default ""; /** * If true, makes the minimum value exclusive, or a greater-than criteria. - * + * * @return the exclusive minimum value for this schema **/ boolean exclusiveMinimum() default false; /** * Sets the maximum length of a string value. Ignored if the value is negative. - * + * * @return the maximum length of this schema **/ int maxLength() default Integer.MAX_VALUE; /** * Sets the minimum length of a string value. Ignored if the value is negative. - * + * * @return the minimum length of this schema **/ int minLength() default 0; /** * A pattern that the value must satisfy. Ignored if the value is an empty string. - * + * * @return the pattern of this schema **/ String pattern() default ""; /** * Constrains the number of arbitrary properties when additionalProperties is defined. Ignored if value is 0. - * + * * @return the maximum number of properties for this schema **/ int maxProperties() default 0; /** * Constrains the number of arbitrary properties when additionalProperties is defined. Ignored if value is 0. - * + * * @return the minimum number of properties for this schema **/ int minProperties() default 0; /** * Allows multiple properties in an object to be marked as required. - * + * * @return the list of required schema properties **/ String[] requiredProperties() default {}; /** * Mandates whether the annotated item is required or not. - * + * * @return whether or not this schema is required **/ boolean required() default false; /** * A description of the schema. - * + * * @return this schema's description **/ String description() default ""; @@ -234,7 +234,7 @@ private False() { * format. For example, if \"type: integer, format: int128\" were used to designate a very large integer, * most consumers will not understand how to handle it, and fall back to simply \"type: integer\" *

    - * + * * @return this schema's format **/ String format() default ""; @@ -244,14 +244,14 @@ private False() { *

    * This property provides a reference to an object defined elsewhere. This property and all other properties are * mutually exclusive. If other properties are defined in addition to the ref property then the result is undefined. - * + * * @return a reference to a schema definition **/ String ref() default ""; /** * Allows sending a null value for the defined schema. - * + * * @return whether or not this schema is nullable **/ boolean nullable() default false; @@ -263,7 +263,7 @@ private False() { * If the property is marked as readOnly being true and is in the required list, the required will take effect on * the response only. A property MUST NOT be marked as both readOnly and writeOnly being true. *

    - * + * * @return whether or not this schema is read only **/ boolean readOnly() default false; @@ -275,7 +275,7 @@ private False() { * If the property is marked as writeOnly being true and is in the required list, the required will take effect on * the request only. A property MUST NOT be marked as both readOnly and writeOnly being true. *

    - * + * * @return whether or not this schema is write only **/ boolean writeOnly() default false; @@ -288,21 +288,21 @@ private False() { *

    * When associated with a specific media type, the example string shall be parsed by the consumer to be treated as * an object or an array. - * + * * @return an example of this schema **/ String example() default ""; /** * Additional external documentation for this schema. - * + * * @return additional schema documentation **/ ExternalDocumentation externalDocs() default @ExternalDocumentation(); /** * Specifies that a schema is deprecated and SHOULD be transitioned out of usage. - * + * * @return whether or not this schema is deprecated **/ boolean deprecated() default false; @@ -313,7 +313,7 @@ private False() { * Value MUST be a string. Multiple types via an array are not supported. *

    * MUST be a valid type per the OpenAPI Specification. - * + * * @return the type of this schema **/ SchemaType type() default SchemaType.DEFAULT; @@ -321,7 +321,7 @@ private False() { /** * Provides a list of enum values. Corresponds to the enum property in the OAS schema and the enumeration property * in the schema model. - * + * * @return a list of allowed schema values */ String[] enumeration() default {}; @@ -333,7 +333,7 @@ private False() { * Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object defined at the same level. *

    * For example, if type is string, then default can be "foo" but cannot be 1. - * + * * @return the default value of this schema */ String defaultValue() default ""; @@ -344,21 +344,21 @@ private False() { * The discriminator is an object name that is used to differentiate between other schemas which may satisfy the * payload description. *

    - * + * * @return the discriminator property */ String discriminatorProperty() default ""; /** * An array of discriminator mappings. - * + * * @return the discriminator mappings for this schema */ DiscriminatorMapping[] discriminatorMapping() default {}; /** * Allows schema to be marked as hidden. - * + * * @return whether or not this schema is hidden */ boolean hidden() default false; @@ -370,7 +370,7 @@ private False() { * An array instance is valid against "maxItems" if its size is less than, or equal to, the value of this keyword. *

    * Ignored if value is Integer.MIN_VALUE. - * + * * @return the maximum number of items in this array **/ int maxItems() default Integer.MIN_VALUE; @@ -383,7 +383,7 @@ private False() { * keyword. *

    * Ignored if value is Integer.MAX_VALUE. - * + * * @return the minimum number of items in this array **/ int minItems() default Integer.MAX_VALUE; @@ -394,7 +394,7 @@ private False() { * If false, the instance validates successfully. If true, the instance validates successfully if all of its * elements are unique. *

    - * + * * @return whether the items in this array are unique **/ boolean uniqueItems() default false; @@ -413,7 +413,7 @@ private False() { * *

    * Example: - * + * *

          * {@literal @}Schema(properties = {
          *   {@literal @}SchemaProperty(name = "creditCard", example = "4567100043210001"),
    @@ -431,24 +431,24 @@ private False() {
         /**
          * Provides a Java class as implementation for additional properties that may be present in instances of this
          * schema.
    -     * 
    +     *
          * 

    * If no additional properties are allowed, the value of this property should be set to {@link False False.class} * which will be rendered as boolean false in the resulting OpenAPI document. - * + * *

    * The default value {@link Void Void.class} will result in no {@code additionalProperties} attribute being * generated in the resulting OpenAPI document. The effective value in that case is {@code true} per the OpenAPI * specification. - * + * *

    * Implementations MAY ignore this property if this schema's {@linkplain #type() type} is not * {@linkplain SchemaType#OBJECT OBJECT}, either explicitly or as derived by the placement of the annotation. - * + * * @return a class that describes the allowable schema for additional properties not explicitly defined - * + * * @since 3.1 - * + * * @see True * @see False */ @@ -459,7 +459,7 @@ private False() { * corresponding to the containing annotation. * * @return array of extensions - * + * * @since 3.1 */ Extension[] extensions() default {}; 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 33f5e985..e603b2bc 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 @@ -61,7 +61,7 @@ *

    * Inline or referenced schema MUST be of a Schema Object and not a standard JSON Schema. *

    - * + * * @return the list of possible classes for a single match **/ Class[] oneOf() default {}; @@ -72,7 +72,7 @@ *

    * Inline or referenced schema MUST be of a Schema Object and not a standard JSON Schema. *

    - * + * * @return the list of possible class matches **/ Class[] anyOf() default {}; @@ -83,7 +83,7 @@ *

    * Inline or referenced schema MUST be of a Schema Object and not a standard JSON Schema. *

    - * + * * @return the list of classes to match **/ Class[] allOf() default {}; @@ -199,7 +199,7 @@ * format. For example, if \"type: integer, format: int128\" were used to designate a very large integer, * most consumers will not understand how to handle it, and fall back to simply \"type: integer\" *

    - * + * * @return this schema's format **/ String format() default ""; @@ -228,7 +228,7 @@ * If the property is marked as readOnly being true and is in the required list, the required will take effect on * the response only. A property MUST NOT be marked as both readOnly and writeOnly being true. *

    - * + * * @return whether or not this schema is read only **/ boolean readOnly() default false; @@ -240,7 +240,7 @@ * If the property is marked as writeOnly being true and is in the required list, the required will take effect on * the request only. A property MUST NOT be marked as both readOnly and writeOnly being true. *

    - * + * * @return whether or not this schema is write only **/ boolean writeOnly() default false; @@ -253,7 +253,7 @@ *

    * When associated with a specific media type, the example string shall be parsed by the consumer to be treated as * an object or an array. - * + * * @return an example of this schema **/ String example() default ""; @@ -309,7 +309,7 @@ * The discriminator is an object name that is used to differentiate between other schemas which may satisfy the * payload description. *

    - * + * * @return the discriminator property */ String discriminatorProperty() default ""; @@ -359,7 +359,7 @@ * If false, the instance validates successfully. If true, the instance validates successfully if all of its * elements are unique. *

    - * + * * @return whether the items in this array are unique **/ boolean uniqueItems() default false; @@ -369,7 +369,7 @@ * corresponding to the containing annotation. * * @return array of extensions - * + * * @since 3.1 */ Extension[] extensions() default {}; diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/media/package-info.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/media/package-info.java index e0495c13..a0fb0c55 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/media/package-info.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/media/package-info.java @@ -13,10 +13,10 @@ /** * A set of annotations to represent input and output data type, media type and relevant examples. - * + * *

    * Example usage: - * + * *

      * content = {@literal @}Content(
      *      examples = {@literal @}ExampleObject(
    diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/package-info.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/package-info.java
    index 27404b1c..1723d696 100644
    --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/package-info.java
    +++ b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/package-info.java
    @@ -14,7 +14,7 @@
     /**
      * A set of annotations, many derived from Swagger Core library. OpenAPI annotations can be augmented with existing
      * JAX-RS annotations in an application to produce a valid OpenAPI document.
    - * 
    + *
      * Examples of annotations in this package include:
      * 
      *
    • Components
    • @@ -24,7 +24,7 @@ *
    *

    * Example of usage: - * + * *

      *  {@literal @}GET
      *  {@literal @}Path("/findByStatus")
    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 b20a9602..6ea8f517 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
    @@ -34,7 +34,7 @@
     
     /**
      * Describes a single operation parameter
    - * 
    + *
      * @see OpenAPI
      *      Specification Parameter Object
      **/
    @@ -58,7 +58,7 @@
          * 

    * For all other cases, the name corresponds to the parameter name used by the in property. *

    - * + * * @return this parameter's name **/ String name() default ""; @@ -68,7 +68,7 @@ *

    * Possible values are specified in ParameterIn enum. Ignored when empty string. *

    - * + * * @return this parameter's location **/ ParameterIn in() default ParameterIn.DEFAULT; @@ -76,7 +76,7 @@ /** * A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich * text representation. - * + * * @return this parameter's description **/ String description() default ""; @@ -87,14 +87,14 @@ * If the parameter location is "path", this property is REQUIRED and its value MUST be true. Otherwise, the * property may be included and its default value is false. *

    - * + * * @return whether or not this parameter is required **/ boolean required() default false; /** * Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. - * + * * @return whether or not this parameter is deprecated **/ boolean deprecated() default false; @@ -107,7 +107,7 @@ * sending a parameter with an empty value. *

    * If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue SHALL be ignored. - * + * * @return whether or not this parameter allows empty values **/ boolean allowEmptyValue() default false; @@ -119,7 +119,7 @@ * form. *

    * Ignored if the properties content or array are specified. - * + * * @return the style of this parameter **/ ParameterStyle style() default ParameterStyle.DEFAULT; @@ -132,7 +132,7 @@ * other styles, the default value is false. *

    * Ignored if the properties content or array are specified. - * + * * @return whether or not to expand individual array members **/ Explode explode() default Explode.DEFAULT; @@ -143,28 +143,28 @@ * This property only applies to parameters with an in value of query. Ignored if the properties content or array * are specified. *

    - * + * * @return whether or not this parameter allows reserved characters **/ boolean allowReserved() default false; /** * The schema defining the type used for the parameter. Ignored if the properties content or array are specified. - * + * * @return the schema of this parameter **/ Schema schema() default @Schema(); /** * The representation of this parameter, for different media types. - * + * * @return the content of this parameter **/ Content[] content() default {}; /** * Allows this parameter to be marked as hidden - * + * * @return whether or not this parameter is hidden */ boolean hidden() default false; @@ -178,7 +178,7 @@ * an object or an array. *

    * Ignored if the properties content or array are specified. - * + * * @return the list of examples for this parameter **/ ExampleObject[] examples() default {}; @@ -193,7 +193,7 @@ * an object or an array. *

    * Ignored if the properties examples, content or array are specified. - * + * * @return an example of the parameter **/ String example() default ""; @@ -213,7 +213,7 @@ * Parameter} model corresponding to the containing annotation. * * @return array of extensions - * + * * @since 3.1 */ Extension[] extensions() default {}; 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 c102050c..e41d0d70 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 @@ -25,7 +25,7 @@ /** * This object encapsulates input parameters - * + * * @see OpenAPI * Specification Parameter Object */ 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 f7412962..c04ed72e 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 @@ -28,7 +28,7 @@ /** * Describes a single request body. - * + * * @see requestBody * Object @@ -42,7 +42,7 @@ *

    * This could contain examples of use. CommonMark syntax MAY be used for rich text representation. *

    - * + * * @return description of this requestBody instance **/ String description() default ""; @@ -50,14 +50,14 @@ /** * The content of the request body. It is a REQUIRED property unless this is only a reference to a request body * instance. - * + * * @return content of this requestBody instance **/ Content[] content() default {}; /** * Determines if the request body is required in the request. - * + * * @return whether or not this requestBody is required **/ boolean required() default false; @@ -67,7 +67,7 @@ * parameter, it is required to match the name of that parameter so the appropriate association can be made. When * the request body is defined within {@link org.eclipse.microprofile.openapi.annotations.Components}. The name will * be used as the key to add this request body to the 'requestBodies' map for reuse. - * + * * @return this request body's name **/ String name() default ""; @@ -87,7 +87,7 @@ * RequestBody} model corresponding to the containing annotation. * * @return array of extensions - * + * * @since 3.1 */ Extension[] extensions() default {}; diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/parameters/package-info.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/parameters/package-info.java index ef05542d..633bda27 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/parameters/package-info.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/parameters/package-info.java @@ -15,7 +15,7 @@ * A set of annotations to describe and encapsulate operation parameters and operation's request body. *

    * Example usage: - * + * *

      * {@literal @}Produces("application/json")
      *  public Response getReviewById(
    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 b47ebcc2..9f75ef50 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
    @@ -36,7 +36,7 @@
      * When this annotation is applied to a JAX-RS method the response is added to the responses defined in the
      * corresponding OpenAPI operation. If the operation already has a response with the specified responseCode the
      * annotation on the method is ignored.
    - * 
    + *
      * 
      * @APIResponse(responseCode = "200", description = "Calculate load size", content = {
      *         @Content(mediaType = "application/json", Schema = @Schema(type = "integer"))})
    @@ -49,12 +49,12 @@
      * When this annotation is applied to a JAX-RS resource class, the response is added to the responses defined in all
      * OpenAPI operations which correspond to a method on that class. If an operation already has a response with the
      * specified responseCode the response is not added to that operation.
    - * 
    + *
      * 

    * When this annotation is applied to an ExceptionMapper class or toResponse method, it allows * developers to describe the API response that will be added to a generated OpenAPI operation based on a JAX-RS method * that declares an Exception of the type handled by the ExceptionMapper. - * + * *

      * @Provider
      * public class NotFoundExceptionMapper implements ExceptionMapper<NotFoundException> {
    @@ -68,9 +68,9 @@
      *     }
      * }
      * 
    - * + * * @see "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#responseObject" - * + * **/ @Target({ElementType.METHOD, ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) @@ -80,14 +80,14 @@ /** * A short description of the response. It is a REQUIRED property unless this is only a reference to a response * instance. - * + * * @return description of the response. **/ String description() default ""; /** * The HTTP response code, or 'default', for the supplied response. May only have 1 default entry. - * + * * @return HTTP response code for this response instance or default **/ String responseCode() default "default"; @@ -97,21 +97,21 @@ *

    * RFC7230 states header names are case insensitive. If a response header is defined with the name "Content-Type", * it SHALL be ignored. - * + * * @return array of headers for this response instance **/ Header[] headers() default {}; /** * An array of operation links that can be followed from the response. - * + * * @return array of operation links for this response instance **/ Link[] links() default {}; /** * An array containing descriptions of potential response payloads for different media types. - * + * * @return content of this response instance **/ Content[] content() default {}; @@ -120,7 +120,7 @@ * The unique name to identify this response. Only REQUIRED when the response is defined within * {@link org.eclipse.microprofile.openapi.annotations.Components}. The name will be used as the key to add this * response to the 'responses' map for reuse. - * + * * @return this response's name **/ String name() default ""; @@ -140,7 +140,7 @@ * APIResponse} model corresponding to the containing annotation. * * @return array of extensions - * + * * @since 3.1 */ Extension[] extensions() default {}; 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 187ef9e5..1a9a3b3f 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 @@ -81,7 +81,7 @@ * If no value is specified, the default value will set to the description given by the * HTTP/1.1 documentation for the * {@link #responseCode() responseCode} in use. - * + * * @return description of the response. **/ String responseDescription() default ""; 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 597eb798..31dde7ef 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 @@ -27,7 +27,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 * Object **/ @@ -47,7 +47,7 @@ * APIResponses} model corresponding to the containing annotation. * * @return array of extensions - * + * * @since 3.1 */ Extension[] extensions() default {}; diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/responses/package-info.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/responses/package-info.java index e0a019d7..2fdb758b 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/responses/package-info.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/responses/package-info.java @@ -16,7 +16,7 @@ * responses from an API operation. *

    * Example usage: - * + * *

      * {@literal @}GET
      *  {@literal @}Path("{id}")
    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 d5477522..c2c0cdc8 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
    @@ -26,7 +26,7 @@
     
     /**
      * Configuration details for a supported OAuth Flow.
    - * 
    + *
      * @see  OAuth Flow
      *      Object
      **/
    @@ -40,7 +40,7 @@
          * This is a REQUIRED property and MUST be in the form of a URL. Applies to oauth2 ("implicit", "authorizationCode")
          * type.
          * 

    - * + * * @return authorization URL for this flow **/ String authorizationUrl() default ""; @@ -51,7 +51,7 @@ * This is a REQUIRED property and MUST be in the form of a URL. Applies to oauth2 ("password", "clientCredentials", * "authorizationCode") type. *

    - * + * * @return token URL for this flow **/ String tokenUrl() default ""; @@ -61,7 +61,7 @@ *

    * This MUST be in the form of a URL. Applies to oauth2 type. *

    - * + * * @return URL for obtaining refresh tokens **/ String refreshUrl() default ""; @@ -71,7 +71,7 @@ *

    * The available scopes for the OAuth2 security scheme. Applies to oauth2 type. *

    - * + * * @return scopes available for this security scheme **/ OAuthScope[] scopes() default {}; @@ -81,7 +81,7 @@ * OAuthFlow} model corresponding to the containing annotation. * * @return array of extensions - * + * * @since 3.1 */ Extension[] extensions() default {}; 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 44ba2fb7..6c6907b4 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 @@ -26,7 +26,7 @@ /** * Allows configuration of the supported OAuth Flows. - * + * * @see OAuthFlows * Object **/ @@ -36,28 +36,28 @@ public @interface OAuthFlows { /** * Configuration for the OAuth Implicit flow. - * + * * @return implicit OAuth flow **/ OAuthFlow implicit() default @OAuthFlow(); /** * Configuration for the OAuth Resource Owner Password flow. - * + * * @return OAuth Resource Owner Password flow **/ OAuthFlow password() default @OAuthFlow(); /** * Configuration for the OAuth Client Credentials flow. - * + * * @return OAuth Client Credentials flow **/ OAuthFlow clientCredentials() default @OAuthFlow(); /** * Configuration for the OAuth Authorization Code flow. - * + * * @return OAuth Authorization Code flow **/ OAuthFlow authorizationCode() default @OAuthFlow(); @@ -67,7 +67,7 @@ * OAuthFlows} model corresponding to the containing annotation. * * @return array of extensions - * + * * @since 3.1 */ Extension[] extensions() default {}; 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 38095b2b..42833aea 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 @@ -24,7 +24,7 @@ /** * Represents an OAuth scope. - * + * * @see OAuthFlow * Object **/ @@ -34,14 +34,14 @@ public @interface OAuthScope { /** * Name of the scope. - * + * * @return the name of this scope */ String name() default ""; /** * Short description of the scope. - * + * * @return the description of this scope */ String description() default ""; 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 332da39f..78e37121 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 @@ -29,7 +29,7 @@ *

    * Applying this annotation to a method or class is equivalent to applying a {@link SecurityRequirementsSet} annotation * containing only this annotation. - * + * * @see SecuirtyRequirement * Object @@ -41,7 +41,7 @@ public @interface SecurityRequirement { /** * Name MUST correspond to a security scheme which is declared in the Security Schemes under the Components Object. - * + * * @return the name of this Security Requirement instance */ String name(); @@ -52,7 +52,7 @@ *

    * For other security scheme types, the array MUST be empty. *

    - * + * * @return a list of scope names required for the execution of this Security Requirement instance. */ String[] scopes() default {}; 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 7985f3cb..d0a8b803 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 @@ -27,14 +27,14 @@ *

    * Note that each {@code SecurityRequirement} annotation is equivalent to a {@link SecurityRequirementsSet} * annotation containing only that annotation. - * + * *

    - * Example: 
    - * security: 
    + * Example:
    + * security:
      *   - oauth_implicit: []
      *   - api_secret: []
      * 
    - * + * * @see SecurityRequirement * Object 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 af8d20f0..db420077 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 @@ -45,14 +45,14 @@ * An empty security requirement set indicates that authentication is not required. *

    * A {@code SecurityRequirementSet} annotation corresponds to a map of security requirements in an OpenAPI document. - * + * *

    - * Example: 
    - * security: 
    + * Example:
    + * security:
      *  - api_secret: []
      *    oauth_implicit: []
      * 
    - * + * * @see SecurityRequirement * Object 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 2504fe16..1d8b4a6e 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 @@ -40,15 +40,15 @@ *

    * A {@code SecurityRequirementSets} annotation corresponds to an array of maps of security requirements in an OpenAPI * document. - * + * *

    - * Example: 
    - * security: 
    + * Example:
    + * security:
      *   - oauth_implicit: []
      *     http_basic: []
      *   - api_secret: []
      * 
    - * + * * @see SecurityRequirement * Object 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 6279f3fb..1610cb29 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 @@ -32,7 +32,7 @@ * Defines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key * (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" **/ @Target({ElementType.METHOD, ElementType.TYPE}) @@ -46,7 +46,7 @@ *

    * It is a REQUIRED property unless this is only a reference to a security scheme instance. *

    - * + * * @return the name of this SecurityScheme instance **/ String securitySchemeName() default ""; @@ -55,14 +55,14 @@ *

    * Type is a REQUIRED property unless this is only a reference to a SecuirtyScheme instance. *

    - * + * * @return the type of this SecuirtyScheme instance **/ SecuritySchemeType type() default SecuritySchemeType.DEFAULT; /** * A short description for security scheme. CommonMark syntax can be used for rich text representation. - * + * * @return description of this SecurityScheme instance **/ String description() default ""; @@ -72,7 +72,7 @@ *

    * The name of the header, query or cookie parameter to be used. *

    - * + * * @return the name of this apiKey type SecurityScheme instance **/ String apiKeyName() default ""; @@ -82,7 +82,7 @@ *

    * The location of the API key. Valid values are defined by SecuritySchemeIn enum. Ignored when empty string. *

    - * + * * @return the location of the API key **/ SecuritySchemeIn in() default SecuritySchemeIn.DEFAULT; @@ -92,7 +92,7 @@ *

    * The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC 7235. *

    - * + * * @return the name of the HTTP Authorization scheme **/ String scheme() default ""; @@ -103,7 +103,7 @@ * A hint to the client to identify how the bearer token is formatted. Bearer tokens are usually generated by an * authorization server, so this information is primarily for documentation purposes. *

    - * + * * @return the format of the bearer token **/ String bearerFormat() default ""; @@ -113,7 +113,7 @@ *

    * An object containing configuration information for the flow types supported. *

    - * + * * @return flow types supported by this SecurityScheme instance **/ OAuthFlows flows() default @OAuthFlows; @@ -123,7 +123,7 @@ *

    * OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL. *

    - * + * * @return URL where OAuth2 configuration values are stored **/ String openIdConnectUrl() default ""; @@ -143,7 +143,7 @@ * SecurityScheme} model corresponding to the containing annotation. * * @return array of extensions - * + * * @since 3.1 */ Extension[] extensions() default {}; 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 a4d2784c..f61c69ec 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 @@ -24,7 +24,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/master/versions/3.0.0.md#security-scheme-object" **/ @Target({ElementType.TYPE}) diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/security/package-info.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/security/package-info.java index 27ed594f..3e5abe03 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/security/package-info.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/security/package-info.java @@ -13,10 +13,10 @@ /** * A set of annotations to represent various security components of an OpenAPI app. - * + * *

    * Example usage: - * + * *

      * {@literal @}Path("/reviews")
      * {@literal @}SecurityScheme(
    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 4113dd52..eaffd8fe 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
    @@ -41,7 +41,7 @@
      * Note: If both {@link org.eclipse.microprofile.openapi.annotations.servers.Server Server} and
      * {@link org.eclipse.microprofile.openapi.annotations.servers.Servers Servers} annotation are specified on the same
      * type, the server definitions will be combined.
    - * 
    + *
      * @see  OpenAPI
      *      Specification Server Object
      **/
    @@ -54,7 +54,7 @@
          * A URL to the target host. This URL supports Server Variables and may be relative, to indicate that the host
          * location is relative to the location where the OpenAPI definition is being served. Variable substitutions will be
          * made when a variable is named in {brackets}. This is a REQUIRED property.
    -     * 
    +     *
          * @return URL to the target host
          **/
         String url() default "";
    @@ -62,14 +62,14 @@
         /**
          * An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text
          * representation.
    -     * 
    +     *
          * @return description of the host designated by URL
          **/
         String description() default "";
     
         /**
          * An array of variables used for substitution in the server's URL template.
    -     * 
    +     *
          * @return array of variables
          **/
         ServerVariable[] variables() default {};
    @@ -79,7 +79,7 @@
          * corresponding to the containing annotation.
          *
          * @return array of extensions
    -     * 
    +     *
          * @since 3.1
          */
         Extension[] extensions() default {};
    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 1702d6f8..ef157eeb 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
    @@ -26,7 +26,7 @@
     
     /**
      * An object representing a Server Variable for server URL template substitution.
    - * 
    + *
      * @see ServerVariable
      *      Object
    @@ -37,7 +37,7 @@
     public @interface ServerVariable {
         /**
          * The name of this server variable. This is a REQUIRED property.
    -     * 
    +     *
          * @return the name of the server variable
          **/
         String name();
    @@ -45,21 +45,21 @@
         /**
          * An array of enum values for this variable. This field maps to the enum property in the OAS schema and to
          * enumeration field of ServerVariable model.
    -     * 
    +     *
          * @return array of possible values for this ServerVariable
          **/
         String[] enumeration() default {};
     
         /**
          * The default value of this server variable. This is a REQUIRED property.
    -     * 
    +     *
          * @return the defualt value of this server variable
          **/
         String defaultValue();
     
         /**
          * An optional description for the server variable. CommonMark syntax can be used for rich text representation.
    -     * 
    +     *
          * @return the description of this server variable
          **/
         String description() default "";
    @@ -69,7 +69,7 @@
          * ServerVariable} model corresponding to the containing annotation.
          *
          * @return array of extensions
    -     * 
    +     *
          * @since 3.1
          */
         Extension[] extensions() default {};
    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 5cdc55fe..11889360 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
    @@ -23,14 +23,14 @@
     import java.lang.annotation.Target;
     
     /**
    - * 
    + *
      * The Servers annotation is a container for @Server annotations. When used on a method or a type it is treated as if
      * each server annotation were applied individually.
      * 

    * Note: If both {@link org.eclipse.microprofile.openapi.annotations.servers.Server Server} and * {@link org.eclipse.microprofile.openapi.annotations.servers.Servers Servers} annotation are specified on the same * type, the server definitions will be combined. - * + * * @see Server * Object * diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/servers/package-info.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/servers/package-info.java index 1dba8cbb..8693d259 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/servers/package-info.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/servers/package-info.java @@ -16,7 +16,7 @@ * well as a way to represent variables for server URL template substitution. *

    * Example usage: - * + * *

      * {@literal @}POST
      * {@literal @}Servers(value={
    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 1a0bd3f8..c17fd6ac 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
    @@ -51,7 +51,7 @@
      * Note: If both {@link org.eclipse.microprofile.openapi.annotations.tags.Tag Tag} and
      * {@link org.eclipse.microprofile.openapi.annotations.tags.Tags Tags} annotations are specified on the same method or
      * class, then both tag definitions should be applied.
    - * 
    + *
      * 
      * @Tag(name = "luggage", description = "Operations related to luggage handling.")
      * @GET
    @@ -59,7 +59,7 @@
      *     return getLuggageLocation(id);
      * }
      * 
    - * + * *
      * @Tag(ref = "Bookings")
      * @GET
    @@ -67,7 +67,7 @@
      *     return Response.ok().entity(bookings.values()).build();
      * }
      * 
    - * + * * @see OpenAPI * Specification Tag Object */ @@ -114,7 +114,7 @@ * corresponding to the containing annotation. * * @return array of extensions - * + * * @since 3.1 */ Extension[] extensions() default {}; 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 872530cb..3c05eecd 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 @@ -30,7 +30,7 @@ * Note: If both {@link org.eclipse.microprofile.openapi.annotations.tags.Tag Tag} and * {@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 * Specification Tag Object * diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/tags/package-info.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/tags/package-info.java index 6ab04f0a..41bbb74a 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/tags/package-info.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/tags/package-info.java @@ -15,7 +15,7 @@ * A set of annotations to represent a tag for an API endpoint and a container that encapsulates multiple such tags. *

    * Example usage: - * + * *

      * {@literal @}Path("/reviews")
      * {@literal @}Tags(
    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 e434fe82..f68310ea 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
    @@ -46,7 +46,7 @@
      * 
  • user-name
  • *
  • my.org.User
  • * - * + * * @see OpenAPI * Specification Components Object */ @@ -61,7 +61,7 @@ public interface Components extends Constructible, Extensible { /** * Sets this Components' schemas property to the given Map containing keys and reusable schema objects. - * + * * @param schemas * a Map containing keys and reusable schema objects */ @@ -69,7 +69,7 @@ public interface Components extends Constructible, Extensible { /** * Sets this Components' schemas property to the given Map containing keys and reusable schemas. - * + * * @param schemas * a Map containing keys and reusable schemas * @return the current Components object diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/models/Constructible.java b/api/src/main/java/org/eclipse/microprofile/openapi/models/Constructible.java index d8c1be65..c1cfee02 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/models/Constructible.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/models/Constructible.java @@ -18,7 +18,7 @@ /** * Marker interface for OpenAPI model objects that can be constructed by the OASFactory. - * + * * @see org.eclipse.microprofile.openapi.OASFactory */ public interface Constructible { diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/models/Extensible.java b/api/src/main/java/org/eclipse/microprofile/openapi/models/Extensible.java index 24a5d317..407204f5 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/models/Extensible.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/models/Extensible.java @@ -36,7 +36,7 @@ public interface Extensible> { /** * Sets this Extensible's extensions property to the given map of extensions. - * + * * @param extensions * map containing keys which start with "x-" and values which provide additional information * @return the current instance 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 3b16f826..1022bf59 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 @@ -22,7 +22,7 @@ *

    * Allows referencing an external resource for extended documentation. *

    - * + * * @see OpenAPI * Specification External Documentation Object 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 d2747d04..3433674e 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 @@ -28,7 +28,7 @@ * OpenAPI *

    * This is the root document object of the OpenAPI document. It contains required and optional fields. - * + * * @see OpenAPI * Specification OpenAPI Object */ 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 644db72f..b1bedad4 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 @@ -32,7 +32,7 @@ *

    * Describes a single API operation on a path. *

    - * + * * @see OpenAPI * Specification Operation Object */ 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 e8ab8f30..e611e438 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 @@ -31,7 +31,7 @@ * 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 * Specification Path Item Object */ @@ -316,14 +316,14 @@ default PathItem TRACE(Operation trace) { /** * Returns a map with all the operations for this path where the keys are {@link PathItem.HttpMethod} items - * + * * @return a map with all the operations for this path where the keys are HttpMethods **/ Map getOperations(); /** * Sets an operation for a given http method. - * + * * @param httpMethod * the http method * @param operation 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 64eefc94..100a644e 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 @@ -27,7 +27,7 @@ * security * constraints. *

    - * + * * @see OpenAPI * Specification Paths Object */ @@ -35,7 +35,7 @@ public interface Paths extends Constructible, Extensible { /** * Adds the given path item to this Paths and return this instance of Paths - * + * * @param name * a path name in the format valid for a Paths object. The field name MUST begin with a slash. * @param item @@ -47,7 +47,7 @@ public interface Paths extends Constructible, Extensible { /** * Removes the given path item to this Paths. - * + * * @param name * a path name that will be removed. */ @@ -55,14 +55,14 @@ public interface Paths extends Constructible, Extensible { /** * Returns a copy map (potentially immutable) of the path items. - * + * * @return all items */ Map getPathItems(); /** * Set the path items map to this Paths - * + * * @param items * a map containing the list of paths. Keys MUST begin with a slash. */ @@ -71,7 +71,7 @@ public interface Paths extends Constructible, Extensible { /** * Check whether a path item is present in the map. This is a convenience method for * getPathItems().containsKey(name) - * + * * @param name * a path name in the format valid for a Paths object. * @return a boolean to indicate if the path item is present or not. @@ -86,7 +86,7 @@ default boolean hasPathItem(String name) { /** * Returns a path item for a given name. This is a convenience method for getPathItems().get(name) - * + * * @param name * a path name in the format valid for a Paths object. * @return the corresponding path item or null. diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/models/Reference.java b/api/src/main/java/org/eclipse/microprofile/openapi/models/Reference.java index 627a6d4d..3639a3b4 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/models/Reference.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/models/Reference.java @@ -42,13 +42,13 @@ public interface Reference> { *

    * The appropriate full reference is determined by the context. For a parameter the short name will be prefixed by * "#/components/parameters/" to create "#/components/parameters/ShortName". - * + * *

          * parameter.setRef("ShortName"); // #/components/parameters/ShortName
          * 
    - * + * * For a response the prefix is "#/components/responses/": - * + * *
          * response.setRef("NotFound"); // #/components/responses/NotFound
          * 
    @@ -56,7 +56,7 @@ public interface Reference> { * This property provides a reference to an object defined elsewhere. This property and all other properties are * mutually exclusive. If other properties are defined in addition to the reference property then the result is * undefined. - * + * * @param ref * a reference to a T object in the components section of this OpenAPI document or a JSON pointer to * another document. 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 128f36bc..4c058d9c 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 @@ -31,7 +31,7 @@ * that describes a set of requests that may be initiated by the API provider and the expected responses. The key value * used to identify the callback object is an expression, evaluated at runtime, that identifies a URL to use for the * callback operation. - * + * * @see OpenAPI * Specification Callback Object */ @@ -44,7 +44,7 @@ public interface Callback extends Constructible, Extensible, Reference * runtime HTTP request/response to identify the URL to be used for the callback request. A simple example might be * $request.body#/url. However, using a runtime expression the complete HTTP message can be accessed. This includes * accessing any part of a body that a JSON Pointer RFC6901 can reference. - * + * * @param name * a runtime expression that can be evaluated in the context of a runtime HTTP request/response * @param pathItem @@ -56,7 +56,7 @@ public interface Callback extends Constructible, Extensible, Reference /** * Removes the given path item of the Callback PathItems. - * + * * @param name * a path name that will be removed. */ @@ -64,14 +64,14 @@ public interface Callback extends Constructible, Extensible, Reference /** * Returns a copy map (potentially immutable) of the path items. - * + * * @return all items */ Map getPathItems(); /** * Set the path items map to this Callback. - * + * * @param items * a map containing the list of paths. */ @@ -80,7 +80,7 @@ public interface Callback extends Constructible, Extensible, Reference /** * Check whether a path item is present to the map. This is a convenience method for * getPathItems().containsKey(name) - * + * * @param name * a path name in the format valid for a Paths object. * @return a boolean to indicate if the path item is present or not. @@ -95,7 +95,7 @@ default boolean hasPathItem(String name) { /** * Returns a path item for a given name. This is a convenience method for getPathItems().get(name) - * + * * @param name * a path name in the format valid for a Paths object. * @return the corresponding path item or null. 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 12a7084f..1b118518 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 @@ -28,7 +28,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 * Specification Example Object */ diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/models/examples/package-info.java b/api/src/main/java/org/eclipse/microprofile/openapi/models/examples/package-info.java index 7fe0283a..2956c679 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/models/examples/package-info.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/models/examples/package-info.java @@ -17,7 +17,7 @@ * The behaviour of methods inherited from java.lang.Object are undefined by the MicroProfile OpenAPI specification. *

    * Example usage: - * + * *

      * .components(OASFactory.createObject(Components.class)
      *      .examples(new HashMap<String, Example>())
    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 6b6ff52e..a85d9004 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
    @@ -31,7 +31,7 @@
      * 

    * Describes a single header parameter for an operation. *

    - * + * * @see OpenAPI * Specification Header Object */ diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/models/headers/package-info.java b/api/src/main/java/org/eclipse/microprofile/openapi/models/headers/package-info.java index bc8c7f84..3d3da47b 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/models/headers/package-info.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/models/headers/package-info.java @@ -17,7 +17,7 @@ * The behaviour of methods inherited from java.lang.Object are undefined by the MicroProfile OpenAPI specification. *

    * Example usage: - * + * *

      * .components(OASFactory.createObject(Components.class)
      *  .headers(new HashMap<String, Header>())
    diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/models/info/package-info.java b/api/src/main/java/org/eclipse/microprofile/openapi/models/info/package-info.java
    index 3f18e6ab..bb6bebb6 100644
    --- a/api/src/main/java/org/eclipse/microprofile/openapi/models/info/package-info.java
    +++ b/api/src/main/java/org/eclipse/microprofile/openapi/models/info/package-info.java
    @@ -18,7 +18,7 @@
      * The behaviour of methods inherited from java.lang.Object are undefined by the MicroProfile OpenAPI specification.
      * 

    * Example: - * + * *

      * public class MyOASModelReaderImpl implements OASModelReader {
      *
    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 0b8ae74d..dd172f59 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
    @@ -38,7 +38,7 @@
      * MUST be unique and resolved in the scope of the OAS document. Because of the potential for name clashes, the
      * operationRef syntax is preferred for specifications with external references.
      * 

    - * + * * @see OpenAPI * Specification Link Object */ diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/models/links/package-info.java b/api/src/main/java/org/eclipse/microprofile/openapi/models/links/package-info.java index 9d45ebcd..0b6e8227 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/models/links/package-info.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/models/links/package-info.java @@ -17,7 +17,7 @@ * The behaviour of methods inherited from java.lang.Object are undefined by the MicroProfile OpenAPI specification. *

    * Example usage: - * + * *

      *  .components(OASFactory.createObject(Components.class)
      *      .links(new HashMap<String, Link>())
    diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/models/media/Content.java b/api/src/main/java/org/eclipse/microprofile/openapi/models/media/Content.java
    index 9ac4ff4e..e63f9799 100644
    --- a/api/src/main/java/org/eclipse/microprofile/openapi/models/media/Content.java
    +++ b/api/src/main/java/org/eclipse/microprofile/openapi/models/media/Content.java
    @@ -25,7 +25,7 @@
      * Content
      * 

    * A map to assist describing the media types for an operation's parameter or response. - * + * */ public interface Content extends Constructible { @@ -44,7 +44,7 @@ public interface Content extends Constructible { /** * Removes the given MediaType for this Content by its name. - * + * * @param name * a path name that will be removed. */ @@ -52,14 +52,14 @@ public interface Content extends Constructible { /** * Returns a copy map (potentially immutable) of media types. - * + * * @return all items */ Map getMediaTypes(); /** * Set the media types map to this Content - * + * * @param mediaTypes * a map containing the list of media types. Keys are name of a media type e.g. application/json. */ @@ -68,7 +68,7 @@ public interface Content extends Constructible { /** * Check whether a media type is present in the map. This is a convenience method for * getMediaTypes().containsKey(name) - * + * * @param name * the name of a media type e.g. application/json. * @return a boolean to indicate if the media type is present or not. @@ -83,7 +83,7 @@ default boolean hasMediaType(String name) { /** * Returns a media type for a given name. This is a convenience method for getMediaTypes().get(name) - * + * * @param name * the name of a media type e.g. application/json. * @return the corresponding media type or null. 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 7eee3364..5bb4fa41 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 @@ -29,7 +29,7 @@ * which is used to inform the consumer of the specification of an alternative schema based on the value associated with * it. *

    - * + * * @see OpenAPI * Specification Discriminator Object @@ -65,7 +65,7 @@ default Discriminator propertyName(String propertyName) { /** * Maps the given name to the given value and stores it in this Discriminator's mapping property. - * + * * @param name * a key which will be compared to information from a request body or response payload. * @param value @@ -77,7 +77,7 @@ default Discriminator propertyName(String propertyName) { /** * Remove the given name to the given value and stores it in this Discriminator's mapping property. - * + * * @param name * a key which will be compared to information from a request body or response payload. */ 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 0dad60cd..a5b55727 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 @@ -54,7 +54,7 @@ public String toString() { * This method sets contentType property for the Encoding instance to the passed parameter and returns the modified * instance *

    - * + * * @param contentType * a string that describes the type of content of the encoding * @return Encoding @@ -71,7 +71,7 @@ default Encoding contentType(String contentType) { *

    * This method returns the contentType property from an Encoding instance. *

    - * + * * @return String contentType **/ String getContentType(); @@ -83,7 +83,7 @@ default Encoding contentType(String contentType) { *

    * This method sets thecontentType property of an Encoding instance to the passed contentType parameter. *

    - * + * * @param contentType * a string that describes the type of content of the encoding */ @@ -95,7 +95,7 @@ default Encoding contentType(String contentType) { * This method sets the headers property of Encoding instance to the passed headers argument and returns the * modified instance. *

    - * + * * @param headers * a map of name to corresponding header object * @return Encoding @@ -110,7 +110,7 @@ default Encoding headers(Map headers) { *

    * This method returns the headers property from a Encoding instance. *

    - * + * * @return a copy Map (potentially immutable) containing headers **/ Map getHeaders(); @@ -120,7 +120,7 @@ default Encoding headers(Map headers) { *

    * This method sets the headers property of Encoding instance to the passed headers argument. *

    - * + * * @param headers * a map of name to corresponding header object */ @@ -151,7 +151,7 @@ default Encoding headers(Map headers) { * This method sets the style property of Encoding instance to the passed style argument and returns the modified * instance *

    - * + * * @param style * a string that descibes how encoding value will be serialized * @return Encoding @@ -166,7 +166,7 @@ default Encoding style(Style style) { *

    * This method returns the style property from a Encoding instance. *

    - * + * * @return String style **/ Style getStyle(); @@ -176,7 +176,7 @@ default Encoding style(Style style) { *

    * This method sets the style property of Encoding instance to the given style argument. *

    - * + * * @param style * a string that descibes how encoding value will be serialized */ @@ -190,7 +190,7 @@ default Encoding style(Style style) { * This method sets the explode property of Encoding instance to the given explode argument and returns the * instance. *

    - * + * * @param explode * a boolean that indicates whether the property values of array or object will generate separate * parameters @@ -208,7 +208,7 @@ default Encoding explode(Boolean explode) { *

    * This method returns the explode property from a Encoding instance. *

    - * + * * @return Boolean explode **/ Boolean getExplode(); @@ -220,7 +220,7 @@ default Encoding explode(Boolean explode) { *

    * This method sets the explode property of Encoding instance to the given explode argument. *

    - * + * * @param explode * a boolean that indicates whether the property values of array or object will generate separate * parameters @@ -234,7 +234,7 @@ default Encoding explode(Boolean explode) { * This method sets the allowReserved property of Encoding instance to the given allowReserved argument and returns * the instance. *

    - * + * * @param allowReserved * a boolean that determines whether the parameter value SHOULD allow reserved characters * @return Encoding @@ -250,7 +250,7 @@ default Encoding allowReserved(Boolean allowReserved) { *

    * This method returns the allowReserved property from a Encoding instance. *

    - * + * * @return Boolean allowReserved **/ Boolean getAllowReserved(); @@ -261,7 +261,7 @@ default Encoding allowReserved(Boolean allowReserved) { *

    * This method sets the allowReserved property to the given allowReserved argument. *

    - * + * * @param allowReserved * a boolean that determines whether the parameter value SHOULD allow reserved characters */ 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 680e7590..27ecf2e0 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 @@ -28,7 +28,7 @@ *

    * Each Media Type Object provides a schema and examples for the media type identified by its key. *

    - * + * * @see OpenAPI * Specification Media Type Object */ 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 03f6d809..7af94377 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 @@ -37,7 +37,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 * Specification Schema Object */ @@ -708,7 +708,7 @@ default Schema properties(Map properties) { *

  • If "additionalProperties" is a Schema, then additional properties are allowed but should conform to the * Schema.
  • * - * + * * @return this Schema's additionalProperties property (as {@link Schema}) */ Schema getAdditionalPropertiesSchema(); @@ -725,7 +725,7 @@ default Schema properties(Map properties) { *
  • If "additionalProperties" is false, then only properties covered by the "properties" and "patternProperties" * are allowed.
  • * - * + * * @return this Schema's additionalProperties property (as {@link Boolean}) */ Boolean getAdditionalPropertiesBoolean(); @@ -1069,7 +1069,7 @@ default Schema items(Schema items) { /** * Sets the schemas used by the allOf property of this Schema. - * + * * @param allOf * the list of schemas used by the allOf property */ @@ -1077,7 +1077,7 @@ default Schema items(Schema items) { /** * Sets the schemas used by the allOf property of this Schema. - * + * * @param allOf * the list of schemas used by the allOf property * @return the current Schema instance @@ -1089,7 +1089,7 @@ default Schema allOf(List allOf) { /** * Adds the given Schema to the list of schemas used by the allOf property. - * + * * @param allOf * a Schema to use with the allOf property * @return the current Schema instance @@ -1098,7 +1098,7 @@ default Schema allOf(List allOf) { /** * Removes the given Schema to the list of schemas used by the allOf property. - * + * * @param allOf * a Schema to use with the allOf property */ @@ -1113,7 +1113,7 @@ default Schema allOf(List allOf) { /** * Sets the schemas used by the anyOf property of this Schema. - * + * * @param anyOf * the list of schemas used by the anyOf property */ @@ -1121,7 +1121,7 @@ default Schema allOf(List allOf) { /** * Sets the schemas used by the anyOf property of this Schema. - * + * * @param anyOf * the list of schemas used by the anyOf property * @return the current Schema instance @@ -1133,7 +1133,7 @@ default Schema anyOf(List anyOf) { /** * Adds the given Schema to the list of schemas used by the anyOf property. - * + * * @param anyOf * a Schema to use with the anyOf property * @return the current Schema instance @@ -1142,7 +1142,7 @@ default Schema anyOf(List anyOf) { /** * Removes the given Schema to the list of schemas used by the anyOf property. - * + * * @param anyOf * a Schema to use with the anyOf property */ @@ -1157,7 +1157,7 @@ default Schema anyOf(List anyOf) { /** * Sets the schemas used by the oneOf property of this Schema. - * + * * @param oneOf * the list of schemas used by the oneOf property */ @@ -1165,7 +1165,7 @@ default Schema anyOf(List anyOf) { /** * Sets the schemas used by the oneOf property of this Schema. - * + * * @param oneOf * the list of schemas used by the oneOf property * @return the current Schema instance @@ -1177,7 +1177,7 @@ default Schema oneOf(List oneOf) { /** * Adds the given Schema to the list of schemas used by the oneOf property. - * + * * @param oneOf * a Schema to use with the oneOf property * @return the current Schema instance @@ -1186,7 +1186,7 @@ default Schema oneOf(List oneOf) { /** * Removes the given Schema to the list of schemas used by the oneOf property. - * + * * @param oneOf * a Schema to use with the oneOf property */ 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 be4bb0ee..1f0db090 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 XML Object *

    */ @@ -35,7 +35,7 @@ public interface XML extends Constructible, Extensible { *

    * The name property replaces the name of the element/attribute used for the described schema property. *

    - * + * * @return String name **/ String getName(); @@ -45,7 +45,7 @@ public interface XML extends Constructible, Extensible { *

    * The name property replaces the name of the element/attribute used for the described schema property. *

    - * + * * @param name * the name of this XML instance */ @@ -57,7 +57,7 @@ public interface XML extends Constructible, Extensible { *

    * The name property replaces the name of the element/attribute used for the described schema property. *

    - * + * * @param name * the name of this XML instance * @return XML instance with the set name property @@ -72,7 +72,7 @@ default XML name(String name) { *

    * The namespace property is the URI of the namespace definition. Value MUST be in the form of an absolute URI. *

    - * + * * @return String namespace **/ String getNamespace(); @@ -82,7 +82,7 @@ default XML name(String name) { *

    * The namespace property is the URI of the namespace definition. Value MUST be in the form of an absolute URI. *

    - * + * * @param namespace * the URI of the namespace definition */ @@ -94,7 +94,7 @@ default XML name(String name) { *

    * The namespace property is the URI of the namespace definition. Value MUST be in the form of an absolute URI. *

    - * + * * @param namespace * the URI of the namespace definition * @return XML instance with the set namespace property @@ -109,7 +109,7 @@ default XML namespace(String namespace) { *

    * This property is a String prefix to be used for the name. *

    - * + * * @return String prefix **/ String getPrefix(); @@ -119,7 +119,7 @@ default XML namespace(String namespace) { *

    * This property is a String prefix to be used for the name. *

    - * + * * @param prefix * string prefix to be used with the name */ @@ -131,7 +131,7 @@ default XML namespace(String namespace) { *

    * This property is a String prefix to be used for the name. *

    - * + * * @param prefix * string prefix to be used with the name * @return XML instance with the set prefix property @@ -147,7 +147,7 @@ default XML prefix(String prefix) { * Attribute property declares whether the property definition translates to an attribute instead of an element. * Default value is FALSE. *

    - * + * * @return Boolean attribute **/ Boolean getAttribute(); @@ -158,7 +158,7 @@ default XML prefix(String prefix) { * Attribute property declares whether the property definition translates to an attribute instead of an element. * Default value is FALSE. *

    - * + * * @param attribute * a boolean that declares whether the property definition translates to an attribute instead of an * element @@ -172,7 +172,7 @@ default XML prefix(String prefix) { * Attribute property declares whether the property definition translates to an attribute instead of an element. * Default value is FALSE. *

    - * + * * @param attribute * a boolean that declares whether the property definition translates to an attribute instead of an * element @@ -189,7 +189,7 @@ default XML attribute(Boolean attribute) { * Wrapped property MAY be used only for an array definition. Signifies whether the array is wrapped. The definition * takes effect only when defined alongside type being array. Default value is FALSE. *

    - * + * * @return Boolean wrapped **/ Boolean getWrapped(); @@ -200,7 +200,7 @@ default XML attribute(Boolean attribute) { * Wrapped property MAY be used only for an array definition. Signifies whether the array is wrapped. The definition * takes effect only when defined alongside type being array. Default value is FALSE. *

    - * + * * @param wrapped * a boolean that signifies whether the array is wrapped */ @@ -213,7 +213,7 @@ default XML attribute(Boolean attribute) { * Wrapped property MAY be used only for an array definition. Signifies whether the array is wrapped. The definition * takes effect only when defined alongside type being array. Default value is FALSE. *

    - * + * * @param wrapped * a boolean that signifies whether the array is wrapped * @return XML instance with the set wrapped property diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/models/media/package-info.java b/api/src/main/java/org/eclipse/microprofile/openapi/models/media/package-info.java index 9a5dec60..a974424c 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/models/media/package-info.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/models/media/package-info.java @@ -17,7 +17,7 @@ * The behaviour of methods inherited from java.lang.Object are undefined by the MicroProfile OpenAPI specification. *

    * Example usage: - * + * *

      * .responses(OASFactory.createObject(APIResponses.class)
      *      .addApiResponse("200", OASFactory.createObject(APIResponse.class)
    diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/models/package-info.java b/api/src/main/java/org/eclipse/microprofile/openapi/models/package-info.java
    index 8eeddc0b..126d8659 100644
    --- a/api/src/main/java/org/eclipse/microprofile/openapi/models/package-info.java
    +++ b/api/src/main/java/org/eclipse/microprofile/openapi/models/package-info.java
    @@ -18,7 +18,7 @@
      * The behaviour of methods inherited from java.lang.Object are undefined by the MicroProfile OpenAPI specification.
      * 

    * Example: - * + * *

      * public class MyOASModelReaderImpl implements OASModelReader {
      *
    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 29680c94..f3472850 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
    @@ -48,7 +48,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 * Specification Parameter Object */ diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/models/parameters/package-info.java b/api/src/main/java/org/eclipse/microprofile/openapi/models/parameters/package-info.java index be7440b4..bf390ff1 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/models/parameters/package-info.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/models/parameters/package-info.java @@ -17,7 +17,7 @@ * The behaviour of methods inherited from java.lang.Object are undefined by the MicroProfile OpenAPI specification. *

    * Example usage: - * + * *

      * .components(OASFactory.createObject(Components.class)
      *      .parameters(new HashMap<String, Parameter>())
    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 ebc330b1..674482b8 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
    @@ -35,7 +35,7 @@ public interface APIResponses extends Constructible, Extensible {
     
         /**
          * Adds an APIResponse in the format of the name as a key and the item as the value to APIResponses map
    -     * 
    +     *
          * @param name
          *            the name of APIResponse (http status code eventually with wildcard or {@value #DEFAULT})
          * @param apiResponse
    @@ -47,7 +47,7 @@ public interface APIResponses extends Constructible, Extensible {
     
         /**
          * Removes the given APIResponse to this APIResponses.
    -     * 
    +     *
          * @param name
          *            the name of APIResponse that will be removed (http status code eventually with wildcard or
          *            {@value #DEFAULT})
    @@ -56,14 +56,14 @@ public interface APIResponses extends Constructible, Extensible {
     
         /**
          * Returns a copy map (potentially immutable) of the APIResponses.
    -     * 
    +     *
          * @return all responses
          */
         Map getAPIResponses();
     
         /**
          * Set the APIResponses map to this APIResponses
    -     * 
    +     *
          * @param items
          *            a map containing all responses. Keys are http statuses code eventually with wildcard or
          *            {@value #DEFAULT}.
    @@ -73,7 +73,7 @@ public interface APIResponses extends Constructible, Extensible {
         /**
          * Check whether a APIResponse is present in the map. This is a convenience method for
          * getAPIResponses().containsKey(name)
    -     * 
    +     *
          * @param name
          *            the name of APIResponse (http status code eventually with wildcard or {@value #DEFAULT})
          * @return a boolean to indicate if the APIResponse is present or not.
    @@ -88,7 +88,7 @@ default boolean hasAPIResponse(String name) {
     
         /**
          * Returns a APIResponse for a given name. This is a convenience method for getAPIResponses().get(name)
    -     * 
    +     *
          * @param name
          *            the name of APIResponse (http status code eventually with wildcard or {@value #DEFAULT})
          * @return the corresponding APIResponse or null.
    @@ -107,7 +107,7 @@ default APIResponse getAPIResponse(String name) {
          * 

    * Convenience method that is the same as calling {@link #getAPIResponse(String)} on the map with {@value #DEFAULT} * as value for the key. - * + * * @return the default documentation of responses **/ APIResponse getDefaultValue(); @@ -118,7 +118,7 @@ default APIResponse getAPIResponse(String name) { *

    * Convenience method that is the same as calling {@link #addAPIResponse(String, APIResponse)} with * {@value #DEFAULT} as value for the key. - * + * * @param defaultValue * the default documentation of responses */ @@ -130,7 +130,7 @@ default APIResponse getAPIResponse(String name) { *

    * Convenience method that is the same as calling {@link #addAPIResponse(String, APIResponse)} with * {@value #DEFAULT} as value for the key. - * + * * @param defaultValue * the default documentation of responses * @return this ApiResponses instance diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/models/responses/package-info.java b/api/src/main/java/org/eclipse/microprofile/openapi/models/responses/package-info.java index 92eb4d2a..41b9c374 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/models/responses/package-info.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/models/responses/package-info.java @@ -18,7 +18,7 @@ * The behaviour of methods inherited from java.lang.Object are undefined by the MicroProfile OpenAPI specification. *

    * Example usage: - * + * *

      *  .GET(OASFactory.createObject(Operation.class)
      *      .summary("Retrieve all bookings for current user")
    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 1c1ea4fd..bfc279d4 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
    @@ -35,7 +35,7 @@ public interface OAuthFlow extends Constructible, Extensible {
          * 

    * This method returns the authorizationUrl property from OAuthFlow instance. *

    - * + * * @return String authorizationUrl **/ String getAuthorizationUrl(); @@ -48,7 +48,7 @@ public interface OAuthFlow extends Constructible, Extensible { *

    * This method sets the authorizationUrl property of an OAuthFlow instance to the given authorizationUrl argument. *

    - * + * * @param authorizationUrl * the authorization URL used for this flow */ @@ -63,7 +63,7 @@ public interface OAuthFlow extends Constructible, Extensible { * This method sets the authorizationUrl property of OAuthFlow instance to the given authorizationUrl argument and * returns the modified instance. *

    - * + * * @param authorizationUrl * the authorization URL used for this flow * @return OAuthFlow instance with the set authorizationUrl property @@ -78,7 +78,7 @@ default OAuthFlow authorizationUrl(String authorizationUrl) { *

    * This method returns the tokenUrl property from OAuthFlow instance. *

    - * + * * @return String tokenUrl **/ String getTokenUrl(); @@ -91,7 +91,7 @@ default OAuthFlow authorizationUrl(String authorizationUrl) { *

    * This method sets the tokenUrl property of OAuthFlow instance to the given tokenUrl argument. *

    - * + * * @param tokenUrl * the token URL to be used for this flow */ @@ -106,7 +106,7 @@ default OAuthFlow authorizationUrl(String authorizationUrl) { * This method sets the tokenUrl property of OAuthFlow instance to the given tokenUrl argument and returns the * instance. *

    - * + * * @param tokenUrl * the token URL to be used for this flow * @return OAuthFlow instance with the set tokenUrl property @@ -121,7 +121,7 @@ default OAuthFlow tokenUrl(String tokenUrl) { *

    * This method returns the refreshUrl property from OAuthFlow instance. *

    - * + * * @return String refreshUrl **/ String getRefreshUrl(); @@ -134,7 +134,7 @@ default OAuthFlow tokenUrl(String tokenUrl) { *

    * This method sets the refreshUrl property of OAuthFlow instance to the given refreshUrl argument. *

    - * + * * @param refreshUrl * the URL to be used for obtaining refresh tokens */ @@ -149,7 +149,7 @@ default OAuthFlow tokenUrl(String tokenUrl) { * This method sets the refreshUrl property of OAuthFlow instance to the given refreshUrl argument and returns the * modified instance. *

    - * + * * @param refreshUrl * the URL to be used for obtaining refresh tokens * @return OAuthFlow instance with the set refreshUrl property @@ -172,7 +172,7 @@ default OAuthFlow refreshUrl(String refreshUrl) { /** * Removes the given scope item to this scope mapping. - * + * * @param scope * the name of a scope */ @@ -187,7 +187,7 @@ default OAuthFlow refreshUrl(String refreshUrl) { *

    * This method sets the scopes property of OAuthFlow instance to the given argument. *

    - * + * * @param scopes * the available scopes for the OAuth2 security scheme */ @@ -203,7 +203,7 @@ default OAuthFlow refreshUrl(String refreshUrl) { * This method sets the scopes property of OAuthFlow instance to the given argument and returns the modified * instance. *

    - * + * * @param scopes * the available scopes for the OAuth2 security scheme * @return OAuthFlow instance with the set scopes property @@ -219,7 +219,7 @@ default OAuthFlow scopes(Map scopes) { *

    * This method returns the scopes property from OAuthFlow instance. *

    - * + * * @return a copy Map (potentially immutable) containing scopes and their descriptions **/ Map getScopes(); 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 a4696ce4..646c7d46 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 @@ -30,14 +30,14 @@ public interface OAuthFlows extends Constructible, Extensible { /** * This method returns the implicit property from OAuthFlows instance. - * + * * @return OAuthFlow implicit **/ OAuthFlow getImplicit(); /** * This method sets the implicit property of OAuthFlows instance to the given implicit argument. - * + * * @param implicit * the OauthFlow instance */ @@ -46,7 +46,7 @@ public interface OAuthFlows extends Constructible, Extensible { /** * This method sets the implicit property of OAuthFlows instance to the given implicit argument and returns the * modified instance. - * + * * @param implicit * the OauthFlow instance * @return OAuthFlows instance with the set implicit property @@ -61,7 +61,7 @@ default OAuthFlows implicit(OAuthFlow implicit) { *

    * This method returns the password property from OAuthFlows instance. *

    - * + * * @return OAuthFlow password **/ OAuthFlow getPassword(); @@ -71,7 +71,7 @@ default OAuthFlows implicit(OAuthFlow implicit) { *

    * This method sets the password property of OAuthFlows instance to the given password argument. *

    - * + * * @param password * the OAuthFlow instance */ @@ -83,7 +83,7 @@ default OAuthFlows implicit(OAuthFlow implicit) { * This method sets the password property of an OAuthFlows instance to the given password argument and returns the * modified instance. *

    - * + * * @param password * the OauthFlow instance * @return OAuthFlows instance with the set password property @@ -98,7 +98,7 @@ default OAuthFlows password(OAuthFlow password) { *

    * This method returns the clientCredentials property from OAuthFlows instance. *

    - * + * * @return OAuthFlow clientCredentials **/ OAuthFlow getClientCredentials(); @@ -108,7 +108,7 @@ default OAuthFlows password(OAuthFlow password) { *

    * This method sets the clientCredentials property of OAuthFlows instance to the given clientCredentials argument. *

    - * + * * @param clientCredentials * the OauthFlow instance */ @@ -120,7 +120,7 @@ default OAuthFlows password(OAuthFlow password) { * This method sets the clientCredentials property of OAuthFlows instance to the given clientCredentials argument * and returns the modified instance. *

    - * + * * @param clientCredentials * the OauthFlow instance * @return OAuthFlows instance with the set clientCredentials property @@ -135,7 +135,7 @@ default OAuthFlows clientCredentials(OAuthFlow clientCredentials) { *

    * This method returns the authorizationCode property from OAuthFlows instance. *

    - * + * * @return OAuthFlow authorizationCode **/ OAuthFlow getAuthorizationCode(); @@ -145,7 +145,7 @@ default OAuthFlows clientCredentials(OAuthFlow clientCredentials) { *

    * This method sets the authorizationCode property of OAuthFlows instance to the given authorizationCode argument. *

    - * + * * @param authorizationCode * the OauthFlow instance */ @@ -157,7 +157,7 @@ default OAuthFlows clientCredentials(OAuthFlow clientCredentials) { * This method sets the authorizationCode property of OAuthFlows instance to the given authorizationCode argument * and returns the modified instance. *

    - * + * * @param authorizationCode * the OauthFlow instance * @return OAuthFlows instance with the set authorizationCode property 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 1730e4db..37f253cc 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 @@ -34,7 +34,7 @@ public interface SecurityRequirement extends Constructible { /** * Adds a security scheme to the SecurityRequirement instance based on the scheme name and required scope (optional) * provided. - * + * * @param securitySchemeName * the name of security scheme declared in the Components section of the OpenAPI document * @param scope @@ -47,7 +47,7 @@ public interface SecurityRequirement extends Constructible { /** * Adds a security scheme to the SecurityRequirement instance based on the scheme name and required scopes * (optional) provided. - * + * * @param securitySchemeName * the name of security scheme declared in the Components section of the OpenAPI document * @param scopes @@ -61,7 +61,7 @@ public interface SecurityRequirement extends Constructible { * Adds a security scheme to the SecurityRequirement instance based on the scheme name. No scopes are included, * resulting in an empty list of scopes for the security scheme. This is valid when the defined security scheme is * not 'oauth2' or 'openIdConnect'. - * + * * @param securitySchemeName * the name of security scheme declared in the Components section of the OpenAPI document * @return Updated SecurityRequirement instance @@ -70,7 +70,7 @@ public interface SecurityRequirement extends Constructible { /** * Removes a security scheme to the SecurityRequirement instance based on the scheme name. - * + * * @param securitySchemeName * the name of security scheme */ @@ -78,7 +78,7 @@ public interface SecurityRequirement extends Constructible { /** * Returns a copy map (potentially immutable) of the schemes. - * + * * @return all items */ Map> getSchemes(); @@ -87,7 +87,7 @@ public interface SecurityRequirement extends Constructible { * Set all security schemes to the SecurityRequirement instance. Keys are the name of security scheme declared in * the Components section of the OpenAPI document, values are a list of required scope - only valid when the defined * scheme is 'oauth2' or 'openIdConnect' - * + * * @param items * a map containing the security schemes. */ @@ -96,7 +96,7 @@ public interface SecurityRequirement extends Constructible { /** * Check whether a scheme is present in the map. This is a convenience method for * getSchemes().containsKey(name) - * + * * @param securitySchemeName * the name of security scheme * @return a boolean to indicate if the scheme is present or not. @@ -112,7 +112,7 @@ default boolean hasScheme(String securitySchemeName) { /** * Returns a list of scopes for a given scheme name. This is a convenience method for * getSchemes().get(name) - * + * * @param securitySchemeName * the name of security scheme * @return a list of scopes or null. 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 41fa332d..e6269ed1 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 @@ -77,7 +77,7 @@ public String toString() { *

    * This method returns the type property from SecurityScheme instance. *

    - * + * * @return Type type **/ SecurityScheme.Type getType(); @@ -87,7 +87,7 @@ public String toString() { *

    * This method sets the type property of SecurityScheme instance to the given Type argument. *

    - * + * * @param type * the type of SecurityScheme instance */ @@ -99,7 +99,7 @@ public String toString() { * This method sets the type property of SecurityScheme instance to the given Type argument and returns the modified * instance. *

    - * + * * @param type * the type of SecurityScheme instance * @return SecurityScheme instance with the set type property @@ -114,7 +114,7 @@ default SecurityScheme type(SecurityScheme.Type type) { *

    * This method returns the description property from SecurityScheme instance. *

    - * + * * @return String description **/ String getDescription(); @@ -124,7 +124,7 @@ default SecurityScheme type(SecurityScheme.Type type) { *

    * This method sets the description property of SecurityScheme instance. *

    - * + * * @param description * short description of the SecuirtyScheme instance */ @@ -135,7 +135,7 @@ default SecurityScheme type(SecurityScheme.Type type) { *

    * This method sets the description property of SecurityScheme instance and returns the modified instance. *

    - * + * * @param description * short description of the SecuirtyScheme instance * @return SecurityScheme instance with the set description property @@ -150,7 +150,7 @@ default SecurityScheme description(String description) { *

    * This method returns the name property from SecurityScheme instance. *

    - * + * * @return String name **/ String getName(); @@ -160,7 +160,7 @@ default SecurityScheme description(String description) { *

    * This method sets the name property of SecurityScheme instance to the parameter. *

    - * + * * @param name * the name of the header, query or cookie parameter to be used */ @@ -172,7 +172,7 @@ default SecurityScheme description(String description) { * This method sets the name property of SecurityScheme instance to the given String argument and returns the * modified instance. *

    - * + * * @param name * the name of the header, query or cookie parameter to be used * @return SecurityScheme instance with the set name property @@ -188,7 +188,7 @@ default SecurityScheme name(String name) { *

    * This method returns the in property from SecurityScheme instance. *

    - * + * * @return In in **/ SecurityScheme.In getIn(); @@ -199,7 +199,7 @@ default SecurityScheme name(String name) { *

    * The method sets the in property of SecurityScheme instance to the given In argument. *

    - * + * * @param in * the location of the API key */ @@ -212,7 +212,7 @@ default SecurityScheme name(String name) { * This method sets the in property of SecurityScheme instance to the given In argument and returns the modified * instance. *

    - * + * * @param in * the location of the API key * @return SecurityScheme instance with the set in property @@ -228,7 +228,7 @@ default SecurityScheme in(SecurityScheme.In in) { *

    * This method returns the scheme property from SecurityScheme instance. *

    - * + * * @return String scheme **/ String getScheme(); @@ -239,7 +239,7 @@ default SecurityScheme in(SecurityScheme.In in) { *

    * This method sets the scheme property of SecurityScheme instance to the given String argument. *

    - * + * * @param scheme * the name of the HTTP Authorization scheme to be used in the Authorization header */ @@ -252,7 +252,7 @@ default SecurityScheme in(SecurityScheme.In in) { * This method sets the scheme property of SecurityScheme instance to the given String argument and returns the * modified instance. *

    - * + * * @param scheme * the name of the HTTP Authorization scheme to be used in the Authorization header * @return SecurityScheme instance with the set scheme property @@ -268,7 +268,7 @@ default SecurityScheme scheme(String scheme) { *

    * This method returns the bearerFormat property from SecurityScheme instance. *

    - * + * * @return String bearerFormat **/ String getBearerFormat(); @@ -279,7 +279,7 @@ default SecurityScheme scheme(String scheme) { *

    * This method sets the bearerFormat property of SecurityScheme instance to the given String argument. *

    - * + * * @param bearerFormat * a hint to the client to identify how the bearer token is formatted */ @@ -292,7 +292,7 @@ default SecurityScheme scheme(String scheme) { * This method sets the bearerFormat property of SecurityScheme instance to the given String argument and returns * the modified instance. *

    - * + * * @param bearerFormat * a hint to the client to identify how the bearer token is formatted * @return SecurityScheme instance with the set bearerFormat property @@ -310,7 +310,7 @@ default SecurityScheme bearerFormat(String bearerFormat) { *

    * This method returns the flows property from SecurityScheme instance. *

    - * + * * @return OAuthFlows flows **/ OAuthFlows getFlows(); @@ -323,7 +323,7 @@ default SecurityScheme bearerFormat(String bearerFormat) { *

    * This method sets the flows property of SecurityScheme instance to the given OAuthFlows argument. *

    - * + * * @param flows * an object containing configuration information for the flow types supported */ @@ -338,7 +338,7 @@ default SecurityScheme bearerFormat(String bearerFormat) { * This method sets the flows property of SecurityScheme instance to the given OAuthFlows argument and returns the * modified instance. *

    - * + * * @param flows * an object containing configuration information for the flow types supported * @return SecurityScheme instance with the set flows property @@ -356,7 +356,7 @@ default SecurityScheme flows(OAuthFlows flows) { *

    * This method returns the openIdConnectUrl property from SecurityScheme instance. *

    - * + * * @return String openIdConnectUrl **/ String getOpenIdConnectUrl(); @@ -369,7 +369,7 @@ default SecurityScheme flows(OAuthFlows flows) { *

    * This method sets the openIdConnectUrl property of a SecurityScheme instance to the given String argument. *

    - * + * * @param openIdConnectUrl * a URL where OAuth2 configuration values are stored */ @@ -384,7 +384,7 @@ default SecurityScheme flows(OAuthFlows flows) { * This method sets the openIdConnectUrl property of SecurityScheme instance to the given String argument and * returns the modified instance. *

    - * + * * @param openIdConnectUrl * a URL where OAuth2 configuration values are stored * @return SecurityScheme instance with the set openIdConnectUrl property diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/models/security/package-info.java b/api/src/main/java/org/eclipse/microprofile/openapi/models/security/package-info.java index ca2366b9..d1e6b5a0 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/models/security/package-info.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/models/security/package-info.java @@ -17,7 +17,7 @@ * The behaviour of methods inherited from java.lang.Object are undefined by the MicroProfile OpenAPI specification. *

    * Example usage: - * + * *

      * {@literal @}Override
      *  public OpenAPI buildModel() {
    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 97b9a428..62947c9b 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
    @@ -40,7 +40,7 @@ public interface Server extends Constructible, Extensible {
          * 

    * This is a REQUIRED property. *

    - * + * * @return String url **/ String getUrl(); @@ -56,7 +56,7 @@ public interface Server extends Constructible, Extensible { *

    * This is a REQUIRED property. *

    - * + * * @param url * a URL to the target host */ @@ -73,7 +73,7 @@ public interface Server extends Constructible, Extensible { *

    * This is a REQUIRED property. *

    - * + * * @param url * a URL to the target host * @return Server instance with the set url property. @@ -86,7 +86,7 @@ default Server url(String url) { /** * This method returns the description property of Server instance. The decsription property is an optional string * describing the host designated by the URL. - * + * * @return String description **/ String getDescription(); @@ -97,7 +97,7 @@ default Server url(String url) { * Description of a server is an optional string describing the host designated by the URL. CommonMark syntax can be * used for rich text representation. *

    - * + * * @param description * an optional string describing the host designated by the URL */ @@ -110,7 +110,7 @@ default Server url(String url) { * Description of a server is an optional string describing the host designated by the URL. CommonMark syntax can be * used for rich text representation. *

    - * + * * @param description * an optional string describing the host designated by the URL * @return Server instance with the set description property. @@ -126,7 +126,7 @@ default Server description(String description) { * Variables are represented as a map between variable name and its value. The value is used for substitution in the * server's URL template. *

    - * + * * @return map of server variables (potentially immutable). **/ Map getVariables(); @@ -144,7 +144,7 @@ default Server description(String description) { /** * Removes the given server variable item from the Server's map of variables - * + * * @param variableName * the name the variable to remove */ @@ -156,7 +156,7 @@ default Server description(String description) { * Variables property is a map between variable name and its value. The value is used for substitution in the * server's URL template. *

    - * + * * @param variables * a map between variable name and its value */ @@ -169,7 +169,7 @@ default Server description(String description) { * Variables property is a map between variable name and its value. The value is used for substitution in the * server's URL template. *

    - * + * * @param variables * a map between variable name and its value * @return Server instance with the set variables property. 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 4cbc5347..d97697d4 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 @@ -37,7 +37,7 @@ public interface ServerVariable extends Constructible, Extensible - * + * * @return a copy List (potentially immutable) of possible values for this variable **/ List getEnumeration(); @@ -48,7 +48,7 @@ public interface ServerVariable extends Constructible, Extensible - * + * * @param enumeration * an list of string values to be used if the substitution options are from a limited set */ @@ -60,7 +60,7 @@ public interface ServerVariable extends Constructible, Extensible * This property represents an enum of string values to be used if the substitution options are from a limited set. *

    - * + * * @param enumeration * an list of string values to be used if the substitution options are from a limited set * @return ServerVariable instance with the set enumeration property @@ -75,7 +75,7 @@ default ServerVariable enumeration(List enumeration) { *

    * If the enumeration list is null, this method should create a new ArrayList and add the item. *

    - * + * * @param enumeration * an item to be added to enum list * @return ServerVariable instance with the added enum item. @@ -84,7 +84,7 @@ default ServerVariable enumeration(List enumeration) { /** * This method removes a string item to enumeration list of a ServerVariable instance. - * + * * @param enumeration * an item to be removed to enum list */ @@ -96,7 +96,7 @@ default ServerVariable enumeration(List enumeration) { *

    * This method returns the defaultValue property from ServerVariable instance. *

    - * + * * @return String defaultValue **/ String getDefaultValue(); @@ -107,7 +107,7 @@ default ServerVariable enumeration(List enumeration) { *

    * This method sets the defaultValue property of ServerVariable instance to the given defaultValue argument. *

    - * + * * @param defaultValue * the value to use for substitution, and to send, if an alternate value is not supplied */ @@ -120,7 +120,7 @@ default ServerVariable enumeration(List enumeration) { * This method sets the defaultValue property of ServerVariable instance to the given defaultValue argument and * returns the modified instance. *

    - * + * * @param defaultValue * the value to use for substitution, and to send, if an alternate value is not supplied * @return ServerVariable instance with the set defaultValue property @@ -134,7 +134,7 @@ default ServerVariable defaultValue(String defaultValue) { /** * This method returns the description property of ServerVariable instance. Description property is optional for * server variable. - * + * * @return String description **/ String getDescription(); @@ -144,7 +144,7 @@ default ServerVariable defaultValue(String defaultValue) { *

    * Description property is optional for server variable. CommonMark syntax can be used for rich text representation. *

    - * + * * @param description * a short description of the server variable */ @@ -156,7 +156,7 @@ default ServerVariable defaultValue(String defaultValue) { *

    * Description property is optional for server variable. CommonMark syntax can be used for rich text representation. *

    - * + * * @param description * a short description of the server variable * @return ServerVariable instance with the set description property diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/models/servers/package-info.java b/api/src/main/java/org/eclipse/microprofile/openapi/models/servers/package-info.java index 162979a6..8a0f9314 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/models/servers/package-info.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/models/servers/package-info.java @@ -18,7 +18,7 @@ * The behaviour of methods inherited from java.lang.Object are undefined by the MicroProfile OpenAPI specification. *

    * Example usage: - * + * *

      * {@literal}Override
      *  public OpenAPI buildModel() {
    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 9dbb801c..d69e833c 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
    @@ -25,7 +25,7 @@
      * Tag
      * 

    * An object to store metadata to be available in the OpenAPI document. - * + * * @see OpenAPI * Specification Tag Object */ @@ -40,7 +40,7 @@ public interface Tag extends Constructible, Extensible { /** * Sets the name property of a Tag instance to the given string. - * + * * @param name * the name property for this tag */ @@ -48,7 +48,7 @@ public interface Tag extends Constructible, Extensible { /** * Sets the name property of a Tag instance to the given string. - * + * * @param name * the name property for this tag * @return the current Tag instance @@ -67,7 +67,7 @@ default Tag name(String name) { /** * Sets the description property of a Tag instance to the given string. - * + * * @param description * the description property for this tag */ @@ -75,7 +75,7 @@ default Tag name(String name) { /** * Sets the description property of a Tag instance to the given string. - * + * * @param description * the description property for this tag * @return the current Tag instance @@ -94,7 +94,7 @@ default Tag description(String description) { /** * Sets the externalDocs property of a Tag instance to the given object. - * + * * @param externalDocs * additional external documentation for this tag */ @@ -102,7 +102,7 @@ default Tag description(String description) { /** * Sets the externalDocs property of a Tag instance to the given object. - * + * * @param externalDocs * additional external documentation for this tag * @return the current Tag instance diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/models/tags/package-info.java b/api/src/main/java/org/eclipse/microprofile/openapi/models/tags/package-info.java index 9bd0d483..195d309a 100644 --- a/api/src/main/java/org/eclipse/microprofile/openapi/models/tags/package-info.java +++ b/api/src/main/java/org/eclipse/microprofile/openapi/models/tags/package-info.java @@ -17,7 +17,7 @@ * The behaviour of methods inherited from java.lang.Object are undefined by the MicroProfile OpenAPI specification. *

    * Example usage: - * + * *

      * {@literal @}Override
      *   public OpenAPI buildModel() {
    diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/spi/OASFactoryResolver.java b/api/src/main/java/org/eclipse/microprofile/openapi/spi/OASFactoryResolver.java
    index 0cf6d161..a0b72b60 100644
    --- a/api/src/main/java/org/eclipse/microprofile/openapi/spi/OASFactoryResolver.java
    +++ b/api/src/main/java/org/eclipse/microprofile/openapi/spi/OASFactoryResolver.java
    @@ -38,14 +38,14 @@ public abstract class OASFactoryResolver {
     
         /**
          * Create a new instance of a constructible element from the OpenAPI model tree.
    -     * 
    +     *
          * @param 
          *            describes the type parameter
          * @param clazz
          *            represents a model which extends the org.eclipse.microprofile.openapi.models.Constructible interface
    -     * 
    +     *
          * @return a new instance of the requested model class
    -     * 
    +     *
          * @throws NullPointerException
          *             if the specified class is null
          * @throws IllegalArgumentException
    @@ -56,7 +56,7 @@ public abstract class OASFactoryResolver {
         /**
          * Creates an OASFactoryResolver object. Only used internally from within
          * {@link org.eclipse.microprofile.openapi.OASFactory}
    -     * 
    +     *
          * @return an instance of OASFactoryResolver
          */
         public static OASFactoryResolver instance() {
    diff --git a/spi/src/main/java/org/eclipse/microprofile/openapi/spi/OASFactoryResolver.java b/spi/src/main/java/org/eclipse/microprofile/openapi/spi/OASFactoryResolver.java
    index ae0711b9..bef662e5 100644
    --- a/spi/src/main/java/org/eclipse/microprofile/openapi/spi/OASFactoryResolver.java
    +++ b/spi/src/main/java/org/eclipse/microprofile/openapi/spi/OASFactoryResolver.java
    @@ -38,14 +38,14 @@ public abstract class OASFactoryResolver {
     
         /**
          * Create a new instance of a constructible element from the OpenAPI model tree.
    -     * 
    +     *
          * @param 
          *            describes the type parameter
          * @param clazz
          *            represents a model which extends the org.eclipse.microprofile.openapi.models.Constructible interface
    -     * 
    +     *
          * @return a new instance of the requested model class
    -     * 
    +     *
          * @throws NullPointerException
          *             if the specified class is null
          * @throws IllegalArgumentException
    @@ -56,7 +56,7 @@ public abstract class OASFactoryResolver {
         /**
          * Creates an OASFactoryResolver object. Only used internally from within
          * {@link org.eclipse.microprofile.openapi.OASFactory}
    -     * 
    +     *
          * @return an instance of OASFactoryResolver
          */
         public static OASFactoryResolver instance() {
    diff --git a/tck/src/main/java/org/eclipse/microprofile/openapi/apps/airlines/model/Review.java b/tck/src/main/java/org/eclipse/microprofile/openapi/apps/airlines/model/Review.java
    index 4a744782..0c7dce7a 100644
    --- a/tck/src/main/java/org/eclipse/microprofile/openapi/apps/airlines/model/Review.java
    +++ b/tck/src/main/java/org/eclipse/microprofile/openapi/apps/airlines/model/Review.java
    @@ -34,7 +34,7 @@ public class Review {
     
         /**
          * Creates an instance of the Review object with the given fields.
    -     * 
    +     *
          * @param id
          *            the unique id of this Review
          * @param user
    @@ -57,7 +57,7 @@ public Review(String id, User user, Airline airlines, int rating, String comment
     
         /**
          * Returns the id of this Review
    -     * 
    +     *
          * @return id
          */
         public String getId() {
    @@ -66,7 +66,7 @@ public String getId() {
     
         /**
          * Sets the id for this Review
    -     * 
    +     *
          * @param id
          *            the unique id of this Review
          */
    @@ -76,7 +76,7 @@ public void setId(String id) {
     
         /**
          * Returns the user of this Review
    -     * 
    +     *
          * @return user
          */
         public User getUser() {
    @@ -85,7 +85,7 @@ public User getUser() {
     
         /**
          * Sets the user for this Review
    -     * 
    +     *
          * @param user
          *            the user associated with this Review
          */
    @@ -95,7 +95,7 @@ public void setUser(User user) {
     
         /**
          * Returns the Airlines of this Review
    -     * 
    +     *
          * @return airlines
          */
         public Airline getAirlines() {
    @@ -104,7 +104,7 @@ public Airline getAirlines() {
     
         /**
          * Sets the airlines for this Review
    -     * 
    +     *
          * @param airlines
          *            the Airline associated with this Review
          */
    @@ -114,7 +114,7 @@ public void setAirlinesID(Airline airlines) {
     
         /**
          * Returns the rating of this Review
    -     * 
    +     *
          * @return rating
          */
         public int getRating() {
    @@ -123,7 +123,7 @@ public int getRating() {
     
         /**
          * Sets the rating for this Review
    -     * 
    +     *
          * @param rating
          *            the rating for this Review
          */
    @@ -133,7 +133,7 @@ public void setRating(int rating) {
     
         /**
          * Returns the comments of this Review
    -     * 
    +     *
          * @return comment
          */
         public String getComment() {
    @@ -142,7 +142,7 @@ public String getComment() {
     
         /**
          * Sets the comments for this Review
    -     * 
    +     *
          * @param comment
          *            the comments for this Review
          */
    diff --git a/tck/src/main/java/org/eclipse/microprofile/openapi/apps/airlines/model/User.java b/tck/src/main/java/org/eclipse/microprofile/openapi/apps/airlines/model/User.java
    index c955d599..5e428e2d 100644
    --- a/tck/src/main/java/org/eclipse/microprofile/openapi/apps/airlines/model/User.java
    +++ b/tck/src/main/java/org/eclipse/microprofile/openapi/apps/airlines/model/User.java
    @@ -53,7 +53,7 @@ public class User {
     
         /**
          * Creates a User instance with the parameters specified.
    -     * 
    +     *
          * @param id
          *            the unique id for this User instance
          * @param userName
    @@ -92,7 +92,7 @@ public User(int id, String userName, String password, String firstName,
     
         /**
          * Returns the id property of a User instance
    -     * 
    +     *
          * @return int id
          */
         public int getId() {
    @@ -101,7 +101,7 @@ public int getId() {
     
         /**
          * Sets the id property of a User instance to the parameter.
    -     * 
    +     *
          * @param id
          *            the unique id for this User instance
          */
    @@ -111,7 +111,7 @@ public void setId(int id) {
     
         /**
          * Returns the userName property of a User instance.
    -     * 
    +     *
          * @return String userName
          */
         public String getUserName() {
    @@ -120,7 +120,7 @@ public String getUserName() {
     
         /**
          * Sets the userName property of a User instance to the parameter.
    -     * 
    +     *
          * @param userName
          *            the user name for this User instance
          */
    @@ -130,7 +130,7 @@ public void setUserName(String userName) {
     
         /**
          * Returns the password property of a User instance.
    -     * 
    +     *
          * @return String password
          */
         public String getPassword() {
    @@ -139,7 +139,7 @@ public String getPassword() {
     
         /**
          * Sets the password property of a User instance to the parameter.
    -     * 
    +     *
          * @param password
          *            the password associated with this User instance
          */
    @@ -149,7 +149,7 @@ public void setPassword(String password) {
     
         /**
          * Returns firstName property of a User instance.
    -     * 
    +     *
          * @return String firstName
          */
         public String getFirstName() {
    @@ -158,7 +158,7 @@ public String getFirstName() {
     
         /**
          * Sets the firstName property of a User instance to the parameter.
    -     * 
    +     *
          * @param firstName
          *            the first name for this User instance
          */
    @@ -168,7 +168,7 @@ public void setFirstName(String firstName) {
     
         /**
          * Returns the lastName property of a User instance.
    -     * 
    +     *
          * @return String lastName
          */
         public String getLastName() {
    @@ -177,7 +177,7 @@ public String getLastName() {
     
         /**
          * Sets the lastName property of a User instance to the parameter.
    -     * 
    +     *
          * @param lastName
          *            the last name for this User instance
          */
    @@ -187,7 +187,7 @@ public void setLastName(String lastName) {
     
         /**
          * Returns the gender property of a User instance.
    -     * 
    +     *
          * @return the gender
          */
         public Gender getGender() {
    @@ -196,7 +196,7 @@ public Gender getGender() {
     
         /**
          * Sets the gender property of a User instance to the parameter.
    -     * 
    +     *
          * @param gender
          *            the gender for this User instance
          */
    @@ -206,7 +206,7 @@ public void setGender(String gender) {
     
         /**
          * Returns the age property of a User instance.
    -     * 
    +     *
          * @return int age
          */
         public int getAge() {
    @@ -215,7 +215,7 @@ public int getAge() {
     
         /**
          * Sets the age property of a User instance to the parameter.
    -     * 
    +     *
          * @param age
          *            the age value for this User instance
          */
    @@ -225,7 +225,7 @@ public void setAge(int age) {
     
         /**
          * Returns the email property of a User instance.
    -     * 
    +     *
          * @return String email
          */
         public String getEmail() {
    @@ -234,7 +234,7 @@ public String getEmail() {
     
         /**
          * Sets the email property of a User instance to the parameter.
    -     * 
    +     *
          * @param email
          *            the email associated with this User instance
          */
    @@ -244,7 +244,7 @@ public void setEmail(String email) {
     
         /**
          * Returns the phone property of a User instance.
    -     * 
    +     *
          * @return String phone
          */
         public String getPhone() {
    @@ -253,7 +253,7 @@ public String getPhone() {
     
         /**
          * Sets the phone property of a User instance to the parameter.
    -     * 
    +     *
          * @param phone
          *            the phone number associated with this User instance
          */
    @@ -265,7 +265,7 @@ public void setPhone(String phone) {
     
         /**
          * Returns the status of this User instance.
    -     * 
    +     *
          * @return the integer associated with this User's status
          */
         public int getUserStatus() {
    @@ -274,7 +274,7 @@ public int getUserStatus() {
     
         /**
          * Sets the status of this User instance.
    -     * 
    +     *
          * @param status
          *            an integer representing the status of this User instance
          */
    diff --git a/tck/src/main/java/org/eclipse/microprofile/openapi/apps/airlines/resources/UserResource.java b/tck/src/main/java/org/eclipse/microprofile/openapi/apps/airlines/resources/UserResource.java
    index db3a2c0a..d6ba7682 100644
    --- a/tck/src/main/java/org/eclipse/microprofile/openapi/apps/airlines/resources/UserResource.java
    +++ b/tck/src/main/java/org/eclipse/microprofile/openapi/apps/airlines/resources/UserResource.java
    @@ -333,7 +333,7 @@ public Response logoutUser() {
     
         /**
          * Operation to test hiding of request body and parameter schemas
    -     * 
    +     *
          * @return a user
          */
         @POST
    diff --git a/tck/src/main/java/org/eclipse/microprofile/openapi/tck/AppTestBase.java b/tck/src/main/java/org/eclipse/microprofile/openapi/tck/AppTestBase.java
    index 3dc821a9..7eb1017d 100644
    --- a/tck/src/main/java/org/eclipse/microprofile/openapi/tck/AppTestBase.java
    +++ b/tck/src/main/java/org/eclipse/microprofile/openapi/tck/AppTestBase.java
    @@ -93,7 +93,7 @@ public ValidatableResponse callEndpoint(String type) {
         /**
          * Lookup the object at the provided path in the response and if the object is a reference (contains a $ref
          * property), return the reference path. If the object is not a reference, return the input path.
    -     * 
    +     *
          * @param vr
          *            the response
          * @param path
    @@ -115,10 +115,10 @@ public static String dereference(ValidatableResponse vr, String path) {
          * Builds an absolute path using the series of provided relative {@code paths} by sequentially searching through the
          * provided {@link ValidatableResponse}. Each time a {@code $ref} is encountered as a key in the path node, it is
          * treated as an absolute (within the response) path that is used as the context for the next {@code paths} entry.
    -     * 
    +     *
          * 

    * Consider the following simple schemas as the response content of the {@link ValidatableResponse} argument: - * + * *

          * {
          *   "components": {
    @@ -141,15 +141,15 @@ public static String dereference(ValidatableResponse vr, String path) {
          *   }
          * }
          * 
    - * + * * Given the {@code paths} {@code "components.schemas.Employee"} and {@code "properties.firstName"}, the value * returned is the absolute path {@code "components.schemas.Person.properties.firstName"}. The path segment * {@code "components.schemas.Employee"} contains a {@code .$ref} which itself resolves to the schema * {@code "components.schemas.Person"} and the second path segment is appended to the resolved reference. - * + * * Note that this method does not currently support the conversion of Json Pointer escape sequences ({@code ~0} and * {@code ~1}) in {@code $ref} values. - * + * * @param vr * the response * @param paths diff --git a/tck/src/main/java/org/eclipse/microprofile/openapi/tck/beanvalidation/BeanValidationTest.java b/tck/src/main/java/org/eclipse/microprofile/openapi/tck/beanvalidation/BeanValidationTest.java index 52ab54f3..f94d45a6 100644 --- a/tck/src/main/java/org/eclipse/microprofile/openapi/tck/beanvalidation/BeanValidationTest.java +++ b/tck/src/main/java/org/eclipse/microprofile/openapi/tck/beanvalidation/BeanValidationTest.java @@ -185,7 +185,7 @@ public void parameterTest(String format) { /** * Asserts that a property from the test schema matches the given matcher - * + * * @param vr * the response * @param propertyName diff --git a/tck/src/main/java/org/eclipse/microprofile/openapi/tck/utils/ConfigAsset.java b/tck/src/main/java/org/eclipse/microprofile/openapi/tck/utils/ConfigAsset.java index ff451120..f901b5c9 100644 --- a/tck/src/main/java/org/eclipse/microprofile/openapi/tck/utils/ConfigAsset.java +++ b/tck/src/main/java/org/eclipse/microprofile/openapi/tck/utils/ConfigAsset.java @@ -27,7 +27,7 @@ * Utility to allow the contents of microprofile-config.properties to be defined within the deployment method *

    * Example usage: - * + * *

      * 
      * ConfigAsset config = new ConfigAsset()