@@ -69,6 +69,124 @@ An OpenAPI documentation is available trough swagger on the `/doc` routes.
6969- When running locally: [ localhost:3000/doc/] ( http://localhost:3000/doc/ )
7070- Deployed version: [ soundhive-api-staging.herokuapp.com/doc/] ( https://soundhive-api-staging.herokuapp.com/doc/ )
7171
72+ For reference here the Module used or provided by the API:
73+
74+ - ` PassportModule `
75+ - ` TypeOrmModule `
76+ - ` LoggerModule `
77+ - ` MinioModule `
78+ - ` JwtModule `
79+ - ` ConfigHostModule `
80+ - ` LoggerCoreModule `
81+ - ` MinioClientModule `
82+ - ` ConfigModule `
83+ - ` TypeOrmCoreModule `
84+ - ` TypeOrmModule `
85+ - ` FollowsModule `
86+ - ` FavoritesModule `
87+ - ` ListeningsModule `
88+ - ` AuthModule `
89+ - ` TicketsModule `
90+ - ` AdminModule `
91+ - ` AppModule `
92+ - ` AlbumsModule `
93+ - ` PlaylistsModule `
94+ - ` UsersModule `
95+ - ` SamplesModule `
96+ - ` TracksModule `
97+
98+ Controllers:
99+
100+ - ` AppController `
101+ - ` UsersController `
102+ - ` TracksController `
103+ - ` AlbumsController `
104+ - ` SamplesController `
105+ - ` PlaylistsController `
106+ - ` AdminController `
107+ - ` TicketsController `
108+
109+ Routes:
110+
111+ | Method | path |
112+ | -------- | -------------------------------------------- |
113+ | ` POST ` | ` /auth/login ` |
114+ | ` GET ` | ` /profile ` |
115+ | ` GET ` | ` / ` |
116+ | ` POST ` | ` /users ` |
117+ | ` PUT ` | ` /users/:username ` |
118+ | ` GET ` | ` /users ` |
119+ | ` GET ` | ` /users/:username ` |
120+ | ` GET ` | ` /users/:username/tracks ` |
121+ | ` GET ` | ` /users/:username/albums ` |
122+ | ` GET ` | ` /users/:username/stats ` |
123+ | ` GET ` | ` /users/:username/stats/last/:count/:period ` |
124+ | ` GET ` | ` /users/:username/samples ` |
125+ | ` GET ` | ` /users/:username/followings ` |
126+ | ` GET ` | ` /users/:username/followings/tracks ` |
127+ | ` GET ` | ` /users/:username/followings/albums ` |
128+ | ` GET ` | ` /users/:username/followers ` |
129+ | ` POST ` | ` /users/:username/follow ` |
130+ | ` DELETE ` | ` /users/:username/follow ` |
131+ | ` GET ` | ` /users/:username/favorites ` |
132+ | ` GET ` | ` /users/:username/history ` |
133+ | ` GET ` | ` /users/:username/playlists ` |
134+ | ` POST ` | ` /tracks ` |
135+ | ` PUT ` | ` /tracks/:id ` |
136+ | ` GET ` | ` /tracks ` |
137+ | ` GET ` | ` /tracks/charts ` |
138+ | ` GET ` | ` /tracks/:id ` |
139+ | ` GET ` | ` /tracks/:id/stats ` |
140+ | ` GET ` | ` /tracks/:id/stats/last/:count/:period ` |
141+ | ` POST ` | ` /tracks/:id/listen ` |
142+ | ` DELETE ` | ` /tracks/:id ` |
143+ | ` POST ` | ` /tracks/:id/favorite ` |
144+ | ` DELETE ` | ` /tracks/:id/favorite ` |
145+ | ` GET ` | ` /tracks/:id/isfavorited ` |
146+ | ` GET ` | ` /tracks/:id/favoriters ` |
147+ | ` POST ` | ` /albums ` |
148+ | ` GET ` | ` /albums ` |
149+ | ` GET ` | ` /albums/:id ` |
150+ | ` GET ` | ` /albums/:id/tracks ` |
151+ | ` PUT ` | ` /albums/:id ` |
152+ | ` DELETE ` | ` /albums/:id ` |
153+ | ` POST ` | ` /samples ` |
154+ | ` PUT ` | ` /samples/:id ` |
155+ | ` GET ` | ` /samples ` |
156+ | ` GET ` | ` /samples/:id ` |
157+ | ` POST ` | ` /samples/:id/listen ` |
158+ | ` DELETE ` | ` /samples/:id ` |
159+ | ` POST ` | ` /playlists ` |
160+ | ` GET ` | ` /playlists ` |
161+ | ` GET ` | ` /playlists/:id ` |
162+ | ` GET ` | ` /playlists/:id/tracks ` |
163+ | ` PUT ` | ` /playlists/:id ` |
164+ | ` DELETE ` | ` /playlists/:id ` |
165+ | ` POST ` | ` /playlists/:id/add-track ` |
166+ | ` POST ` | ` /admin/album ` |
167+ | ` PUT ` | ` /admin/album/:id ` |
168+ | ` DELETE ` | ` /admin/album/:id ` |
169+ | ` POST ` | ` /admin/playlist ` |
170+ | ` PUT ` | ` /admin/playlist/:id ` |
171+ | ` DELETE ` | ` /admin/playlist/:id ` |
172+ | ` POST ` | ` /admin/sample ` |
173+ | ` PUT ` | ` /admin/sample/:id ` |
174+ | ` DELETE ` | ` /admin/sample/:id ` |
175+ | ` POST ` | ` /admin/track ` |
176+ | ` PUT ` | ` /admin/track/:id ` |
177+ | ` DELETE ` | ` /admin/track/:id ` |
178+ | ` PUT ` | ` /admin/user/:username ` |
179+ | ` DELETE ` | ` /admin/user/:username ` |
180+ | ` POST ` | ` /admin/ticket/:id/comment ` |
181+ | ` POST ` | ` /admin/ticket/:id/assign ` |
182+ | ` POST ` | ` /admin/ticket/:id/close ` |
183+ | ` POST ` | ` /tickets ` |
184+ | ` GET ` | ` /tickets ` |
185+ | ` GET ` | ` /tickets/:id ` |
186+ | ` POST ` | ` /tickets/:id/comment ` |
187+
188+ Details for routes such as input/output properties and types are detailed in the doc mentioned beforehand.
189+
72190### Admin
73191
74192The admin functionality is still limited but you can still toggle the ` isAdmin ` column for your user in the database to access the ` /admin ` routes.
0 commit comments