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

@@ -197,7 +197,7 @@
}
}
},
"revision": "20200407",
"revision": "20200630",
"rootUrl": "https://servicecontrol.googleapis.com/",
"schemas": {
"AllocateInfo": {
@@ -399,7 +399,7 @@
"type": "array"
},
"audiences": {
"description": "The intended audience(s) for this authentication information. Reflects\nthe audience (`aud`) claim within a JWT. The audience\nvalue(s) depends on the `issuer`, but typically include one or more of\nthe following pieces of information:\n\n* The services intended to receive the credential such as\n [\"pubsub.googleapis.com\", \"storage.googleapis.com\"]\n* A set of service-based scopes. For example,\n [\"https://www.googleapis.com/auth/cloud-platform\"]\n* The client id of an app, such as the Firebase project id for JWTs\n from Firebase Auth.\n\nConsult the documentation for the credential issuer to determine the\ninformation provided.",
"description": "The intended audience(s) for this authentication information. Reflects\nthe audience (`aud`) claim within a JWT. The audience\nvalue(s) depends on the `issuer`, but typically include one or more of\nthe following pieces of information:\n\n* The services intended to receive the credential. For example,\n [\"https://pubsub.googleapis.com/\", \"https://storage.googleapis.com/\"].\n* A set of service-based scopes. For example,\n [\"https://www.googleapis.com/auth/cloud-platform\"].\n* The client id of an app, such as the Firebase project id for JWTs\n from Firebase Auth.\n\nConsult the documentation for the credential issuer to determine the\ninformation provided.",
"items": {
"type": "string"
},
@@ -578,7 +578,7 @@
"description": "Contains public information about the check error. If available,\n`status.code` will be non zero and client can propagate it out as public\nerror."
},
"subject": {
"description": "Subject to whom this error applies. See the specific code enum for more\ndetails on this field. For example:\n - \u201cproject:<project-id or project-number>\u201d\n - \u201cfolder:<folder-id>\u201d\n - \u201corganization:<organization-id>\u201d",
"description": "Subject to whom this error applies. See the specific code enum for more\ndetails on this field. For example:\n\n- \"project:<project-id or project-number>\"\n- \"folder:<folder-id>\"\n- \"organization:<organization-id>\"",
"type": "string"
}
},
@@ -1165,6 +1165,17 @@
"format": "google-datetime",
"type": "string"
},
"extensions": {
"description": "Unimplemented.",
"items": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
},
"type": "array"
},
"importance": {
"description": "DO NOT USE. This is an experimental field.",
"enum": [
@@ -1389,14 +1400,16 @@
"NORMAL",
"BEST_EFFORT",
"CHECK_ONLY",
"QUERY_ONLY"
"QUERY_ONLY",
"ADJUST_ONLY"
],
"enumDescriptions": [
"Guard against implicit default. Must not be used.",
"For AllocateQuota request, allocates quota for the amount specified in\nthe service configuration or specified using the quota metrics. If the\namount is higher than the available quota, allocation error will be\nreturned and no quota will be allocated.\nIf multiple quotas are part of the request, and one fails, none of the\nquotas are allocated or released.",
"The operation allocates quota for the amount specified in the service\nconfiguration or specified using the quota metrics. If the amount is\nhigher than the available quota, request does not fail but all available\nquota will be allocated.\nFor rate quota, BEST_EFFORT will continue to deduct from other groups\neven if one does not have enough quota. For allocation, it will find the\nminimum available amount across all groups and deduct that amount from\nall the affected groups.",
"For AllocateQuota request, only checks if there is enough quota\navailable and does not change the available quota. No lock is placed on\nthe available quota either.",
"Unimplemented. When used in AllocateQuotaRequest, this returns the\neffective quota limit(s) in the response, and no quota check will be\nperformed. Not supported for other requests, and even for\nAllocateQuotaRequest, this is currently supported only for whitelisted\nservices."
"Unimplemented. When used in AllocateQuotaRequest, this returns the\neffective quota limit(s) in the response, and no quota check will be\nperformed. Not supported for other requests, and even for\nAllocateQuotaRequest, this is currently supported only for whitelisted\nservices.",
"The operation allocates quota for the amount specified in the service\nconfiguration or specified using the quota metrics. If the requested\namount is higher than the available quota, request does not fail and\nremaining quota would become negative (going over the limit)\nNot supported for Rate Quota."
],
"type": "string"
}