Changes report: Tags with only name provided are being added to the openAPI.tags field #1648.

Author: bnasslahsen

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/service/OpenAPIService.java

@@ -341,8 +341,8 @@ public Operation buildTags(HandlerMethod handlerMethod, Operation operation, Ope
 		Set<io.swagger.v3.oas.models.tags.Tag> tags = new HashSet<>();
 		Set<String> tagsStr = new HashSet<>();
 
-		buildTagsFromClass(handlerMethod.getBeanType(), tags, tagsStr, locale);
 		buildTagsFromMethod(handlerMethod.getMethod(), tags, tagsStr, locale);
+		buildTagsFromClass(handlerMethod.getBeanType(), tags, tagsStr, locale);
 
 		if (!CollectionUtils.isEmpty(tagsStr))
 			tagsStr = tagsStr.stream()
@@ -436,13 +436,14 @@ private void buildTagsFromMethod(Method method, Set<io.swagger.v3.oas.models.tag
 	 */
 	private void addTags(List<Tag> sourceTags, Set<io.swagger.v3.oas.models.tags.Tag> tags, Locale locale) {
 		Optional<Set<io.swagger.v3.oas.models.tags.Tag>> optionalTagSet = AnnotationsUtils
-				.getTags(sourceTags.toArray(new Tag[0]), false);
+				.getTags(sourceTags.toArray(new Tag[0]), true);
 		optionalTagSet.ifPresent(tagsSet -> {
 			tagsSet.forEach(tag -> {
 				tag.name(propertyResolverUtils.resolve(tag.getName(), locale));
 				tag.description(propertyResolverUtils.resolve(tag.getDescription(), locale));
+				if (tags.stream().noneMatch(t -> t.getName().equals(tag.getName())))
+					tags.add(tag);
 			});
-			tags.addAll(tagsSet);
 		});
 	}
 

springdoc-openapi-starter-webmvc-api/src/test/java/test/org/springdoc/api/v30/app187/HelloController.java

@@ -0,0 +1,53 @@
+/*
+ *
+ *  *
+ *  *  *
+ *  *  *  *
+ *  *  *  *  * 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 test.org.springdoc.api.v30.app187;
+
+import io.swagger.v3.oas.annotations.ExternalDocumentation;
+import io.swagger.v3.oas.annotations.OpenAPIDefinition;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
+
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+@OpenAPIDefinition(tags = {
+		@Tag(name = "Definition First Tag"),
+		@Tag(name = "Definition Second Tag full", description = "desc definition")
+})
+@Tag(name = "Second Tag")
+@Tag(name = "Fourth Tag Full", description = "desc class", externalDocs = @ExternalDocumentation(description = "docs desc class"))
+@Tag(name = "Fifth Tag Full", description = "desc class", externalDocs = @ExternalDocumentation(description = "docs desc class"))
+@Tag(name = "Sixth Tag")
+public class HelloController {
+
+	@GetMapping("/hello")
+	@Operation(tags = {"Example Tag", "Second Tag"})
+	@Tag(name = "Third Tag")
+	@Tag(name = "Second Tag")
+	@Tag(name = "Fourth Tag Full", description = "desc", externalDocs = @ExternalDocumentation(description = "docs desc"))
+	public void hello() {}
+	
+}

springdoc-openapi-starter-webmvc-api/src/test/java/test/org/springdoc/api/v30/app187/SpringDocApp187Test.java

@@ -0,0 +1,36 @@
+/*
+ *
+ *  *
+ *  *  *
+ *  *  *  *
+ *  *  *  *  * 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 test.org.springdoc.api.v30.app187;
+
+import test.org.springdoc.api.v30.AbstractSpringDocV30Test;
+
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+public class SpringDocApp187Test extends AbstractSpringDocV30Test {
+
+    @SpringBootApplication
+    static class SpringDocTestApp {}
+
+}

springdoc-openapi-starter-webmvc-api/src/test/resources/results/3.0.1/app1.json

@@ -14,20 +14,6 @@
       "description": "Generated server url"
     }
   ],
-  "tags": [
-    {
-      "name": "inventory"
-    },
-    {
-      "name": "people"
-    },
-    {
-      "name": "tea"
-    },
-    {
-      "name": "items"
-    }
-  ],
   "paths": {
     "/{email}": {
       "get": {
@@ -436,12 +422,12 @@
               }
             }
           },
-          "400": {
-            "description": "invalid input, object invalid"
-          },
           "201": {
             "description": "item created"
           },
+          "400": {
+            "description": "invalid input, object invalid"
+          },
           "409": {
             "description": "an existing item already exists"
           }

springdoc-openapi-starter-webmvc-api/src/test/resources/results/3.0.1/app100.json

@@ -10,14 +10,6 @@
       "description": "Generated server url"
     }
   ],
-  "tags": [
-    {
-      "name": "hello-ap1"
-    },
-    {
-      "name": "hello-ap2"
-    }
-  ],
   "paths": {
     "/search": {
       "get": {

springdoc-openapi-starter-webmvc-api/src/test/resources/results/3.0.1/app104.json

@@ -10,11 +10,6 @@
       "description": "Generated server url"
     }
   ],
-  "tags": [
-    {
-      "name": "design"
-    }
-  ],
   "paths": {
     "/design": {
       "get": {

springdoc-openapi-starter-webmvc-api/src/test/resources/results/3.0.1/app122.json

@@ -10,11 +10,6 @@
       "description": "Generated server url"
     }
   ],
-  "tags": [
-    {
-      "name": "example"
-    }
-  ],
   "paths": {
     "/": {
       "post": {
@@ -50,21 +45,21 @@
   },
   "components": {
     "schemas": {
-      "CustomerDto": {
+      "WrapperCustomerDto": {
         "type": "object",
         "properties": {
-          "baseStr": {
-            "type": "string"
-          },
-          "customerName": {
+          "wrapper": {
             "type": "string"
           }
         }
       },
-      "WrapperCustomerDto": {
+      "CustomerDto": {
         "type": "object",
         "properties": {
-          "wrapper": {
+          "baseStr": {
+            "type": "string"
+          },
+          "customerName": {
             "type": "string"
           }
         }

springdoc-openapi-starter-webmvc-api/src/test/resources/results/3.0.1/app134-1.json

@@ -10,11 +10,6 @@
       "description": "Generated server url"
     }
   ],
-  "tags": [
-    {
-      "name": "The sample resource"
-    }
-  ],
   "paths": {
     "/{id}": {
       "get": {

springdoc-openapi-starter-webmvc-api/src/test/resources/results/3.0.1/app134-2.json

@@ -10,11 +10,6 @@
       "description": "Generated server url"
     }
   ],
-  "tags": [
-    {
-      "name": "The sample resource"
-    }
-  ],
   "paths": {
     "/search": {
       "post": {

springdoc-openapi-starter-webmvc-api/src/test/resources/results/3.0.1/app134-3.json

@@ -10,11 +10,6 @@
       "description": "Generated server url"
     }
   ],
-  "tags": [
-    {
-      "name": "The sample resource"
-    }
-  ],
   "paths": {
     "/{id}": {
       "get": {