John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 75 | <h1><a href="discovery_v1.html">API Discovery Service</a> . <a href="discovery_v1.apis.html">apis</a></h1> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 78 | <code><a href="#close">close()</a></code></p> |
| 79 | <p class="firstline">Close httplib2 connections.</p> |
| 80 | <p class="toc_element"> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 81 | <code><a href="#getRest">getRest(api, version)</a></code></p> |
| 82 | <p class="firstline">Retrieve the description of a particular version of an api.</p> |
| 83 | <p class="toc_element"> |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 84 | <code><a href="#list">list(name=None, preferred=None)</a></code></p> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 85 | <p class="firstline">Retrieve the list of APIs supported at this endpoint.</p> |
| 86 | <h3>Method Details</h3> |
| 87 | <div class="method"> |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 88 | <code class="details" id="close">close()</code> |
| 89 | <pre>Close httplib2 connections.</pre> |
| 90 | </div> |
| 91 | |
| 92 | <div class="method"> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 93 | <code class="details" id="getRest">getRest(api, version)</code> |
| 94 | <pre>Retrieve the description of a particular version of an api. |
| 95 | |
| 96 | Args: |
| 97 | api: string, The name of the API. (required) |
| 98 | version: string, The version of the API. (required) |
| 99 | |
| 100 | Returns: |
| 101 | An object of the form: |
| 102 | |
| 103 | { |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 104 | "revision": "A String", # The version of this API. |
| 105 | "discoveryVersion": "v1", # Indicate the version of the Discovery API used to generate this doc. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 106 | "basePath": "A String", # [DEPRECATED] The base path for REST requests. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 107 | "servicePath": "A String", # The base path for all REST requests. |
| 108 | "ownerName": "A String", # The name of the owner of this API. See ownerDomain. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 109 | "auth": { # Authentication information. |
| 110 | "oauth2": { # OAuth 2.0 authentication information. |
| 111 | "scopes": { # Available OAuth 2.0 scopes. |
| 112 | "a_key": { # The scope value. |
| 113 | "description": "A String", # Description of scope. |
| 114 | }, |
| 115 | }, |
| 116 | }, |
| 117 | }, |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 118 | "icons": { # Links to 16x16 and 32x32 icons representing the API. |
| 119 | "x16": "A String", # The URL of the 16x16 icon. |
| 120 | "x32": "A String", # The URL of the 32x32 icon. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 121 | }, |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 122 | "methods": { # API-level methods for this API. |
| 123 | "a_key": { # An individual method description. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 124 | "supportsSubscription": True or False, # Whether this method supports subscriptions. |
| 125 | "scopes": [ # OAuth 2.0 scopes applicable to this method. |
| 126 | "A String", |
| 127 | ], |
| 128 | "etagRequired": True or False, # Whether this method requires an ETag to be specified. The ETag is sent as an HTTP If-Match or If-None-Match header. |
| 129 | "mediaUpload": { # Media upload parameters. |
| 130 | "accept": [ # MIME Media Ranges for acceptable media uploads to this method. |
| 131 | "A String", |
| 132 | ], |
| 133 | "maxSize": "A String", # Maximum size of a media upload, such as "1MB", "2GB" or "3TB". |
| 134 | "protocols": { # Supported upload protocols. |
| 135 | "simple": { # Supports uploading as a single HTTP request. |
| 136 | "path": "A String", # The URI path to be used for upload. Should be used in conjunction with the basePath property at the api-level. |
| 137 | "multipart": true, # True if this endpoint supports upload multipart media. |
| 138 | }, |
| 139 | "resumable": { # Supports the Resumable Media Upload protocol. |
| 140 | "multipart": true, # True if this endpoint supports uploading multipart media. |
| 141 | "path": "A String", # The URI path to be used for upload. Should be used in conjunction with the basePath property at the api-level. |
| 142 | }, |
| 143 | }, |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 144 | }, |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 145 | "supportsMediaUpload": True or False, # Whether this method supports media uploads. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 146 | "parameters": { # Details for all parameters in this method. |
| 147 | "a_key": { # Details for a single parameter in this method. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 148 | "readOnly": True or False, # The value is read-only, generated by the service. The value cannot be modified by the client. If the value is included in a POST, PUT, or PATCH request, it is ignored by the service. |
| 149 | "repeated": True or False, # Whether this parameter may appear multiple times. |
| 150 | "description": "A String", # A description of this object. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 151 | "default": "A String", # The default value of this property (if one exists). |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 152 | "enum": [ # Values this parameter may take (if it is an enum). |
| 153 | "A String", |
| 154 | ], |
| 155 | "type": "A String", # The value type for this schema. A list of values can be found here: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1 |
| 156 | "minimum": "A String", # The minimum value of this parameter. |
| 157 | "location": "A String", # Whether this parameter goes in the query or the path for REST requests. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 158 | "variant": { # In a variant data type, the value of one property is used to determine how to interpret the entire entity. Its value must exist in a map of descriminant values to schema names. |
| 159 | "map": [ # The map of discriminant value to schema to use for parsing.. |
| 160 | { |
| 161 | "type_value": "A String", |
| 162 | "$ref": "A String", |
| 163 | }, |
| 164 | ], |
| 165 | "discriminant": "A String", # The name of the type discriminant property. |
| 166 | }, |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 167 | "$ref": "A String", # A reference to another schema. The value of this property is the "id" of another schema. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 168 | "format": "A String", # An additional regular expression or key that helps constrain the value. For more details see: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.23 |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 169 | "additionalProperties": # Object with schema name: JsonSchema # If this is a schema for an object, this property is the schema for any additional properties with dynamic keys on this object. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 170 | "properties": { # If this is a schema for an object, list the schema for each property of this object. |
| 171 | "a_key": # Object with schema name: JsonSchema # A single property of this object. The value is itself a JSON Schema object describing this property. |
| 172 | }, |
| 173 | "items": # Object with schema name: JsonSchema # If this is a schema for an array, this property is the schema for each element in the array. |
| 174 | "required": True or False, # Whether the parameter is required. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 175 | "annotations": { # Additional information about this property. |
| 176 | "required": [ # A list of methods for which this property is required on requests. |
| 177 | "A String", |
| 178 | ], |
| 179 | }, |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 180 | "enumDescriptions": [ # The descriptions for the enums. Each position maps to the corresponding value in the "enum" array. |
| 181 | "A String", |
| 182 | ], |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 183 | "id": "A String", # Unique identifier for this schema. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 184 | "maximum": "A String", # The maximum value of this parameter. |
| 185 | "pattern": "A String", # The regular expression this parameter must conform to. Uses Java 6 regex format: http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 186 | }, |
| 187 | }, |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 188 | "id": "A String", # A unique ID for this method. This property can be used to match methods between different versions of Discovery. |
| 189 | "useMediaDownloadService": True or False, # Indicates that downloads from this method should use the download service URL (i.e. "/download"). Only applies if the method supports media download. |
| 190 | "httpMethod": "A String", # HTTP method used by this method. |
| 191 | "parameterOrder": [ # Ordered list of required parameters, serves as a hint to clients on how to structure their method signatures. The array is ordered such that the "most-significant" parameter appears first. |
| 192 | "A String", |
| 193 | ], |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 194 | "path": "A String", # The URI path of this REST method. Should be used in conjunction with the basePath property at the api-level. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 195 | "description": "A String", # Description of this method. |
| 196 | "response": { # The schema for the response. |
| 197 | "$ref": "A String", # Schema ID for the response schema. |
| 198 | }, |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 199 | "request": { # The schema for the request. |
| 200 | "$ref": "A String", # Schema ID for the request schema. |
| 201 | "parameterName": "A String", # parameter name. |
| 202 | }, |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 203 | "supportsMediaDownload": True or False, # Whether this method supports media downloads. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 204 | }, |
| 205 | }, |
| 206 | "kind": "discovery#restDescription", # The kind for this response. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 207 | "id": "A String", # The ID of this API. |
| 208 | "features": [ # A list of supported features for this API. |
| 209 | "A String", |
| 210 | ], |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 211 | "resources": { # The resources in this API. |
| 212 | "a_key": { # An individual resource description. Contains methods and sub-resources related to this resource. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 213 | "methods": { # Methods on this resource. |
| 214 | "a_key": { # Description for any methods on this resource. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 215 | "supportsSubscription": True or False, # Whether this method supports subscriptions. |
| 216 | "scopes": [ # OAuth 2.0 scopes applicable to this method. |
| 217 | "A String", |
| 218 | ], |
| 219 | "etagRequired": True or False, # Whether this method requires an ETag to be specified. The ETag is sent as an HTTP If-Match or If-None-Match header. |
| 220 | "mediaUpload": { # Media upload parameters. |
| 221 | "accept": [ # MIME Media Ranges for acceptable media uploads to this method. |
| 222 | "A String", |
| 223 | ], |
| 224 | "maxSize": "A String", # Maximum size of a media upload, such as "1MB", "2GB" or "3TB". |
| 225 | "protocols": { # Supported upload protocols. |
| 226 | "simple": { # Supports uploading as a single HTTP request. |
| 227 | "path": "A String", # The URI path to be used for upload. Should be used in conjunction with the basePath property at the api-level. |
| 228 | "multipart": true, # True if this endpoint supports upload multipart media. |
| 229 | }, |
| 230 | "resumable": { # Supports the Resumable Media Upload protocol. |
| 231 | "multipart": true, # True if this endpoint supports uploading multipart media. |
| 232 | "path": "A String", # The URI path to be used for upload. Should be used in conjunction with the basePath property at the api-level. |
| 233 | }, |
| 234 | }, |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 235 | }, |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 236 | "supportsMediaUpload": True or False, # Whether this method supports media uploads. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 237 | "parameters": { # Details for all parameters in this method. |
| 238 | "a_key": { # Details for a single parameter in this method. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 239 | "readOnly": True or False, # The value is read-only, generated by the service. The value cannot be modified by the client. If the value is included in a POST, PUT, or PATCH request, it is ignored by the service. |
| 240 | "repeated": True or False, # Whether this parameter may appear multiple times. |
| 241 | "description": "A String", # A description of this object. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 242 | "default": "A String", # The default value of this property (if one exists). |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 243 | "enum": [ # Values this parameter may take (if it is an enum). |
| 244 | "A String", |
| 245 | ], |
| 246 | "type": "A String", # The value type for this schema. A list of values can be found here: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1 |
| 247 | "minimum": "A String", # The minimum value of this parameter. |
| 248 | "location": "A String", # Whether this parameter goes in the query or the path for REST requests. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 249 | "variant": { # In a variant data type, the value of one property is used to determine how to interpret the entire entity. Its value must exist in a map of descriminant values to schema names. |
| 250 | "map": [ # The map of discriminant value to schema to use for parsing.. |
| 251 | { |
| 252 | "type_value": "A String", |
| 253 | "$ref": "A String", |
| 254 | }, |
| 255 | ], |
| 256 | "discriminant": "A String", # The name of the type discriminant property. |
| 257 | }, |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 258 | "$ref": "A String", # A reference to another schema. The value of this property is the "id" of another schema. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 259 | "format": "A String", # An additional regular expression or key that helps constrain the value. For more details see: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.23 |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 260 | "additionalProperties": # Object with schema name: JsonSchema # If this is a schema for an object, this property is the schema for any additional properties with dynamic keys on this object. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 261 | "properties": { # If this is a schema for an object, list the schema for each property of this object. |
| 262 | "a_key": # Object with schema name: JsonSchema # A single property of this object. The value is itself a JSON Schema object describing this property. |
| 263 | }, |
| 264 | "items": # Object with schema name: JsonSchema # If this is a schema for an array, this property is the schema for each element in the array. |
| 265 | "required": True or False, # Whether the parameter is required. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 266 | "annotations": { # Additional information about this property. |
| 267 | "required": [ # A list of methods for which this property is required on requests. |
| 268 | "A String", |
| 269 | ], |
| 270 | }, |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 271 | "enumDescriptions": [ # The descriptions for the enums. Each position maps to the corresponding value in the "enum" array. |
| 272 | "A String", |
| 273 | ], |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 274 | "id": "A String", # Unique identifier for this schema. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 275 | "maximum": "A String", # The maximum value of this parameter. |
| 276 | "pattern": "A String", # The regular expression this parameter must conform to. Uses Java 6 regex format: http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 277 | }, |
| 278 | }, |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 279 | "id": "A String", # A unique ID for this method. This property can be used to match methods between different versions of Discovery. |
| 280 | "useMediaDownloadService": True or False, # Indicates that downloads from this method should use the download service URL (i.e. "/download"). Only applies if the method supports media download. |
| 281 | "httpMethod": "A String", # HTTP method used by this method. |
| 282 | "parameterOrder": [ # Ordered list of required parameters, serves as a hint to clients on how to structure their method signatures. The array is ordered such that the "most-significant" parameter appears first. |
| 283 | "A String", |
| 284 | ], |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 285 | "path": "A String", # The URI path of this REST method. Should be used in conjunction with the basePath property at the api-level. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 286 | "description": "A String", # Description of this method. |
| 287 | "response": { # The schema for the response. |
| 288 | "$ref": "A String", # Schema ID for the response schema. |
| 289 | }, |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 290 | "request": { # The schema for the request. |
| 291 | "$ref": "A String", # Schema ID for the request schema. |
| 292 | "parameterName": "A String", # parameter name. |
| 293 | }, |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 294 | "supportsMediaDownload": True or False, # Whether this method supports media downloads. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 295 | }, |
| 296 | }, |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 297 | "resources": { # Sub-resources on this resource. |
| 298 | "a_key": # Object with schema name: RestResource # Description for any sub-resources on this resource. |
| 299 | }, |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 300 | }, |
| 301 | }, |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 302 | "canonicalName": "A String", # Indicates how the API name should be capitalized and split into various parts. Useful for generating pretty class names. |
| 303 | "schemas": { # The schemas for this API. |
| 304 | "a_key": { # An individual schema description. |
| 305 | "readOnly": True or False, # The value is read-only, generated by the service. The value cannot be modified by the client. If the value is included in a POST, PUT, or PATCH request, it is ignored by the service. |
| 306 | "repeated": True or False, # Whether this parameter may appear multiple times. |
| 307 | "description": "A String", # A description of this object. |
| 308 | "default": "A String", # The default value of this property (if one exists). |
| 309 | "enum": [ # Values this parameter may take (if it is an enum). |
| 310 | "A String", |
| 311 | ], |
| 312 | "type": "A String", # The value type for this schema. A list of values can be found here: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1 |
| 313 | "minimum": "A String", # The minimum value of this parameter. |
| 314 | "location": "A String", # Whether this parameter goes in the query or the path for REST requests. |
| 315 | "variant": { # In a variant data type, the value of one property is used to determine how to interpret the entire entity. Its value must exist in a map of descriminant values to schema names. |
| 316 | "map": [ # The map of discriminant value to schema to use for parsing.. |
| 317 | { |
| 318 | "type_value": "A String", |
| 319 | "$ref": "A String", |
| 320 | }, |
| 321 | ], |
| 322 | "discriminant": "A String", # The name of the type discriminant property. |
| 323 | }, |
| 324 | "$ref": "A String", # A reference to another schema. The value of this property is the "id" of another schema. |
| 325 | "format": "A String", # An additional regular expression or key that helps constrain the value. For more details see: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.23 |
| 326 | "additionalProperties": # Object with schema name: JsonSchema # If this is a schema for an object, this property is the schema for any additional properties with dynamic keys on this object. |
| 327 | "properties": { # If this is a schema for an object, list the schema for each property of this object. |
| 328 | "a_key": # Object with schema name: JsonSchema # A single property of this object. The value is itself a JSON Schema object describing this property. |
| 329 | }, |
| 330 | "items": # Object with schema name: JsonSchema # If this is a schema for an array, this property is the schema for each element in the array. |
| 331 | "required": True or False, # Whether the parameter is required. |
| 332 | "annotations": { # Additional information about this property. |
| 333 | "required": [ # A list of methods for which this property is required on requests. |
| 334 | "A String", |
| 335 | ], |
| 336 | }, |
| 337 | "enumDescriptions": [ # The descriptions for the enums. Each position maps to the corresponding value in the "enum" array. |
| 338 | "A String", |
| 339 | ], |
| 340 | "id": "A String", # Unique identifier for this schema. |
| 341 | "maximum": "A String", # The maximum value of this parameter. |
| 342 | "pattern": "A String", # The regular expression this parameter must conform to. Uses Java 6 regex format: http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html |
| 343 | }, |
| 344 | }, |
| 345 | "ownerDomain": "A String", # The domain of the owner of this API. Together with the ownerName and a packagePath values, this can be used to generate a library for this API which would have a unique fully qualified name. |
| 346 | "rootUrl": "A String", # The root URL under which all API services live. |
| 347 | "protocol": "rest", # The protocol described by this document. |
| 348 | "title": "A String", # The title of this API. |
| 349 | "etag": "A String", # The ETag for this response. |
| 350 | "batchPath": "A String", # The path for REST batch requests. |
| 351 | "name": "A String", # The name of this API. |
| 352 | "packagePath": "A String", # The package of the owner of this API. See ownerDomain. |
| 353 | "documentationLink": "A String", # A link to human readable documentation for the API. |
| 354 | "parameters": { # Common parameters that apply across all apis. |
| 355 | "a_key": { # Description of a single parameter. |
| 356 | "readOnly": True or False, # The value is read-only, generated by the service. The value cannot be modified by the client. If the value is included in a POST, PUT, or PATCH request, it is ignored by the service. |
| 357 | "repeated": True or False, # Whether this parameter may appear multiple times. |
| 358 | "description": "A String", # A description of this object. |
| 359 | "default": "A String", # The default value of this property (if one exists). |
| 360 | "enum": [ # Values this parameter may take (if it is an enum). |
| 361 | "A String", |
| 362 | ], |
| 363 | "type": "A String", # The value type for this schema. A list of values can be found here: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1 |
| 364 | "minimum": "A String", # The minimum value of this parameter. |
| 365 | "location": "A String", # Whether this parameter goes in the query or the path for REST requests. |
| 366 | "variant": { # In a variant data type, the value of one property is used to determine how to interpret the entire entity. Its value must exist in a map of descriminant values to schema names. |
| 367 | "map": [ # The map of discriminant value to schema to use for parsing.. |
| 368 | { |
| 369 | "type_value": "A String", |
| 370 | "$ref": "A String", |
| 371 | }, |
| 372 | ], |
| 373 | "discriminant": "A String", # The name of the type discriminant property. |
| 374 | }, |
| 375 | "$ref": "A String", # A reference to another schema. The value of this property is the "id" of another schema. |
| 376 | "format": "A String", # An additional regular expression or key that helps constrain the value. For more details see: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.23 |
| 377 | "additionalProperties": # Object with schema name: JsonSchema # If this is a schema for an object, this property is the schema for any additional properties with dynamic keys on this object. |
| 378 | "properties": { # If this is a schema for an object, list the schema for each property of this object. |
| 379 | "a_key": # Object with schema name: JsonSchema # A single property of this object. The value is itself a JSON Schema object describing this property. |
| 380 | }, |
| 381 | "items": # Object with schema name: JsonSchema # If this is a schema for an array, this property is the schema for each element in the array. |
| 382 | "required": True or False, # Whether the parameter is required. |
| 383 | "annotations": { # Additional information about this property. |
| 384 | "required": [ # A list of methods for which this property is required on requests. |
| 385 | "A String", |
| 386 | ], |
| 387 | }, |
| 388 | "enumDescriptions": [ # The descriptions for the enums. Each position maps to the corresponding value in the "enum" array. |
| 389 | "A String", |
| 390 | ], |
| 391 | "id": "A String", # Unique identifier for this schema. |
| 392 | "maximum": "A String", # The maximum value of this parameter. |
| 393 | "pattern": "A String", # The regular expression this parameter must conform to. Uses Java 6 regex format: http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html |
| 394 | }, |
| 395 | }, |
| 396 | "exponentialBackoffDefault": True or False, # Enable exponential backoff for suitable methods in the generated clients. |
| 397 | "baseUrl": "A String", # [DEPRECATED] The base URL for REST requests. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 398 | "version_module": True or False, |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 399 | "version": "A String", # The version of this API. |
| 400 | "description": "A String", # The description of this API. |
| 401 | "labels": [ # Labels for the status of this API, such as labs or deprecated. |
| 402 | "A String", |
| 403 | ], |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 404 | }</pre> |
| 405 | </div> |
| 406 | |
| 407 | <div class="method"> |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 408 | <code class="details" id="list">list(name=None, preferred=None)</code> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 409 | <pre>Retrieve the list of APIs supported at this endpoint. |
| 410 | |
| 411 | Args: |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 412 | name: string, Only include APIs with the given name. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 413 | preferred: boolean, Return only the preferred version of an API. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 414 | |
| 415 | Returns: |
| 416 | An object of the form: |
| 417 | |
| 418 | { |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 419 | "kind": "discovery#directoryList", # The kind for this response. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 420 | "items": [ # The individual directory entries. One entry per api/version pair. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 421 | { |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 422 | "labels": [ # Labels for the status of this API, such as labs or deprecated. |
| 423 | "A String", |
| 424 | ], |
| 425 | "name": "A String", # The name of the API. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 426 | "discoveryLink": "A String", # A link to the discovery document. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 427 | "icons": { # Links to 16x16 and 32x32 icons representing the API. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 428 | "x16": "A String", # The URL of the 16x16 icon. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 429 | "x32": "A String", # The URL of the 32x32 icon. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 430 | }, |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 431 | "description": "A String", # The description of this API. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 432 | "documentationLink": "A String", # A link to human readable documentation for the API. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 433 | "kind": "discovery#directoryItem", # The kind for this response. |
| 434 | "id": "A String", # The id of this API. |
| 435 | "preferred": True or False, # True if this version is the preferred version to use. |
| 436 | "discoveryRestUrl": "A String", # The URL for the discovery REST document. |
| 437 | "version": "A String", # The version of the API. |
| 438 | "title": "A String", # The title of this API. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 439 | }, |
| 440 | ], |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 441 | "discoveryVersion": "v1", # Indicate the version of the Discovery API used to generate this doc. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 442 | }</pre> |
| 443 | </div> |
| 444 | |
| 445 | </body></html> |