Skip to content

Commit 20e93a9

Browse files
docs: update swagger and readme
1 parent ec9bc98 commit 20e93a9

14 files changed

Lines changed: 7385 additions & 1651 deletions

README.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
║ PROSTAFF API — Ruby on Rails 7.2 (API-Only) ║
3131
╠══════════════════════════════════════════════════════════════════════════════╣
3232
║ Backend da plataforma ProStaff.gg para gestão de equipes de esports. ║
33-
170+ endpoints documentados · JWT Auth · Modular Monolith · p95 ~500ms ║
33+
200+ endpoints documentados · JWT Auth · Modular Monolith · p95 ~500ms ║
3434
╚══════════════════════════════════════════════════════════════════════════════╝
3535
```
3636

@@ -43,7 +43,7 @@
4343
┌─────────────────────────────────────────────────────────────────────────────┐
4444
│ [■] JWT Authentication — Refresh tokens + token blacklisting │
4545
│ [■] HashID URLs — Base62 encoding para URLs ofuscadas │
46-
│ [■] Swagger Docs — 170+ endpoints documentados interativamente │
46+
│ [■] Swagger Docs — 200+ endpoints documentados interativamente │
4747
│ [■] Riot Games API — Import automático de partidas e jogadores │
4848
│ [■] Advanced Analytics — KDA trends, champion pools, vision control │
4949
│ [■] Scouting System — Talent discovery + watchlist management │
@@ -538,12 +538,15 @@ http://localhost:3333/api-docs
538538

539539
```bash
540540
# Run integration specs and generate Swagger docs
541-
bundle exec rake rswag:specs:swaggerize
541+
RSWAG_GENERATE=1 bundle exec rake rswag:specs:swaggerize
542542

543543
# Or run specs individually
544544
bundle exec rspec spec/integration/
545545
```
546546

547+
> **Note:** `RSWAG_GENERATE=1` bypasses the local test-DB requirement — the
548+
> swagger formatter uses `--dry-run` so no database queries are executed.
549+
547550
Generated file: `swagger/v1/swagger.yaml`
548551

549552
### Base URL
@@ -769,7 +772,7 @@ Integration tests serve dual purpose:
769772

770773
```bash
771774
# Run integration tests and generate Swagger docs
772-
bundle exec rake rswag:specs:swaggerize
775+
RSWAG_GENERATE=1 bundle exec rake rswag:specs:swaggerize
773776

774777
# Run specific integration spec
775778
bundle exec rspec spec/integration/players_spec.rb
@@ -795,9 +798,17 @@ bundle exec rspec spec/integration/players_spec.rb
795798
║ Competitive ║ 14 ║
796799
║ Scrims ║ 14 ║
797800
║ Strategy ║ 16 ║
798-
║ Support ║ 15 ║
801+
║ Support ║ 16 ║
802+
║ Admin ║ 9 ║
803+
║ Notifications ║ 6 ║
804+
║ Profile ║ 4 ║
805+
║ Rosters ║ 4 ║
806+
║ Team Members ║ 1 ║
807+
║ Messages ║ 2 ║
808+
║ Constants ║ 1 ║
809+
║ Fantasy ║ 2 ║
799810
╠══════════════════════════╬════════════════════╣
800-
║ TOTAL ║ 170+ endpoints ║
811+
║ TOTAL ║ 200+ endpoints ║
801812
╚══════════════════════════╩════════════════════╝
802813
```
803814

0 commit comments

Comments
 (0)