Javadoc update

Author: bnasslahsen

springdoc-openapi-common/src/main/java/org/springdoc/api/AbstractOpenApiResource.java

@@ -612,6 +612,9 @@ protected void calculatePath(RouterOperation routerOperation, Locale locale) {
 	 * @param handlerMethod the handler method
 	 * @param operationPath the operation path
 	 * @param requestMethods the request methods
+	 * @param consumes the consumes
+	 * @param produces the produces
+	 * @param headers the headers
 	 * @param locale the locale
 	 */
 	protected void calculatePath(HandlerMethod handlerMethod, String operationPath,

springdoc-openapi-common/src/main/java/org/springdoc/api/ErrorMessage.java

@@ -1,18 +1,22 @@
 /*
  *
- *  * Copyright 2019-2020 the original author or authors.
  *  *
- *  * Licensed under the Apache License, Version 2.0 (the "License");
- *  * you may not use this file except in compliance with the License.
- *  * You may obtain a copy of the License at
+ *  *  *
+ *  *  *  * Copyright 2019-2022 the original author or authors.
+ *  *  *  *
+ *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
+ *  *  *  * you may not use this file except in compliance with the License.
+ *  *  *  * You may obtain a copy of the License at
+ *  *  *  *
+ *  *  *  *      https://www.apache.org/licenses/LICENSE-2.0
+ *  *  *  *
+ *  *  *  * Unless required by applicable law or agreed to in writing, software
+ *  *  *  * distributed under the License is distributed on an "AS IS" BASIS,
+ *  *  *  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  *  *  * See the License for the specific language governing permissions and
+ *  *  *  * limitations under the License.
+ *  *  *
  *  *
- *  *      https://www.apache.org/licenses/LICENSE-2.0
- *  *
- *  * Unless required by applicable law or agreed to in writing, software
- *  * distributed under the License is distributed on an "AS IS" BASIS,
- *  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *  * See the License for the specific language governing permissions and
- *  * limitations under the License.
  *
  */
 

springdoc-openapi-common/src/main/java/org/springdoc/api/OpenApiResourceNotFoundException.java

@@ -1,3 +1,25 @@
+/*
+ *
+ *  *
+ *  *  *
+ *  *  *  * Copyright 2019-2022 the original author or authors.
+ *  *  *  *
+ *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
+ *  *  *  * you may not use this file except in compliance with the License.
+ *  *  *  * You may obtain a copy of the License at
+ *  *  *  *
+ *  *  *  *      https://www.apache.org/licenses/LICENSE-2.0
+ *  *  *  *
+ *  *  *  * Unless required by applicable law or agreed to in writing, software
+ *  *  *  * distributed under the License is distributed on an "AS IS" BASIS,
+ *  *  *  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  *  *  * See the License for the specific language governing permissions and
+ *  *  *  * limitations under the License.
+ *  *  *
+ *  *
+ *
+ */
+
 package org.springdoc.api;
 
 /**

springdoc-openapi-common/src/main/java/org/springdoc/api/annotations/ParameterObject.java

@@ -1,19 +1,21 @@
 /*
  *
  *  *
- *  *  * Copyright 2019-2020 the original author or authors.
  *  *  *
- *  *  * Licensed under the Apache License, Version 2.0 (the "License");
- *  *  * you may not use this file except in compliance with the License.
- *  *  * You may obtain a copy of the License at
+ *  *  *  * Copyright 2019-2022 the original author or authors.
+ *  *  *  *
+ *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
+ *  *  *  * you may not use this file except in compliance with the License.
+ *  *  *  * You may obtain a copy of the License at
+ *  *  *  *
+ *  *  *  *      https://www.apache.org/licenses/LICENSE-2.0
+ *  *  *  *
+ *  *  *  * Unless required by applicable law or agreed to in writing, software
+ *  *  *  * distributed under the License is distributed on an "AS IS" BASIS,
+ *  *  *  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  *  *  * See the License for the specific language governing permissions and
+ *  *  *  * limitations under the License.
  *  *  *
- *  *  *      https://www.apache.org/licenses/LICENSE-2.0
- *  *  *
- *  *  * Unless required by applicable law or agreed to in writing, software
- *  *  * distributed under the License is distributed on an "AS IS" BASIS,
- *  *  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *  *  * See the License for the specific language governing permissions and
- *  *  * limitations under the License.
  *  *
  *
  */

springdoc-openapi-common/src/main/java/org/springdoc/api/mixins/SortedOpenAPIMixin.java

@@ -1,19 +1,21 @@
 /*
  *
  *  *
- *  *  * Copyright 2019-2020 the original author or authors.
  *  *  *
- *  *  * Licensed under the Apache License, Version 2.0 (the "License");
- *  *  * you may not use this file except in compliance with the License.
- *  *  * You may obtain a copy of the License at
+ *  *  *  * Copyright 2019-2022 the original author or authors.
+ *  *  *  *
+ *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
+ *  *  *  * you may not use this file except in compliance with the License.
+ *  *  *  * You may obtain a copy of the License at
+ *  *  *  *
+ *  *  *  *      https://www.apache.org/licenses/LICENSE-2.0
+ *  *  *  *
+ *  *  *  * Unless required by applicable law or agreed to in writing, software
+ *  *  *  * distributed under the License is distributed on an "AS IS" BASIS,
+ *  *  *  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  *  *  * See the License for the specific language governing permissions and
+ *  *  *  * limitations under the License.
  *  *  *
- *  *  *      https://www.apache.org/licenses/LICENSE-2.0
- *  *  *
- *  *  * Unless required by applicable law or agreed to in writing, software
- *  *  * distributed under the License is distributed on an "AS IS" BASIS,
- *  *  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *  *  * See the License for the specific language governing permissions and
- *  *  * limitations under the License.
  *  *
  *
  */
@@ -32,19 +34,36 @@
 import io.swagger.v3.oas.models.Paths;
 
 /**
+ * The interface Sorted open api mixin.
  * @author bnasslashen
  */
 @JsonPropertyOrder(value = {"openapi", "info", "externalDocs", "servers", "security", "tags", "paths", "components"}, alphabetic = true)
 public interface SortedOpenAPIMixin {
 
+	/**
+	 * Gets extensions.
+	 *
+	 * @return the extensions
+	 */
 	@JsonAnyGetter
 	@JsonInclude(value = Include.ALWAYS)
 	@JsonPropertyOrder(alphabetic = true)
 	Map<String, Object> getExtensions();
 
+	/**
+	 * Add extension.
+	 *
+	 * @param name the name
+	 * @param value the value
+	 */
 	@JsonAnySetter
 	void addExtension(String name, Object value);
 
+	/**
+	 * Gets paths.
+	 *
+	 * @return the paths
+	 */
 	@JsonSerialize(using = PathsSerializer.class)
 	Paths getPaths();
 }

springdoc-openapi-common/src/main/java/org/springdoc/api/mixins/SortedOpenAPIMixin31.java

@@ -34,19 +34,36 @@
 import io.swagger.v3.oas.models.Paths;
 
 /**
+ * The interface Sorted open api mixin 31.
  * @author bnasslashen
  */
 @JsonPropertyOrder(value = {"openapi", "info", "externalDocs", "servers", "security", "tags", "paths", "components", "webhooks"}, alphabetic = true)
 public interface SortedOpenAPIMixin31 {
 
+	/**
+	 * Gets extensions.
+	 *
+	 * @return the extensions
+	 */
 	@JsonAnyGetter
 	@JsonInclude(value = Include.ALWAYS)
 	@JsonPropertyOrder(alphabetic = true)
 	Map<String, Object> getExtensions();
 
+	/**
+	 * Add extension.
+	 *
+	 * @param name the name
+	 * @param value the value
+	 */
 	@JsonAnySetter
 	void addExtension(String name, Object value);
 
+	/**
+	 * Gets paths.
+	 *
+	 * @return the paths
+	 */
 	@JsonSerialize(using = PathsSerializer.class)
 	Paths getPaths();
 

springdoc-openapi-common/src/main/java/org/springdoc/api/mixins/SortedSchemaMixin.java

@@ -1,19 +1,21 @@
 /*
  *
  *  *
- *  *  * Copyright 2019-2020 the original author or authors.
  *  *  *
- *  *  * Licensed under the Apache License, Version 2.0 (the "License");
- *  *  * you may not use this file except in compliance with the License.
- *  *  * You may obtain a copy of the License at
+ *  *  *  * Copyright 2019-2022 the original author or authors.
+ *  *  *  *
+ *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
+ *  *  *  * you may not use this file except in compliance with the License.
+ *  *  *  * You may obtain a copy of the License at
+ *  *  *  *
+ *  *  *  *      https://www.apache.org/licenses/LICENSE-2.0
+ *  *  *  *
+ *  *  *  * Unless required by applicable law or agreed to in writing, software
+ *  *  *  * distributed under the License is distributed on an "AS IS" BASIS,
+ *  *  *  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  *  *  * See the License for the specific language governing permissions and
+ *  *  *  * limitations under the License.
  *  *  *
- *  *  *      https://www.apache.org/licenses/LICENSE-2.0
- *  *  *
- *  *  * Unless required by applicable law or agreed to in writing, software
- *  *  * distributed under the License is distributed on an "AS IS" BASIS,
- *  *  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *  *  * See the License for the specific language governing permissions and
- *  *  * limitations under the License.
  *  *
  *
  */
@@ -32,51 +34,123 @@
 import io.swagger.v3.oas.models.media.Schema;
 
 /**
+ * The interface Sorted schema mixin.
  * @author bnasslashen
  */
 @JsonPropertyOrder(value = { "type", "format" }, alphabetic = true)
 public interface SortedSchemaMixin {
 
+	/**
+	 * Gets extensions.
+	 *
+	 * @return the extensions
+	 */
 	@JsonAnyGetter
 	@JsonPropertyOrder(alphabetic = true)
 	Map<String, Object> getExtensions();
 
+	/**
+	 * Add extension.
+	 *
+	 * @param name the name
+	 * @param value the value
+	 */
 	@JsonAnySetter
 	void addExtension(String name, Object value);
 
+	/**
+	 * Gets example set flag.
+	 *
+	 * @return the example set flag
+	 */
 	@JsonIgnore
 	boolean getExampleSetFlag();
 
+	/**
+	 * Gets example.
+	 *
+	 * @return the example
+	 */
 	@JsonInclude(JsonInclude.Include.CUSTOM)
 	Object getExample();
 
+	/**
+	 * Gets json schema.
+	 *
+	 * @return the json schema
+	 */
 	@JsonIgnore
 	Map<String, Object> getJsonSchema();
 
+	/**
+	 * Gets exclusive minimum value.
+	 *
+	 * @return the exclusive minimum value
+	 */
 	@JsonIgnore
 	BigDecimal getExclusiveMinimumValue();
 
+	/**
+	 * Gets exclusive maximum value.
+	 *
+	 * @return the exclusive maximum value
+	 */
 	@JsonIgnore
 	BigDecimal getExclusiveMaximumValue();
 
+	/**
+	 * Gets pattern properties.
+	 *
+	 * @return the pattern properties
+	 */
 	@JsonIgnore
 	Map<String, Schema> getPatternProperties();
 
+	/**
+	 * Gets contains.
+	 *
+	 * @return the contains
+	 */
 	@JsonIgnore
 	Schema getContains();
 
+	/**
+	 * Get id string.
+	 *
+	 * @return the string
+	 */
 	@JsonIgnore
 	String get$id();
 
+	/**
+	 * Get anchor string.
+	 *
+	 * @return the string
+	 */
 	@JsonIgnore
 	String get$anchor();
 
+	/**
+	 * Get schema string.
+	 *
+	 * @return the string
+	 */
 	@JsonIgnore
 	String get$schema();
 
+	/**
+	 * Gets types.
+	 *
+	 * @return the types
+	 */
 	@JsonIgnore
 	Set<String> getTypes();
 
+	/**
+	 * Gets json schema.
+	 *
+	 * @return the json schema
+	 */
 	@JsonIgnore
 	Object getJsonSchemaImpl();