More info for crash reporter form type and payload
authorThanasis Polychronakis <thanpolas@gmail.com>
Tue, 15 Mar 2016 13:49:34 +0000 (15:49 +0200)
committerThanasis Polychronakis <thanpolas@gmail.com>
Tue, 15 Mar 2016 13:49:34 +0000 (15:49 +0200)
docs/api/crash-reporter.md

index 98465df..5a7ff72 100644 (file)
@@ -54,7 +54,7 @@ ID.
 
 ## crash-reporter Payload
 
-The crash reporter will send the following data to the `submitURL` as `POST`:
+The crash reporter will send the following data to the `submitURL` as a `multipart/form-data` `POST`:
 
 * `ver` String - The version of Electron.
 * `platform` String - e.g. 'win32'.
@@ -66,6 +66,6 @@ The crash reporter will send the following data to the `submitURL` as `POST`:
 * `prod` String - Name of the underlying product. In this case Electron.
 * `_companyName` String - The company name in the `crashReporter` `options`
   object.
-* `upload_file_minidump` File - The crash report as file.
+* `upload_file_minidump` File - The crash report as file, a binary.
 * All level one properties of the `extra` object in the `crashReporter`.
   `options` object