wire-api-0.1.0
Safe HaskellSafe-Inferred
LanguageGHC2021

Wire.API.Routes.Public.Brig.Services

Documentation

type ServicesAPI = Named "post-provider-services" (Summary "Create a new service" :> (CanThrow 'AccessDenied :> (CanThrow 'InvalidServiceKey :> (ZProvider :> ("provider" :> ("services" :> (ReqBody '[JSON] NewService :> MultiVerb1 'POST '[JSON] (Respond 201 "" NewServiceResponse)))))))) :<|> (Named "get-provider-services" (Summary "List provider services" :> (CanThrow 'AccessDenied :> (ZProvider :> ("provider" :> ("services" :> Get '[JSON] [Service]))))) :<|> (Named "get-provider-services-by-service-id" (Summary "Get provider service by service id" :> (CanThrow 'AccessDenied :> (CanThrow 'ServiceNotFound :> (ZProvider :> ("provider" :> ("services" :> (Capture "service-id" ServiceId :> Get '[JSON] Service))))))) :<|> (Named "put-provider-services-by-service-id" (Summary "Update provider service" :> (CanThrow 'AccessDenied :> (CanThrow 'ServiceNotFound :> (CanThrow 'ProviderNotFound :> (ZProvider :> ("provider" :> ("services" :> (Capture "service-id" ServiceId :> (ReqBody '[JSON] UpdateService :> MultiVerb1 'PUT '[PlainText, JSON] (RespondEmpty 200 "Provider service updated")))))))))) :<|> (Named "put-provider-services-connection-by-service-id" (Summary "Update provider service connection" :> (CanThrow 'AccessDenied :> (CanThrow 'ServiceNotFound :> (CanThrow 'BadCredentials :> (CanThrow 'InvalidServiceKey :> (ZProvider :> ("provider" :> ("services" :> (Capture "service-id" ServiceId :> ("connection" :> (ReqBody '[JSON] UpdateServiceConn :> MultiVerb1 'PUT '[PlainText, JSON] (RespondEmpty 200 "Provider service connection updated")))))))))))) :<|> (Named "delete-provider-services-by-service-id" (Summary "Delete service" :> (CanThrow 'AccessDenied :> (CanThrow 'BadCredentials :> (CanThrow 'ServiceNotFound :> (ZProvider :> ("provider" :> ("services" :> (Capture "service-id" ServiceId :> (ReqBody '[JSON] DeleteService :> MultiVerb1 'DELETE '[PlainText] (RespondEmpty 202 "")))))))))) :<|> (Named "get-provider-services-by-provider-id" (Summary "Get provider services by provider id" :> (CanThrow 'AccessDenied :> (ZUser :> ("providers" :> (Capture "provider-id" ProviderId :> ("services" :> Get '[JSON] [ServiceProfile])))))) :<|> (Named "get-services" (Summary "List services" :> (CanThrow 'AccessDenied :> (ZUser :> ("services" :> (QueryParam "tags" (QueryAnyTags 1 3) :> (QueryParam "start" Text :> (QueryParam "size" (Range 10 100 Int32) :> Get '[JSON] ServiceProfilePage))))))) :<|> (Named "get-services-tags" (Summary "Get services tags" :> (CanThrow 'AccessDenied :> (ZUser :> ("services" :> ("tags" :> Get '[JSON] ServiceTagList))))) :<|> (Named "get-provider-services-by-provider-id-and-service-id" (Summary "Get provider service by provider id and service id" :> (CanThrow 'AccessDenied :> (CanThrow 'ServiceNotFound :> (ZUser :> ("providers" :> (Capture "provider-id" ProviderId :> ("services" :> (Capture "service-id" ServiceId :> Get '[JSON] ServiceProfile)))))))) :<|> (Named "get-whitelisted-services-by-team-id" (Summary "Get whitelisted services by team id" :> (ZUser :> ("teams" :> (Capture "team-id" TeamId :> ("services" :> ("whitelisted" :> (QueryParam "prefix" (Range 1 128 Text) :> (QueryParam "filter_disabled" Bool :> (QueryParam "size" (Range 10 100 Int32) :> Get '[JSON] ServiceProfilePage))))))))) :<|> Named "post-team-whitelist-by-team-id" (Summary "Update service whitelist" :> (ZUser :> (ZConn :> ("teams" :> (Capture "team-id" TeamId :> ("services" :> ("whitelist" :> (ReqBody '[JSON] UpdateServiceWhitelist :> MultiVerb 'POST '[PlainText] '[RespondEmpty 200 "UpdateServiceWhitelistRespChanged", RespondEmpty 204 "UpdateServiceWhitelistRespUnchanged"] UpdateServiceWhitelistResp)))))))))))))))))) Source #