You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This is an extension that adds API specifications as an output format to [Spring REST Docs](https://projects.spring.io/spring-restdocs/).
@@ -41,6 +39,7 @@ This is why we came up with this project.
41
39
42
40
-[Motivation](#motivation)
43
41
-[Getting started](#getting-started)
42
+
-[Version compatibility](#version-compatibility)
44
43
-[Project structure](#project-structure)
45
44
-[Build configuration](#build-configuration)
46
45
-[Gradle](#gradle)
@@ -67,6 +66,15 @@ This is why we came up with this project.
67
66
68
67
## Getting started
69
68
69
+
### Version compatibility
70
+
71
+
Spring Boot and Spring REST Docs 3.0.0 introduced [breaking chances to how request parameters are documented: `RequestParameterSnippet` was split into `QueryParameterSnippet` and `FormParameterSnippet`.](https://github.com/spring-projects/spring-restdocs/issues/832)
72
+
73
+
|Spring Boot version | restdocs-api-spec version|
74
+
|---|---|
75
+
|3.x|0.17.1 or later|
76
+
|2.x|0.16.4|
77
+
70
78
### Project structure
71
79
72
80
The project consists of the following main components:
@@ -591,7 +599,7 @@ This section of the README is targeted at project maintainers.
591
599
592
600
### Publish project
593
601
594
-
The project is published with the help of [TravisCI](./.travis.yml).
602
+
~~The project is published with the help of [TravisCI](./.travis.yml).~~
595
603
It's version number is determined by the Git tags (see [allegro/axion-release-plugin](https://axion-release-plugin.readthedocs.io)).
596
604
The Java dependencies are published to Sonatype with the help of the [gradle-nexus/publish-plugin](https://github.com/gradle-nexus/publish-plugin) and the Maven Publish Plugin.
597
605
The Gradle plugin is published to the [Gradle plugin portal](https://plugins.gradle.org/plugin/com.epages.restdocs-api-spec) with the help of the ['plugin-publish' plugin](https://plugins.gradle.org/plugin/com.gradle.plugin-publish) (see [docs.gradle.org](https://docs.gradle.org/current/userguide/publishing_gradle_plugins.html)).
@@ -600,7 +608,7 @@ Given that the `master` branch on the upstream repository is in the state from w
600
608
601
609
1. [Create release via the GitHub UI](https://github.com/ePages-de/restdocs-api-spec/releases/new) <br>
602
610
Use the intended version number as "Tag version", e.g. "0.16.0".
603
-
This will automatically trigger a Travis build which publishes the JAR files for this release to Sonatype.
611
+
~~This will automatically trigger a Travis build which publishes the JAR files for this release to Sonatype.~~
604
612
2. Login to Sonatype and navigate to the [staging repositories](https://oss.sonatype.org/#stagingRepositories)
605
613
3. Close the staging repository <br>
606
614
Select the generated staging repository and close it.
0 commit comments