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

@@ -599,7 +599,7 @@
}
}
},
"revision": "20200403",
"revision": "20200615",
"rootUrl": "https://osconfig.googleapis.com/",
"schemas": {
"AptRepository": {
@@ -890,7 +890,7 @@
"type": "object"
},
"ExecutePatchJobRequest": {
"description": "A request message to initiate patching across Google Compute Engine\ninstances.",
"description": "A request message to initiate patching across Compute Engine instances.",
"id": "ExecutePatchJobRequest",
"properties": {
"description": {
@@ -1124,7 +1124,7 @@
"type": "object"
},
"OneTimeSchedule": {
"description": "Sets the time for a one time patch deployment. Timestamp is in\n<a href=\"https://www.ietf.org/rfc/rfc3339.txt\" target=\"_blank\">RFC3339</a>\ntext format.",
"description": "Sets the time for a one time patch deployment. Timestamp is in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
"id": "OneTimeSchedule",
"properties": {
"executeTime": {
@@ -1257,11 +1257,11 @@
"type": "object"
},
"PatchDeployment": {
"description": "Patch deployments are configurations that individual patch jobs use to\ncomplete a patch. These configurations include instance filter, package\nrepository settings, and a schedule. For more information about creating and\nmanaging patch deployments, see [Scheduling patch\njobs](/compute/docs/os-patch-management/schedule-patch-jobs).",
"description": "Patch deployments are configurations that individual patch jobs use to\ncomplete a patch. These configurations include instance filter, package\nrepository settings, and a schedule. For more information about creating and\nmanaging patch deployments, see [Scheduling patch\njobs](https://cloud.google.com/compute/docs/os-patch-management/schedule-patch-jobs).",
"id": "PatchDeployment",
"properties": {
"createTime": {
"description": "Output only. Time the patch deployment was created. Timestamp is in\n<a href=\"https://www.ietf.org/rfc/rfc3339.txt\" target=\"_blank\">RFC3339</a>\ntext format.",
"description": "Output only. Time the patch deployment was created. Timestamp is in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
"format": "google-datetime",
"type": "string"
},
@@ -1279,7 +1279,7 @@
"description": "Required. VM instances to patch."
},
"lastExecuteTime": {
"description": "Output only. The last time a patch job was started by this deployment.\nTimestamp is in\n<a href=\"https://www.ietf.org/rfc/rfc3339.txt\" target=\"_blank\">RFC3339</a>\ntext format.",
"description": "Output only. The last time a patch job was started by this deployment.\nTimestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text\nformat.",
"format": "google-datetime",
"type": "string"
},
@@ -1300,7 +1300,7 @@
"description": "Required. Schedule recurring executions."
},
"updateTime": {
"description": "Output only. Time the patch deployment was last updated. Timestamp is in\n<a href=\"https://www.ietf.org/rfc/rfc3339.txt\" target=\"_blank\">RFC3339</a>\ntext format.",
"description": "Output only. Time the patch deployment was last updated. Timestamp is in\n[RFC3339](\"https://www.ietf.org/rfc/rfc3339.txt) text format.",
"format": "google-datetime",
"type": "string"
}
@@ -1354,14 +1354,14 @@
"additionalProperties": {
"type": "string"
},
"description": "Google Compute Engine instance labels that must be present for a VM\ninstance to be targeted by this filter.",
"description": "Compute Engine instance labels that must be present for a VM instance to\nbe targeted by this filter.",
"type": "object"
}
},
"type": "object"
},
"PatchJob": {
"description": "A high level representation of a patch job that is either in progress\nor has completed.\n\nInstances details are not included in the job. To paginate through instance\ndetails, use ListPatchJobInstanceDetails.\n\nFor more information about patch jobs, see\n[Creating patch jobs](/compute/docs/os-patch-management/create-patch-job).",
"description": "A high level representation of a patch job that is either in progress\nor has completed.\n\nInstance details are not included in the job. To paginate through instance\ndetails, use `ListPatchJobInstanceDetails`.\n\nFor more information about patch jobs, see\n[Creating patch\njobs](https://cloud.google.com/compute/docs/os-patch-management/create-patch-job).",
"id": "PatchJob",
"properties": {
"createTime": {
@@ -1416,7 +1416,7 @@
"type": "number"
},
"state": {
"description": "The current state of the PatchJob .",
"description": "The current state of the PatchJob.",
"enum": [
"STATE_UNSPECIFIED",
"STARTED",
@@ -1448,7 +1448,7 @@
"type": "object"
},
"PatchJobInstanceDetails": {
"description": "Patch details for a VM instance. For more information about reviewing VM\ninstance details, see\n[Listing all VM instance details for a specific patch\njob](/compute/docs/os-patch-management/manage-patch-jobs#list-instance-details).",
"description": "Patch details for a VM instance. For more information about reviewing VM\ninstance details, see\n[Listing all VM instance details for a specific patch\njob](https://cloud.google.com/compute/docs/os-patch-management/manage-patch-jobs#list-instance-details).",
"id": "PatchJobInstanceDetails",
"properties": {
"attemptCount": {
@@ -1651,7 +1651,7 @@
"type": "object"
},
"SoftwareRecipe": {
"description": "A software recipe is a set of instructions for installing and configuring a\npiece of software. It consists of a set of artifacts that are\ndownloaded, and a set of steps that install, configure, and/or update the\nsoftware.\n\nRecipes support installing and updating software from artifacts in the\nfollowing formats:\nZip archive, Tar archive, Windows MSI, Debian package, and RPM package.\n\nAdditionally, recipes support executing a script (either defined in a file or\ndirectly in this api) in bash, sh, cmd, and powershell.\n\nUpdating a software recipe\n\nIf a recipe is assigned to an instance and there is a recipe with the same\nname but a lower version already installed and the assigned state\nof the recipe is `INSTALLED_KEEP_UPDATED`, then the recipe is updated to\nthe new version.\n\nScript Working Directories\n\nEach script or execution step is run in its own temporary directory which\nis deleted after completing the step.",
"description": "A software recipe is a set of instructions for installing and configuring a\npiece of software. It consists of a set of artifacts that are\ndownloaded, and a set of steps that install, configure, and/or update the\nsoftware.\n\nRecipes support installing and updating software from artifacts in the\nfollowing formats:\nZip archive, Tar archive, Windows MSI, Debian package, and RPM package.\n\nAdditionally, recipes support executing a script (either defined in a file or\ndirectly in this api) in bash, sh, cmd, and powershell.\n\nUpdating a software recipe\n\nIf a recipe is assigned to an instance and there is a recipe with the same\nname but a lower version already installed and the assigned state\nof the recipe is `UPDATED`, then the recipe is updated to\nthe new version.\n\nScript Working Directories\n\nEach script or execution step is run in its own temporary directory which\nis deleted after completing the step.",
"id": "SoftwareRecipe",
"properties": {
"artifacts": {
@@ -1662,7 +1662,7 @@
"type": "array"
},
"desiredState": {
"description": "Default is INSTALLED. The desired state the agent should maintain for this\nrecipe.\n\nINSTALLED: The software recipe is installed on the instance but\n won't be updated to new versions.\nINSTALLED_KEEP_UPDATED: The software recipe is installed on the\n instance. The recipe is updated to a higher\n version, if a higher version of the recipe is\n assigned to this instance.\nREMOVE: Remove is unsupported for software recipes and attempts to\n create or update a recipe to the REMOVE state is rejected.",
"description": "Default is INSTALLED. The desired state the agent should maintain for this\nrecipe.\n\nINSTALLED: The software recipe is installed on the instance but\n won't be updated to new versions.\nUPDATED: The software recipe is installed on the instance. The recipe is\n updated to a higher version, if a higher version of the recipe is\n assigned to this instance.\nREMOVE: Remove is unsupported for software recipes and attempts to\n create or update a recipe to the REMOVE state is rejected.",
"enum": [
"DESIRED_STATE_UNSPECIFIED",
"INSTALLED",