Spring Boot compatibility matrix

[breun]

Is your feature request related to a problem? Please describe.

• Spring Boot does not provide a backwards compatibility guarantee across minor version updates. Spring Boot 3.4 contains breaking changes compared to Spring Boot 3.3, which in turns contains breaking changes compared to Spring Boot 3.2, etc. These changes may or may not be relevant for Springdoc OpenAPI. Springdoc OpenAPI bumps its dependency on Spring Boot in minor version updates, which means that Springdoc OpenAPI minor releases are not necessarily guaranteed to be backwards compatible across Spring Boot versions.
• It is currently not easy to determine which version of Springdoc OpenAPI uses which version of Spring Boot. The release notes mention when the Spring Boot dependency is updated, but as a user I need to manually go through all release notes to find which version of Springdoc OpenAPI uses a particular Spring Boot minor version.

Describe the solution you'd like

I'd like to see a Spring Boot compatibility matrix in this project's documentation and README.md. This would allow users to immediate see what version they should use for a particular project. I think the the compatibility matrix provided by Spring Cloud GCP is good example.

The Spring Boot compatibility matrix could look something like this:

Spring Boot version	Compatible Springdoc OpenAPI versions	Support status
3.4.x	2.7.x	Supported
3.3.x	2.6.x	?
3.2.x	2.3.x - 2.5.x	?
3.1.x	2.2.x	?
3.0.x	2.0.x - 2.1.x	?

[bnasslahsen]

@breun,

Did you read this: https://springdoc.org/#what-is-the-compatibility-matrix-of-springdoc-openapi-with-spring-boot ?

[bnasslahsen]

@breun,

This you read this: https://springdoc.org/#what-is-the-compatibility-matrix-of-springdoc-openapi-with-spring-boot ?

[breun]

Ah thanks, I hadn't found that yet.

I don't see entries for Spring Boot 3.1, 3.2 and 3.3 in that table though?

Also, this table lists minimum Springdoc OpenAPI versions, but doesn't mention maximum versions. For example, the table says that Spring Boot 3.0.x requires Springdoc OpenAPI 2.0.x or later, which implies that for instance Springdoc OpenAPI 2.6.0 (which is based on Spring Boot 3.3) is compatible with Spring Boot 3.0.x, but is that actually guaranteed and verified to be the case?

[bnasslahsen]

@breun,

Can you propose the update on this file, on what you are expecting and i will review it:

• https://github.com/springdoc/springdoc.github.io/blob/master/src/docs/asciidoc/faq.adoc

[breun]

I created a pull request with my proposal: #85

I wasn't able to run Maven for this project to also update the committed HTML file. I got this error:

[ERROR] Failed to execute goal on project docs: Could not collect dependencies for project org.springdoc:docs:jar:3.1.2-SNAPSHOT
[ERROR] Failed to read artifact descriptor for io.spring.docresources:spring-doc-resources:zip:0.2.5
[ERROR]         Caused by: The following artifacts could not be resolved: io.spring.docresources:spring-doc-resources:pom:0.2.5 (absent): Could not transfer artifact io.spring.docresources:spring-doc-resources:pom:0.2.5 from/to spring-release (https://repo.spring.io/release): status code: 401, reason phrase:  (401)

[bnasslahsen]

@breun,

No worries, it should be updated in the online docs now.