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
This commit is contained in:
Min RK
2020-01-31 17:18:30 +01:00
parent ff8c4ca8a3
commit 0ae9cfa42f

View File

@@ -248,10 +248,13 @@ paths:
when spawning via the API instead of spawn form. when spawning via the API instead of spawn form.
The structure of the options The structure of the options
will depend on the Spawner's configuration. will depend on the Spawner's configuration.
The body itself will be available as `user_options` for the
Spawner.
in: body in: body
required: false required: false
schema: schema:
type: object type: object
responses: responses:
'201': '201':
description: The user's notebook server has started description: The user's notebook server has started
@@ -312,14 +315,18 @@ paths:
in: path in: path
required: true required: true
type: string type: string
- name: remove - name: body
description: |
Whether to fully remove the server, rather than just stop it.
Removing a server deletes things like the state of the stopped server.
in: body in: body
required: false required: false
schema: schema:
type: boolean type: object
properties:
remove:
type: boolean
description: |
Whether to fully remove the server, rather than just stop it.
Removing a server deletes things like the state of the stopped server.
Default: false.
responses: responses:
'204': '204':
description: The user's notebook named-server has stopped description: The user's notebook named-server has stopped