Skip to content

Commit 9b94b29

Browse files
kalskykalsky
committed
fix many sandbox api examples
1 parent 6fdf177 commit 9b94b29

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+314
-184
lines changed

‎docs/api-guide/cs-sandbox-api/cs-sandbox-api-version-1-reference-guide/blueprint-start.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ The scheduling and input parameters of the sandbox in JSON format. The elements
4949
| --- | --- |
5050
| `name` | The name of the sandbox. `(string)` <br/> If you do not specify a name, you will get the following error message: "Reservation name and duration must be specified in request body". |
5151
| `duration` | The duration for this sandbox. Time must be specified in ISO 8601 format (for example PT23H). `(string)` <br/> If you do not specify the duration, you will get the following error message: "Duration format must be a valid 'ISO 8601' (e.g 'PT23H' or 'PT4H2M')". |
52+
| `start_time` | Optional parameter, if not provided the sandbox will start immediatly. Must conform to ISO 8601 standard, which means that a timezone offset is passed with the value. For UTC: 2039-09-07T15:50+00Z. For UTC+2: 2039-09-26T07:58:30.996+0200". |
5253
| `params` | Any published input parameters defined for the blueprint and its abstract resources. Input parameters that have no default must be included in the request. Abstract resource input parameters must be associated to global inputs (specify the global inputs in the request). `(Array)` <br/> If you do not specify the input parameters, you will get the following error message: "Blueprint has invalid inputs". |
5354
| `permitted_users` | Users permitted to use the sandbox. Permitted users must have access to the logged-in domain. |
5455

@@ -98,6 +99,7 @@ The `blueprint start` method returns details about the new sandbox. The output i
9899
"state":"Ready",
99100
"type":"Sandbox",
100101
"components":[
102+
{
101103
"name":"MySwitch",
102104
"type":"Resource",
103105
"component_type":"Generic Switch Model",
@@ -106,7 +108,7 @@ The `blueprint start` method returns details about the new sandbox. The output i
106108
{
107109
"type":"string",
108110
"name":"vendor",
109-
"value":" """
111+
"value":""
110112
}
111113
],
112114
"connection_interfaces":[
@@ -143,6 +145,7 @@ The `blueprint start` method returns details about the new sandbox. The output i
143145
"name":"get all sandboxes"
144146
}
145147
}
148+
}
146149
```
147150
</details>
148151

‎docs/api-guide/cs-sandbox-api/cs-sandbox-api-version-1-reference-guide/blueprints.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,8 @@ The `blueprints` method returns a list of all the blueprints associated with the
4949
"categories":[
5050

5151
],
52-
"estimated_setup_duration":"PT25M""_links":{
52+
"estimated_setup_duration":"PT25M",
53+
"_links":{
5354
"self":{
5455
"href":"/blueprints/c6abccb6-71eb-423b-b754-477c11d6bc2a",
5556
"method":"GET",

‎docs/api-guide/cs-sandbox-api/cs-sandbox-api-version-1-reference-guide/sandbox-identifier.md‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,8 @@ The `sandbox identifier` method returns details about a particular sandbox (as o
4646
"name":"Test Blprnt 2",
4747
"id":"994bd534-740a-45f5-851f-ff452f2a17a2",
4848
"state":"Ready",
49-
"setup_stage":"Provisioning""type":"Sandbox",
49+
"setup_stage":"Provisioning",
50+
"type":"Sandbox",
5051
"components":[
5152
{
5253
"name":"MySwitch",
@@ -57,7 +58,7 @@ The `sandbox identifier` method returns details about a particular sandbox (as o
5758
{
5859
"type":"string",
5960
"name":"vendor",
60-
"value":" """
61+
"value":""
6162
}
6263
],
6364
"connection_interfaces":[
@@ -75,13 +76,14 @@ The `sandbox identifier` method returns details about a particular sandbox (as o
7576
"description":""
7677
}
7778
],
78-
]"permitted_users":[
79+
"permitted_users":[
7980
{
8081
"john.s",
8182
"emily.b",
8283
"lucas.w"
8384
}
84-
]"_links":{
85+
],
86+
"_links":{
8587
"self":{
8688
"href":"/sandboxes/994bd534-740a-45f5-851f-ff452f2a17a2",
8789
"method":"GET",
@@ -98,7 +100,7 @@ The `sandbox identifier` method returns details about a particular sandbox (as o
98100
"href":"/sandboxes",
99101
"method":"GET",
100102
"name":"get all sandboxes"
101-
103+
}
102104
}
103105
}
104106
```

‎docs/api-guide/cs-sandbox-api/cs-sandbox-api-version-1-reference-guide/sandboxes.md‎

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -46,25 +46,30 @@ The `sandboxes` method returns a list of all the sandboxes and the actions that
4646
"description":"This is a list of sandboxes in this user domain",
4747
"state":"Ready",
4848
"blueprint":{
49-
"name":"Test Blprnt2""id":"2f4c972b-5c64-4b08-bae4-73408d7b171d"
50-
}"_links":{
49+
"name":"Test Blprnt2",
50+
"id":"2f4c972b-5c64-4b08-bae4-73408d7b171d"
51+
},
52+
"_links":{
5153
"self":{
5254
"href":"/sandboxes/11491c80-6f79-4e9c-b592-78242c6dc698",
53-
"method":"GET""</code><MadCap":"conditionalText MadCap":"conditions=""REST-API.REST API&#160;V1"">""name":"get a sandbox' details",
54-
"templated":"true</code></MadCap":"conditionalText><code class=""language-javascript"">"
55+
"method":"GET",
56+
"name":"get a sandbox' details",
57+
"templated":true
5558
},
56-
"</code><MadCap":"conditionalText MadCap":"conditions=""REST-API.REST API&#160;V2"">""components":{
59+
"components":{
5760
"href":"/sandboxes/11491c80-6f79-4e9c-b592-78242c6dc698/components",
58-
"method":"GET""</code></MadCap":"conditionalText>"
61+
"method":"GET"
5962
},
6063
"stop":{
6164
"href":"/sandboxes/11491c80-6f79-4e9c-b592-78242c6dc698/stop",
62-
"method":"POST""</code><MadCap":"conditionalText MadCap":"conditions=""REST-API.REST API&#160;V1"">""name":"stop a sandbox",
63-
"templated":"true</code></MadCap":"conditionalText>"
65+
"method":"POST",
66+
"name":"stop a sandbox",
67+
"templated":true
6468
},
6569
"all":{
6670
"href":"/sandboxes",
67-
"method":"GET""</code></pre><pre xml":"space=""preserve"">""name":"get all sandboxes"
71+
"method":"GET",
72+
"name":"get all sandboxes"
6873
}
6974
}
7075
}

‎docs/api-guide/cs-sandbox-api/cs-sandbox-api-version-2-reference-guide/blueprint-start.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ The scheduling and input parameters of the sandbox in JSON format. The elements
4848
| --- | --- |
4949
| `name` | The name of the sandbox. `(string)` <br/> If you do not specify a name, you will get the following error message: "Reservation name and duration must be specified in request body". |
5050
| `duration` | The duration for this sandbox. Time must be specified in ISO 8601 format (for example PT23H). `(string)` <br/> If you do not specify the duration, you will get the following error message: "Duration format must be a valid 'ISO 8601' (e.g 'PT23H' or 'PT4H2M')". |
51+
| `start_time` | Optional parameter, if not provided the sandbox will start immediatly. Must conform to ISO 8601 standard, which means that a timezone offset is passed with the value. For UTC: 2039-09-07T15:50+00Z. For UTC+2: 2039-09-26T07:58:30.996+0200". |
5152
| `params` | Any published input parameters defined for the blueprint and its abstract resources. Input parameters that have no default must be included in the request. Abstract resource input parameters must be associated to global inputs (specify the global inputs in the request). `(Array)` <br/> If you do not specify the input parameters, you will get the following error message: "Blueprint has invalid inputs". |
5253
| `permitted_users` | Users permitted to use the sandbox. Permitted users must have access to the logged-in domain. |
5354

‎docs/api-guide/cs-sandbox-api/cs-sandbox-api-version-2-reference-guide/blueprints.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,15 +41,17 @@ Example header format for the `blueprints` method:
4141
The `blueprints` method returns a list of all the blueprints associated with the user's domain and permissions and the actions that can be performed on the individual blueprints:
4242

4343
```javascript
44-
}{
44+
[
45+
{
4546
"name":"WebApi",
4647
"id":"c6abccb6-71eb-423b-b754-477c11d6bc2a",
4748
"description":null,
4849
"availability":"Not Available",
4950
"categories":[
5051

5152
],
52-
"estimated_setup_duration":"PT25M""_links":{
53+
"estimated_setup_duration":"PT25M",
54+
"_links":{
5355
"self":{
5456
"href":"/blueprints/c6abccb6-71eb-423b-b754-477c11d6bc2a",
5557
"method":"GET",

‎docs/api-guide/cs-sandbox-api/cs-sandbox-api-version-2-reference-guide/component-command-name.md‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,16 +51,19 @@ The `component command name` method returns details about a specific component c
5151
{
5252
"name":"param1",
5353
"description":"",
54-
"type":"numeric""possible values":[
54+
"type":"numeric",
55+
"possible values":[
5556

5657
],
57-
"default value":"""mandatory":false
58+
"default value":"",
59+
"mandatory":false
5860
}
59-
]"executions":[
61+
],
62+
"executions":[
6063
{
6164
"id":"0daead01-8e57-4064-81d4-84911effa911",
6265
"status":"Pending",
63-
"supports_Cancelation":"false",
66+
"supports_cancellation":"false",
6467
"_links":{
6568
"self":{
6669
"href":"/executions/0daead01-8e57-4064-81d4-84911effa911",

‎docs/api-guide/cs-sandbox-api/cs-sandbox-api-version-2-reference-guide/component-command-start.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,8 @@ The `component command start` method returns details about a specific execution
9696
```javascript
9797
{
9898
"executionId":"1DEB29BF-22B0-4CF6-B7BE-02173520EB81",
99-
"supports_cancellation":true"_links":{
99+
"supports_cancellation":true,
100+
"_links":{
100101
"self":{
101102
"href":"/execution/1DEB29BF-22B0-4CF6-B7BE-02173520EB81",
102103
"method":"GET"

‎docs/api-guide/cs-sandbox-api/cs-sandbox-api-version-2-reference-guide/execution-id.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,8 @@ The `execution id` method returns details about a specific execution of a sandbo
4444
{
4545
"id":"1DEB29BF-22B0-4CF6-B7BE-02173520EB81",
4646
"supports_cancellation":"true",
47-
"started":"""ended":"",
47+
"started":"",
48+
"ended":"",
4849
"status":"",
4950
"output":"",
5051
"_links":{

‎docs/api-guide/cs-sandbox-api/cs-sandbox-api-version-2-reference-guide/sandbox-activity.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -65,16 +65,16 @@ The `sandbox activity` method returns the events from the Activity Feed of a par
6565
"event_type":"success",
6666
"event_text":"Sandbox 'MyBlueprint' has started",
6767
"output":"Null",
68-
"time":"2017-01-15T09:51:17Z"
69-
"execution_server": null
68+
"time":"2017-01-15T09:51:17Z",
69+
"execution_server": null
7070
},
7171
{
7272
"id":"79549eaf-7f1a-4180-a88b-e7da27e5075b",
7373
"event_type":"success",
7474
"event_text":"'Deploy' resource command on 'vCenter VM From...' started",
7575
"output":"Null",
76-
"time":"2017-01-15T09:51:17Z"
77-
"execution_server": "WIN-ES-NY"
76+
"time":"2017-01-15T09:51:17Z",
77+
"execution_server": "WIN-ES-NY"
7878
}
7979
]
8080
}

0 commit comments

Comments
 (0)