Skip to content

Additional Swagger docs for access_role_v2 in create new conv schema #2409

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

Merged
battermann merged 2 commits into from
May 19, 2022
Merged

Additional Swagger docs for access_role_v2 in create new conv schema #2409

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e63357a
additional swagger docs for access_role_v2 in create new conversation…
battermann May 18, 2022
f1013c8
hi ci
battermann May 19, 2022
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
6 changes: 4 additions & 2 deletions libs/wire-api/src/Wire/API/Conversation.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,8 +174,10 @@ accessRolesSchemaOpt = toOutput .= accessRolesSchemaTuple `withParser` validate

accessRolesSchemaTuple :: ObjectSchema SwaggerDoc (Maybe AccessRoleLegacy, Maybe (Set AccessRoleV2))
accessRolesSchemaTuple =
(,) <$> fst .= optField "access_role" (maybeWithDefault A.Null schema)
<*> snd .= optField "access_role_v2" (maybeWithDefault A.Null $ set schema)
(,) <$> fst .= optFieldWithDocModifier "access_role" (description ?~ "Deprecated, please use access_role_v2") (maybeWithDefault A.Null schema)
<*> snd .= optFieldWithDocModifier "access_role_v2" (description ?~ desc) (maybeWithDefault A.Null $ set schema)
where
desc = "This field is optional. If it is not present, the default will be `[team_member, non_team_member, service]`. Please note that an empty list is not allowed when creating a new conversation."
Copy link
Contributor

@fisx fisx May 19, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
desc = "This field is optional. If it is not present, the default will be `[team_member, non_team_member, service]`. Please note that an empty list is not allowed when creating a new conversation."
desc = "This field is optional. If it is not present, the default will be `[team_member, non_team_member, service]`.\
\ Please note that an empty list is not allowed when creating a new conversation."

please ignore this :)


conversationMetadataObjectSchema :: ObjectSchema SwaggerDoc ConversationMetadata
conversationMetadataObjectSchema =
Expand Down