Skip to content

Commit f72b277

Browse files
nanotaboadaclaude
andcommitted
docs: merge API reference table, fix descriptions, add markdownlint
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 12a1782 commit f72b277

2 files changed

Lines changed: 17 additions & 20 deletions

File tree

.markdownlint.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"MD013": false,
3+
"MD024": {
4+
"siblings_only": true
5+
}
6+
}

README.md

Lines changed: 11 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -141,26 +141,17 @@ Interactive API documentation is available via Swagger UI at `https://localhost:
141141

142142
> 💡 Swagger documentation is only available in development mode for security reasons.
143143
144-
**Quick Reference:**
145-
146-
- `GET /players` - List all players
147-
- `GET /players/{id:Guid}` - Get player by ID (requires authentication)
148-
- `GET /players/squadNumber/{squadNumber:int}` - Get player by squad number
149-
- `POST /players` - Create new player
150-
- `PUT /players/squadNumber/{squadNumber:int}` - Update player
151-
- `DELETE /players/squadNumber/{squadNumber:int}` - Remove player
152-
- `GET /health` - Health check
153-
154-
**Response Codes:**
155-
156-
| Code | Description |
157-
| ---- | ----------- |
158-
| `200 OK` | Successful GET/PUT |
159-
| `201 Created` | Successful POST |
160-
| `204 No Content` | Successful DELETE |
161-
| `400 Bad Request` | Validation failed |
162-
| `404 Not Found` | Player not found |
163-
| `409 Conflict` | Duplicate squad number on POST |
144+
| Method | Endpoint | Description | Status |
145+
| ------ | -------- | ----------- | ------ |
146+
| `GET` | `/players` | List all players | `200 OK` |
147+
| `GET` | `/players/{id:Guid}` | Get player by ID *(requires authentication)* | `200 OK` |
148+
| `GET` | `/players/squadNumber/{squadNumber:int}` | Get player by squad number | `200 OK` |
149+
| `POST` | `/players` | Create new player | `201 Created` |
150+
| `PUT` | `/players/squadNumber/{squadNumber:int}` | Update player by squad number | `200 OK` |
151+
| `DELETE` | `/players/squadNumber/{squadNumber:int}` | Remove player by squad number | `204 No Content` |
152+
| `GET` | `/health` | Health check | `200 OK` |
153+
154+
Error codes: `400 Bad Request` (validation failed) · `404 Not Found` (player not found) · `409 Conflict` (duplicate squad number on `POST`)
164155

165156
For complete endpoint documentation with request/response schemas, explore the [interactive Swagger UI](https://localhost:9000/swagger/index.html).
166157

0 commit comments

Comments
 (0)