OLD | NEW |
1 [ | 1 [ |
2 { | 2 { |
3 "namespace": "experimental.record", | 3 "namespace": "experimental.record", |
4 "types": [ | 4 "types": [ |
5 { | 5 { |
6 "id": "SessionDetails", | 6 "id": "SessionDetails", |
7 "type": "object", | 7 "type": "object", |
8 "description": "", | 8 "description": "", |
9 "properties": { | 9 "properties": { |
10 "extensionPath": {"type": "string", "optional": true, "description": "
A path to an extension to run in the session. Should be an unpacked extension."} | 10 "extensionPath": { |
| 11 "type": "string", |
| 12 "optional": true, |
| 13 "description": |
| 14 "Absolute path to an unpacked extension to run in the subbrowser
session." |
| 15 } |
11 } | 16 } |
12 }, | 17 }, |
13 { | 18 { |
14 "id": "ReplayURLsResult", | 19 "id": "ReplayURLsResult", |
15 "type": "object", | 20 "type": "object", |
16 "description": "", | 21 "description": "Return value for Replay callback", |
17 "properties": { | 22 "properties": { |
18 "runTime": {"type": "integer", "description": "Time in milliseconds to
complete all runs."}, | 23 "runTime": { |
19 "stats": {"type": "string", "description": "Full multiline dump of out
put stats."}, | 24 "type": "number", |
20 "errors": {"type": "array", "items": {"type": "string"}, "description"
: "List of errors during replay."} | 25 "description": "Time in milliseconds to complete all runs." |
| 26 }, |
| 27 "stats": { |
| 28 "type": "string", |
| 29 "description": "Full multiline dump of output stats, showing one st
atistic per line, comprising an abbreviated statistic name and its value (e.g. v
msize_f_b= 696164352 bytes for final vm size). This is ugly, and will be change
d shortly." |
| 30 }, |
| 31 "errors": { |
| 32 "type": "array", |
| 33 "items": {"type": "string"}, |
| 34 "description": "List of errors during replay. Presently, this shoul
d only be abnormal browser termination for unexpected reasons." |
| 35 } |
21 } | 36 } |
22 } | 37 } |
23 ], | 38 ], |
24 "functions": [ | 39 "functions": [ |
25 { | 40 { |
26 "name": "captureURLs", | 41 "name": "captureURLs", |
27 "description": "", | 42 "description": "", |
28 "type": "function", | 43 "type": "function", |
29 "parameters": [ | 44 "parameters": [ |
30 { | 45 { |
| 46 "type": "string", |
| 47 "description": "Unique name of the capture.", |
| 48 "name": "captureName" |
| 49 }, |
| 50 { |
31 "type": "array", | 51 "type": "array", |
32 "items": {"type": "string"}, | 52 "items": {"type": "string"}, |
| 53 "description": "URL list to visit during capture.", |
33 "name": "urls" | 54 "name": "urls" |
34 }, | 55 }, |
35 { | 56 { |
36 "type": "string", | |
37 "name": "cacheDirectoryPath" | |
38 }, | |
39 { | |
40 "name": "callback", | 57 "name": "callback", |
41 "type": "function", | 58 "type": "function", |
42 "description": "Called when capture has completed.", | 59 "description": "Called when capture has completed.", |
43 "optional": true, | 60 "optional": true, |
44 "parameters": [ | 61 "parameters": [ |
45 { | 62 { |
46 "type": "array", | 63 "type": "array", |
47 "items": {"type": "string"}, | 64 "items": {"type": "string"}, |
48 "name": "errors" | 65 "name": "errors", |
| 66 "description": "List of any URLs that failed to load, one error
per textline, along with failure reason (e.g. unknown domain). Also may include
general abnormal-exit message if the subbrowser run failed for other reasons." |
49 } | 67 } |
50 ] | 68 ] |
51 } | 69 } |
52 ] | 70 ] |
53 }, | 71 }, |
54 { | 72 { |
55 "name": "replayURLs", | 73 "name": "replayURLs", |
56 "description": "", | 74 "description": "", |
57 "type": "function", | 75 "type": "function", |
58 "parameters": [ | 76 "parameters": [ |
59 { | 77 { |
60 "type": "array", | |
61 "items": {"type": "string"}, | |
62 "name": "urls" | |
63 }, | |
64 { | |
65 "type": "string", | 78 "type": "string", |
66 "name": "captureDirectoryPath" | 79 "name": "captureName", |
| 80 "description": "Unique name of capture. Use to determine cache." |
67 }, | 81 }, |
68 { | 82 { |
69 "type": "integer", | 83 "type": "integer", |
70 "name": "repeatCount", | 84 "name": "repeatCount", |
71 "minimum": 0, | 85 "minimum": 0, |
72 "maximum": 100 | 86 "maximum": 100 |
73 }, | 87 }, |
74 { | 88 { |
75 "$ref": "SessionDetails", | 89 "$ref": "SessionDetails", |
76 "name": "details", | 90 "name": "details", |
77 "optional": true | 91 "optional": true |
78 }, | 92 }, |
79 { | 93 { |
80 "name": "callback", | 94 "name": "callback", |
81 "type": "function", | 95 "type": "function", |
| 96 "optional": true, |
82 "description": "Called when playback has completed.", | 97 "description": "Called when playback has completed.", |
83 "parameters": [{"$ref": "ReplayURLsResult", "name": "result"}] | 98 "parameters": [ |
| 99 { |
| 100 "$ref": "ReplayURLsResult", |
| 101 "name": "result" |
| 102 } |
| 103 ] |
84 } | 104 } |
85 ] | 105 ] |
86 } | 106 } |
87 ] | 107 ] |
88 } | 108 } |
89 ] | 109 ] |
OLD | NEW |