chromedp/cmd/chromedp-gen/har.json
Kenneth Shaw 7fbfef7cf1 Adding synthesized "HAR" domain to protocol generation
* Added "HAR" domain
* Fixed issue with omitempty on domain types
2017-07-02 18:44:34 +07:00

640 lines
23 KiB
JSON

{
"version": {
"major": "1",
"minor": "2"
},
"domains": [
{
"domain": "HAR",
"description": "HTTP Archive Format",
"types": [
{
"type": "object",
"id": "Cache",
"description": "This objects contains info about a request coming from browser cache.",
"properties": [
{
"name": "beforeRequest",
"description": "State of a cache entry before the request. Leave out this field if the information is not available.",
"optional": true,
"$ref": "CacheData"
},
{
"name": "afterRequest",
"description": "State of a cache entry after the request. Leave out this field if the information is not available.",
"optional": true,
"$ref": "CacheData"
},
{
"type": "string",
"name": "comment",
"description": "A comment provided by the user or the application.",
"optional": true
}
]
},
{
"type": "object",
"id": "CacheData",
"description": "Describes the cache data for beforeRequest and afterRequest.",
"properties": [
{
"type": "string",
"name": "expires",
"description": "Expiration time of the cache entry.",
"optional": true
},
{
"type": "string",
"name": "lastAccess",
"description": "The last time the cache entry was opened."
},
{
"type": "string",
"name": "eTag",
"description": "Etag"
},
{
"type": "integer",
"name": "hitCount",
"description": "The number of times the cache entry has been opened."
},
{
"type": "string",
"name": "comment",
"description": "A comment provided by the user or the application.",
"optional": true
}
]
},
{
"type": "object",
"id": "Content",
"description": "This object describes details about response content (embedded in \u003cresponse\u003e object).",
"properties": [
{
"type": "integer",
"name": "size",
"description": "Length of the returned content in bytes. Should be equal to response.bodySize if there is no compression and bigger when the content has been compressed."
},
{
"type": "integer",
"name": "compression",
"description": "Number of bytes saved. Leave out this field if the information is not available.",
"optional": true
},
{
"type": "string",
"name": "mimeType",
"description": "MIME type of the response text (value of the Content-Type response header). The charset attribute of the MIME type is included (if available)."
},
{
"type": "string",
"name": "text",
"description": "Response body sent from the server or loaded from the browser cache. This field is populated with textual content only. The text field is either HTTP decoded text or a encoded (e.g. \"base64\") representation of the response body. Leave out this field if the information is not available.",
"optional": true
},
{
"type": "string",
"name": "encoding",
"description": "Encoding used for response text field e.g \"base64\". Leave out this field if the text field is HTTP decoded (decompressed \u0026 unchunked), than trans-coded from its original character set into UTF-8.",
"optional": true
},
{
"type": "string",
"name": "comment",
"description": "A comment provided by the user or the application.",
"optional": true
}
]
},
{
"type": "object",
"id": "Cookie",
"description": "This object contains list of all cookies (used in \u003crequest\u003e and \u003cresponse\u003e objects).",
"properties": [
{
"type": "string",
"name": "name",
"description": "The name of the cookie."
},
{
"type": "string",
"name": "value",
"description": "The cookie value."
},
{
"type": "string",
"name": "path",
"description": "The path pertaining to the cookie.",
"optional": true
},
{
"type": "string",
"name": "domain",
"description": "The host of the cookie.",
"optional": true
},
{
"type": "string",
"name": "expires",
"description": "Cookie expiration time. (ISO 8601 - YYYY-MM-DDThh:mm:ss.sTZD, e.g. 2009-07-24T19:20:30.123+02:00).",
"optional": true
},
{
"type": "boolean",
"name": "httpOnly",
"description": "Set to true if the cookie is HTTP only, false otherwise.",
"optional": true
},
{
"type": "boolean",
"name": "secure",
"description": "True if the cookie was transmitted over ssl, false otherwise.",
"optional": true
},
{
"type": "string",
"name": "comment",
"description": "A comment provided by the user or the application.",
"optional": true
}
]
},
{
"type": "object",
"id": "Creator",
"description": "Creator and browser objects share the same structure.",
"properties": [
{
"type": "string",
"name": "name",
"description": "Name of the application/browser used to export the log."
},
{
"type": "string",
"name": "version",
"description": "Version of the application/browser used to export the log."
},
{
"type": "string",
"name": "comment",
"description": "A comment provided by the user or the application.",
"optional": true
}
]
},
{
"type": "object",
"id": "Entry",
"description": "This object represents an array with all exported HTTP requests. Sorting entries by startedDateTime (starting from the oldest) is preferred way how to export data since it can make importing faster. However the reader application should always make sure the array is sorted (if required for the import).",
"properties": [
{
"type": "string",
"name": "pageref",
"description": "Reference to the parent page. Leave out this field if the application does not support grouping by pages.",
"optional": true
},
{
"type": "string",
"name": "startedDateTime",
"description": "Date and time stamp of the request start (ISO 8601 - YYYY-MM-DDThh:mm:ss.sTZD)."
},
{
"type": "number",
"name": "time",
"description": "Total elapsed time of the request in milliseconds. This is the sum of all timings available in the timings object (i.e. not including -1 values) ."
},
{
"name": "request",
"description": "Detailed info about the request.",
"$ref": "Request"
},
{
"name": "response",
"description": "Detailed info about the response.",
"$ref": "Response"
},
{
"name": "cache",
"description": "Info about cache usage.",
"$ref": "Cache"
},
{
"name": "timings",
"description": "Detailed timing info about request/response round trip.",
"$ref": "Timings"
},
{
"type": "string",
"name": "serverIPAddress",
"description": "IP address of the server that was connected (result of DNS resolution).",
"optional": true
},
{
"type": "string",
"name": "connection",
"description": "Unique ID of the parent TCP/IP connection, can be the client or server port number. Note that a port number doesn't have to be unique identifier in cases where the port is shared for more connections. If the port isn't available for the application, any other unique connection ID can be used instead (e.g. connection index). Leave out this field if the application doesn't support this info.",
"optional": true
},
{
"type": "string",
"name": "comment",
"description": "A comment provided by the user or the application.",
"optional": true
}
]
},
{
"type": "object",
"id": "HAR",
"description": "Parent container for HAR log.",
"properties": [
{
"name": "log",
"$ref": "Log"
}
]
},
{
"type": "object",
"id": "Log",
"description": "This object represents the root of exported data.",
"properties": [
{
"type": "string",
"name": "version",
"description": "Version number of the format. If empty, string \"1.1\" is assumed by default."
},
{
"name": "creator",
"description": "Name and version info of the log creator application.",
"$ref": "Creator"
},
{
"name": "browser",
"description": "Name and version info of used browser.",
"optional": true,
"$ref": "Creator"
},
{
"type": "array",
"name": "pages",
"description": "List of all exported (tracked) pages. Leave out this field if the application does not support grouping by pages.",
"optional": true,
"items": {
"$ref": "Page"
}
},
{
"type": "array",
"name": "entries",
"description": "List of all exported (tracked) requests.",
"items": {
"$ref": "Entry"
}
},
{
"type": "string",
"name": "comment",
"description": "A comment provided by the user or the application.",
"optional": true
}
]
},
{
"type": "object",
"id": "NameValuePair",
"description": "Describes a name/value pair.",
"properties": [
{
"type": "string",
"name": "name",
"description": "Name of the pair."
},
{
"type": "string",
"name": "value",
"description": "Value of the pair."
},
{
"type": "string",
"name": "comment",
"description": "A comment provided by the user or the application.",
"optional": true
}
]
},
{
"type": "object",
"id": "Page",
"description": "This object represents list of exported pages.",
"properties": [
{
"type": "string",
"name": "startedDateTime",
"description": "Date and time stamp for the beginning of the page load (ISO 8601 - YYYY-MM-DDThh:mm:ss.sTZD, e.g. 2009-07-24T19:20:30.45+01:00)."
},
{
"type": "string",
"name": "id",
"description": "Unique identifier of a page within the \u003clog\u003e. Entries use it to refer the parent page."
},
{
"type": "string",
"name": "title",
"description": "Page title."
},
{
"name": "pageTimings",
"description": "Detailed timing info about page load.",
"$ref": "PageTimings"
},
{
"type": "string",
"name": "comment",
"description": "A comment provided by the user or the application.",
"optional": true
}
]
},
{
"type": "object",
"id": "PageTimings",
"description": "This object describes timings for various events (states) fired during the page load. All times are specified in milliseconds. If a time info is not available appropriate field is set to -1.",
"properties": [
{
"type": "number",
"name": "onContentLoad",
"description": "Content of the page loaded. Number of milliseconds since page load started (page.startedDateTime). Use -1 if the timing does not apply to the current request.",
"optional": true
},
{
"type": "number",
"name": "onLoad",
"description": "Page is loaded (onLoad event fired). Number of milliseconds since page load started (page.startedDateTime). Use -1 if the timing does not apply to the current request.",
"optional": true
},
{
"type": "string",
"name": "comment",
"description": "A comment provided by the user or the application.",
"optional": true
}
]
},
{
"type": "object",
"id": "Param",
"description": "List of posted parameters, if any (embedded in \u003cpostData\u003e object).",
"properties": [
{
"type": "string",
"name": "name",
"description": "name of a posted parameter."
},
{
"type": "string",
"name": "value",
"description": "value of a posted parameter or content of a posted file.",
"optional": true
},
{
"type": "string",
"name": "fileName",
"description": "name of a posted file.",
"optional": true
},
{
"type": "string",
"name": "contentType",
"description": "content type of a posted file.",
"optional": true
},
{
"type": "string",
"name": "comment",
"description": "A comment provided by the user or the application.",
"optional": true
}
]
},
{
"type": "object",
"id": "PostData",
"description": "This object describes posted data, if any (embedded in \u003crequest\u003e object).",
"properties": [
{
"type": "string",
"name": "mimeType",
"description": "Mime type of posted data."
},
{
"type": "array",
"name": "params",
"description": "List of posted parameters (in case of URL encoded parameters).",
"items": {
"$ref": "Param"
}
},
{
"type": "string",
"name": "text",
"description": "Plain text posted data"
},
{
"type": "string",
"name": "comment",
"description": "A comment provided by the user or the application.",
"optional": true
}
]
},
{
"type": "object",
"id": "Request",
"description": "This object contains detailed info about performed request.",
"properties": [
{
"type": "string",
"name": "method",
"description": "Request method (GET, POST, ...)."
},
{
"type": "string",
"name": "url",
"description": "Absolute URL of the request (fragments are not included)."
},
{
"type": "string",
"name": "httpVersion",
"description": "Request HTTP Version."
},
{
"type": "array",
"name": "cookies",
"description": "List of cookie objects.",
"items": {
"$ref": "Cookie"
}
},
{
"type": "array",
"name": "headers",
"description": "List of header objects.",
"items": {
"$ref": "NameValuePair"
}
},
{
"type": "array",
"name": "queryString",
"description": "List of query parameter objects.",
"items": {
"$ref": "NameValuePair"
}
},
{
"name": "postData",
"description": "Posted data info.",
"optional": true,
"$ref": "PostData"
},
{
"type": "integer",
"name": "headersSize",
"description": "Total number of bytes from the start of the HTTP request message until (and including) the double CRLF before the body. Set to -1 if the info is not available."
},
{
"type": "integer",
"name": "bodySize",
"description": "Size of the request body (POST data payload) in bytes. Set to -1 if the info is not available."
},
{
"type": "string",
"name": "comment",
"description": "A comment provided by the user or the application.",
"optional": true
}
]
},
{
"type": "object",
"id": "Response",
"description": "This object contains detailed info about the response.",
"properties": [
{
"type": "integer",
"name": "status",
"description": "Response status."
},
{
"type": "string",
"name": "statusText",
"description": "Response status description."
},
{
"type": "string",
"name": "httpVersion",
"description": "Response HTTP Version."
},
{
"type": "array",
"name": "cookies",
"description": "List of cookie objects.",
"items": {
"$ref": "Cookie"
}
},
{
"type": "array",
"name": "headers",
"description": "List of header objects.",
"items": {
"$ref": "NameValuePair"
}
},
{
"name": "content",
"description": "Details about the response body.",
"$ref": "Content"
},
{
"type": "string",
"name": "redirectURL",
"description": "Redirection target URL from the Location response header."
},
{
"type": "integer",
"name": "headersSize",
"description": "Total number of bytes from the start of the HTTP response message until (and including) the double CRLF before the body. Set to -1 if the info is not available."
},
{
"type": "integer",
"name": "bodySize",
"description": "Size of the received response body in bytes. Set to zero in case of responses coming from the cache (304). Set to -1 if the info is not available."
},
{
"type": "string",
"name": "comment",
"description": "A comment provided by the user or the application.",
"optional": true
}
]
},
{
"type": "object",
"id": "Timings",
"description": "This object describes various phases within request-response round trip. All times are specified in milliseconds.",
"properties": [
{
"type": "number",
"name": "blocked",
"description": "Time spent in a queue waiting for a network connection. Use -1 if the timing does not apply to the current request.",
"optional": true
},
{
"type": "number",
"name": "dns",
"description": "DNS resolution time. The time required to resolve a host name. Use -1 if the timing does not apply to the current request.",
"optional": true
},
{
"type": "number",
"name": "connect",
"description": "Time required to create TCP connection. Use -1 if the timing does not apply to the current request.",
"optional": true
},
{
"type": "number",
"name": "send",
"description": "Time required to send HTTP request to the server."
},
{
"type": "number",
"name": "wait",
"description": "Waiting for a response from the server."
},
{
"type": "number",
"name": "receive",
"description": "Time required to read entire response from the server (or cache)."
},
{
"type": "number",
"name": "ssl",
"description": "Time required for SSL/TLS negotiation. If this field is defined then the time is also included in the connect field (to ensure backward compatibility with HAR 1.1). Use -1 if the timing does not apply to the current request.",
"optional": true
},
{
"type": "string",
"name": "comment",
"description": "A comment provided by the user or the application.",
"optional": true
}
]
}
]
}
]
}