104 lines
2.0 KiB
Plaintext
104 lines
2.0 KiB
Plaintext
|
|
[[_paths]]
|
|
== Paths
|
|
|
|
[[_launchcommand_post]]
|
|
=== LaunchCommand
|
|
....
|
|
POST /LaunchCommand
|
|
....
|
|
|
|
|
|
==== Description
|
|
Dummy description
|
|
|
|
|
|
==== Parameters
|
|
|
|
[options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|
|
|===
|
|
|Type|Name|Description|Schema|Default
|
|
|*Query*|*Option* +
|
|
_optional_|An optional option|string|
|
|
|*Query*|*Version* +
|
|
_optional_|The API version|string|
|
|
|*Body*|*LaunchCommandRequest* +
|
|
_optional_|Launch something new|<<_launchcommand_post_launchcommandrequest,LaunchCommandRequest>>|
|
|
|===
|
|
|
|
[[_launchcommand_post_launchcommandrequest]]
|
|
*LaunchCommandRequest*
|
|
|
|
[options="header", cols=".^1,.^6,.^1,.^1,.^1"]
|
|
|===
|
|
|Name|Description|Schema|Default|Example
|
|
|*Command* +
|
|
_required_|Dummy description|<<_launchcommand_post_command,Command>>||
|
|
|*Location* +
|
|
_optional_|Dummy description|<<_location,Location>>||
|
|
|*Options* +
|
|
_optional_|Dummy description|string||
|
|
|===
|
|
|
|
[[_launchcommand_post_command]]
|
|
*Command*
|
|
|
|
[options="header", cols=".^1,.^6,.^1,.^1,.^1"]
|
|
|===
|
|
|Name|Description|Schema|Default|Example
|
|
|*args* +
|
|
_optional_|Command arguments|string||
|
|
|*path* +
|
|
_optional_|Command path|string||
|
|
|===
|
|
|
|
|
|
==== Responses
|
|
|
|
===== HTTP Code 200
|
|
|
|
[options="header", cols=".^1,.^3,.^1"]
|
|
|===
|
|
|HTTP Code|Description|Schema
|
|
|*200*|Result|<<_launchcommand_post_response_200,Response 200>>
|
|
|===
|
|
|
|
*Headers*
|
|
|
|
[options="header", cols=".^1,.^3,.^1,.^1"]
|
|
|===
|
|
|Name|Description|Schema|Default
|
|
|*X-Rate-Limit-Limit*|The number of allowed requests in the current period|integer|
|
|
|*X-Rate-Limit-Remaining*|The number of remaining requests in the current period|integer|
|
|
|*X-Rate-Limit-Reset*|The number of seconds left in the current period|integer|
|
|
|===
|
|
|
|
|
|
===== HTTP Code 400
|
|
|
|
[options="header", cols=".^1,.^3,.^1"]
|
|
|===
|
|
|HTTP Code|Description|Schema
|
|
|*400*|Error|<<_error,Error>>
|
|
|===
|
|
|
|
[[_launchcommand_post_response_200]]
|
|
*Response 200*
|
|
|
|
[options="header", cols=".^1,.^6,.^1,.^1,.^1"]
|
|
|===
|
|
|Name|Description|Schema|Default|Example
|
|
|*Location* +
|
|
_optional_|<description>|<<_location,Location>>||
|
|
|*ReservationId* +
|
|
_optional_|<description>|string||
|
|
|===
|
|
|
|
|
|
==== Tags
|
|
|
|
* All
|
|
|
|
|
|
|