Commit Graph

69 Commits

Author SHA1 Message Date
0mar
684cac4dc9 Fixed newlines 2021-06-16 09:15:27 +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
Min RK
4e41a39b30 Sync with main 2021-05-12 16:08:03 +02:00
Min RK
e7d249bb3d Sync with master 2021-05-11 10:52:46 +02:00
Min RK
63a61bcc2f prepare to rename default branch to main
- update references to default branch name in docs, workflows
- use HEAD in github urls, which always works regardless of default branch name
- fix petstore URLs since the old petstore links seem to have stopped working
2021-05-11 10:40:04 +02:00
Min RK
cf4b25ac56 sync with master 2021-04-22 14:14:02 +02:00
Nathan Barber
7bd660d899 Revert documentation updates on /groups/{name} 2021-04-21 10:05:50 -04:00
Nathan Barber
5d095c0234 Merge remote-tracking branch 'upstream/master' into pagination 2021-04-20 22:07:48 -04:00
IvanaH8
79b57b7f3b Add admin:users:auth_state/server_state to docs/rest-api.yml 2021-04-20 16:48:56 +02:00
Min RK
574d343881 release 1.4.0 2021-04-19 13:41:28 +02:00
Nathan Barber
3c328385a4 Add default limit and max limit config vars 2021-04-16 13:11:57 -04: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
Nathan Barber
100111ed2c Add pagination info to docs 2021-04-15 17:37:57 -04:00
IvanaH8
d38a7b9aa7 Change scope for PATCH /users API in rest-api.yml 2021-04-08 16:08:43 +02:00
IvanaH8
f5bbe78dbd Resolve merge conflicts with rbac 2021-04-08 11:32:41 +02:00
IvanaH8
a512867a1e Update scopes in docs/rest-api.yml 2021-04-07 14:10:38 +02:00
IvanaH8
bdc4bd4763 Resolve merge conflicts with Vertical Filtering and improve tests 2021-03-24 13:39:59 +01:00
Min RK
43a6767276 run pre-commit after merge 2021-03-22 15:57:52 +01:00
Min RK
b552e364f3 Merge master into rbac 2021-03-22 12:29:48 +01:00
IvanaH8
8064cda47a Update RBAC docs implementing review suggestions 2021-03-17 17:13:09 +01:00
IvanaH8
bc1e370d7d updated tech implementation section 2021-02-19 12:37:20 +01:00
Min RK
9331dd13da run pre-commit (prettier) 2021-02-12 15:25:58 +01:00
IvanaH8
1a513f8dd9 added roles to groups 2021-01-11 12:08:50 +01:00
Min RK
6fc3dc4c01 Merge master into rbac 2020-12-02 11:28:53 +01:00
IvanaH8
18ed1b58cc added roles to token model and POST /users/{name}/tokens request body 2020-11-19 09:17:03 +01:00
IvanaH8
a220899bf9 fix for scope names in rest-api.yml 2020-10-08 13:49:04 +02:00
Min RK
30b8bc3664 add ?state= filter for GET /users
allows selecting users based on the 'ready' 'active' or 'inactive' states of their servers

- ready: users who have any servers in the 'ready' state
- active: users who have any servers in the 'active' state (i.e. ready OR pending)
- inactive: users who have *no* servers in the 'active' state (inactive + active = all users, no overlap)

Does not change the user model, so a user with *any* ready servers will still return all their servers
2020-09-17 12:31:16 +02:00
IvanaH8
3d7e4458fc correction of scope for GET /authorizations/token/{token} 2020-09-11 11:07:03 +02:00
IvanaH8
f1940c7c61 added read:all scope (whoami) to GET /authorizations/token/{token} 2020-09-09 15:12:06 +02:00
IvanaH8
eac2e75fe4 adding scopes on operational level for API endpoints 2020-09-09 10:38:00 +02:00
IvanaH8
14ed312414 adding security definition (with scopes) for oauth 2020-09-07 16:44:18 +02:00
Min RK
7f6886c60f Merge pull request #3104 from cmd-ntrf/rest-api-version
Update version in docs/rest-api.yaml
2020-08-27 11:00:14 +02:00
Felipe Faria
5ab735fea3 Added extra documentation for endpoint /users/{name}/servers/{server_name}. 2020-08-26 19:07:57 -04:00
Félix-Antoine Fortin
d80dab284d Update version in docs/rest-api.yaml 2020-06-30 08:59:29 -04:00
Matt Riedemann
6b521e0b86 api-ref: document user_options for server resource
APIHandler.server_model unconditionally returns the Spawner's
user_options dict but it wasn't mentioned in the API reference
so it's added here. The description is taken from the docstring
on Spawner.user_options.

Closes issue #2965
2020-03-02 12:12:29 -05:00
Min RK
0ae9cfa42f fix schema for remove parameter in rest api
it wasn't showing up properly since it's a *property* of the body, not the body itself
2020-01-31 17:18:30 +01:00
Sören Brunk
30cfdcaa83 Change API description to a valid OpenAPI spec
* Add missing responses (doesn't include all possible responses yet)
* Refactor invalid multi in body parameters into a single parameter
* Change form type into valid formData
* Fix use of required fields
* Apply a few other minor fixes
2019-05-28 18:04:17 +02:00
Min RK
b196dd2bea add activity spec to rest api 2019-02-06 13:15:42 +01:00
Min RK
69933e240f document specifying options via rest api 2018-11-23 16:06:38 +01:00
Min RK
e79b43e906 support removing named servers 2018-09-24 16:21:40 +02:00
Min RK
f0260aae52 add missing expiry fields in rest-api doc 2018-06-13 15:15:09 +02:00
Min RK
98d60402b5 add service.info to rest api docs 2018-05-28 14:09:53 +02:00
Richard Darst
2344d696ca API: pass 'server_state' through to admin clients only
- This will allow, for example, cull_idle_servers to be more
  intelligent when culling servers.
- This is only given to admin API users, because we don't know if all
  spawners expect their state to be made available to users.
2018-04-24 16:52:18 +03:00
Min RK
4401cdc16a Always have .servers model on users
rather than only when named_servers is enabled.

Put new-in-0.9 state there, rather than continuing to add server fields to top-level user model.
2018-04-24 11:35:15 +02:00
Min RK
b629e520a9 add token api to rest yaml 2018-04-20 15:34:52 +02:00
analect
c6ac9e1d15 Add handling for POST/DELETE of named-servers introduced in 0.8x 2017-09-19 13:20:15 +01:00
Carol Willing
b70f2fa20a remove schema error 2017-08-08 22:41:08 -07:00
Min RK
3f032abc25 finish oauth swagger doc
- clarify that /authorize is not really an API endpoint, but the redirect target
- /oauth2/token accepts x-www-form-urlencoded not json
2017-08-04 15:23:50 +02:00
Carol Willing
cebb962645 Edit per mirnk review 2017-08-03 10:34:12 -07:00