wikimusic-api-spec-1.1.0.0
Safe HaskellSafe-Inferred
LanguageGHC2021

WikiMusic.Servant.ApiSpec

Documentation

type WikiMusicPublicAPI = ("login" :> (ReqBody '[JSON] LoginRequest :> Verb 'POST 204 '[JSON] (Headers '[WithAuth] NoContent))) :<|> (("reset-password" :> ("email" :> (Capture "email" Text :> Post '[JSON] MakeResetPasswordLinkResponse))) :<|> (("reset-password" :> ("do" :> (ReqBody '[JSON] DoPasswordResetRequest :> Verb 'POST 204 '[JSON] ()))) :<|> ("system-information" :> Get '[JSON] SystemInformationResponse))) Source #

type WikiMusicPrivateArtistsAPI = ("artists" :> (WithAuth :> (QueryParam "limit" Int :> (QueryParam "offset" Int :> (QueryParam "sort-order" Text :> (QueryParam "include" Text :> Get '[JSON] GetArtistsQueryResponse)))))) :<|> (("artists" :> (WithAuth :> ("search" :> (Capture "searchInput" Text :> (QueryParam "limit" Int :> (QueryParam "offset" Int :> (QueryParam "sort-order" Text :> (QueryParam "include" Text :> Get '[JSON] GetArtistsQueryResponse)))))))) :<|> (("artists" :> ("identifier" :> (WithAuth :> (Capture "identifier" UUID :> (QueryParam "sort-order" Text :> (QueryParam "include" Text :> Get '[JSON] GetArtistsQueryResponse)))))) :<|> (("artists" :> (WithAuth :> (ReqBody '[JSON] InsertArtistsRequest :> Post '[JSON] InsertArtistsCommandResponse))) :<|> (("artists" :> ("comments" :> (WithAuth :> (ReqBody '[JSON] InsertArtistCommentsRequest :> Post '[JSON] InsertArtistCommentsCommandResponse)))) :<|> (("artists" :> ("opinions" :> (WithAuth :> (ReqBody '[JSON] UpsertArtistOpinionsRequest :> Post '[JSON] UpsertArtistOpinionsCommandResponse)))) :<|> (("artists" :> ("artworks" :> (WithAuth :> (ReqBody '[JSON] InsertArtistArtworksRequest :> Post '[JSON] InsertArtistArtworksCommandResponse)))) :<|> (("artists" :> (WithAuth :> (Capture "identifier" UUID :> Delete '[JSON] ()))) :<|> (("artists" :> ("comments" :> (WithAuth :> (Capture "identifier" UUID :> Delete '[JSON] ())))) :<|> (("artists" :> ("opinions" :> (WithAuth :> (Capture "identifier" UUID :> Delete '[JSON] ())))) :<|> (("artists" :> ("artworks" :> (WithAuth :> (Capture "identifier" UUID :> Delete '[JSON] ())))) :<|> (("artists" :> ("artworks" :> ("order" :> (WithAuth :> (ReqBody '[JSON] ArtistArtworkOrderUpdateRequest :> Patch '[JSON] ()))))) :<|> ("artists" :> ("edit" :> (WithAuth :> (ReqBody '[JSON] ArtistDeltaRequest :> Patch '[JSON] ()))))))))))))))) Source #

type WikiMusicPrivateSongsAPI = ("songs" :> (WithAuth :> (QueryParam "limit" Int :> (QueryParam "offset" Int :> (QueryParam "sort-order" Text :> (QueryParam "include" Text :> Get '[JSON] GetSongsQueryResponse)))))) :<|> (("songs" :> ("search" :> (WithAuth :> (Capture "searchInput" Text :> (QueryParam "limit" Int :> (QueryParam "offset" Int :> (QueryParam "sort-order" Text :> (QueryParam "include" Text :> Get '[JSON] GetSongsQueryResponse)))))))) :<|> (("songs" :> ("identifier" :> (WithAuth :> (Capture "identifier" UUID :> (QueryParam "sort-order" Text :> (QueryParam "include" Text :> Get '[JSON] GetSongsQueryResponse)))))) :<|> (("songs" :> (WithAuth :> (ReqBody '[JSON] InsertSongsRequest :> Post '[JSON] InsertSongsCommandResponse))) :<|> (("songs" :> ("comments" :> (WithAuth :> (ReqBody '[JSON] InsertSongCommentsRequest :> Post '[JSON] InsertSongCommentsCommandResponse)))) :<|> (("songs" :> ("opinions" :> (WithAuth :> (ReqBody '[JSON] UpsertSongOpinionsRequest :> Post '[JSON] UpsertSongOpinionsCommandResponse)))) :<|> (("songs" :> ("artworks" :> (WithAuth :> (ReqBody '[JSON] InsertSongArtworksRequest :> Post '[JSON] InsertSongArtworksCommandResponse)))) :<|> (("songs" :> ("artists" :> (WithAuth :> (ReqBody '[JSON] InsertArtistsOfSongsRequest :> Post '[JSON] InsertArtistsOfSongCommandResponse)))) :<|> (("songs" :> ("artists" :> (WithAuth :> (ReqBody '[JSON] InsertArtistsOfSongsRequest :> Delete '[JSON] ())))) :<|> (("songs" :> (WithAuth :> (Capture "identifier" UUID :> Delete '[JSON] ()))) :<|> (("songs" :> ("comments" :> (WithAuth :> (Capture "identifier" UUID :> Delete '[JSON] ())))) :<|> (("songs" :> ("opinions" :> (WithAuth :> (Capture "identifier" UUID :> Delete '[JSON] ())))) :<|> (("songs" :> ("artworks" :> (WithAuth :> (Capture "identifier" UUID :> Delete '[JSON] ())))) :<|> (("songs" :> ("artworks" :> ("order" :> (WithAuth :> (ReqBody '[JSON] SongArtworkOrderUpdateRequest :> Patch '[JSON] ()))))) :<|> (("songs" :> ("edit" :> (WithAuth :> (ReqBody '[JSON] SongDeltaRequest :> Patch '[JSON] ())))) :<|> (("songs" :> ("contents" :> (WithAuth :> (ReqBody '[JSON] InsertSongContentsRequest :> Post '[JSON] InsertSongContentsCommandResponse)))) :<|> (("songs" :> ("contents" :> (WithAuth :> (Capture "identifier" UUID :> Delete '[JSON] ())))) :<|> ("songs" :> ("contents" :> (WithAuth :> (ReqBody '[JSON] SongContentDeltaRequest :> Patch '[JSON] ())))))))))))))))))))) Source #

type WikiMusicPrivateAuthAPI = ("me" :> (WithAuth :> Get '[JSON] GetMeQueryResponse)) :<|> (("users" :> ("invite" :> (WithAuth :> (ReqBody '[JSON] InviteUsersRequest :> Post '[JSON] MakeResetPasswordLinkResponse)))) :<|> ("users" :> ("delete" :> (WithAuth :> (ReqBody '[JSON] DeleteUsersRequest :> Post '[JSON] ()))))) Source #

type WikiMusicPrivateGenresAPI = ("genres" :> (WithAuth :> (QueryParam "limit" Int :> (QueryParam "offset" Int :> (QueryParam "sort-order" Text :> (QueryParam "include" Text :> Get '[JSON] GetGenresQueryResponse)))))) :<|> (("genres" :> ("search" :> (WithAuth :> (Capture "searchInput" Text :> (QueryParam "limit" Int :> (QueryParam "offset" Int :> (QueryParam "sort-order" Text :> (QueryParam "include" Text :> Get '[JSON] GetGenresQueryResponse)))))))) :<|> (("genres" :> ("identifier" :> (WithAuth :> (Capture "identifier" UUID :> (QueryParam "sort-order" Text :> (QueryParam "include" Text :> Get '[JSON] GetGenresQueryResponse)))))) :<|> (("genres" :> (WithAuth :> (ReqBody '[JSON] InsertGenresRequest :> Post '[JSON] InsertGenresCommandResponse))) :<|> (("genres" :> ("comments" :> (WithAuth :> (ReqBody '[JSON] InsertGenreCommentsRequest :> Post '[JSON] InsertGenreCommentsCommandResponse)))) :<|> (("genres" :> ("opinions" :> (WithAuth :> (ReqBody '[JSON] UpsertGenreOpinionsRequest :> Post '[JSON] UpsertGenreOpinionsCommandResponse)))) :<|> (("genres" :> ("artworks" :> (WithAuth :> (ReqBody '[JSON] InsertGenreArtworksRequest :> Post '[JSON] InsertGenreArtworksCommandResponse)))) :<|> (("genres" :> (WithAuth :> (Capture "identifier" UUID :> Delete '[JSON] ()))) :<|> (("genres" :> ("comments" :> (WithAuth :> (Capture "identifier" UUID :> Delete '[JSON] ())))) :<|> (("genres" :> ("opinions" :> (WithAuth :> (Capture "identifier" UUID :> Delete '[JSON] ())))) :<|> (("genres" :> ("artworks" :> (WithAuth :> (Capture "identifier" UUID :> Delete '[JSON] ())))) :<|> (("genres" :> ("artworks" :> ("order" :> (WithAuth :> (ReqBody '[JSON] GenreArtworkOrderUpdateRequest :> Patch '[JSON] ()))))) :<|> ("genres" :> ("edit" :> (WithAuth :> (ReqBody '[JSON] GenreDeltaRequest :> Patch '[JSON] ()))))))))))))))) Source #