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
Carol Willing
a1591185c1
Flesh out auth in swagger spec
2017-07-27 19:44:59 -07:00
Carol Willing
831b7d2a86
WIP
2017-07-27 19:44:59 -07:00
Carol Willing
057a52dd32
Add oauth to swagger api doc
2017-07-27 19:44:59 -07:00
Min RK
eec0a11ef0
add POST /authorizations/token to rest API docs
2017-02-08 14:39:13 +01:00
Carol Willing
10c3fbe5cf
Add changes per @minrk
2016-09-22 09:12:26 -07:00
Carol Willing
193b236ef1
Add additional review questions re: API
2016-09-19 11:52:43 -07:00
Carol Willing
1851e6a29d
Edit descriptions in API spec for user clarity
2016-09-19 10:49:56 -07:00
Min RK
5ad618bfc1
add API endpoint for services
2016-09-02 15:19:45 +02:00
Will Starms
80fa5418b7
Fix missing description for responce
2016-08-03 16:59:14 -05:00
Will Starms
b0a09c027d
Fix invalid type bool->boolean
2016-08-03 16:57:17 -05:00
Kyle Kelley
4edf59efeb
Merge pull request #675 from minrk/api-info
...
Add /api/ and /api/info endpoints
2016-08-02 22:26:10 -05:00
Min RK
2c47fd4a02
Add /api/ and /api/info endpoints
...
/api/ is not authenticated, and just reports JupyterHub's version for now.
/api/info is admin-only, and reports more detailed info about Python, authenticators/spawners in use, etc.
2016-08-01 15:15:59 +02:00
Min RK
9878f1e32d
Document parameters to shutdown API
2016-08-01 15:12:05 +02:00
Will Starms
4974775cd9
Fix timestamp type
2016-07-31 19:23:59 -05:00
Will Starms
499ba89f07
Correct invalid JSON pointers
2016-07-28 22:25:38 -05:00
Will Starms
05d743f725
Correct invalid license object in API spec
2016-07-28 22:19:05 -05:00
Min RK
19ae38c108
add REST API to docs
...
include local build, even though it's not as nice as petstore.
Due the that, link to petstore as well.
2016-07-23 12:05:25 +02:00
Min RK
6d106b24f4
add groups API
2016-06-01 14:04:32 +02:00
Min RK
479b40d840
add swagger spec for REST API
2016-01-12 16:32:50 +01:00
