Skip to content

Commit 7e80eaf

Browse files
committed
docs: align compatibility messaging (Java 17+, Spring Boot 3.4/3.5) and update badges/cover
1 parent e27f3af commit 7e80eaf

5 files changed

Lines changed: 39 additions & 15 deletions

File tree

CONTRIBUTING.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ This repository provides a **contract-first, generics-aware OpenAPI platform**,
77
88
Built with:
99

10-
* Java 21
11-
* Spring Boot 3.5.x
10+
* Java 17+
11+
* Spring Boot 3.4.x, 3.5.x
1212
* OpenAPI Generator 7.x
1313

1414
> Be kind. Be constructive. See our [Code of Conduct](./CODE_OF_CONDUCT.md).
@@ -76,7 +76,7 @@ git checkout -b feature/scope-short-title
7676

7777
### Prerequisites
7878

79-
* Java 21
79+
* Java 17+ (21 recommended)
8080
* Maven 3.9+
8181

8282
### Build (core platform)
@@ -137,6 +137,8 @@ Notes:
137137

138138
## Architecture principles (important)
139139

140+
> These are not guidelines — they are invariants.
141+
140142
This project follows strict boundaries:
141143

142144
### 1. Contract is the source of truth

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
[![Release](https://img.shields.io/github/v/release/blueprint-platform/openapi-generics?label=release&logo=github)](https://github.com/blueprint-platform/openapi-generics/releases/latest)
55
[![CodeQL](https://github.com/blueprint-platform/openapi-generics/actions/workflows/codeql.yml/badge.svg)](https://github.com/blueprint-platform/openapi-generics/actions/workflows/codeql.yml)
66
[![codecov](https://codecov.io/gh/blueprint-platform/openapi-generics/branch/main/graph/badge.svg)](https://codecov.io/gh/blueprint-platform/openapi-generics)
7-
[![Java](https://img.shields.io/badge/Java-21-red?logo=openjdk)](https://openjdk.org/projects/jdk/21/)
8-
[![Spring Boot](https://img.shields.io/badge/Spring%20Boot-3.5.x-green?logo=springboot)](https://spring.io/projects/spring-boot)
7+
[![Java](https://img.shields.io/badge/Java-17%2B-red?logo=openjdk)](https://openjdk.org/)
8+
[![Spring Boot](https://img.shields.io/badge/Spring%20Boot-3.4.x%20%7C%203.5.x-green?logo=springboot)](https://spring.io/projects/spring-boot)
99
[![OpenAPI Generator](https://img.shields.io/badge/OpenAPI%20Generator-7.x-blue?logo=openapiinitiative)](https://openapi-generator.tech/)
1010
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
1111

@@ -109,14 +109,15 @@ Inherit the parent:
109109

110110
That’s it.
111111

112-
Everything else in this repository is a **reference implementation of this setup**.
112+
Everything else in this repository is a **reference implementation of this setup**.
113+
For detailed setup and advanced usage, see the [Adoption Guides](#adoption-guides).
113114

114115
---
115116

116117
## ⚡ Quick Start (2 minutes)
117118

118-
> Requires Spring Boot 3.4+ and OpenAPI Generator 7.x
119-
> See module documentation for compatibility details.
119+
> Requires Java 17+, Spring Boot 3.4.x / 3.5.x, and OpenAPI Generator 7.x
120+
> See module documentation for full compatibility details.
120121
121122
This repository demonstrates a **contract-first, generics-aware API lifecycle**.
122123

docs/images/cover/cover.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -166,25 +166,25 @@ <h1 class="title">
166166
</div>
167167

168168
<div class="badges" aria-label="Tech badges">
169-
<span class="badge green" title="Spring Boot 3.5.x">
169+
<span class="badge green" title="Spring Boot 3.4.x / 3.5.x">
170170
<svg viewBox="0 0 24 24" fill="none"><path d="M12 3l9 5v8l-9 5-9-5V8l9-5z" fill="#16a34a"/></svg>
171-
Spring Boot&nbsp;3.5.x
171+
Spring Boot&nbsp;3.4.x&nbsp;|&nbsp;3.5.x
172172
</span>
173173
<span class="badge blue" title="OpenAPI Generator 7.x">
174174
<svg viewBox="0 0 24 24" fill="none"><circle cx="12" cy="12" r="10" fill="#2563eb"/></svg>
175175
OpenAPI Generator&nbsp;7.x
176176
</span>
177-
<span class="badge yellow" title="Java 21">
177+
<span class="badge yellow" title="Java 17+">
178178
<svg viewBox="0 0 24 24" fill="none"><path d="M4 18h16M6 14h12M8 10h8M10 6h4" stroke="#a16207" stroke-width="2" stroke-linecap="round"/></svg>
179-
Java&nbsp;21
179+
Java&nbsp;17+
180180
</span>
181181
</div>
182182
</div>
183183

184184
<div class="footer">
185185
<span>One Contract. Zero Drift.</span>
186186
<span class="sep"></span>
187-
<span>github.com/bsayli</span>
187+
<span>github.com/blueprint-platform/openapi-generics</span>
188188
</div>
189189
</section>
190190
</body>

docs/images/cover/cover.png

7.99 KB
Loading

docs/index.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,11 @@ nav_order: 1
1515

1616
- [Why this exists](#why-this-exists)
1717
- [What you actually do](#what-you-actually-do)
18-
- [Quick Start](#-quick-start)
18+
- [Quick Start](#-quick-start)
1919
- [1. Server (producer)](#1-server-producer)
2020
- [2. Client (consumer)](#2-client-consumer)
2121
- [Result](#result)
22+
- [Compatibility Matrix](#-compatibility-matrix)
2223
- [Proof — Generated Client (Before vs After)](#proof--generated-client-before-vs-after)
2324
- [Before (default OpenAPI behavior)](#before-default-openapi-behavior)
2425
- [After (contract-aligned generation)](#after-contract-aligned-generation)
@@ -29,7 +30,7 @@ nav_order: 1
2930
- [Why this matters](#why-this-matters)
3031
- [Mental model](#mental-model)
3132
- [Next steps](#next-steps)
32-
- [🔗 References & External Links](#-references--external-links)
33+
- [References & External Links](#-references--external-links)
3334
- [Final note](#final-note)
3435

3536
---
@@ -125,6 +126,26 @@ The exact same contract type flows from server to client.
125126

126127
---
127128

129+
## 🔧 Compatibility Matrix
130+
131+
This platform is designed for a **stable, production-proven stack**.
132+
133+
### Runtime (Server)
134+
135+
| Component | Supported Versions |
136+
|--------------------|--------------------------|
137+
| Java | 17+ |
138+
| Spring Boot | 3.4.x, 3.5.x |
139+
| springdoc-openapi | 2.8.x (WebMvc starter) |
140+
141+
### Build-time (Client Generation)
142+
143+
| Component | Supported Versions |
144+
|--------------------|-------------------|
145+
| OpenAPI Generator | 7.x |
146+
147+
---
148+
128149
## Proof — Generated Client (Before vs After)
129150

130151
### Before (default OpenAPI behavior)

0 commit comments

Comments
 (0)