Blame - docs/dyn/discovery_v1.apis.html - platform/external/python/google-api-python-client

2021-01-15 07:10:04 -0800

[diff] [blame]

139

"httpMethod": "A String", # HTTP method used by this method.

140

"id": "A String", # A unique ID for this method. This property can be used to match methods between different versions of Discovery.

141

"mediaUpload": { # Media upload parameters.

142

"accept": [ # MIME Media Ranges for acceptable media uploads to this method.

143

"A String",

144

],

145

"maxSize": "A String", # Maximum size of a media upload, such as "1MB", "2GB" or "3TB".

146

"protocols": { # Supported upload protocols.

147

"resumable": { # Supports the Resumable Media Upload protocol.

148

"multipart": true, # True if this endpoint supports uploading multipart media.

149

"path": "A String", # The URI path to be used for upload. Should be used in conjunction with the basePath property at the api-level.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

150

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

151

"simple": { # Supports uploading as a single HTTP request.

152

"multipart": true, # True if this endpoint supports upload multipart media.

153

"path": "A String", # The URI path to be used for upload. Should be used in conjunction with the basePath property at the api-level.

},

},

},

"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.

158

"A String",

159

],

160

"parameters": { # Details for all parameters in this method.

161

"a_key": { # Details for a single parameter in this method.

162

"$ref": "A String", # A reference to another schema. The value of this property is the "id" of another schema.

163

"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.

164

"annotations": { # Additional information about this property.

165

"required": [ # A list of methods for which this property is required on requests.

"A String",

],

},

"default": "A String", # The default value of this property (if one exists).

170

"description": "A String", # A description of this object.

171

"enum": [ # Values this parameter may take (if it is an enum).

Yoshi Automation Bot

b6971b0

2020-11-26 17:16:03 -0800

[diff] [blame]

172

"A String",

173

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

174

"enumDescriptions": [ # The descriptions for the enums. Each position maps to the corresponding value in the "enum" array.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

175

"A String",

176

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

177

"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

178

"id": "A String", # Unique identifier for this schema.

179

"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.

180

"location": "A String", # Whether this parameter goes in the query or the path for REST requests.

181

"maximum": "A String", # The maximum value of this parameter.

182

"minimum": "A String", # The minimum value of this parameter.

183

"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

184

"properties": { # If this is a schema for an object, list the schema for each property of this object.

185

"a_key": # Object with schema name: JsonSchema # A single property of this object. The value is itself a JSON Schema object describing this property.

186

},

187

"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.

188

"repeated": True or False, # Whether this parameter may appear multiple times.

189

"required": True or False, # Whether the parameter is required.

190

"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

191

"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.

192

"discriminant": "A String", # The name of the type discriminant property.

193

"map": [ # The map of discriminant value to schema to use for parsing..

194

{

195

"$ref": "A String",

196

"type_value": "A String",

Yoshi Automation Bot

b6971b0

2020-11-26 17:16:03 -0800

[diff] [blame]

197

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

],

},

},

},

"path": "A String", # The URI path of this REST method. Should be used in conjunction with the basePath property at the api-level.

203

"request": { # The schema for the request.

204

"$ref": "A String", # Schema ID for the request schema.

205

"parameterName": "A String", # parameter name.

206

},

207

"response": { # The schema for the response.

208

"$ref": "A String", # Schema ID for the response schema.

209

},

210

"scopes": [ # OAuth 2.0 scopes applicable to this method.

211

"A String",

212

],

213

"supportsMediaDownload": True or False, # Whether this method supports media downloads.

214

"supportsMediaUpload": True or False, # Whether this method supports media uploads.

215

"supportsSubscription": True or False, # Whether this method supports subscriptions.

216

"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.

217

},

218

},

219

"name": "A String", # The name of this API.

220

"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.

221

"ownerName": "A String", # The name of the owner of this API. See ownerDomain.

222

"packagePath": "A String", # The package of the owner of this API. See ownerDomain.

223

"parameters": { # Common parameters that apply across all apis.

224

"a_key": { # Description of a single parameter.

225

"$ref": "A String", # A reference to another schema. The value of this property is the "id" of another schema.

226

"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.

227

"annotations": { # Additional information about this property.

228

"required": [ # A list of methods for which this property is required on requests.

"A String",

],

},

"default": "A String", # The default value of this property (if one exists).

233

"description": "A String", # A description of this object.

234

"enum": [ # Values this parameter may take (if it is an enum).

235

"A String",

236

],

237

"enumDescriptions": [ # The descriptions for the enums. Each position maps to the corresponding value in the "enum" array.

238

"A String",

239

],

240

"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

241

"id": "A String", # Unique identifier for this schema.

242

"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.

243

"location": "A String", # Whether this parameter goes in the query or the path for REST requests.

244

"maximum": "A String", # The maximum value of this parameter.

245

"minimum": "A String", # The minimum value of this parameter.

246

"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

247

"properties": { # If this is a schema for an object, list the schema for each property of this object.

248

"a_key": # Object with schema name: JsonSchema # A single property of this object. The value is itself a JSON Schema object describing this property.

249

},

250

"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.

251

"repeated": True or False, # Whether this parameter may appear multiple times.

252

"required": True or False, # Whether the parameter is required.

253

"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

254

"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.

255

"discriminant": "A String", # The name of the type discriminant property.

256

"map": [ # The map of discriminant value to schema to use for parsing..

257

{

258

"$ref": "A String",

259

"type_value": "A String",

},

],

},

},

},

"protocol": "rest", # The protocol described by this document.

266

"resources": { # The resources in this API.

267

"a_key": { # An individual resource description. Contains methods and sub-resources related to this resource.

268

"methods": { # Methods on this resource.

269

"a_key": { # Description for any methods on this resource.

270

"description": "A String", # Description of this method.

271

"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.

Anthonios Partheniou

10f4b67

2021-04-13 14:47:53 -0400

[diff] [blame^]

272

"flatPath": "A String", # The URI path of this REST method in (RFC 6570) format without level 2 features ({+var}). Supplementary to the path property.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

273

"httpMethod": "A String", # HTTP method used by this method.

274

"id": "A String", # A unique ID for this method. This property can be used to match methods between different versions of Discovery.

275

"mediaUpload": { # Media upload parameters.

276

"accept": [ # MIME Media Ranges for acceptable media uploads to this method.

277

"A String",

278

],

279

"maxSize": "A String", # Maximum size of a media upload, such as "1MB", "2GB" or "3TB".

280

"protocols": { # Supported upload protocols.

281

"resumable": { # Supports the Resumable Media Upload protocol.

282

"multipart": true, # True if this endpoint supports uploading multipart media.

283

"path": "A String", # The URI path to be used for upload. Should be used in conjunction with the basePath property at the api-level.

284

},

285

"simple": { # Supports uploading as a single HTTP request.

286

"multipart": true, # True if this endpoint supports upload multipart media.

287

"path": "A String", # The URI path to be used for upload. Should be used in conjunction with the basePath property at the api-level.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

288

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

289

},

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame]

290

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

291

"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.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

292

"A String",

293

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

294

"parameters": { # Details for all parameters in this method.

295

"a_key": { # Details for a single parameter in this method.

296

"$ref": "A String", # A reference to another schema. The value of this property is the "id" of another schema.

297

"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.

298

"annotations": { # Additional information about this property.

299

"required": [ # A list of methods for which this property is required on requests.

"A String",

],

},

"default": "A String", # The default value of this property (if one exists).

304

"description": "A String", # A description of this object.

305

"enum": [ # Values this parameter may take (if it is an enum).

306

"A String",

307

],

308

"enumDescriptions": [ # The descriptions for the enums. Each position maps to the corresponding value in the "enum" array.

309

"A String",

310

],

311

"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

312

"id": "A String", # Unique identifier for this schema.

313

"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.

314

"location": "A String", # Whether this parameter goes in the query or the path for REST requests.

315

"maximum": "A String", # The maximum value of this parameter.

316

"minimum": "A String", # The minimum value of this parameter.

317

"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

318

"properties": { # If this is a schema for an object, list the schema for each property of this object.

319

"a_key": # Object with schema name: JsonSchema # A single property of this object. The value is itself a JSON Schema object describing this property.

320

},

321

"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.

322

"repeated": True or False, # Whether this parameter may appear multiple times.

323

"required": True or False, # Whether the parameter is required.

324

"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

325

"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.

326

"discriminant": "A String", # The name of the type discriminant property.

327

"map": [ # The map of discriminant value to schema to use for parsing..

328

{

329

"$ref": "A String",

330

"type_value": "A String",

331

},

332

],

333

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

334

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

335

},

336

"path": "A String", # The URI path of this REST method. Should be used in conjunction with the basePath property at the api-level.

337

"request": { # The schema for the request.

338

"$ref": "A String", # Schema ID for the request schema.

339

"parameterName": "A String", # parameter name.

340

},

341

"response": { # The schema for the response.

342

"$ref": "A String", # Schema ID for the response schema.

343

},

344

"scopes": [ # OAuth 2.0 scopes applicable to this method.

345

"A String",

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

346

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

347

"supportsMediaDownload": True or False, # Whether this method supports media downloads.

348

"supportsMediaUpload": True or False, # Whether this method supports media uploads.

349

"supportsSubscription": True or False, # Whether this method supports subscriptions.

350

"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.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

351

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

352

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

353

"resources": { # Sub-resources on this resource.

354

"a_key": # Object with schema name: RestResource # Description for any sub-resources on this resource.

355

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

356

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

357

},

358

"revision": "A String", # The version of this API.

359

"rootUrl": "A String", # The root URL under which all API services live.

360

"schemas": { # The schemas for this API.

361

"a_key": { # An individual schema description.

362

"$ref": "A String", # A reference to another schema. The value of this property is the "id" of another schema.

363

"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.

364

"annotations": { # Additional information about this property.

365

"required": [ # A list of methods for which this property is required on requests.

"A String",

],

},

"default": "A String", # The default value of this property (if one exists).

370

"description": "A String", # A description of this object.

371

"enum": [ # Values this parameter may take (if it is an enum).

372

"A String",

373

],

374

"enumDescriptions": [ # The descriptions for the enums. Each position maps to the corresponding value in the "enum" array.

375

"A String",

376

],

377

"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

378

"id": "A String", # Unique identifier for this schema.

379

"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.

380

"location": "A String", # Whether this parameter goes in the query or the path for REST requests.

381

"maximum": "A String", # The maximum value of this parameter.

382

"minimum": "A String", # The minimum value of this parameter.

383

"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

384

"properties": { # If this is a schema for an object, list the schema for each property of this object.

385

"a_key": # Object with schema name: JsonSchema # A single property of this object. The value is itself a JSON Schema object describing this property.

386

},

387

"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.

388

"repeated": True or False, # Whether this parameter may appear multiple times.

389

"required": True or False, # Whether the parameter is required.

390

"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

391

"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.

392

"discriminant": "A String", # The name of the type discriminant property.

393

"map": [ # The map of discriminant value to schema to use for parsing..

394

{

395

"$ref": "A String",

396

"type_value": "A String",

},

],

},

},

},

"servicePath": "A String", # The base path for all REST requests.

403

"title": "A String", # The title of this API.

404

"version": "A String", # The version of this API.

405

"version_module": True or False,

406

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

410

<code class="details" id="list">list(name=None, preferred=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

411

<pre>Retrieve the list of APIs supported at this endpoint.

412

413

Args:

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

414

name: string, Only include APIs with the given name.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

415

preferred: boolean, Return only the preferred version of an API.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

416

417

Returns:

418

An object of the form:

419

420

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

421

"discoveryVersion": "v1", # Indicate the version of the Discovery API used to generate this doc.

422

"items": [ # The individual directory entries. One entry per api/version pair.

423

{

424

"description": "A String", # The description of this API.

425

"discoveryLink": "A String", # A link to the discovery document.

426

"discoveryRestUrl": "A String", # The URL for the discovery REST document.

427

"documentationLink": "A String", # A link to human readable documentation for the API.

428

"icons": { # Links to 16x16 and 32x32 icons representing the API.

429

"x16": "A String", # The URL of the 16x16 icon.

430

"x32": "A String", # The URL of the 32x32 icon.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

431

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

432

"id": "A String", # The id of this API.

433

"kind": "discovery#directoryItem", # The kind for this response.

434

"labels": [ # Labels for the status of this API, such as labs or deprecated.

435

"A String",

436

],

437

"name": "A String", # The name of the API.

438

"preferred": True or False, # True if this version is the preferred version to use.

439

"title": "A String", # The title of this API.

440

"version": "A String", # The version of the API.

441

},

442

],

443

"kind": "discovery#directoryList", # The kind for this response.

444

}</pre>

John Asmuth