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

Add missing documentation #332

Closed
7 tasks done
fmigneault opened this issue Apr 24, 2020 · 0 comments
Closed
7 tasks done

Add missing documentation #332

fmigneault opened this issue Apr 24, 2020 · 0 comments
Assignees
Labels
doc Documentation improvements or building problem help wanted
Milestone

Comments

@fmigneault
Copy link
Collaborator

fmigneault commented Apr 24, 2020

Following magpie features have no explicit mention or setup details. Relevant sections should be created so that they can be found by new users.

  • resource auto-sync feature for a given service and cron configuration setup for it (fixed by 29b907f)
  • listing and explanation/features of every available service types (fixed by 29b907f)
  • explicit description of user/group vs service/resource objects and their relationships
  • description of flags that modify request results (effective, inherited, cascade, list) (see descriptions in [Feature] Effective permission API responses #341)
  • distinction between different kind of permissions:
    • applied permissions : entry for a given service/resource-user/group combination
    • effective permissions: resolution of applied permissions of user & his group membership
    • access permissions: allowed level to routes to request details (ie: roles) (wip Milestone 2.0 - User scope views, Discoverable Groups & Patches #340)
    • ownership permissions: extra set of permissions to user/group that owns the service/resource (?)
      (provides access permissions to some specific routes matching the service/resource & provide all applied permissions for it)
  • distinction of applied permission modifiers ([Feature] Improve user/group permissions scheme #342):
    • match vs recur
      • recur: recursive to this and all children resources: (implicit for backward compat when no modifier provided)
      • match: only applied onto this specific resource
    • allow vs deny (Support of DENY access #235)
      • allow: default when permission is added (for backward compat)
      • deny: explicit override of any previous 'allow' (including recursive of parent resource, no permission equals deny)
  • AuthN details refer to specific issue ([Feature] Document authentication methods and related authenticated-user details #344)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation improvements or building problem help wanted
Projects
None yet
Development

No branches or pull requests

3 participants