| 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 |
|
| 75 |
<h1><a href="discovery_v1.html">API Discovery Service</a> . <a href="discovery_v1.apis.html">apis</a></h1> |
| 76 |
<h2>Instance Methods</h2> |
| 77 |
<p class="toc_element"> |
| 78 |
<code><a href="#close">close()</a></code></p> |
| 79 |
<p class="firstline">Close httplib2 connections.</p> |
| 80 |
<p class="toc_element"> |
| 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"> |
| 84 |
<code><a href="#list">list(name=None, preferred=None)</a></code></p> |
| 85 |
<p class="firstline">Retrieve the list of APIs supported at this endpoint.</p> |
| 86 |
<h3>Method Details</h3> |
| 87 |
<div class="method"> |
| 88 |
<code class="details" id="close">close()</code> |
| 89 |
<pre>Close httplib2 connections.</pre> |
| 90 |
</div> |
| 91 |
|
| 92 |
<div class="method"> |
| 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 |
{ |
| 104 |
"auth": { # Authentication information. |
| 105 |
"oauth2": { # OAuth 2.0 authentication information. |
| 106 |
"scopes": { # Available OAuth 2.0 scopes. |
| 107 |
"a_key": { # The scope value. |
| 108 |
"description": "A String", # Description of scope. |
| 109 |
}, |
| 110 |
}, |
| 111 |
}, |
| 112 |
}, |
| 113 |
"basePath": "A String", # [DEPRECATED] The base path for REST requests. |
| 114 |
"baseUrl": "A String", # [DEPRECATED] The base URL for REST requests. |
| 115 |
"batchPath": "A String", # The path for REST batch requests. |
| 116 |
"canonicalName": "A String", # Indicates how the API name should be capitalized and split into various parts. Useful for generating pretty class names. |
| 117 |
"description": "A String", # The description of this API. |
| 118 |
"discoveryVersion": "v1", # Indicate the version of the Discovery API used to generate this doc. |
| 119 |
"documentationLink": "A String", # A link to human readable documentation for the API. |
| 120 |
"endpoints": [ # A list of location-based endpoint objects for this API. Each object contains the endpoint URL, location, description and deprecation status. |
| 121 |
{ # A single endpoint object |
| 122 |
"deprecated": True or False, # Whether this endpoint is deprecated |
| 123 |
"description": "A String", # A string describing the host designated by the URL |
| 124 |
"endpointUrl": "A String", # The URL of the endpoint target host |
| 125 |
"location": "A String", # The location of the endpoint |
| 126 |
}, |
| 127 |
], |
| 128 |
"etag": "A String", # The ETag for this response. |
| 129 |
"exponentialBackoffDefault": True or False, # Enable exponential backoff for suitable methods in the generated clients. |
| 130 |
"features": [ # A list of supported features for this API. |
| 131 |
"A String", |
| 132 |
], |
| 133 |
"icons": { # Links to 16x16 and 32x32 icons representing the API. |
| 134 |
"x16": "A String", # The URL of the 16x16 icon. |
| 135 |
"x32": "A String", # The URL of the 32x32 icon. |
| 136 |
}, |
| 137 |
"id": "A String", # The ID of this API. |
| 138 |
"kind": "discovery#restDescription", # The kind for this response. |
| 139 |
"labels": [ # Labels for the status of this API, such as labs or deprecated. |
| 140 |
"A String", |
| 141 |
], |
| 142 |
"methods": { # API-level methods for this API. |
| 143 |
"a_key": { # An individual method description. |
| 144 |
"apiVersion": "A String", # The API Version of this method, as passed in via the `X-Goog-Api-Version` header or `$apiVersion` query parameter. |
| 145 |
"deprecated": True or False, # Whether this method is deprecated. |
| 146 |
"description": "A String", # Description of this method. |
| 147 |
"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. |
| 148 |
"flatPath": "A String", # The URI path of this REST method in (RFC 6570) format without level 2 features ({+var}). Supplementary to the path property. |
| 149 |
"httpMethod": "A String", # HTTP method used by this method. |
| 150 |
"id": "A String", # A unique ID for this method. This property can be used to match methods between different versions of Discovery. |
| 151 |
"mediaUpload": { # Media upload parameters. |
| 152 |
"accept": [ # MIME Media Ranges for acceptable media uploads to this method. |
| 153 |
"A String", |
| 154 |
], |
| 155 |
"maxSize": "A String", # Maximum size of a media upload, such as "1MB", "2GB" or "3TB". |
| 156 |
"protocols": { # Supported upload protocols. |
| 157 |
"resumable": { # Supports the Resumable Media Upload protocol. |
| 158 |
"multipart": true, # True if this endpoint supports uploading multipart media. |
| 159 |
"path": "A String", # The URI path to be used for upload. Should be used in conjunction with the basePath property at the api-level. |
| 160 |
}, |
| 161 |
"simple": { # Supports uploading as a single HTTP request. |
| 162 |
"multipart": true, # True if this endpoint supports upload multipart media. |
| 163 |
"path": "A String", # The URI path to be used for upload. Should be used in conjunction with the basePath property at the api-level. |
| 164 |
}, |
| 165 |
}, |
| 166 |
}, |
| 167 |
"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. |
| 168 |
"A String", |
| 169 |
], |
| 170 |
"parameters": { # Details for all parameters in this method. |
| 171 |
"a_key": { # Details for a single parameter in this method. |
| 172 |
"$ref": "A String", # A reference to another schema. The value of this property is the "id" of another schema. |
| 173 |
"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. |
| 174 |
"annotations": { # Additional information about this property. |
| 175 |
"required": [ # A list of methods for which this property is required on requests. |
| 176 |
"A String", |
| 177 |
], |
| 178 |
}, |
| 179 |
"default": "A String", # The default value of this property (if one exists). |
| 180 |
"deprecated": True or False, # Whether the parameter is deprecated. |
| 181 |
"description": "A String", # A description of this object. |
| 182 |
"enum": [ # Values this parameter may take (if it is an enum). |
| 183 |
"A String", |
| 184 |
], |
| 185 |
"enumDeprecated": [ # The deprecation status for the enums. Each position maps to the corresponding value in the "enum" array. |
| 186 |
True or False, |
| 187 |
], |
| 188 |
"enumDescriptions": [ # The descriptions for the enums. Each position maps to the corresponding value in the "enum" array. |
| 189 |
"A String", |
| 190 |
], |
| 191 |
"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 |
| 192 |
"id": "A String", # Unique identifier for this schema. |
| 193 |
"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. |
| 194 |
"location": "A String", # Whether this parameter goes in the query or the path for REST requests. |
| 195 |
"maximum": "A String", # The maximum value of this parameter. |
| 196 |
"minimum": "A String", # The minimum value of this parameter. |
| 197 |
"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 |
| 198 |
"properties": { # If this is a schema for an object, list the schema for each property of this object. |
| 199 |
"a_key": # Object with schema name: JsonSchema # A single property of this object. The value is itself a JSON Schema object describing this property. |
| 200 |
}, |
| 201 |
"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. |
| 202 |
"repeated": True or False, # Whether this parameter may appear multiple times. |
| 203 |
"required": True or False, # Whether the parameter is required. |
| 204 |
"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 |
| 205 |
"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. |
| 206 |
"discriminant": "A String", # The name of the type discriminant property. |
| 207 |
"map": [ # The map of discriminant value to schema to use for parsing.. |
| 208 |
{ |
| 209 |
"$ref": "A String", |
| 210 |
"type_value": "A String", |
| 211 |
}, |
| 212 |
], |
| 213 |
}, |
| 214 |
}, |
| 215 |
}, |
| 216 |
"path": "A String", # The URI path of this REST method. Should be used in conjunction with the basePath property at the api-level. |
| 217 |
"request": { # The schema for the request. |
| 218 |
"$ref": "A String", # Schema ID for the request schema. |
| 219 |
"parameterName": "A String", # parameter name. |
| 220 |
}, |
| 221 |
"response": { # The schema for the response. |
| 222 |
"$ref": "A String", # Schema ID for the response schema. |
| 223 |
}, |
| 224 |
"scopes": [ # OAuth 2.0 scopes applicable to this method. |
| 225 |
"A String", |
| 226 |
], |
| 227 |
"supportsMediaDownload": True or False, # Whether this method supports media downloads. |
| 228 |
"supportsMediaUpload": True or False, # Whether this method supports media uploads. |
| 229 |
"supportsSubscription": True or False, # Whether this method supports subscriptions. |
| 230 |
"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. |
| 231 |
}, |
| 232 |
}, |
| 233 |
"name": "A String", # The name of this API. |
| 234 |
"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. |
| 235 |
"ownerName": "A String", # The name of the owner of this API. See ownerDomain. |
| 236 |
"packagePath": "A String", # The package of the owner of this API. See ownerDomain. |
| 237 |
"parameters": { # Common parameters that apply across all apis. |
| 238 |
"a_key": { # Description of a single parameter. |
| 239 |
"$ref": "A String", # A reference to another schema. The value of this property is the "id" of another schema. |
| 240 |
"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. |
| 241 |
"annotations": { # Additional information about this property. |
| 242 |
"required": [ # A list of methods for which this property is required on requests. |
| 243 |
"A String", |
| 244 |
], |
| 245 |
}, |
| 246 |
"default": "A String", # The default value of this property (if one exists). |
| 247 |
"deprecated": True or False, # Whether the parameter is deprecated. |
| 248 |
"description": "A String", # A description of this object. |
| 249 |
"enum": [ # Values this parameter may take (if it is an enum). |
| 250 |
"A String", |
| 251 |
], |
| 252 |
"enumDeprecated": [ # The deprecation status for the enums. Each position maps to the corresponding value in the "enum" array. |
| 253 |
True or False, |
| 254 |
], |
| 255 |
"enumDescriptions": [ # The descriptions for the enums. Each position maps to the corresponding value in the "enum" array. |
| 256 |
"A String", |
| 257 |
], |
| 258 |
"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 |
| 259 |
"id": "A String", # Unique identifier for this schema. |
| 260 |
"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. |
| 261 |
"location": "A String", # Whether this parameter goes in the query or the path for REST requests. |
| 262 |
"maximum": "A String", # The maximum value of this parameter. |
| 263 |
"minimum": "A String", # The minimum value of this parameter. |
| 264 |
"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 |
| 265 |
"properties": { # If this is a schema for an object, list the schema for each property of this object. |
| 266 |
"a_key": # Object with schema name: JsonSchema # A single property of this object. The value is itself a JSON Schema object describing this property. |
| 267 |
}, |
| 268 |
"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. |
| 269 |
"repeated": True or False, # Whether this parameter may appear multiple times. |
| 270 |
"required": True or False, # Whether the parameter is required. |
| 271 |
"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 |
| 272 |
"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. |
| 273 |
"discriminant": "A String", # The name of the type discriminant property. |
| 274 |
"map": [ # The map of discriminant value to schema to use for parsing.. |
| 275 |
{ |
| 276 |
"$ref": "A String", |
| 277 |
"type_value": "A String", |
| 278 |
}, |
| 279 |
], |
| 280 |
}, |
| 281 |
}, |
| 282 |
}, |
| 283 |
"protocol": "rest", # The protocol described by this document. |
| 284 |
"resources": { # The resources in this API. |
| 285 |
"a_key": { # An individual resource description. Contains methods and sub-resources related to this resource. |
| 286 |
"deprecated": True or False, # Whether this resource is deprecated. |
| 287 |
"methods": { # Methods on this resource. |
| 288 |
"a_key": { # Description for any methods on this resource. |
| 289 |
"apiVersion": "A String", # The API Version of this method, as passed in via the `X-Goog-Api-Version` header or `$apiVersion` query parameter. |
| 290 |
"deprecated": True or False, # Whether this method is deprecated. |
| 291 |
"description": "A String", # Description of this method. |
| 292 |
"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. |
| 293 |
"flatPath": "A String", # The URI path of this REST method in (RFC 6570) format without level 2 features ({+var}). Supplementary to the path property. |
| 294 |
"httpMethod": "A String", # HTTP method used by this method. |
| 295 |
"id": "A String", # A unique ID for this method. This property can be used to match methods between different versions of Discovery. |
| 296 |
"mediaUpload": { # Media upload parameters. |
| 297 |
"accept": [ # MIME Media Ranges for acceptable media uploads to this method. |
| 298 |
"A String", |
| 299 |
], |
| 300 |
"maxSize": "A String", # Maximum size of a media upload, such as "1MB", "2GB" or "3TB". |
| 301 |
"protocols": { # Supported upload protocols. |
| 302 |
"resumable": { # Supports the Resumable Media Upload protocol. |
| 303 |
"multipart": true, # True if this endpoint supports uploading multipart media. |
| 304 |
"path": "A String", # The URI path to be used for upload. Should be used in conjunction with the basePath property at the api-level. |
| 305 |
}, |
| 306 |
"simple": { # Supports uploading as a single HTTP request. |
| 307 |
"multipart": true, # True if this endpoint supports upload multipart media. |
| 308 |
"path": "A String", # The URI path to be used for upload. Should be used in conjunction with the basePath property at the api-level. |
| 309 |
}, |
| 310 |
}, |
| 311 |
}, |
| 312 |
"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. |
| 313 |
"A String", |
| 314 |
], |
| 315 |
"parameters": { # Details for all parameters in this method. |
| 316 |
"a_key": { # Details for a single parameter in this method. |
| 317 |
"$ref": "A String", # A reference to another schema. The value of this property is the "id" of another schema. |
| 318 |
"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. |
| 319 |
"annotations": { # Additional information about this property. |
| 320 |
"required": [ # A list of methods for which this property is required on requests. |
| 321 |
"A String", |
| 322 |
], |
| 323 |
}, |
| 324 |
"default": "A String", # The default value of this property (if one exists). |
| 325 |
"deprecated": True or False, # Whether the parameter is deprecated. |
| 326 |
"description": "A String", # A description of this object. |
| 327 |
"enum": [ # Values this parameter may take (if it is an enum). |
| 328 |
"A String", |
| 329 |
], |
| 330 |
"enumDeprecated": [ # The deprecation status for the enums. Each position maps to the corresponding value in the "enum" array. |
| 331 |
True or False, |
| 332 |
], |
| 333 |
"enumDescriptions": [ # The descriptions for the enums. Each position maps to the corresponding value in the "enum" array. |
| 334 |
"A String", |
| 335 |
], |
| 336 |
"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 |
| 337 |
"id": "A String", # Unique identifier for this schema. |
| 338 |
"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. |
| 339 |
"location": "A String", # Whether this parameter goes in the query or the path for REST requests. |
| 340 |
"maximum": "A String", # The maximum value of this parameter. |
| 341 |
"minimum": "A String", # The minimum 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 |
"properties": { # If this is a schema for an object, list the schema for each property of this object. |
| 344 |
"a_key": # Object with schema name: JsonSchema # A single property of this object. The value is itself a JSON Schema object describing this property. |
| 345 |
}, |
| 346 |
"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. |
| 347 |
"repeated": True or False, # Whether this parameter may appear multiple times. |
| 348 |
"required": True or False, # Whether the parameter is required. |
| 349 |
"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 |
| 350 |
"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. |
| 351 |
"discriminant": "A String", # The name of the type discriminant property. |
| 352 |
"map": [ # The map of discriminant value to schema to use for parsing.. |
| 353 |
{ |
| 354 |
"$ref": "A String", |
| 355 |
"type_value": "A String", |
| 356 |
}, |
| 357 |
], |
| 358 |
}, |
| 359 |
}, |
| 360 |
}, |
| 361 |
"path": "A String", # The URI path of this REST method. Should be used in conjunction with the basePath property at the api-level. |
| 362 |
"request": { # The schema for the request. |
| 363 |
"$ref": "A String", # Schema ID for the request schema. |
| 364 |
"parameterName": "A String", # parameter name. |
| 365 |
}, |
| 366 |
"response": { # The schema for the response. |
| 367 |
"$ref": "A String", # Schema ID for the response schema. |
| 368 |
}, |
| 369 |
"scopes": [ # OAuth 2.0 scopes applicable to this method. |
| 370 |
"A String", |
| 371 |
], |
| 372 |
"supportsMediaDownload": True or False, # Whether this method supports media downloads. |
| 373 |
"supportsMediaUpload": True or False, # Whether this method supports media uploads. |
| 374 |
"supportsSubscription": True or False, # Whether this method supports subscriptions. |
| 375 |
"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. |
| 376 |
}, |
| 377 |
}, |
| 378 |
"resources": { # Sub-resources on this resource. |
| 379 |
"a_key": # Object with schema name: RestResource # Description for any sub-resources on this resource. |
| 380 |
}, |
| 381 |
}, |
| 382 |
}, |
| 383 |
"revision": "A String", # The version of this API. |
| 384 |
"rootUrl": "A String", # The root URL under which all API services live. |
| 385 |
"schemas": { # The schemas for this API. |
| 386 |
"a_key": { # An individual schema description. |
| 387 |
"$ref": "A String", # A reference to another schema. The value of this property is the "id" of another schema. |
| 388 |
"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. |
| 389 |
"annotations": { # Additional information about this property. |
| 390 |
"required": [ # A list of methods for which this property is required on requests. |
| 391 |
"A String", |
| 392 |
], |
| 393 |
}, |
| 394 |
"default": "A String", # The default value of this property (if one exists). |
| 395 |
"deprecated": True or False, # Whether the parameter is deprecated. |
| 396 |
"description": "A String", # A description of this object. |
| 397 |
"enum": [ # Values this parameter may take (if it is an enum). |
| 398 |
"A String", |
| 399 |
], |
| 400 |
"enumDeprecated": [ # The deprecation status for the enums. Each position maps to the corresponding value in the "enum" array. |
| 401 |
True or False, |
| 402 |
], |
| 403 |
"enumDescriptions": [ # The descriptions for the enums. Each position maps to the corresponding value in the "enum" array. |
| 404 |
"A String", |
| 405 |
], |
| 406 |
"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 |
| 407 |
"id": "A String", # Unique identifier for this schema. |
| 408 |
"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. |
| 409 |
"location": "A String", # Whether this parameter goes in the query or the path for REST requests. |
| 410 |
"maximum": "A String", # The maximum value of this parameter. |
| 411 |
"minimum": "A String", # The minimum value of this parameter. |
| 412 |
"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 |
| 413 |
"properties": { # If this is a schema for an object, list the schema for each property of this object. |
| 414 |
"a_key": # Object with schema name: JsonSchema # A single property of this object. The value is itself a JSON Schema object describing this property. |
| 415 |
}, |
| 416 |
"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. |
| 417 |
"repeated": True or False, # Whether this parameter may appear multiple times. |
| 418 |
"required": True or False, # Whether the parameter is required. |
| 419 |
"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 |
| 420 |
"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. |
| 421 |
"discriminant": "A String", # The name of the type discriminant property. |
| 422 |
"map": [ # The map of discriminant value to schema to use for parsing.. |
| 423 |
{ |
| 424 |
"$ref": "A String", |
| 425 |
"type_value": "A String", |
| 426 |
}, |
| 427 |
], |
| 428 |
}, |
| 429 |
}, |
| 430 |
}, |
| 431 |
"servicePath": "A String", # The base path for all REST requests. |
| 432 |
"title": "A String", # The title of this API. |
| 433 |
"version": "A String", # The version of this API. |
| 434 |
"version_module": True or False, |
| 435 |
}</pre> |
| 436 |
</div> |
| 437 |
|
| 438 |
<div class="method"> |
| 439 |
<code class="details" id="list">list(name=None, preferred=None)</code> |
| 440 |
<pre>Retrieve the list of APIs supported at this endpoint. |
| 441 |
|
| 442 |
Args: |
| 443 |
name: string, Only include APIs with the given name. |
| 444 |
preferred: boolean, Return only the preferred version of an API. |
| 445 |
|
| 446 |
Returns: |
| 447 |
An object of the form: |
| 448 |
|
| 449 |
{ |
| 450 |
"discoveryVersion": "v1", # Indicate the version of the Discovery API used to generate this doc. |
| 451 |
"items": [ # The individual directory entries. One entry per api/version pair. |
| 452 |
{ |
| 453 |
"description": "A String", # The description of this API. |
| 454 |
"discoveryLink": "A String", # A link to the discovery document. |
| 455 |
"discoveryRestUrl": "A String", # The URL for the discovery REST document. |
| 456 |
"documentationLink": "A String", # A link to human readable documentation for the API. |
| 457 |
"icons": { # Links to 16x16 and 32x32 icons representing the API. |
| 458 |
"x16": "A String", # The URL of the 16x16 icon. |
| 459 |
"x32": "A String", # The URL of the 32x32 icon. |
| 460 |
}, |
| 461 |
"id": "A String", # The id of this API. |
| 462 |
"kind": "discovery#directoryItem", # The kind for this response. |
| 463 |
"labels": [ # Labels for the status of this API, such as labs or deprecated. |
| 464 |
"A String", |
| 465 |
], |
| 466 |
"name": "A String", # The name of the API. |
| 467 |
"preferred": True or False, # True if this version is the preferred version to use. |
| 468 |
"title": "A String", # The title of this API. |
| 469 |
"version": "A String", # The version of the API. |
| 470 |
}, |
| 471 |
], |
| 472 |
"kind": "discovery#directoryList", # The kind for this response. |
| 473 |
}</pre> |
| 474 |
</div> |
| 475 |
|
| 476 |
</body></html> |