Skip to content

Commit 662e7cf

Browse files
nanotaboadaclaude
andcommitted
fix(docs): correct OpenAPI path and CD validation description (#297)
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 5314eff commit 662e7cf

2 files changed

Lines changed: 4 additions & 3 deletions

File tree

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ Interactive API documentation is available via Swagger UI at `http://localhost:9
153153

154154
Error codes: `400 Bad Request` (validation failed) · `404 Not Found` (player not found) · `409 Conflict` (duplicate squad number on `POST`)
155155

156-
For complete endpoint documentation with request/response schemas, explore the [interactive Swagger UI](http://localhost:9000/swagger/index.html). You can also access the OpenAPI JSON specification at `http://localhost:9000/v3/api-docs`.
156+
For complete endpoint documentation with request/response schemas, explore the [interactive Swagger UI](http://localhost:9000/swagger/index.html). You can also access the OpenAPI JSON specification at `http://localhost:9000/docs`.
157157

158158
## Prerequisites
159159

@@ -196,7 +196,7 @@ Once the application is running, you can access:
196196

197197
- **API Server**: `http://localhost:9000`
198198
- **Swagger UI**: `http://localhost:9000/swagger/index.html`
199-
- **OpenAPI Spec**: `http://localhost:9000/v3/api-docs`
199+
- **OpenAPI Spec**: `http://localhost:9000/docs`
200200
- **Health Check**: `http://localhost:9001/actuator/health`
201201

202202
## Containers
@@ -257,6 +257,7 @@ server.port=9000
257257
management.server.port=9001
258258
spring.datasource.url=jdbc:sqlite:storage/players-sqlite3.db
259259
springdoc.swagger-ui.path=/swagger/index.html
260+
springdoc.api-docs.path=/docs
260261
```
261262

262263
### Testing

RELEASES.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ git push origin v1.0.0-arsenal
5353

5454
Pushing the tag triggers the CD workflow which automatically:
5555

56-
1. Validates the club name
56+
1. Validates tag format (semver and club name)
5757
2. Builds and tests the project with Maven
5858
3. Publishes Docker images to GitHub Container Registry with three tags
5959
4. Creates a GitHub Release with auto-generated changelog from commits

0 commit comments

Comments
 (0)