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

Update docs. #870

Merged
merged 1 commit into from
Oct 7, 2019
Merged

Update docs. #870

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
5 changes: 5 additions & 0 deletions docs/reference/provisioning/scim-via-curl.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,11 @@ This page shows you how to communicate with the wire backend through
the [SCIM API](http://www.simplecloud.info/) by example. All examples
are [curl](https://curl.haxx.se/) (in bash syntax).

We support setting the handle and user name in wire (the thing with
Copy link
Member

Choose a reason for hiding this comment

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

Hm, perhaps you can clarify a little: What do you mean with in wire? Via curl? There is an API endpoint? Via the graphical desktop/mobile clients?
Instead of the thing with @, perhaps clarify a bit more, e.g.: A user handle is globally unique and usually visually shown with a @. Example: @wireuser123. A user name has no restrictions and is shown in the conversation flow.
I'm not sure the average reader of this page easily understand what you mean with rich-info and group provisioning. Could you perhaps define these concepts? (Would a mini-glossary make sense?)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The intended audience is people who develop against our backend, and the lack of context in this paragraph matches the rest of the document.

I can't prioritize this PR now. But I was passing on the link and need to add this bit of information on top, and I would like to have it contained in the document next time that happens.

Does that make sense?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

note to self: next time mark PR as "doesn't have to be good, just has to be no worse than the status before". this gives relevant context to the reviewer. (sorry @jschaul :))

`@` and the longer thing without `@`). There is also support for
setting rich-info. Group provisioning is planned, but the release
date hasn't been fixed yet.

If you want to dive into the backend code, start [reading here in our
backend](https://github.com/wireapp/wire-server/blob/develop/services/spar/src/Spar/Scim.hs)
and [our hscim library](https://github.com/wireapp/hscim).
Expand Down