Skip to content

Commit

Permalink
Add note on version compatibility
Browse files Browse the repository at this point in the history
  • Loading branch information
Oliver Zscheyge committed Jan 31, 2023
1 parent 9b84729 commit 9f7318f
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ This is why we came up with this project.

- [Motivation](#motivation)
- [Getting started](#getting-started)
- [Version compatibility](#version-compatibility)
- [Project structure](#project-structure)
- [Build configuration](#build-configuration)
- [Gradle](#gradle)
Expand All @@ -67,6 +68,15 @@ This is why we came up with this project.

## Getting started

### Version compatibility

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)

|Spring Boot version | restdocs-api-spec version|
|---|---|
|3.x|0.17.0 or later|
|2.x|0.16.4|

### Project structure

The project consists of the following main components:
Expand Down

0 comments on commit 9f7318f

Please sign in to comment.