Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix swagger. #852

Merged
merged 1 commit into from
Sep 11, 2019
Merged

Fix swagger. #852

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions services/brig/src/Brig/API.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@ sitemap o = do

document "HEAD" "userExists" $ do
Doc.summary "Check if a user ID exists"
Doc.parameter Doc.Path "id" Doc.bytes' $
Doc.parameter Doc.Path "uid" Doc.bytes' $
Doc.description "User ID"
Doc.response 200 "User exists" Doc.end
Doc.errorResponse userNotFound
Expand All @@ -228,7 +228,7 @@ sitemap o = do

document "GET" "user" $ do
Doc.summary "Get a user by ID"
Doc.parameter Doc.Path "id" Doc.bytes' $
Doc.parameter Doc.Path "uid" Doc.bytes' $
Doc.description "User ID"
Doc.returns (Doc.ref Doc.user)
Doc.response 200 "User" Doc.end
Expand Down Expand Up @@ -317,7 +317,7 @@ sitemap o = do

document "GET" "getPrekeyBundle" $ do
Doc.summary "Get a prekey for each client of a user."
Doc.parameter Doc.Path "user" Doc.bytes' $
Doc.parameter Doc.Path "uid" Doc.bytes' $
Doc.description "User ID"
Doc.returns (Doc.ref Doc.prekeyBundle)
Doc.response 200 "Prekey Bundle" Doc.end
Expand All @@ -331,7 +331,7 @@ sitemap o = do

document "GET" "getPrekey" $ do
Doc.summary "Get a prekey for a specific client of a user."
Doc.parameter Doc.Path "user" Doc.bytes' $
Doc.parameter Doc.Path "uid" Doc.bytes' $
Doc.description "User ID"
Doc.parameter Doc.Path "client" Doc.bytes' $
Doc.description "Client ID"
Expand All @@ -346,7 +346,7 @@ sitemap o = do

document "GET" "getUserClients" $ do
Doc.summary "Get all of a user's clients."
Doc.parameter Doc.Path "user" Doc.bytes' $
Doc.parameter Doc.Path "uid" Doc.bytes' $
Doc.description "User ID"
Doc.returns (Doc.array (Doc.ref Doc.pubClient))
Doc.response 200 "List of clients" Doc.end
Expand All @@ -360,7 +360,7 @@ sitemap o = do

document "GET" "getUserClient" $ do
Doc.summary "Get a specific client of a user."
Doc.parameter Doc.Path "user" Doc.bytes' $
Doc.parameter Doc.Path "uid" Doc.bytes' $
Doc.description "User ID"
Doc.parameter Doc.Path "client" Doc.bytes' $
Doc.description "Client ID"
Expand All @@ -376,7 +376,7 @@ sitemap o = do

document "GET" "getRichInfo" $ do
Doc.summary "Get user's rich info"
Doc.parameter Doc.Path "user" Doc.bytes' $
Doc.parameter Doc.Path "uid" Doc.bytes' $
Doc.description "User ID"
Doc.returns (Doc.ref Doc.richInfo)
Doc.response 200 "RichInfo" Doc.end
Expand Down
14 changes: 7 additions & 7 deletions services/galley/src/Galley/API.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ sitemap = do

document "PUT" "updateTeam" $ do
summary "Update team properties"
parameter Path "id" bytes' $
parameter Path "tid" bytes' $
description "Team ID"
body (ref TeamsModel.update) $
description "JSON body"
Expand Down Expand Up @@ -96,7 +96,7 @@ sitemap = do

document "GET" "getTeam" $ do
summary "Get a team by ID"
parameter Path "id" bytes' $
parameter Path "tid" bytes' $
description "Team ID"
returns (ref TeamsModel.team)
response 200 "Team data" end
Expand All @@ -114,7 +114,7 @@ sitemap = do

document "DELETE" "deleteTeam" $ do
summary "Delete a team"
parameter Path "id" bytes' $
parameter Path "tid" bytes' $
description "Team ID"
body (ref TeamsModel.teamDelete) $ do
optional
Expand All @@ -135,7 +135,7 @@ sitemap = do

document "GET" "getTeamMembers" $ do
summary "Get team members"
parameter Path "id" bytes' $
parameter Path "tid" bytes' $
description "Team ID"
returns (ref TeamsModel.teamMemberList)
response 200 "Team members" end
Expand Down Expand Up @@ -171,7 +171,7 @@ sitemap = do

document "POST" "addTeamMember" $ do
summary "Add a new team member"
parameter Path "id" bytes' $
parameter Path "tid" bytes' $
description "Team ID"
body (ref TeamsModel.newTeamMember) $
description "JSON body"
Expand Down Expand Up @@ -216,7 +216,7 @@ sitemap = do

document "PUT" "updateTeamMember" $ do
summary "Update an existing team member"
parameter Path "id" bytes' $
parameter Path "tid" bytes' $
description "Team ID"
body (ref TeamsModel.newTeamMember) $
description "JSON body"
Expand All @@ -233,7 +233,7 @@ sitemap = do

document "GET" "getTeamConversations" $ do
summary "Get team conversations"
parameter Path "id" bytes' $
parameter Path "tid" bytes' $
description "Team ID"
returns (ref TeamsModel.teamConversationList)
response 200 "Team conversations" end
Expand Down