Merge branch 'main' of https://github.com/JorgeRuizDev/SpotMyFM

JorgeRuizDev · Jul 7, 2022 · 6ba0d19 · 6ba0d19
2 parents efdae5e + 36903dd
commit 6ba0d19
Show file tree

Hide file tree

Showing 3 changed files with 111 additions and 107 deletions.
diff --git a/Docs/Latex/README.md b/Docs/Latex/README.md
@@ -2,27 +2,26 @@
 
 La plantilla se compone de dos documentos maestros: uno para la memoria y otro para los anexos.
 
-- Memoría: ```memoria.tex```
-- Anexos: ```anexos.tex```
+- Memoría: `memoria.tex`
+- Anexos: `anexos.tex`
 
-En la carpeta ```tex``` se encuentran los distintos documentos que forman los documentos maestros. 
+En la carpeta `tex` se encuentran los distintos documentos que forman los documentos maestros.
 Dichos documentos contienen las secciones y subsecciones a completar.
-En el documento ```3_Conceptos_teoricos.tex``` se encuentra una breve guía de como usar LaTeX y los comandos propios de esta plantilla.
+En el documento `3_Conceptos_teoricos.tex` se encuentra una breve guía de como usar LaTeX y los comandos propios de esta plantilla.
 
 # Creación y edición de documentos en LaTeX
 
-LaTeX es un lenguaje de marcado. 
+LaTeX es un lenguaje de marcado.
 Para crear y editar documentos en LaTeX se necesita un editor de LaTeX, que puede estar instalado en nuestro ordenador http://www.xm1math.net/texmaker/, o puede tratarse de un servicio web https://www.overleaf.com/.
 
-Un videotutorial de la instalación de Miktex + TexMaker en windows puede verse en 
+Un videotutorial de la instalación de Miktex + TexMaker en windows puede verse en
 https://www.youtube.com/watch?v=DIdHfVpIiAk
 
 # Petición de cambios y sugerencias
 
 Se ruega a los alumnos y tutores que detecten fallos o que quieran proponer una sugerencia, que lo notifiquen mediante la creación de una issue https://github.com/ubutfgm/plantillaLatex/issues
 
 # Gracias a los contribuidores
+
 César Ignacio García Osorio, Álvar Arnaiz Gonzalez, José Francisco Díez Pastor, Carlos Lopez Nozal.
 Álvaro López Cantero, Roberto Izquierdo Amo, David Miguel Lozano.
-
-
diff --git a/Docs/Latex/manual/home.md b/Docs/Latex/manual/home.md
@@ -1,2 +1,3 @@
 # Página Principal
-![](img/home/home.png)
+
+![](img/home/home.png)
diff --git a/Docs/Latex/markdown/next.md b/Docs/Latex/markdown/next.md
@@ -1,11 +1,13 @@
 # SpotMyFM Api Specification
+
 The SpotMyFM OpenAPI Swagger Specification
 
 ## Version: 0.1.9
 
 ### /database/albums/tagAlbums
 
 #### GET
+
 ##### Summary:
 
 Gets the tagged albums and their tags from the user
@@ -15,22 +17,22 @@ Gets the tagged albums and their tags from the user
 Gets the tagged albums and their tags from the user.
 The user is identified with the JWT Token
 
-
 ##### Responses
 
-| Code | Description |
-| ---- | ----------- |
-| 200 | The album tags were retrieved. |
-| 400 | Bad Request |
-| 403 | Not Authorized (Bad Token) |
+| Code | Description                    |
+| ---- | ------------------------------ |
+| 200  | The album tags were retrieved. |
+| 400  | Bad Request                    |
+| 403  | Not Authorized (Bad Token)     |
 
 ##### Security
 
 | Security Schema | Scopes |
-| --- | --- |
-| jwt | |
+| --------------- | ------ |
+| jwt             |        |
 
 #### POST
+
 ##### Summary:
 
 Updates the album tags
@@ -41,24 +43,24 @@ Updates the album tags
 The user is identified with the JWT Token
 There is a limit of 50 album tags per request
 
-
 ##### Responses
 
-| Code | Description |
-| ---- | ----------- |
-| 200 | The album tags were retrieved. |
-| 400 | Bad Request |
-| 403 | Not Authorized (Bad Token) |
+| Code | Description                    |
+| ---- | ------------------------------ |
+| 200  | The album tags were retrieved. |
+| 400  | Bad Request                    |
+| 403  | Not Authorized (Bad Token)     |
 
 ##### Security
 
 | Security Schema | Scopes |
-| --- | --- |
-| jwt | |
+| --------------- | ------ |
+| jwt             |        |
 
 ### /database/user/drop
 
 #### POST
+
 ##### Summary:
 
 Drops the current user document identified by the JWT Token
@@ -67,24 +69,24 @@ Drops the current user document identified by the JWT Token
 
 This endpoint tries to remove all the stored user's data from the database.
 
-
 ##### Responses
 
-| Code | Description |
-| ---- | ----------- |
-| 200 | The user was successfully removed from the database. |
-| 400 | Bad Request |
-| 403 | Not Authorized (Bad Token) |
+| Code | Description                                          |
+| ---- | ---------------------------------------------------- |
+| 200  | The user was successfully removed from the database. |
+| 400  | Bad Request                                          |
+| 403  | Not Authorized (Bad Token)                           |
 
 ##### Security
 
 | Security Schema | Scopes |
-| --- | --- |
-| jwt | |
+| --------------- | ------ |
+| jwt             |        |
 
 ### /lastFM/getBulkAlbumTags
 
 #### POST
+
 ##### Summary:
 
 Gets album tags of given album names and artists
@@ -95,21 +97,22 @@ The endpoint only alllows a maximum of 50 pairs artist-album per request.
 
 ##### Responses
 
-| Code | Description |
-| ---- | ----------- |
-| 200 | A successful operation. |
-| 400 | Bad Request |
-| 403 | Not Authorized |
+| Code | Description             |
+| ---- | ----------------------- |
+| 200  | A successful operation. |
+| 400  | Bad Request             |
+| 403  | Not Authorized          |
 
 ##### Security
 
 | Security Schema | Scopes |
-| --- | --- |
-| jwt | |
+| --------------- | ------ |
+| jwt             |        |
 
 ### /ludwig/track/bulk
 
 #### POST
+
 ##### Summary:
 
 Analyzes a bulk of songs
@@ -120,21 +123,22 @@ This endpoint analyzes as bulk of songs, extracting the genre, subgenres and moo
 
 ##### Responses
 
-| Code | Description |
-| ---- | ----------- |
-| 200 | A successful operation. |
-| 400 | Bad Request |
-| 403 | Not Authorized |
+| Code | Description             |
+| ---- | ----------------------- |
+| 200  | A successful operation. |
+| 400  | Bad Request             |
+| 403  | Not Authorized          |
 
 ##### Security
 
 | Security Schema | Scopes |
-| --- | --- |
-| jwt | |
+| --------------- | ------ |
+| jwt             |        |
 
 ### /spotify/oauth2/auth
 
 #### POST
+
 ##### Summary:
 
 Obtains the Spotify Auth Code used in OAUTH2
@@ -146,20 +150,21 @@ This endpoint retrieves the authorization code from Spotify Api that is used in
 It also serves as the main auth pipeline of SpotMyFM as it generates the JWS token used along all the endpoints.
 
 Requirements:
-  - Response Code
-  - Authorized Url Callback
 
+- Response Code
+- Authorized Url Callback
 
 ##### Responses
 
-| Code | Description |
-| ---- | ----------- |
-| 200 | The Auth and JWT Token have been generated |
-| 400 | Bad Request |
+| Code | Description                                |
+| ---- | ------------------------------------------ |
+| 200  | The Auth and JWT Token have been generated |
+| 400  | Bad Request                                |
 
 ### /spotify/oauth2/refresh
 
 #### POST
+
 ##### Summary:
 
 Obtains the Spotify Auth Code used in OAUTH2 given a Valid Refresh Token
@@ -171,104 +176,103 @@ This endpoint refreshes the authorization code from Spotify Api that is used in
 It also serves as the main refresh token pipeline of SpotMyFM as it generates the JWS token used along all the endpoints.
 
 Requirements:
-  - Refresh Token (obtained from /spotify/oauth2/auth)
 
+- Refresh Token (obtained from /spotify/oauth2/auth)
 
 ##### Responses
 
-| Code | Description |
-| ---- | ----------- |
-| 200 | The Auth and JWT Token have been generated |
-| 400 | Bad Request |
+| Code | Description                                |
+| ---- | ------------------------------------------ |
+| 200  | The Auth and JWT Token have been generated |
+| 400  | Bad Request                                |
 
 ### Models
 
-
 #### Error
 
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| error | string |  | No |
+| Name  | Type   | Description | Required |
+| ----- | ------ | ----------- | -------- |
+| error | string |             | No       |
 
 #### Ok
 
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| message | string |  | No |
+| Name    | Type   | Description | Required |
+| ------- | ------ | ----------- | -------- |
+| message | string |             | No       |
 
 #### PutAlbumTagsReq
 
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| tags | [ object ] |  | Yes |
+| Name | Type       | Description | Required |
+| ---- | ---------- | ----------- | -------- |
+| tags | [ object ] |             | Yes      |
 
 #### MirResult
 
 Music Information Retrieval Result (includes the confidence of each label)
 
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| label | string |  | No |
-| confidence | number |  | No |
+| Name       | Type   | Description | Required |
+| ---------- | ------ | ----------- | -------- |
+| label      | string |             | No       |
+| confidence | number |             | No       |
 
 #### MirRequest
 
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| moods | boolean | If the result should include moods | No |
-| genres | boolean | If the result should include genres and subgenres. | No |
-| tracks | [ object ] |  | Yes |
+| Name   | Type       | Description                                        | Required |
+| ------ | ---------- | -------------------------------------------------- | -------- |
+| moods  | boolean    | If the result should include moods                 | No       |
+| genres | boolean    | If the result should include genres and subgenres. | No       |
+| tracks | [ object ] |                                                    | Yes      |
 
 #### LudwigRes
 
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| tracks | [ object ] |  | Yes |
+| Name   | Type       | Description | Required |
+| ------ | ---------- | ----------- | -------- |
+| tracks | [ object ] |             | Yes      |
 
 #### AlbumTagsRes
 
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| tags | [ object ] |  | Yes |
+| Name | Type       | Description | Required |
+| ---- | ---------- | ----------- | -------- |
+| tags | [ object ] |             | Yes      |
 
 #### SpotifyRefreshReq
 
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| refreshToken | string | OAUTH2 Refresh Token obtained from /spotify/oauth2/auth | Yes |
+| Name         | Type   | Description                                             | Required |
+| ------------ | ------ | ------------------------------------------------------- | -------- |
+| refreshToken | string | OAUTH2 Refresh Token obtained from /spotify/oauth2/auth | Yes      |
 
 #### SpotifyAuthReq
 
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| redirectUri | string | Redirect Uri (Same as Response Code) | Yes |
-| responseCode | string | Response Code from the Spotify Server | Yes |
+| Name         | Type   | Description                           | Required |
+| ------------ | ------ | ------------------------------------- | -------- |
+| redirectUri  | string | Redirect Uri (Same as Response Code)  | Yes      |
+| responseCode | string | Response Code from the Spotify Server | Yes      |
 
 #### SpotifyAuthRes
 
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| access_token | string | Valid Spotify Token | Yes |
-| expires_in | number | Token TTL (in seconds) | Yes |
-| token | string | Signed JWT used in every endpoint as Auth. | No |
-| refresh_token | string | Token used in the /spotify/refresh endpoint | Yes |
-| token_type | string | Http token Type (Possibly "Bearer") | Yes |
+| Name          | Type   | Description                                 | Required |
+| ------------- | ------ | ------------------------------------------- | -------- |
+| access_token  | string | Valid Spotify Token                         | Yes      |
+| expires_in    | number | Token TTL (in seconds)                      | Yes      |
+| token         | string | Signed JWT used in every endpoint as Auth.  | No       |
+| refresh_token | string | Token used in the /spotify/refresh endpoint | Yes      |
+| token_type    | string | Http token Type (Possibly "Bearer")         | Yes      |
 
 #### LastFMTagReq
 
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| albums | [ object ] |  | Yes |
+| Name   | Type       | Description | Required |
+| ------ | ---------- | ----------- | -------- |
+| albums | [ object ] |             | Yes      |
 
 #### LastFMTagResponse
 
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| album_tags | [ [LastFMTag](#lastfmtag) ] |  | Yes |
+| Name       | Type                        | Description | Required |
+| ---------- | --------------------------- | ----------- | -------- |
+| album_tags | [ [LastFMTag](#lastfmtag) ] |             | Yes      |
 
 #### LastFMTag
 
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| album_id | string |  | No |
-| tags | [ object ] |  | No |
+| Name     | Type       | Description | Required |
+| -------- | ---------- | ----------- | -------- |
+| album_id | string     |             | No       |
+| tags     | [ object ] |             | No       |