#27: Give more details to project overview

dgroup · Feb 8, 2022 · 0f149ea · 0f149ea
1 parent f340f77
commit 0f149ea
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 7 deletions.
diff --git a/readme.md b/readme.md
@@ -43,7 +43,7 @@ We are using the latest stable pmd-java version which is `6.42.0` as a start poi
 | PMD rule                                                                                                     |  Provider  | Since  | Status | Spring | Quarkus |
 |:-------------------------------------------------------------------------------------------------------------|:----------:|:------:|:-------:|:------:|:-------:|
 | [UseExistingMediaTypeConstant](https://github.com/dgroup/arch4u-pmd/discussions/43)                          | arch4u-pmd | 0.1.0  |    ✅    |   ⌛    |    ⌛    |
-| [UsePublicMethodsWithOverrideAnnotationInRestEndpoints](https://github.com/dgroup/arch4u-pmd/discussions/73) | arch4u-pmd | 0.1.0  |    ✅    |   ⌛    |    ⌛    |
+| [UseOpenApiInRestEndpoints](https://github.com/dgroup/arch4u-pmd/discussions/73) | arch4u-pmd | 0.1.0  |    ✅    |   ⌛    |    ⌛    |
 | [RestEndpointsWithoutExposedMetrics](https://github.com/dgroup/arch4u-pmd/discussions/74)                    | arch4u-pmd | 0.1.0  |    ✅    |   ⌛    |    ⌛    |
 | [UseConstantAsMetricName](https://github.com/dgroup/arch4u-pmd/discussions/75)                               | arch4u-pmd | 0.1.0  |    ✅    |   ⌛    |    ⌛    |
 | [NoMandatoryConstructorInExceptionClass](https://github.com/dgroup/arch4u-pmd/discussions/31)                | arch4u-pmd | 0.1.0  |    ✅    |   ⌛    |    ⌛    |

diff --git a/src/main/resources/io/github/dgroup/arch4u/pmd/api/arch4u-rest-ruleset.xml b/src/main/resources/io/github/dgroup/arch4u/pmd/api/arch4u-rest-ruleset.xml
@@ -53,7 +53,7 @@
     </example>
   </rule>
 
-  <rule name="UsePublicMethodsWithOverrideAnnotationInRestEndpoints"
+  <rule name="UseOpenApiInRestEndpoints"
         since="0.1.0"
         language="java"
         externalInfoUrl="https://github.com/dgroup/arch4u-pmd/discussions/73"

diff --git a/...h4u/pmd/WrongRestMethodSignatureTest.java → ...4u/pmd/UseOpenApiInRestEndpointsTest.java b/...h4u/pmd/WrongRestMethodSignatureTest.java → ...4u/pmd/UseOpenApiInRestEndpointsTest.java
@@ -32,13 +32,10 @@
  * @since 0.1.0
  */
 @SuppressWarnings({"PMD.TestClassWithoutTestCases", "PMD.JUnit4TestShouldUseBeforeAnnotation"})
-public final class WrongRestMethodSignatureTest extends SimpleAggregatorTst {
+public final class UseOpenApiInRestEndpointsTest extends SimpleAggregatorTst {
 
     @Override
     public void setUp() {
-        addRule(
-            "io/github/dgroup/arch4u/pmd/arch4u-ruleset.xml",
-            "UsePublicMethodsWithOverrideAnnotationInRestEndpoints"
-        );
+        addRule("io/github/dgroup/arch4u/pmd/arch4u-ruleset.xml", "UseOpenApiInRestEndpoints");
     }
 }
diff --git a/...WithOverrideAnnotationInRestEndpoints.xml → ...h4u/pmd/xml/UseOpenApiInRestEndpoints.xml b/...WithOverrideAnnotationInRestEndpoints.xml → ...h4u/pmd/xml/UseOpenApiInRestEndpoints.xml