chore: init commit from GitHub
This commit is contained in:
Lisoveliy
249
SWAD.API/doc.xml
Normal file
249
SWAD.API/doc.xml
Normal file
@@ -0,0 +1,249 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>SWAD.API</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="F:SWAD.API.Consts.Enums.MusicService.Spotify">
|
||||
<summary>
|
||||
Spotify Service
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:SWAD.API.Consts.Enums.MusicService.Tidal">
|
||||
<summary>
|
||||
Tidal Service
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:SWAD.API.Consts.Enums.MusicService.Yandex">
|
||||
<summary>
|
||||
Yandex Service
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:SWAD.API.Consts.Enums.ServiceResult">
|
||||
<summary>
|
||||
Service errors for controller
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:SWAD.API.Consts.Enums.ServiceResult.Success">
|
||||
<summary>
|
||||
Returns on the successful executed state
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:SWAD.API.Consts.Enums.ServiceResult.Failure">
|
||||
<summary>
|
||||
Returns on the unsuccessful executed state
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:SWAD.API.Consts.Enums.ServiceResult.NoResponse">
|
||||
<summary>
|
||||
Returns on the unsuccessful executed state not by code
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:SWAD.API.Consts.Enums.ServiceResult.BadRequest">
|
||||
<summary>
|
||||
Returns on the unsuccessful executed state by user
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:SWAD.API.Consts.Enums.ServiceResult.NotFound">
|
||||
<summary>
|
||||
Returns on the unsuccessful executed state by service
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:SWAD.API.Controllers.DTOs.TrackDto">
|
||||
<summary>
|
||||
Track directly from query
|
||||
</summary>
|
||||
<param Name="Name">Name of track</param>
|
||||
<param Name="Artist">Artist of track</param>
|
||||
<param Name="AlbumObject">AlbumObject of track</param>
|
||||
<param Name="Service">Service provider</param>
|
||||
</member>
|
||||
<member name="M:SWAD.API.Controllers.DTOs.TrackDto.#ctor(System.String,System.String,System.String,SWAD.API.Consts.Enums.MusicService)">
|
||||
<summary>
|
||||
Track directly from query
|
||||
</summary>
|
||||
<param Name="Name">Name of track</param>
|
||||
<param Name="Artist">Artist of track</param>
|
||||
<param Name="AlbumObject">AlbumObject of track</param>
|
||||
<param Name="Service">Service provider</param>
|
||||
</member>
|
||||
<member name="T:SWAD.API.Controllers.DTOs.TrackLinkDto">
|
||||
<summary>
|
||||
Track from service link
|
||||
</summary>
|
||||
<param Name="Link">
|
||||
Spotify example: https://open.spotify.com/track/2K7xn816oNHJZ0aVqdQsha
|
||||
Tidal example: https://tidal.com/track/294942856
|
||||
Yandex.Music example: https://music.yandex.by/Albums/25851387/track/113810002 P.S.: Будда какая параша, даже тут
|
||||
яндекс отличился
|
||||
</param>
|
||||
<param Name="Service">
|
||||
</param>
|
||||
</member>
|
||||
<member name="M:SWAD.API.Controllers.DTOs.TrackLinkDto.#ctor(System.String,SWAD.API.Consts.Enums.MusicService)">
|
||||
<summary>
|
||||
Track from service link
|
||||
</summary>
|
||||
<param Name="Link">
|
||||
Spotify example: https://open.spotify.com/track/2K7xn816oNHJZ0aVqdQsha
|
||||
Tidal example: https://tidal.com/track/294942856
|
||||
Yandex.Music example: https://music.yandex.by/Albums/25851387/track/113810002 P.S.: Будда какая параша, даже тут
|
||||
яндекс отличился
|
||||
</param>
|
||||
<param Name="Service">
|
||||
</param>
|
||||
</member>
|
||||
<member name="T:SWAD.API.Controllers.DTOs.ServiceDto">
|
||||
<summary>
|
||||
Service Name
|
||||
</summary>
|
||||
<param Name="Service">Enum MusicService</param>
|
||||
<param Name="Name">MusicService.ToString</param>
|
||||
</member>
|
||||
<member name="M:SWAD.API.Controllers.DTOs.ServiceDto.#ctor(SWAD.API.Consts.Enums.MusicService,System.String)">
|
||||
<summary>
|
||||
Service Name
|
||||
</summary>
|
||||
<param Name="Service">Enum MusicService</param>
|
||||
<param Name="Name">MusicService.ToString</param>
|
||||
</member>
|
||||
<member name="T:SWAD.API.Controllers.DTOs.LinkResultDto">
|
||||
<summary>
|
||||
Result of GetLink method
|
||||
</summary>
|
||||
<param Name="Link"></param>
|
||||
</member>
|
||||
<member name="M:SWAD.API.Controllers.DTOs.LinkResultDto.#ctor(System.String)">
|
||||
<summary>
|
||||
Result of GetLink method
|
||||
</summary>
|
||||
<param Name="Link"></param>
|
||||
</member>
|
||||
<member name="T:SWAD.API.Controllers.LinkController">
|
||||
<summary>
|
||||
Controller for get links from music providers
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:SWAD.API.Controllers.LinkController.#ctor(SWAD.API.Services.Links.LinksService)">
|
||||
<summary>
|
||||
Controller for get links from music providers
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:SWAD.API.Controllers.LinkController.GetLink(SWAD.API.Controllers.DTOs.TrackLinkDto)">
|
||||
<summary>
|
||||
Get link from other link
|
||||
</summary>
|
||||
<param Name="track">Track query such as Name, artist, Albums</param>
|
||||
<returns>Link for track</returns>
|
||||
</member>
|
||||
<member name="M:SWAD.API.Controllers.LinkController.GetLink(SWAD.API.Controllers.DTOs.TrackDto)">
|
||||
<summary>
|
||||
Get link from search query such as artist and song Name
|
||||
</summary>
|
||||
<param Name="track">Track query such as Name, artist, Albums</param>
|
||||
<returns>Link for track</returns>
|
||||
</member>
|
||||
<member name="M:SWAD.API.Controllers.LinkController.GetServiceOfLink(System.String)">
|
||||
<summary>
|
||||
Get service what uses that link
|
||||
</summary>
|
||||
<param name="link"></param>
|
||||
<returns></returns>
|
||||
<exception cref="T:System.ApplicationException"></exception>
|
||||
</member>
|
||||
<member name="T:SWAD.API.Middlewares.ExceptionMiddleware">
|
||||
<summary>
|
||||
DONT TOUCH THAT!!! Generate good messages for responses and handle to logger exceptions
|
||||
</summary>
|
||||
<param Name="logger"></param>
|
||||
<param Name="env"></param>
|
||||
<param Name="next"></param>
|
||||
</member>
|
||||
<member name="M:SWAD.API.Middlewares.ExceptionMiddleware.#ctor(Microsoft.Extensions.Logging.ILogger{SWAD.API.Middlewares.ExceptionMiddleware},Microsoft.AspNetCore.Hosting.IWebHostEnvironment,Microsoft.AspNetCore.Http.RequestDelegate)">
|
||||
<summary>
|
||||
DONT TOUCH THAT!!! Generate good messages for responses and handle to logger exceptions
|
||||
</summary>
|
||||
<param Name="logger"></param>
|
||||
<param Name="env"></param>
|
||||
<param Name="next"></param>
|
||||
</member>
|
||||
<member name="T:SWAD.API.Models.JsonStructures.MusicAPI.Spotify.SpotifyAuthResponse">
|
||||
<summary>
|
||||
Json Structure for spotify auth response
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:SWAD.API.Models.JsonStructures.MusicAPI.Spotify.SpotifySearchResponse">
|
||||
<summary>
|
||||
Json Structure for spotify search response
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:SWAD.API.Models.JsonStructures.MusicAPI.Spotify.SpotifyTrackResponse">
|
||||
<summary>
|
||||
Json Structure for tidal track response
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:SWAD.API.Models.JsonStructures.MusicAPI.Tidal.TidalTrackResponse">
|
||||
<summary>
|
||||
Json Structure for tidal track response
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:SWAD.API.Services.Links.LinksService">
|
||||
<summary>
|
||||
Service for manipulating with links (LinkController)
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:SWAD.API.Services.Links.LinksService.GetLinkByQuery(SWAD.API.Controllers.DTOs.TrackDto)">
|
||||
<summary>
|
||||
Get link by query
|
||||
</summary>
|
||||
<param Name="query">Search query</param>
|
||||
<returns>Success, Failure, BadRequest, NoResponse</returns>
|
||||
</member>
|
||||
<member name="M:SWAD.API.Services.Links.LinksService.GetServiceByLink(System.String)">
|
||||
<summary>
|
||||
Get MusicService by url
|
||||
</summary>
|
||||
<param Name="link"></param>
|
||||
<returns>Success, Failure</returns>
|
||||
</member>
|
||||
<member name="M:SWAD.API.Services.Links.LinksService.MapLinks(SWAD.API.Controllers.DTOs.TrackLinkDto)">
|
||||
<summary>
|
||||
Get Link from other service
|
||||
</summary>
|
||||
<param Name="trackLink">link from first service</param>
|
||||
<returns>link from another service, Success, Failure, BadRequest, NoResponse</returns>
|
||||
</member>
|
||||
<member name="T:SWAD.API.Services.MusicAPI.Api.ApiService">
|
||||
<summary>
|
||||
Abstract ApiService of music services
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:SWAD.API.Services.MusicAPI.Api.ApiService.GetAllImplementations">
|
||||
<summary>
|
||||
Get all implemented API Services
|
||||
</summary>
|
||||
<returns>API Services types</returns>
|
||||
</member>
|
||||
<member name="M:SWAD.API.Services.MusicAPI.Api.SpotifyService.GetLinkByQuery(SWAD.API.Controllers.DTOs.TrackDto)">
|
||||
<summary>
|
||||
Get link to spotify by search query
|
||||
</summary>
|
||||
<param Name="query">DTO with search query</param>
|
||||
<returns>link from spotify</returns>
|
||||
<exception cref="T:Microsoft.AspNetCore.Authentication.AuthenticationFailureException">If token problems</exception>
|
||||
<exception cref="T:System.Net.Http.HttpRequestException">If response is bad</exception>
|
||||
</member>
|
||||
<member name="M:SWAD.API.Services.MusicAPI.Auth.AbstractAuthService.GetAllImplementations">
|
||||
<summary>
|
||||
Get all implemented Auth Services
|
||||
</summary>
|
||||
<returns>API Services types</returns>
|
||||
</member>
|
||||
<member name="T:SWAD.API.Services.MusicAPI.Auth.SpotifyAuthService">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:SWAD.API.Services.MusicAPI.Auth.TidalAuthService">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Reference in New Issue
Block a user