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.

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

UI for making API private for a user group #1622

Closed
1 of 4 tasks
bajiat opened this issue Sep 23, 2016 · 9 comments
Closed
1 of 4 tasks

UI for making API private for a user group #1622

bajiat opened this issue Sep 23, 2016 · 9 comments
Assignees
Milestone

Comments

@bajiat
Copy link
Contributor

bajiat commented Sep 23, 2016

In addition to being able to select between private and public, owner should be able to select that the API is public/visible to certain users: "private to a group".

Definition of done

  • In the API profile, the owner can select that the API is private to a group.
  • In the API Catalog, the owner can see an indication of
    • completely private API
    • API being partially provate (visible to a selected group of users).

Wireframes

  1. API Visibility comes under Settings tab.
    Has a separate Pane with radio buttons to select visibility option.
    Default is public.
    closedapi
  2. To give access to specific people.
    The section gets active when radio button is selected
    Users can be added via email.
    On adding a new user, they should appear as tags under the text field.
    In API profile page , and API catalog, special icon should appear to indicate the API is visible for a specific group
    (reference of BS tags: https://bootstrap-tagsinput.github.io/bootstrap-tagsinput/examples/)
    closedapi2
  3. API is accessible only to owner
    In API profile page , and API catalog, special icon should appear to indicate the API is visible only for owner
    closedapi3
@Nazarah
Copy link
Contributor

Nazarah commented Sep 28, 2016

@NNN any design ideas about this issue?

@Nazarah
Copy link
Contributor

Nazarah commented Sep 28, 2016

@bajiat : currently we have a toggler in API profile to make an API public/private to the audience. Should this toggler still remain as we are changing the privacy option of an API?
Or it is going to be replaced by this issue?

@bajiat
Copy link
Contributor Author

bajiat commented Sep 28, 2016

@Nazarah Toggler with three options? Can you sketch (even on paper) some options for the owner to select between the options?

@Nazarah
Copy link
Contributor

Nazarah commented Sep 28, 2016

@NNN based on a discussion with @bajiat and @jykae I prepared the given wireframes.
Please have a look and give your feedback

@55
Copy link
Contributor

55 commented Sep 29, 2016

@Nazarah, really nice, love it!

We need to start separating content of this view into subviews, ex. with leftside navigation.
Maybe not in this task.

@55
Copy link
Contributor

55 commented Sep 29, 2016

One thing about the icons of indication. Let's use label instead of icons.
And only one label - Private if API is private to everybody and same label if available to some users.
It will make UI look cleaner. Owners can always check who can see theirs API in the settings. There is no need to separately show these with different types of icons/labels.

@Nazarah
Copy link
Contributor

Nazarah commented Sep 29, 2016

@NNN agreed with the design suggestions.

@Nazarah
Copy link
Contributor

Nazarah commented Sep 29, 2016

@NNN I've got another suggestion, to change the API header, card and table row (in API catalog) color if an API is private. The label is good for profile header and table row, where more space is available. Am not just sure about the card view with little space.

@brylie
Copy link
Contributor

brylie commented Oct 4, 2016

...moving discussion here from #1623.

After our stand-up today, we reviewed the API Visibility feature/UI. @philippeluickx suggested, and we generally agreed, that the API Visibility selector should be a drop-down, rather than radio buttons. @Nazarah agreed to wireframe the select drop-down, as part of this task.

As an enhancement, we are discussing improving the drop-down by using an enhancement library, such as:

Using one of the above plugins would allow us to include the help text directly within the select menu, similar to how it is included among the radio select options:

screenshot from 2016-10-04 13-46-14

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants