GH-203 Update wiki for 5.x branch, start 6.x on main

javalin · Jan 2, 2024 · 911c45e · 911c45e
1 parent 624c4d3
commit 911c45e
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 9 deletions.
diff --git a/.github/README.md b/.github/README.md
@@ -24,12 +24,27 @@ the API looks quite the same despite some minor changes.
 * [Reposilite](https://github.com/dzikoysk/reposilite) - real world app using Javalin and OpenApi integration
 
 ### Repository structure
-* `openapi-annotation-processor` - compile-time annotation processor, should generate `/openapi-plugin/openapi.json` resource
-* `openapi-specification` - annotations & classes used to describe OpenAPI specification
-* `openapi-test` - example Javalin application that uses OpenApi plugin in Gradle & Maven
 
-Javalin:
+#### Universal modules
 
-* `javalin-openapi-plugin` - loads `/openapi-plugin/openapi.json` resource and serves main OpenApi endpoint
-* `javalin-swagger-plugin` - serves Swagger UI
-* `javalin-redoc-plugin` - serves ReDoc UI
+| Module                         | Description                                                                                |
+|:-------------------------------|:-------------------------------------------------------------------------------------------|
+| `openapi-annotation-processor` | Compile-time annotation processor, should generate `/openapi-plugin/openapi.json` resource |
+| `openapi-specification`        | Annotations & classes used to describe OpenAPI specification                               |
+| `openapi-test`                 | Example Javalin application that uses OpenApi plugin in Gradle & Maven                     |
+
+#### Javalin plugins
+
+| Plugin                   | Description                                                                    |
+|:-------------------------|:-------------------------------------------------------------------------------|
+| `javalin-openapi-plugin` | Loads `/openapi-plugin/openapi.json` resource and serves main OpenApi endpoint |
+| `javalin-swagger-plugin` | Serves Swagger UI                                                              |
+| `javalin-redoc-plugin`   | Serves ReDoc UI                                                                |
+
+#### Branches
+
+| Branch                                                       | Javalin version | OpenApi Version | Java Version |
+|:-------------------------------------------------------------|:----------------|:----------------|:-------------|
+| [main](https://github.com/javalin/javalin-openapi/tree/main) | 6.x             | 6.x             | JDK11        |
+| [5.x](https://github.com/javalin/javalin-openapi/tree/5.x)   | 5.x             | 5.x             | JDK11        |
+| [4.x](https://github.com/javalin/javalin-openapi/tree/4.x)   | 4.x             | 1.x             | JDK8         |
diff --git a/examples/javalin-maven-java/pom.xml b/examples/javalin-maven-java/pom.xml
@@ -12,7 +12,7 @@
         <maven.compiler.source>11</maven.compiler.source>
         <maven.compiler.target>11</maven.compiler.target>
         <javalin.version>5.6.3</javalin.version>
-        <javalin.openapi.version>5.6.3-2</javalin.openapi.version>
+        <javalin.openapi.version>5.6.3-3</javalin.openapi.version>
     </properties>
 
     <repositories>

diff --git a/wiki b/wiki