Erik Sundell
807c5b8ff9
Make the generate-scope-table script autoformat its output
2022-01-10 10:48:01 +01:00
Erik Sundell
1c1be8a24b
Generate yaml formatted to match prettier better
2022-01-10 10:31:30 +01:00
Erik Sundell
a14d9ecaa1
ci: refactor to avoid triggering all tests on changes to docs
2022-01-04 00:53:33 +01:00
Min RK
8813bb63d4
update to openapi 3.0
...
easier to implement oneOf schemas
document scopes, session_id in /api/user model
2021-11-17 09:44:38 +01:00
Min RK
468aa5e93c
render openapi spec client-side
...
- move spec to _static/rest-api.yml, since the original yaml must be served
- copy javascript rendering code from FastAPI (uses swagger-ui)
- remove link to pet store, since there isn't a big enough difference to duplicate it
- remove bootprint rendering with node
2021-10-29 13:13:41 +02:00
Min RK
5c01370e6f
set version as long as we are rewriting the file
2021-10-29 13:13:41 +02:00
Min RK
b25517efe8
Rename 'all' metascope to more descriptive 'inherit'
...
since it means 'inheriting' the owner's permissions
'all' prompted the question 'all of what, exactly?'
Additionally, fix some NameErrors that should have been KeyErrors
2021-10-27 16:00:21 +02:00
Min RK
5f19989467
suggest roles instead of admin_users
...
and make admin link permission check match admin page
it would be nice if this could be consolidated (maybe an `admin:ui` permission?)
2021-09-16 11:57:36 +02:00
Min RK
8603723dbb
add list:users|groups|services scopes
...
and govern GET /users|groups|services endpoints with these
Greatly simplifies filtering and pagination,
because these filters can be expressed in db filters,
unlike the potentially complex `read:users`.
Now the query itself will never return a model that should be excluded.
While writing the tests, I added more cleanup between tests.
We now ensure cleanup of all users and groups after each test,
which required updating some group tests which relied on this state leaking
2021-08-24 13:56:11 +02:00
Min RK
7533cb7602
[doc] add example specifying scopes for a default role
2021-08-24 09:04:08 +02:00
Min RK
e35dde8112
Merge pull request #3520 from IvanaH8/rbac-docs-update
...
[rbac] Docs updates
2021-06-25 07:15:29 +00:00
IvanaH8
a6471670c2
Update upgrade section
2021-06-23 11:44:40 +02:00
IvanaH8
8764f6493b
Add scope variable nomenclature and update tech implementation
2021-06-23 11:33:48 +02:00
IvanaH8
024e8fca30
Add !user filter explanation
2021-06-22 17:16:06 +02:00
IvanaH8
eb0f995886
Add scope hierarchy duplicates explanation
2021-06-22 16:22:51 +02:00
IvanaH8
f767a082f8
Fix user/admin default role assignment in roles.md
2021-06-18 13:10:02 +02:00
IvanaH8
a137134d3a
Update roles.md for rbac docs with role creation/deletion and assignment changes
2021-06-18 12:28:30 +02:00
Samuel Gaist
5a4314ea8c
Refactor scope relationships creation
...
This version reduces the number of access to dictionaries data.
2021-06-17 16:06:59 +02:00
0mar
ceed989e77
Generate REST API scope descriptions from source code
2021-06-15 13:49:24 +02:00
0mar
7a3b237bb3
Refactored scope names and updated docs to reflect this
2021-06-15 13:00:15 +02:00
0mar
8864780bfb
Adjusted documentation for auth pages
2021-06-11 13:32:20 +02:00
0mar
5e3201cfe3
Minor formatting change
2021-06-11 12:27:40 +02:00
0mar
73a6b3477a
Fixed typos and formatting
2021-06-11 11:59:18 +02:00
0mar
d169359d51
Refactored scope description to be usable for both docs and authorization page
2021-06-11 11:44:10 +02:00
0mar
c121a17310
Removed default service roles from upgrade and docs
2021-06-09 09:10:51 +02:00
Min RK
8eaed91f79
Merge pull request #3444 from minrk/oauth-details
...
Oauth details docs
2021-06-07 11:56:49 +00:00
Min RK
d39673eea2
Flesh out oauth details doc
...
adress review, add emoji, expand details, examlpes, and add discussion of caching and revocation.
2021-05-26 12:28:59 +02:00
IvanaH8
4a1459195e
Move scope_definitions dict to jupyterhub/scopes.py
2021-05-21 16:58:45 +02:00
IvanaH8
e61cacf5e8
Add message to run make clean before make html
2021-05-20 14:59:49 +02:00
IvanaH8
7914c01099
Call scope table generation in makefile and include in scopes.md
2021-05-20 14:52:28 +02:00
IvanaH8
948179ee0e
Generate scope table in separate markdown file
2021-05-20 14:49:28 +02:00
IvanaH8
65f3933da4
Create scope dictionary
2021-05-20 14:36:21 +02:00
Min RK
a2b76bceb9
minor copy-editing, TODOs in rbac docs
2021-04-22 13:39:36 +02:00
IvanaH8
4687a76a6f
Add role name conventions to docs/source/rbac/roles.md
2021-04-20 17:28:41 +02:00
IvanaH8
5a95681853
Add %TODO: flag for generating the table in docs/source/rbac/scopes.md
2021-04-16 17:26:19 +02:00
IvanaH8
0638783939
Synchronize docs/rest-api.yml with Available scopes table in docs/source/rbac/scopes.md
2021-04-16 17:11:46 +02:00
IvanaH8
b0f4548753
Add read:users(services):roles scopes to docs/source/rbac/scopes.md
2021-04-16 16:49:15 +02:00
IvanaH8
c6e3e06af9
Add Upgrade section to docs/source/rbac/upgrade.md
2021-04-16 16:31:01 +02:00
IvanaH8
649524d357
Add available scopes table in docs/source/rbac/scopes.md
2021-04-08 16:03:17 +02:00
IvanaH8
f5bbe78dbd
Resolve merge conflicts with rbac
2021-04-08 11:32:41 +02:00
IvanaH8
949ec5cc75
Add and update scopes, roles, charts and text in docs/source/rbac docs
2021-04-08 09:39:01 +02:00
IvanaH8
8064cda47a
Update RBAC docs implementing review suggestions
2021-03-17 17:13:09 +01:00
Ivana
5a15fba8b7
Applied text improvement suggestions from code review by @manics
...
Co-authored-by: Simon Li <orpheus+devel@gmail.com >
2021-02-23 15:05:41 +01:00
IvanaH8
bc1e370d7d
updated tech implementation section
2021-02-19 12:37:20 +01:00
IvanaH8
45a0945a6b
updated requirements.txt
2021-02-17 15:46:10 +01:00
IvanaH8
7d1b6a2021
split the docs in docs/source/rbac folder
2021-02-15 16:19:13 +01:00
