Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 075572b86b87d93810e12170f57bcbf72ab4c507 / . / docs / dyn / discovery_v1.apis.html
blob: dd96317f27181c68a2625e52ae75b353bdcb0db7 [file] [log] [blame]
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame^]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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">APIs 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="#getRest">getRest(api, version)</a></code></p>
79<p class="firstline">Retrieve the description of a particular version of an api.</p>
80<p class="toc_element">
81 <code><a href="#list">list(name=None, preferred=None, label=None)</a></code></p>
82<p class="firstline">Retrieve the list of APIs supported at this endpoint.</p>
83<h3>Method Details</h3>
84<div class="method">
85 <code class="details" id="getRest">getRest(api, version)</code>
86 <pre>Retrieve the description of a particular version of an api.
87
88Args:
89 api: string, The name of the API. (required)
90 version: string, The version of the API. (required)
91
92Returns:
93 An object of the form:
94
95 {
96 "protocol": "rest", # The protocol described by this document.
97 "methods": { # API-level methods for this API.
98 },
99 "labels": [ # Labels for the status of this API, such as labs or deprecated.
100 "A String",
101 ],
102 "batchPath": "batch", # The path for REST batch requests.
103 "id": "A String", # The id of this API.
104 "schemas": { # The schemas for this API.
105 },
106 "rootUrl": "A String", # The root url under which all API services live.
107 "parameters": { # Common parameters that apply across all apis.
108 },
109 "icons": { # Links to 16x16 and 32x32 icons representing the API.
110 "x32": "A String", # The url of the 32x32 icon.
111 "x16": "A String", # The url of the 16x16 icon.
112 },
113 "baseUrl": "A String", # [DEPRECATED] The base URL for REST requests.
114 "version": "A String", # The version of this API.
115 "features": [ # A list of supported features for this API.
116 "A String",
117 ],
118 "servicePath": "A String", # The base path for all REST requests.
119 "resources": { # The resources in this API.
120 },
121 "revision": "A String", # The version of this API.
122 "description": "A String", # The description of this API.
123 "auth": { # Authentication information.
124 "oauth2": { # OAuth 2.0 authentication information.
125 "scopes": { # Available OAuth 2.0 scopes.
126 },
127 },
128 },
129 "kind": "discovery#restDescription", # The kind for this response.
130 "name": "A String", # The name of this API.
131 "basePath": "A String", # [DEPRECATED] The base path for REST requests.
132 "title": "A String", # The title of this API.
133 "discoveryVersion": "v1", # Indicate the version of the Discovery API used to generate this doc.
134 "documentationLink": "A String", # A link to human readable documentation for the API.
135 }</pre>
136</div>
137
138<div class="method">
139 <code class="details" id="list">list(name=None, preferred=None, label=None)</code>
140 <pre>Retrieve the list of APIs supported at this endpoint.
141
142Args:
143 name: string, Only include APIs with the given name.
144 preferred: boolean, Return only the preferred version of an API.
145 label: string, Only include APIs with a matching label, such as 'graduated' or 'labs'.
146 Allowed values
147 deprecated - APIs that have been deprecated.
148 graduated - Supported APIs that have graduated from labs.
149 labs - APIs that are experimental
150
151Returns:
152 An object of the form:
153
154 {
155 "items": [ # The individual directory entries. One entry per api/version pair.
156 {
157 "kind": "discovery#directoryItem", # The kind for this response.
158 "labels": [ # Labels for the status of this API, such as labs or deprecated.
159 "A String",
160 ],
161 "description": "A String", # The description of this API.
162 "icons": { # Links to 16x16 and 32x32 icons representing the API.
163 "x32": "A String", # The url of the 32x32 icon.
164 "x16": "A String", # The url of the 16x16 icon.
165 },
166 "discoveryRestUrl": "A String", # The url for the discovery REST document.
167 "preferred": True or False, # True if this version is the preferred version to use.
168 "name": "A String", # The name of the API.
169 "discoveryLink": "A String", # A link to the discovery document.
170 "version": "A String", # The version of the API.
171 "title": "A String", # The title of this API.
172 "id": "A String", # The id of this API.
173 "documentationLink": "A String", # A link to human readable documentation for the API.
174 },
175 ],
176 "discoveryVersion": "v1", # Indicate the version of the Discovery API used to generate this doc.
177 "kind": "discovery#directoryList", # The kind for this response.
178 }</pre>
179</div>
180
181</body></html>