update API descriptions

This commit is contained in:
Sebastian Thiel
2020-07-10 09:11:32 +08:00
parent b6ee34dcff
commit 69fb05c4e1
271 changed files with 82506 additions and 23249 deletions

View File

@@ -273,7 +273,7 @@
}
}
},
"revision": "20200408",
"revision": "20200708",
"rootUrl": "https://testing.googleapis.com/",
"schemas": {
"Account": {
@@ -457,12 +457,14 @@
"enum": [
"DEVICE_FORM_UNSPECIFIED",
"VIRTUAL",
"PHYSICAL"
"PHYSICAL",
"EMULATOR"
],
"enumDescriptions": [
"Do not use. For proto versioning only.",
"A software stack that simulates the device.",
"Actual hardware."
"Android virtual device using Compute Engine native virtualization. Firebase\nTest Lab only.",
"Actual hardware.",
"Android virtual device using emulator in nested virtualization. Equivalent\nto Android Studio."
],
"type": "string"
},
@@ -535,7 +537,7 @@
"type": "array"
},
"thumbnailUrl": {
"description": "URL of a thumbnail image of the device.",
"description": "URL of a thumbnail image (photo) of the device.\ne.g. https://lh3.googleusercontent.com/90WcauuJiCYABEl8U0lcZeuS5STUbf2yW...",
"type": "string"
}
},
@@ -936,7 +938,7 @@
"id": "FileReference",
"properties": {
"gcsPath": {
"description": "A path to a file in Google Cloud Storage.\nExample: gs://build-app-1414623860166/app-debug-unaligned.apk",
"description": "A path to a file in Google Cloud Storage.\nExample: gs://build-app-1414623860166/app%40debug-unaligned.apk\nThese paths are expected to be url encoded (percent encoding)",
"type": "string"
}
},
@@ -1065,7 +1067,7 @@
"type": "object"
},
"IosModel": {
"description": "A description of an iOS device tests may be run on.\nNext tag: 12",
"description": "A description of an iOS device tests may be run on.\nNext tag: 13",
"id": "IosModel",
"properties": {
"deviceCapabilities": {
@@ -1229,6 +1231,10 @@
"description": "Output only. The bundle id for the application under test.",
"type": "string"
},
"testSpecialEntitlements": {
"description": "The option to test special app entitlements. Setting this would re-sign the\napp having special entitlements with an explicit application-identifier.\nCurrently supports testing aps-environment entitlement.",
"type": "boolean"
},
"testsZip": {
"$ref": "FileReference",
"description": "Required. The .zip containing the .xctestrun file and the contents of the\nDerivedData/Build/Products directory.\nThe .xctestrun file in this zip is ignored if the xctestrun field is\nspecified."
@@ -1281,7 +1287,7 @@
"id": "ManualSharding",
"properties": {
"testTargetsForShard": {
"description": "Required. Group of packages, classes, and/or test methods to be run for\neach shard. The number of shard_test_targets must be >= 1 and <= 50.",
"description": "Required. Group of packages, classes, and/or test methods to be run for\neach shard. When any physical devices are selected, the number of\ntest_targets_for_shard must be >= 1 and <= 50. When no physical devices are\nselected, the number must be >= 1 and <= 250.",
"items": {
"$ref": "TestTargetsForShard"
},
@@ -1377,7 +1383,7 @@
"description": "Required. The source file."
},
"devicePath": {
"description": "Required. Where to put the content on the device. Must be an absolute,\nwhitelisted path. If the file exists, it will be replaced.\nThe following device-side directories and any of their subdirectories are\nwhitelisted:\n<p>${EXTERNAL_STORAGE}, or /sdcard</p>\n<p>${ANDROID_DATA}/local/tmp, or /data/local/tmp</p>\n<p>Specifying a path outside of these directory trees is invalid.\n\n<p> The paths /sdcard and /data will be made available and treated as\nimplicit path substitutions. E.g. if /sdcard on a particular device does\nnot map to external storage, the system will replace it with the external\nstorage path prefix for that device and copy the file there.\n\n<p> It is strongly advised to use the <a href=\n\"http://developer.android.com/reference/android/os/Environment.html\">\nEnvironment API</a> in app and test code to access files on the device in a\nportable way.",
"description": "Required. Where to put the content on the device. Must be an absolute,\nallowlisted path. If the file exists, it will be replaced.\nThe following device-side directories and any of their subdirectories are\nallowlisted:\n<p>${EXTERNAL_STORAGE}, /sdcard, or /storage</p>\n<p>${ANDROID_DATA}/local/tmp, or /data/local/tmp</p>\n<p>Specifying a path outside of these directory trees is invalid.\n\n<p> The paths /sdcard and /data will be made available and treated as\nimplicit path substitutions. E.g. if /sdcard on a particular device does\nnot map to external storage, the system will replace it with the external\nstorage path prefix for that device and copy the file there.\n\n<p> It is strongly advised to use the <a href=\n\"http://developer.android.com/reference/android/os/Environment.html\">\nEnvironment API</a> in app and test code to access files on the device in a\nportable way.",
"type": "string"
}
},
@@ -1831,12 +1837,16 @@
"type": "array"
},
"directoriesToPull": {
"description": "List of directories on the device to upload to GCS at the end of the test;\nthey must be absolute paths under /sdcard or /data/local/tmp.\nPath names are restricted to characters a-z A-Z 0-9 _ - . + and /\n\nNote: The paths /sdcard and /data will be made available and treated as\nimplicit path substitutions. E.g. if /sdcard on a particular device does\nnot map to external storage, the system will replace it with the external\nstorage path prefix for that device.",
"description": "List of directories on the device to upload to GCS at the end of the test;\nthey must be absolute paths under /sdcard, /storage or /data/local/tmp.\nPath names are restricted to characters a-z A-Z 0-9 _ - . + and /\n\nNote: The paths /sdcard and /data will be made available and treated as\nimplicit path substitutions. E.g. if /sdcard on a particular device does\nnot map to external storage, the system will replace it with the external\nstorage path prefix for that device.",
"items": {
"type": "string"
},
"type": "array"
},
"dontAutograntPermissions": {
"description": "Whether to prevent all runtime permissions to be granted at app install",
"type": "boolean"
},
"environmentVariables": {
"description": "Environment variables to set for the test (only applicable for\ninstrumentation tests).",
"items": {
@@ -2018,7 +2028,7 @@
"id": "UniformSharding",
"properties": {
"numShards": {
"description": "Required. Total number of shards. The number must be >= 1 and <= 50.",
"description": "Required. Total number of shards. When any physical devices are selected,\nthe number must be >= 1 and <= 50. When no physical devices are selected,\nthe number must be >= 1 and <= 250.",
"format": "int32",
"type": "integer"
}