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

Turn long summaries into descriptions #3706

Merged
merged 4 commits into from
Nov 16, 2023
Merged

Turn long summaries into descriptions #3706

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ed4a0fa
Turn long summaries into descriptions
pcapriotti Nov 10, 2023
7ae5d6e
Add CHANGELOG entry
pcapriotti Nov 10, 2023
a9d0faf
fixup! Add CHANGELOG entry
pcapriotti Nov 15, 2023
9e5b2f5
fixup! fixup! Add CHANGELOG entry
pcapriotti Nov 16, 2023
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
1 change: 1 addition & 0 deletions changelog.d/4-docs/long-summaries
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Turn long summaries in openapi documentation into descriptions
23 changes: 10 additions & 13 deletions libs/wire-api/src/Wire/API/Routes/Public/Brig.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -684,9 +684,8 @@ type PrekeyAPI =
:<|> Named
"get-multi-user-prekey-bundle-unqualified"
( Summary
"(deprecated) Given a map of user IDs to client IDs return a \
\prekey for each one. You can't request information for more users than \
\maximum conversation size."
"(deprecated) Given a map of user IDs to client IDs return a prekey for each one."
:> Description "You can't request information for more users than maximum conversation size."
:> Until 'V2
:> ZUser
:> "users"
Expand All @@ -697,9 +696,8 @@ type PrekeyAPI =
:<|> Named
"get-multi-user-prekey-bundle-qualified@v3"
( Summary
"Given a map of domain to (map of user IDs to client IDs) return a \
\prekey for each one. You can't request information for more users than \
\maximum conversation size."
"(deprecated) Given a map of user IDs to client IDs return a prekey for each one."
:> Description "You can't request information for more users than maximum conversation size."
:> MakesFederatedCall 'Brig "claim-multi-prekey-bundle"
:> ZUser
:> Until 'V4
Expand All @@ -711,9 +709,8 @@ type PrekeyAPI =
:<|> Named
"get-multi-user-prekey-bundle-qualified"
( Summary
"Given a map of domain to (map of user IDs to client IDs) return a \
\prekey for each one. You can't request information for more users than \
\maximum conversation size."
"(deprecated) Given a map of user IDs to client IDs return a prekey for each one."
:> Description "You can't request information for more users than maximum conversation size."
:> MakesFederatedCall 'Brig "claim-multi-prekey-bundle"
:> ZUser
:> From 'V4
Expand Down Expand Up @@ -1570,10 +1567,10 @@ type TeamsAPI =
)
:<|> Named
"get-team-size"
( Summary
"Returns the number of team members as an integer. \
\Can be out of sync by roughly the `refresh_interval` \
\of the ES index."
( Summary "Get the number of team members as an integer"
:> Description
"Can be out of sync by roughly the `refresh_interval` \
\of the ES index."
:> CanThrow 'InvalidInvitationCode
:> ZUser
:> "teams"
Expand Down
16 changes: 8 additions & 8 deletions libs/wire-api/src/Wire/API/Routes/Public/Galley/Conversation.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -723,10 +723,10 @@ type ConversationAPI =
-- - MemberJoin event to members
:<|> Named
"join-conversation-by-code-unqualified"
( Summary
"Join a conversation using a reusable code.\
\If the guest links team feature is disabled, this will fail with 409 GuestLinksDisabled.\
\Note that this is currently inconsistent (for backwards compatibility reasons) with `POST /conversations/code-check` which responds with 404 CodeNotFound if guest links are disabled."
( Summary "Join a conversation using a reusable code"
:> Description
"If the guest links team feature is disabled, this will fail with 409 GuestLinksDisabled.\
\Note that this is currently inconsistent (for backwards compatibility reasons) with `POST /conversations/code-check` which responds with 404 CodeNotFound if guest links are disabled."
:> MakesFederatedCall 'Galley "on-conversation-updated"
:> CanThrow 'CodeNotFound
:> CanThrow 'InvalidConversationPassword
Expand All @@ -745,10 +745,10 @@ type ConversationAPI =
)
:<|> Named
"code-check"
( Summary
"Check validity of a conversation code.\
\If the guest links team feature is disabled, this will fail with 404 CodeNotFound.\
\Note that this is currently inconsistent (for backwards compatibility reasons) with `POST /conversations/join` which responds with 409 GuestLinksDisabled if guest links are disabled."
( Summary "Check validity of a conversation code."
:> Description
"If the guest links team feature is disabled, this will fail with 404 CodeNotFound.\
\Note that this is currently inconsistent (for backwards compatibility reasons) with `POST /conversations/join` which responds with 409 GuestLinksDisabled if guest links are disabled."
:> CanThrow 'CodeNotFound
:> CanThrow 'ConvNotFound
:> CanThrow 'InvalidConversationPassword
Expand Down