Merge ~jugmac00/launchpadlib:apply-inclusive-naming into launchpadlib:main
- Git
- lp:~jugmac00/launchpadlib
- apply-inclusive-naming
- Merge into main
Proposed by
Jürgen Gmach
Status: | Merged |
---|---|
Merged at revision: | d90fe8932586a6bed14ca9cc873fbb4ecf990b91 |
Proposed branch: | ~jugmac00/launchpadlib:apply-inclusive-naming |
Merge into: | launchpadlib:main |
Diff against target: |
58732 lines (+21700/-22738) 5 files modified
.pre-commit-config.yaml (+4/-0) .woke.yaml (+228/-0) NEWS.rst (+1/-0) src/launchpadlib/testing/launchpad-wadl.xml (+21465/-22736) src/launchpadlib/tests/test_launchpad.py (+2/-2) |
Related bugs: |
Reviewer | Review Type | Date Requested | Status |
---|---|---|---|
Colin Watson (community) | Approve | ||
Review via email: mp+411789@code.launchpad.net |
Commit message
Apply inclusive naming via the `woke` `pre-commit` hook
Description of the change
To post a comment you must log in.
Revision history for this message
Guruprasad (lgp171188) : | # |
Revision history for this message
Colin Watson (cjwatson) : | # |
Revision history for this message
Colin Watson (cjwatson) : | # |
Revision history for this message
Jürgen Gmach (jugmac00) wrote : | # |
Revision history for this message
Jürgen Gmach (jugmac00) wrote : | # |
Please note - the diff is too long and needs to be reviewed on the command line (or similar).
Revision history for this message
Colin Watson (cjwatson) wrote : | # |
I've only really sampled the WADL updates, but they broadly look fine to me and are clearly just bringing things up to date with Launchpad itself. The rest is OK too.
review:
Approve
Preview Diff
[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1 | diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml |
2 | index c528329..fe333f3 100644 |
3 | --- a/.pre-commit-config.yaml |
4 | +++ b/.pre-commit-config.yaml |
5 | @@ -19,3 +19,7 @@ repos: |
6 | rev: 21.9b0 |
7 | hooks: |
8 | - id: black |
9 | +- repo: https://github.com/get-woke/woke |
10 | + rev: v0.17.0 |
11 | + hooks: |
12 | + - id: woke-from-source |
13 | diff --git a/.woke.yaml b/.woke.yaml |
14 | new file mode 100644 |
15 | index 0000000..424838e |
16 | --- /dev/null |
17 | +++ b/.woke.yaml |
18 | @@ -0,0 +1,228 @@ |
19 | + |
20 | +# Based on Canonical's Guidelines |
21 | +# https://docs.google.com/document/d/1mJUa1VJHOMWa723dmKmNjSKGW-nlBv9xktzGZZwacVo/edit#heading=h.5efudb237qdb |
22 | +rules: |
23 | + - name: whitelist |
24 | + terms: |
25 | + - whitelist |
26 | + - white-list |
27 | + - whitelisted |
28 | + - white-listed |
29 | + alternatives: |
30 | + - allowlist |
31 | + - inclusion list |
32 | + severity: warning |
33 | + note: "The underlying assumption of the whitelist/blacklist metaphor is that white = good and black = bad. Because colors in and of themselves have no predetermined meaning, any meaning we assign to them is cultural: for example, the color red in many Southeast Asian countries is lucky, and is often associated with events like marriages, whereas the color white carries the same connotations in many European countries. In the case of whitelist/blacklist, the terms originate in the publishing industry – one dominated by the USA and England, two countries which participated in slavery and which grapple with their racist legacies to this day." |
34 | + |
35 | + - name: blacklist |
36 | + terms: |
37 | + - blacklist |
38 | + - black-list |
39 | + - blacklisted |
40 | + - black-listed |
41 | + alternatives: |
42 | + - denylist |
43 | + - blocklist |
44 | + - exclusion list |
45 | + severity: warning |
46 | + note: "The underlying assumption of the whitelist/blacklist metaphor is that white = good and black = bad. Because colors in and of themselves have no predetermined meaning, any meaning we assign to them is cultural: for example, the color red in many Southeast Asian countries is lucky, and is often associated with events like marriages, whereas the color white carries the same connotations in many European countries. In the case of whitelist/blacklist, the terms originate in the publishing industry – one dominated by the USA and England, two countries which participated in slavery and which grapple with their racist legacies to this day." |
47 | + |
48 | + - name: master-slave |
49 | + terms: |
50 | + - master-slave |
51 | + - master/slave |
52 | + alternatives: |
53 | + - leader/follower |
54 | + - main/replica |
55 | + - primary/replica |
56 | + - primary/standby |
57 | + - primary/secondary |
58 | + |
59 | + - name: slave |
60 | + terms: |
61 | + - slave |
62 | + alternatives: |
63 | + - follower |
64 | + - replica |
65 | + - standby |
66 | + |
67 | + - name: grandfathered |
68 | + terms: |
69 | + - grandfathered |
70 | + alternatives: |
71 | + - legacy status |
72 | + - legacied |
73 | + - exempted |
74 | + - carried |
75 | + - brought forward |
76 | + - rolled over |
77 | + |
78 | + - name: man-hours |
79 | + terms: |
80 | + - man hours |
81 | + - man-hours |
82 | + alternatives: |
83 | + - person hours |
84 | + - engineer hours |
85 | + |
86 | + - name: sanity |
87 | + terms: |
88 | + - sanity |
89 | + alternatives: |
90 | + - confidence |
91 | + - quick check |
92 | + - coherence check |
93 | + |
94 | + - name: dummy |
95 | + terms: |
96 | + - dummy |
97 | + alternatives: |
98 | + - placeholder |
99 | + - sample |
100 | + |
101 | + - name: guys |
102 | + terms: |
103 | + - guys |
104 | + alternatives: |
105 | + - folks |
106 | + - people |
107 | + - you all |
108 | + - y'all |
109 | + - yinz |
110 | + |
111 | + - name: whitebox |
112 | + terms: |
113 | + - white-box |
114 | + - whitebox |
115 | + - white box |
116 | + alternatives: |
117 | + - open-box |
118 | + |
119 | + - name: blackbox |
120 | + terms: |
121 | + - black-box |
122 | + - blackbox |
123 | + - black box |
124 | + alternatives: |
125 | + - closed-box |
126 | + |
127 | + - name: blackhat |
128 | + terms: |
129 | + - blackhat |
130 | + - black-hat |
131 | + - black hat |
132 | + alternatives: |
133 | + - attacker |
134 | + - malicious actor |
135 | + |
136 | + - name: whitehat |
137 | + terms: |
138 | + - whitehat |
139 | + - white-hat |
140 | + - white hat |
141 | + alternatives: |
142 | + - researcher |
143 | + - security specialist |
144 | + |
145 | + - name: illegal characters |
146 | + terms: |
147 | + - illegal characters |
148 | + alternatives: |
149 | + - invalid characters |
150 | + - unsupported characters |
151 | + - special characters |
152 | + |
153 | + - name: native feature |
154 | + terms: |
155 | + - native feature |
156 | + alternatives: |
157 | + - core feature |
158 | + - built-in feature |
159 | + |
160 | + - name: native feature |
161 | + terms: |
162 | + - native feature |
163 | + alternatives: |
164 | + - core feature |
165 | + - built-in feature |
166 | + |
167 | + - name: chairman/foreman |
168 | + terms: |
169 | + - chairman |
170 | + - foreman |
171 | + alternatives: |
172 | + - chair |
173 | + - foreperson |
174 | + |
175 | + - name: man in the middle |
176 | + terms: |
177 | + - man in the middle |
178 | + - man-in-the-middle |
179 | + alternatives: |
180 | + - machine-in-the-middle |
181 | + - person-in-the-middle |
182 | + - system-in-the-middle |
183 | + - intermediary attack |
184 | + |
185 | + - name: middleman |
186 | + terms: |
187 | + - middleman |
188 | + alternatives: |
189 | + - middleperson |
190 | + - intermediary |
191 | + |
192 | + - name: manned |
193 | + terms: |
194 | + - manned |
195 | + alternatives: |
196 | + - crewed |
197 | + - staffed |
198 | + - monitored |
199 | + - human operated |
200 | + |
201 | + - name: mom test / girlfriend test |
202 | + terms: |
203 | + - mom test |
204 | + - girlfriend test |
205 | + alternatives: |
206 | + - user test |
207 | + - user friendly |
208 | + |
209 | + - name: crazy |
210 | + terms: |
211 | + - crazy |
212 | + alternatives: |
213 | + - baffling |
214 | + - unexplained |
215 | + - errant |
216 | + |
217 | + - name: cripples |
218 | + terms: |
219 | + - cripples |
220 | + alternatives: |
221 | + - slows down |
222 | + - hinders |
223 | + - obstructs |
224 | + |
225 | + - name: crippling |
226 | + terms: |
227 | + - crippling |
228 | + alternatives: |
229 | + - attenuating |
230 | + - incapacitating |
231 | + |
232 | + - name: stonith/stomith |
233 | + terms: |
234 | + - stonith |
235 | + - stomith |
236 | + alternatives: |
237 | + - fence failed nodes |
238 | + - machines |
239 | + |
240 | + - name: demilitarized zone |
241 | + terms: |
242 | + - demilitarized zone |
243 | + - dmz |
244 | + alternatives: |
245 | + - perimeter network |
246 | + - passthrough network |
247 | \ No newline at end of file |
248 | diff --git a/NEWS.rst b/NEWS.rst |
249 | index d89f010..b7c734b 100644 |
250 | --- a/NEWS.rst |
251 | +++ b/NEWS.rst |
252 | @@ -9,6 +9,7 @@ NEWS for launchpadlib |
253 | - Apply ``black`` code formatter. |
254 | - Publish documentation on Read the Docs. |
255 | - Remove remnants of ``simplejson`` in favour of ``json``. |
256 | +- Apply inclusive naming via the ``woke`` ``pre-commit`` hook. |
257 | |
258 | 1.10.15.1 (2021-10-27) |
259 | ====================== |
260 | diff --git a/src/launchpadlib/testing/launchpad-wadl.xml b/src/launchpadlib/testing/launchpad-wadl.xml |
261 | index 0d87ea8..f138c26 100644 |
262 | --- a/src/launchpadlib/testing/launchpad-wadl.xml |
263 | +++ b/src/launchpadlib/testing/launchpad-wadl.xml |
264 | @@ -2,20 +2,14 @@ |
265 | <!DOCTYPE application [ |
266 | <!ENTITY nbsp "\ "> |
267 | ]> |
268 | -<wadl:application xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" |
269 | - xmlns="http://research.sun.com/wadl/2006/10" |
270 | - xmlns:xsd="http://www.w3.org/2001/XMLSchema" |
271 | - xmlns:wadl="http://research.sun.com/wadl/2006/10" |
272 | - xsi:schemaLocation="http://research.sun.com/wadl/2006/10/wadl.xsd"> |
273 | - |
274 | - <wadl:doc xmlns="http://www.w3.org/1999/xhtml" |
275 | - title="About this service">The Launchpad web service allows automated |
276 | +<wadl:application xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://research.sun.com/wadl/2006/10" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wadl="http://research.sun.com/wadl/2006/10" xsi:schemaLocation="http://research.sun.com/wadl/2006/10/wadl.xsd"> |
277 | + |
278 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml" title="About this service">The Launchpad web service allows automated |
279 | clients to access most of the functionality available on the |
280 | Launchpad web site. For help getting started, see |
281 | <a href="https://help.launchpad.net/API/">the help wiki.</a></wadl:doc> |
282 | |
283 | - <wadl:doc xmlns="http://www.w3.org/1999/xhtml" |
284 | - title="About version 1.0">This version of the web service removes unnecessary |
285 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml" title="About version 1.0">This version of the web service removes unnecessary |
286 | named operations. It was introduced in March 2010, and its |
287 | end-of-life date is April 2015, the same as the server version |
288 | of the Ubuntu release "Lucid Lynx".</wadl:doc> |
289 | @@ -23,7 +17,7 @@ |
290 | <!--There is one "service root" resource, located (as you'd expect) |
291 | at the service root. This very document is the WADL |
292 | representation of the "service root" resource.--> |
293 | - <wadl:resources base="https://api.launchpad.net/1.0/"> |
294 | + <wadl:resources base="https://api.launchpad.test/1.0/"> |
295 | <wadl:resource path="" type="#service-root"/> |
296 | </wadl:resources> |
297 | |
298 | @@ -42,141 +36,153 @@ |
299 | number of links to collection-type resources.--> |
300 | <wadl:representation mediaType="application/json" id="service-root-json"> |
301 | |
302 | - <wadl:param style="plain" |
303 | - path="$['branches_collection_link']" |
304 | - name="branches_collection_link"> |
305 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#branches"/> |
306 | + <wadl:param style="plain" name="archives_collection_link" path="$['archives_collection_link']"> |
307 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#archives"/> |
308 | + </wadl:param> |
309 | + |
310 | + |
311 | + <wadl:param style="plain" name="branches_collection_link" path="$['branches_collection_link']"> |
312 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#branches"/> |
313 | + </wadl:param> |
314 | + |
315 | + |
316 | + <wadl:param style="plain" name="bug_trackers_collection_link" path="$['bug_trackers_collection_link']"> |
317 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#bug_trackers"/> |
318 | + </wadl:param> |
319 | + |
320 | + |
321 | + <wadl:param style="plain" name="bugs_collection_link" path="$['bugs_collection_link']"> |
322 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#bugs"/> |
323 | + </wadl:param> |
324 | + |
325 | + |
326 | + <wadl:param style="plain" name="builders_collection_link" path="$['builders_collection_link']"> |
327 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#builders"/> |
328 | + </wadl:param> |
329 | + |
330 | + |
331 | + <wadl:param style="plain" name="charm_bases_collection_link" path="$['charm_bases_collection_link']"> |
332 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#charm_bases"/> |
333 | </wadl:param> |
334 | |
335 | |
336 | - <wadl:param style="plain" |
337 | - path="$['bug_trackers_collection_link']" |
338 | - name="bug_trackers_collection_link"> |
339 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#bug_trackers"/> |
340 | + <wadl:param style="plain" name="charm_recipes_collection_link" path="$['charm_recipes_collection_link']"> |
341 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#charm_recipes"/> |
342 | </wadl:param> |
343 | |
344 | |
345 | - <wadl:param style="plain" |
346 | - path="$['bugs_collection_link']" |
347 | - name="bugs_collection_link"> |
348 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#bugs"/> |
349 | + <wadl:param style="plain" name="countries_collection_link" path="$['countries_collection_link']"> |
350 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#countries"/> |
351 | </wadl:param> |
352 | |
353 | |
354 | - <wadl:param style="plain" |
355 | - path="$['builders_collection_link']" |
356 | - name="builders_collection_link"> |
357 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#builders"/> |
358 | + <wadl:param style="plain" name="cves_collection_link" path="$['cves_collection_link']"> |
359 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#cves"/> |
360 | </wadl:param> |
361 | |
362 | |
363 | - <wadl:param style="plain" |
364 | - path="$['countries_collection_link']" |
365 | - name="countries_collection_link"> |
366 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#countries"/> |
367 | + <wadl:param style="plain" name="distributions_collection_link" path="$['distributions_collection_link']"> |
368 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#distributions"/> |
369 | </wadl:param> |
370 | |
371 | |
372 | - <wadl:param style="plain" |
373 | - path="$['cves_collection_link']" |
374 | - name="cves_collection_link"> |
375 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#cves"/> |
376 | + <wadl:param style="plain" name="git_repositories_collection_link" path="$['git_repositories_collection_link']"> |
377 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#git_repositories"/> |
378 | </wadl:param> |
379 | |
380 | |
381 | - <wadl:param style="plain" |
382 | - path="$['distributions_collection_link']" |
383 | - name="distributions_collection_link"> |
384 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#distributions"/> |
385 | + <wadl:param style="plain" name="languages_collection_link" path="$['languages_collection_link']"> |
386 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#languages"/> |
387 | </wadl:param> |
388 | |
389 | |
390 | - <wadl:param style="plain" |
391 | - path="$['languages_collection_link']" |
392 | - name="languages_collection_link"> |
393 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#languages"/> |
394 | + <wadl:param style="plain" name="livefses_collection_link" path="$['livefses_collection_link']"> |
395 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#livefses"/> |
396 | </wadl:param> |
397 | |
398 | |
399 | - <wadl:param style="plain" path="$['me_link']" |
400 | - name="me_link"> |
401 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#person"/> |
402 | + <wadl:param style="plain" name="me_link" path="$['me_link']"> |
403 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#person"/> |
404 | </wadl:param> |
405 | |
406 | |
407 | - <wadl:param style="plain" |
408 | - path="$['packagesets_collection_link']" |
409 | - name="packagesets_collection_link"> |
410 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#packagesets"/> |
411 | + <wadl:param style="plain" name="packagesets_collection_link" path="$['packagesets_collection_link']"> |
412 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#packagesets"/> |
413 | </wadl:param> |
414 | |
415 | |
416 | - <wadl:param style="plain" |
417 | - path="$['people_collection_link']" |
418 | - name="people_collection_link"> |
419 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#people"/> |
420 | + <wadl:param style="plain" name="people_collection_link" path="$['people_collection_link']"> |
421 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#people"/> |
422 | </wadl:param> |
423 | |
424 | |
425 | - <wadl:param style="plain" path="$['pillars_link']" |
426 | - name="pillars_link"> |
427 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#pillars"/> |
428 | + <wadl:param style="plain" name="pillars_link" path="$['pillars_link']"> |
429 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#pillars"/> |
430 | </wadl:param> |
431 | |
432 | |
433 | - <wadl:param style="plain" |
434 | - path="$['processor_families_collection_link']" |
435 | - name="processor_families_collection_link"> |
436 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#processor_families"/> |
437 | + <wadl:param style="plain" name="polls_collection_link" path="$['polls_collection_link']"> |
438 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#polls"/> |
439 | </wadl:param> |
440 | |
441 | |
442 | - <wadl:param style="plain" |
443 | - path="$['processors_collection_link']" |
444 | - name="processors_collection_link"> |
445 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#processors"/> |
446 | + <wadl:param style="plain" name="processors_collection_link" path="$['processors_collection_link']"> |
447 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#processors"/> |
448 | </wadl:param> |
449 | |
450 | |
451 | - <wadl:param style="plain" |
452 | - path="$['project_groups_collection_link']" |
453 | - name="project_groups_collection_link"> |
454 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#project_groups"/> |
455 | + <wadl:param style="plain" name="project_groups_collection_link" path="$['project_groups_collection_link']"> |
456 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#project_groups"/> |
457 | </wadl:param> |
458 | |
459 | |
460 | - <wadl:param style="plain" |
461 | - path="$['projects_collection_link']" |
462 | - name="projects_collection_link"> |
463 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#projects"/> |
464 | + <wadl:param style="plain" name="projects_collection_link" path="$['projects_collection_link']"> |
465 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#projects"/> |
466 | </wadl:param> |
467 | |
468 | |
469 | - <wadl:param style="plain" |
470 | - path="$['questions_collection_link']" |
471 | - name="questions_collection_link"> |
472 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#questions"/> |
473 | + <wadl:param style="plain" name="questions_collection_link" path="$['questions_collection_link']"> |
474 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#questions"/> |
475 | </wadl:param> |
476 | |
477 | |
478 | - <wadl:param style="plain" |
479 | - path="$['temporary_blobs_collection_link']" |
480 | - name="temporary_blobs_collection_link"> |
481 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#temporary_blobs"/> |
482 | + <wadl:param style="plain" name="services_link" path="$['services_link']"> |
483 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#service_factory"/> |
484 | </wadl:param> |
485 | |
486 | |
487 | - <wadl:param style="plain" |
488 | - path="$['translation_groups_collection_link']" |
489 | - name="translation_groups_collection_link"> |
490 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#translation_groups"/> |
491 | + <wadl:param style="plain" name="snap_bases_collection_link" path="$['snap_bases_collection_link']"> |
492 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#snap_bases"/> |
493 | </wadl:param> |
494 | |
495 | |
496 | - <wadl:param style="plain" |
497 | - path="$['translation_import_queue_entries_collection_link']" |
498 | - name="translation_import_queue_entries_collection_link"> |
499 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#translation_import_queue_entries"/> |
500 | + <wadl:param style="plain" name="snappy_serieses_collection_link" path="$['snappy_serieses_collection_link']"> |
501 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#snappy_serieses"/> |
502 | + </wadl:param> |
503 | + |
504 | + |
505 | + <wadl:param style="plain" name="snaps_collection_link" path="$['snaps_collection_link']"> |
506 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#snaps"/> |
507 | + </wadl:param> |
508 | + |
509 | + |
510 | + <wadl:param style="plain" name="specifications_collection_link" path="$['specifications_collection_link']"> |
511 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#specifications"/> |
512 | + </wadl:param> |
513 | + |
514 | + |
515 | + <wadl:param style="plain" name="temporary_blobs_collection_link" path="$['temporary_blobs_collection_link']"> |
516 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#temporary_blobs"/> |
517 | + </wadl:param> |
518 | + |
519 | + |
520 | + <wadl:param style="plain" name="translation_groups_collection_link" path="$['translation_groups_collection_link']"> |
521 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#translation_groups"/> |
522 | + </wadl:param> |
523 | + |
524 | + |
525 | + <wadl:param style="plain" name="translation_import_queue_entries_collection_link" path="$['translation_import_queue_entries_collection_link']"> |
526 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#translation_import_queue_entries"/> |
527 | </wadl:param> |
528 | |
529 | <wadl:param style="plain" name="resource_type_link" path="$['resource_type_link']"> |
530 | @@ -191,17 +197,29 @@ |
531 | |
532 | <!--Begin resource_type definitions for collection resources.--> |
533 | |
534 | + <wadl:resource_type id="archives"> |
535 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
536 | +Interface for ArchiveSet |
537 | +</wadl:doc> |
538 | + <wadl:method name="GET" id="archives-get"> |
539 | + <wadl:response> |
540 | + <wadl:representation href="https://api.launchpad.test/1.0/#archive-page"/> |
541 | + <wadl:representation mediaType="application/vnd.sun.wadl+xml" id="archives-wadl"/> |
542 | + </wadl:response> |
543 | + </wadl:method> |
544 | + |
545 | + </wadl:resource_type> |
546 | + |
547 | + |
548 | + |
549 | <wadl:resource_type id="branches"> |
550 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
551 | Interface representing the set of branches. |
552 | </wadl:doc> |
553 | <wadl:method name="GET" id="branches-get"> |
554 | <wadl:response> |
555 | - <wadl:representation |
556 | - href="https://api.launchpad.net/1.0/#branch-page"/> |
557 | - <wadl:representation |
558 | - mediaType="application/vnd.sun.wadl+xml" |
559 | - id="branches-wadl"/> |
560 | + <wadl:representation href="https://api.launchpad.test/1.0/#branch-page"/> |
561 | + <wadl:representation mediaType="application/vnd.sun.wadl+xml" id="branches-wadl"/> |
562 | </wadl:response> |
563 | </wadl:method> |
564 | |
565 | @@ -228,12 +246,10 @@ associated branch, the URL will map to None.</td> |
566 | </wadl:doc> |
567 | <wadl:request> |
568 | |
569 | - <wadl:param style="query" name="ws.op" |
570 | - required="true" fixed="getByUrls"> |
571 | + <wadl:param style="query" name="ws.op" required="true" fixed="getByUrls"> |
572 | <wadl:doc>The name of the operation being invoked.</wadl:doc> |
573 | </wadl:param> |
574 | - <wadl:param style="query" required="true" |
575 | - name="urls"> |
576 | + <wadl:param style="query" name="urls" required="true"> |
577 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
578 | <p>A list of URLs of branches</p> |
579 | <p>These can be URLs external to Launchpad, lp: URLs, or <a class="rst-reference external" href="http://bazaar.launchpad.net/" target="_top">http://bazaar.launchpad.net/</a> URLs, or any mix of all these different kinds.</p> |
580 | @@ -253,13 +269,10 @@ associated branch, the URL will map to None.</td> |
581 | </wadl:doc> |
582 | <wadl:request> |
583 | |
584 | - <wadl:param style="query" name="ws.op" |
585 | - required="true" |
586 | - fixed="getByUniqueName"> |
587 | + <wadl:param style="query" name="ws.op" required="true" fixed="getByUniqueName"> |
588 | <wadl:doc>The name of the operation being invoked.</wadl:doc> |
589 | </wadl:param> |
590 | - <wadl:param style="query" required="true" |
591 | - name="unique_name"> |
592 | + <wadl:param style="query" name="unique_name" required="true"> |
593 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
594 | Branch unique name |
595 | </wadl:doc> |
596 | @@ -269,8 +282,7 @@ Branch unique name |
597 | </wadl:request> |
598 | <wadl:response> |
599 | |
600 | - <wadl:representation |
601 | - href="https://api.launchpad.net/1.0/#branch-full"/> |
602 | + <wadl:representation href="https://api.launchpad.test/1.0/#branch-full"/> |
603 | </wadl:response> |
604 | </wadl:method> |
605 | <wadl:method id="branches-getByUrl" name="GET"> |
606 | @@ -286,12 +298,10 @@ Launchpad app, use the IBranchLookup version instead.</p> |
607 | </wadl:doc> |
608 | <wadl:request> |
609 | |
610 | - <wadl:param style="query" name="ws.op" |
611 | - required="true" fixed="getByUrl"> |
612 | + <wadl:param style="query" name="ws.op" required="true" fixed="getByUrl"> |
613 | <wadl:doc>The name of the operation being invoked.</wadl:doc> |
614 | </wadl:param> |
615 | - <wadl:param style="query" required="true" |
616 | - name="url"> |
617 | + <wadl:param style="query" name="url" required="true"> |
618 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
619 | Branch URL |
620 | </wadl:doc> |
621 | @@ -301,8 +311,7 @@ Branch URL |
622 | </wadl:request> |
623 | <wadl:response> |
624 | |
625 | - <wadl:representation |
626 | - href="https://api.launchpad.net/1.0/#branch-full"/> |
627 | + <wadl:representation href="https://api.launchpad.test/1.0/#branch-full"/> |
628 | </wadl:response> |
629 | </wadl:method> |
630 | </wadl:resource_type> |
631 | @@ -318,30 +327,25 @@ example, bugzilla.mozilla.org is distinct from bugzilla.gnome.org.</p> |
632 | </wadl:doc> |
633 | <wadl:method name="GET" id="bug_trackers-get"> |
634 | <wadl:response> |
635 | - <wadl:representation |
636 | - href="https://api.launchpad.net/1.0/#bug_tracker-page"/> |
637 | - <wadl:representation |
638 | - mediaType="application/vnd.sun.wadl+xml" |
639 | - id="bug_trackers-wadl"/> |
640 | + <wadl:representation href="https://api.launchpad.test/1.0/#bug_tracker-page"/> |
641 | + <wadl:representation mediaType="application/vnd.sun.wadl+xml" id="bug_trackers-wadl"/> |
642 | </wadl:response> |
643 | </wadl:method> |
644 | |
645 | - <wadl:method id="bug_trackers-queryByBaseURL" |
646 | - name="GET"> |
647 | + <wadl:method id="bug_trackers-getByName" name="GET"> |
648 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
649 | -Return one or None BugTracker's by baseurl |
650 | +<p>Get a BugTracker by its name.</p> |
651 | +<p>If no tracker with the given name exists, return default.</p> |
652 | + |
653 | </wadl:doc> |
654 | <wadl:request> |
655 | |
656 | - <wadl:param style="query" name="ws.op" |
657 | - required="true" |
658 | - fixed="queryByBaseURL"> |
659 | + <wadl:param style="query" name="ws.op" required="true" fixed="getByName"> |
660 | <wadl:doc>The name of the operation being invoked.</wadl:doc> |
661 | </wadl:param> |
662 | - <wadl:param style="query" required="true" |
663 | - name="base_url"> |
664 | + <wadl:param style="query" name="name" required="true"> |
665 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
666 | -The base URL of the bug tracker |
667 | +The bug tracker name |
668 | </wadl:doc> |
669 | |
670 | </wadl:param> |
671 | @@ -349,26 +353,21 @@ The base URL of the bug tracker |
672 | </wadl:request> |
673 | <wadl:response> |
674 | |
675 | - <wadl:representation |
676 | - href="https://api.launchpad.net/1.0/#bug_tracker-full"/> |
677 | + <wadl:representation href="https://api.launchpad.test/1.0/#bug_tracker-full"/> |
678 | </wadl:response> |
679 | </wadl:method> |
680 | - <wadl:method id="bug_trackers-getByName" name="GET"> |
681 | + <wadl:method id="bug_trackers-queryByBaseURL" name="GET"> |
682 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
683 | -<p>Get a BugTracker by its name.</p> |
684 | -<p>If no tracker with the given name exists, return default.</p> |
685 | - |
686 | +Return one or None BugTracker's by baseurl |
687 | </wadl:doc> |
688 | <wadl:request> |
689 | |
690 | - <wadl:param style="query" name="ws.op" |
691 | - required="true" fixed="getByName"> |
692 | + <wadl:param style="query" name="ws.op" required="true" fixed="queryByBaseURL"> |
693 | <wadl:doc>The name of the operation being invoked.</wadl:doc> |
694 | </wadl:param> |
695 | - <wadl:param style="query" required="true" |
696 | - name="name"> |
697 | + <wadl:param style="query" name="base_url" required="true"> |
698 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
699 | -The bug tracker name |
700 | +The base URL of the bug tracker |
701 | </wadl:doc> |
702 | |
703 | </wadl:param> |
704 | @@ -376,45 +375,29 @@ The bug tracker name |
705 | </wadl:request> |
706 | <wadl:response> |
707 | |
708 | - <wadl:representation |
709 | - href="https://api.launchpad.net/1.0/#bug_tracker-full"/> |
710 | + <wadl:representation href="https://api.launchpad.test/1.0/#bug_tracker-full"/> |
711 | </wadl:response> |
712 | </wadl:method> |
713 | - <wadl:method id="bug_trackers-ensureBugTracker" |
714 | - name="POST"> |
715 | + <wadl:method id="bug_trackers-ensureBugTracker" name="POST"> |
716 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
717 | <p>Make sure that there is a bugtracker for the given base url.</p> |
718 | <p>If not, create one using the given attributes.</p> |
719 | |
720 | </wadl:doc> |
721 | <wadl:request> |
722 | - <wadl:representation |
723 | - mediaType="application/x-www-form-urlencoded"> |
724 | - <wadl:param style="query" name="ws.op" |
725 | - required="true" |
726 | - fixed="ensureBugTracker"> |
727 | + <wadl:representation mediaType="application/x-www-form-urlencoded"> |
728 | + <wadl:param style="query" name="ws.op" required="true" fixed="ensureBugTracker"> |
729 | <wadl:doc>The name of the operation being invoked.</wadl:doc> |
730 | </wadl:param> |
731 | - <wadl:param style="query" required="false" |
732 | - name="name"> |
733 | - <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
734 | -<p>Name</p> |
735 | -<p>A URL-friendly name for the bug tracker, such as "mozilla-bugs".</p> |
736 | - |
737 | -</wadl:doc> |
738 | - |
739 | - </wadl:param> |
740 | - <wadl:param style="query" required="false" |
741 | - name="title"> |
742 | + <wadl:param style="query" name="base_url" required="true"> |
743 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
744 | -<p>Title</p> |
745 | -<p>A descriptive label for this tracker to show in listings.</p> |
746 | +<p>Location</p> |
747 | +<p>The top-level URL for the bug tracker, or an upstream email address. This must be accurate so that Launchpad can link to external bug reports.</p> |
748 | |
749 | </wadl:doc> |
750 | |
751 | </wadl:param> |
752 | - <wadl:param style="query" required="false" |
753 | - name="bug_tracker_type"> |
754 | + <wadl:param style="query" name="bug_tracker_type" required="false"> |
755 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
756 | Bug Tracker Type |
757 | </wadl:doc> |
758 | @@ -430,18 +413,18 @@ Bug Tracker Type |
759 | <wadl:option value="Savane"/> |
760 | <wadl:option value="PHP Project Bugtracker"/> |
761 | <wadl:option value="Google Code"/> |
762 | + <wadl:option value="GitHub Issues"/> |
763 | + <wadl:option value="GitLab Issues"/> |
764 | </wadl:param> |
765 | - <wadl:param style="query" required="true" |
766 | - name="base_url"> |
767 | + <wadl:param style="query" name="title" required="false"> |
768 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
769 | -<p>Location</p> |
770 | -<p>The top-level URL for the bug tracker, or an upstream email address. This must be accurate so that Launchpad can link to external bug reports.</p> |
771 | +<p>Title</p> |
772 | +<p>A descriptive label for this tracker to show in listings.</p> |
773 | |
774 | </wadl:doc> |
775 | |
776 | </wadl:param> |
777 | - <wadl:param style="query" required="false" |
778 | - name="summary"> |
779 | + <wadl:param style="query" name="summary" required="false"> |
780 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
781 | <p>Summary</p> |
782 | <p>A brief introduction or overview of this bug tracker instance.</p> |
783 | @@ -449,8 +432,7 @@ Bug Tracker Type |
784 | </wadl:doc> |
785 | |
786 | </wadl:param> |
787 | - <wadl:param style="query" required="false" |
788 | - name="contact_details"> |
789 | + <wadl:param style="query" name="contact_details" required="false"> |
790 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
791 | <p>Contact details</p> |
792 | <p>The contact details for the external bug tracker (so that, for example, its administrators can be contacted about a security breach).</p> |
793 | @@ -458,11 +440,19 @@ Bug Tracker Type |
794 | </wadl:doc> |
795 | |
796 | </wadl:param> |
797 | + <wadl:param style="query" name="name" required="false"> |
798 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
799 | +<p>Name</p> |
800 | +<p>A URL-friendly name for the bug tracker, such as "mozilla-bugs".</p> |
801 | + |
802 | +</wadl:doc> |
803 | + |
804 | + </wadl:param> |
805 | </wadl:representation> |
806 | </wadl:request> |
807 | <wadl:response> |
808 | <wadl:param name="Location" style="header"> |
809 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#bug_tracker"/> |
810 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#bug_tracker"/> |
811 | </wadl:param> |
812 | |
813 | </wadl:response> |
814 | @@ -482,11 +472,8 @@ methods that affect a single Builder should be on IBuilder.</p> |
815 | </wadl:doc> |
816 | <wadl:method name="GET" id="builders-get"> |
817 | <wadl:response> |
818 | - <wadl:representation |
819 | - href="https://api.launchpad.net/1.0/#builder-page"/> |
820 | - <wadl:representation |
821 | - mediaType="application/vnd.sun.wadl+xml" |
822 | - id="builders-wadl"/> |
823 | + <wadl:representation href="https://api.launchpad.test/1.0/#builder-page"/> |
824 | + <wadl:representation mediaType="application/vnd.sun.wadl+xml" id="builders-wadl"/> |
825 | </wadl:response> |
826 | </wadl:method> |
827 | |
828 | @@ -496,12 +483,10 @@ Retrieve a builder by name |
829 | </wadl:doc> |
830 | <wadl:request> |
831 | |
832 | - <wadl:param style="query" name="ws.op" |
833 | - required="true" fixed="getByName"> |
834 | + <wadl:param style="query" name="ws.op" required="true" fixed="getByName"> |
835 | <wadl:doc>The name of the operation being invoked.</wadl:doc> |
836 | </wadl:param> |
837 | - <wadl:param style="query" required="true" |
838 | - name="name"> |
839 | + <wadl:param style="query" name="name" required="true"> |
840 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
841 | Builder name |
842 | </wadl:doc> |
843 | @@ -511,10 +496,39 @@ Builder name |
844 | </wadl:request> |
845 | <wadl:response> |
846 | |
847 | - <wadl:representation |
848 | - href="https://api.launchpad.net/1.0/#builder-full"/> |
849 | + <wadl:representation href="https://api.launchpad.test/1.0/#builder-full"/> |
850 | + </wadl:response> |
851 | + </wadl:method> |
852 | + </wadl:resource_type> |
853 | + |
854 | + |
855 | + |
856 | + <wadl:resource_type id="charm_bases"> |
857 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
858 | +Interface representing the set of bases for charms. |
859 | +</wadl:doc> |
860 | + <wadl:method name="GET" id="charm_bases-get"> |
861 | + <wadl:response> |
862 | + <wadl:representation href="https://api.launchpad.test/1.0/#charm_base-page"/> |
863 | + <wadl:representation mediaType="application/vnd.sun.wadl+xml" id="charm_bases-wadl"/> |
864 | + </wadl:response> |
865 | + </wadl:method> |
866 | + |
867 | + </wadl:resource_type> |
868 | + |
869 | + |
870 | + |
871 | + <wadl:resource_type id="charm_recipes"> |
872 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
873 | +A utility to create and access charm recipes. |
874 | +</wadl:doc> |
875 | + <wadl:method name="GET" id="charm_recipes-get"> |
876 | + <wadl:response> |
877 | + <wadl:representation href="https://api.launchpad.test/1.0/#charm_recipe-page"/> |
878 | + <wadl:representation mediaType="application/vnd.sun.wadl+xml" id="charm_recipes-wadl"/> |
879 | </wadl:response> |
880 | </wadl:method> |
881 | + |
882 | </wadl:resource_type> |
883 | |
884 | |
885 | @@ -525,28 +539,23 @@ A container for countries. |
886 | </wadl:doc> |
887 | <wadl:method name="GET" id="countries-get"> |
888 | <wadl:response> |
889 | - <wadl:representation |
890 | - href="https://api.launchpad.net/1.0/#country-page"/> |
891 | - <wadl:representation |
892 | - mediaType="application/vnd.sun.wadl+xml" |
893 | - id="countries-wadl"/> |
894 | + <wadl:representation href="https://api.launchpad.test/1.0/#country-page"/> |
895 | + <wadl:representation mediaType="application/vnd.sun.wadl+xml" id="countries-wadl"/> |
896 | </wadl:response> |
897 | </wadl:method> |
898 | |
899 | - <wadl:method id="countries-getByCode" name="GET"> |
900 | + <wadl:method id="countries-getByName" name="GET"> |
901 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
902 | -Return a country by its code. |
903 | +Return a country by its name. |
904 | </wadl:doc> |
905 | <wadl:request> |
906 | |
907 | - <wadl:param style="query" name="ws.op" |
908 | - required="true" fixed="getByCode"> |
909 | + <wadl:param style="query" name="ws.op" required="true" fixed="getByName"> |
910 | <wadl:doc>The name of the operation being invoked.</wadl:doc> |
911 | </wadl:param> |
912 | - <wadl:param style="query" required="true" |
913 | - name="code"> |
914 | + <wadl:param style="query" name="name" required="true"> |
915 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
916 | -Code |
917 | +Name |
918 | </wadl:doc> |
919 | |
920 | </wadl:param> |
921 | @@ -554,24 +563,21 @@ Code |
922 | </wadl:request> |
923 | <wadl:response> |
924 | |
925 | - <wadl:representation |
926 | - href="https://api.launchpad.net/1.0/#country-full"/> |
927 | + <wadl:representation href="https://api.launchpad.test/1.0/#country-full"/> |
928 | </wadl:response> |
929 | </wadl:method> |
930 | - <wadl:method id="countries-getByName" name="GET"> |
931 | + <wadl:method id="countries-getByCode" name="GET"> |
932 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
933 | -Return a country by its name. |
934 | +Return a country by its code. |
935 | </wadl:doc> |
936 | <wadl:request> |
937 | |
938 | - <wadl:param style="query" name="ws.op" |
939 | - required="true" fixed="getByName"> |
940 | + <wadl:param style="query" name="ws.op" required="true" fixed="getByCode"> |
941 | <wadl:doc>The name of the operation being invoked.</wadl:doc> |
942 | </wadl:param> |
943 | - <wadl:param style="query" required="true" |
944 | - name="name"> |
945 | + <wadl:param style="query" name="code" required="true"> |
946 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
947 | -Name |
948 | +Code |
949 | </wadl:doc> |
950 | |
951 | </wadl:param> |
952 | @@ -579,8 +585,7 @@ Name |
953 | </wadl:request> |
954 | <wadl:response> |
955 | |
956 | - <wadl:representation |
957 | - href="https://api.launchpad.net/1.0/#country-full"/> |
958 | + <wadl:representation href="https://api.launchpad.test/1.0/#country-full"/> |
959 | </wadl:response> |
960 | </wadl:method> |
961 | </wadl:resource_type> |
962 | @@ -593,10 +598,8 @@ The set of ICve objects. |
963 | </wadl:doc> |
964 | <wadl:method name="GET" id="cves-get"> |
965 | <wadl:response> |
966 | - <wadl:representation |
967 | - href="https://api.launchpad.net/1.0/#cve-page"/> |
968 | - <wadl:representation |
969 | - mediaType="application/vnd.sun.wadl+xml" id="cves-wadl"/> |
970 | + <wadl:representation href="https://api.launchpad.test/1.0/#cve-page"/> |
971 | + <wadl:representation mediaType="application/vnd.sun.wadl+xml" id="cves-wadl"/> |
972 | </wadl:response> |
973 | </wadl:method> |
974 | |
975 | @@ -610,11 +613,23 @@ Interface for DistrosSet |
976 | </wadl:doc> |
977 | <wadl:method name="GET" id="distributions-get"> |
978 | <wadl:response> |
979 | - <wadl:representation |
980 | - href="https://api.launchpad.net/1.0/#distribution-page"/> |
981 | - <wadl:representation |
982 | - mediaType="application/vnd.sun.wadl+xml" |
983 | - id="distributions-wadl"/> |
984 | + <wadl:representation href="https://api.launchpad.test/1.0/#distribution-page"/> |
985 | + <wadl:representation mediaType="application/vnd.sun.wadl+xml" id="distributions-wadl"/> |
986 | + </wadl:response> |
987 | + </wadl:method> |
988 | + |
989 | + </wadl:resource_type> |
990 | + |
991 | + |
992 | + |
993 | + <wadl:resource_type id="git_repositories"> |
994 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
995 | +Interface representing the set of Git repositories. |
996 | +</wadl:doc> |
997 | + <wadl:method name="GET" id="git_repositories-get"> |
998 | + <wadl:response> |
999 | + <wadl:representation href="https://api.launchpad.test/1.0/#git_repository-page"/> |
1000 | + <wadl:representation mediaType="application/vnd.sun.wadl+xml" id="git_repositories-wadl"/> |
1001 | </wadl:response> |
1002 | </wadl:method> |
1003 | |
1004 | @@ -632,11 +647,8 @@ the getAllLanguages method.</p> |
1005 | </wadl:doc> |
1006 | <wadl:method name="GET" id="languages-get"> |
1007 | <wadl:response> |
1008 | - <wadl:representation |
1009 | - href="https://api.launchpad.net/1.0/#language-page"/> |
1010 | - <wadl:representation |
1011 | - mediaType="application/vnd.sun.wadl+xml" |
1012 | - id="languages-wadl"/> |
1013 | + <wadl:representation href="https://api.launchpad.test/1.0/#language-page"/> |
1014 | + <wadl:representation mediaType="application/vnd.sun.wadl+xml" id="languages-wadl"/> |
1015 | </wadl:response> |
1016 | </wadl:method> |
1017 | |
1018 | @@ -646,19 +658,31 @@ Return a result set of all ILanguages from Launchpad. |
1019 | </wadl:doc> |
1020 | <wadl:request> |
1021 | |
1022 | - <wadl:param style="query" name="ws.op" |
1023 | - required="true" |
1024 | - fixed="getAllLanguages"> |
1025 | + <wadl:param style="query" name="ws.op" required="true" fixed="getAllLanguages"> |
1026 | <wadl:doc>The name of the operation being invoked.</wadl:doc> |
1027 | </wadl:param> |
1028 | |
1029 | </wadl:request> |
1030 | <wadl:response> |
1031 | |
1032 | - <wadl:representation |
1033 | - href="https://api.launchpad.net/1.0/#language-page"/> |
1034 | + <wadl:representation href="https://api.launchpad.test/1.0/#language-page"/> |
1035 | + </wadl:response> |
1036 | + </wadl:method> |
1037 | + </wadl:resource_type> |
1038 | + |
1039 | + |
1040 | + |
1041 | + <wadl:resource_type id="livefses"> |
1042 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1043 | +A utility to create and access live filesystems. |
1044 | +</wadl:doc> |
1045 | + <wadl:method name="GET" id="livefses-get"> |
1046 | + <wadl:response> |
1047 | + <wadl:representation href="https://api.launchpad.test/1.0/#livefs-page"/> |
1048 | + <wadl:representation mediaType="application/vnd.sun.wadl+xml" id="livefses-wadl"/> |
1049 | </wadl:response> |
1050 | </wadl:method> |
1051 | + |
1052 | </wadl:resource_type> |
1053 | |
1054 | |
1055 | @@ -669,371 +693,321 @@ Application root for malone. |
1056 | </wadl:doc> |
1057 | <wadl:method name="GET" id="bugs-get"> |
1058 | <wadl:response> |
1059 | - <wadl:representation |
1060 | - href="https://api.launchpad.net/1.0/#bug-page"/> |
1061 | - <wadl:representation |
1062 | - mediaType="application/vnd.sun.wadl+xml" id="bugs-wadl"/> |
1063 | + <wadl:representation href="https://api.launchpad.test/1.0/#bug-page"/> |
1064 | + <wadl:representation mediaType="application/vnd.sun.wadl+xml" id="bugs-wadl"/> |
1065 | </wadl:response> |
1066 | </wadl:method> |
1067 | |
1068 | - <wadl:method id="bugs-createBug" name="POST"> |
1069 | + <wadl:method id="bugs-searchTasks" name="GET"> |
1070 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1071 | -<p>Create a bug (with an appropriate bugtask) and return it.</p> |
1072 | +<p>Search the IBugTasks reported on this entity.</p> |
1073 | <table class="rst-docutils field-list" frame="void" rules="none"> |
1074 | <col class="field-name" /> |
1075 | <col class="field-body" /> |
1076 | <tbody valign="top"> |
1077 | -<tr class="rst-field"><th class="rst-field-name">param target:</th><td class="rst-field-body">The Product, Distribution or DistributionSourcePackage |
1078 | -affected by this bug.</td> |
1079 | +<tr class="rst-field"><th class="rst-field-name">search_params:</th><td class="rst-field-body">a BugTaskSearchParams object</td> |
1080 | </tr> |
1081 | </tbody> |
1082 | </table> |
1083 | -<p>Things to note when using this factory:</p> |
1084 | -<blockquote> |
1085 | -<ul class="rst-simple"> |
1086 | -<li>the owner will be subscribed to the bug</li> |
1087 | -<li>distribution, product and package contacts (whichever ones are |
1088 | -applicable based on the bug report target) will be subscribed to |
1089 | -all <em>public bugs only</em></li> |
1090 | -<li>for public upstreams bugs where there is no upstream bug contact, |
1091 | -the product owner will be subscribed instead</li> |
1092 | -</ul> |
1093 | -</blockquote> |
1094 | +<p>Return an iterable of matching results.</p> |
1095 | +<p>Note: milestone is currently ignored for all IBugTargets |
1096 | +except IProduct.</p> |
1097 | |
1098 | </wadl:doc> |
1099 | <wadl:request> |
1100 | - <wadl:representation |
1101 | - mediaType="application/x-www-form-urlencoded"> |
1102 | - <wadl:param style="query" name="ws.op" |
1103 | - required="true" fixed="createBug"> |
1104 | + |
1105 | + <wadl:param style="query" name="ws.op" required="true" fixed="searchTasks"> |
1106 | <wadl:doc>The name of the operation being invoked.</wadl:doc> |
1107 | </wadl:param> |
1108 | - <wadl:param style="query" required="false" |
1109 | - name="security_related"> |
1110 | + <wadl:param style="query" name="bug_reporter" required="false"> |
1111 | + |
1112 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#person"/> |
1113 | + </wadl:param> |
1114 | + <wadl:param style="query" name="has_cve" required="false"> |
1115 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1116 | -This bug is a security vulnerability. |
1117 | +Show only bugs associated with a CVE |
1118 | </wadl:doc> |
1119 | |
1120 | </wadl:param> |
1121 | - <wadl:param style="query" required="true" |
1122 | - name="target"> |
1123 | + <wadl:param style="query" name="omit_targeted" required="false"> |
1124 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1125 | -The project, distribution or source package that has this bug. |
1126 | +Omit bugs targeted to a series |
1127 | </wadl:doc> |
1128 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#bug_target"/> |
1129 | + |
1130 | + </wadl:param> |
1131 | + <wadl:param style="query" name="bug_subscriber" required="false"> |
1132 | + |
1133 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#person"/> |
1134 | </wadl:param> |
1135 | - <wadl:param style="query" required="false" |
1136 | - name="tags"> |
1137 | + <wadl:param style="query" name="status_upstream" required="false"> |
1138 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1139 | -<p>Tags</p> |
1140 | -<p>Space-separated keywords for classifying this bug report.</p> |
1141 | +<p>Status upstream</p> |
1142 | +<p>Indicates the status of any remote watches associated with the bug. Possible values include: pending_bugwatch, hide_upstream, resolved_upstream, and open_upstream.</p> |
1143 | |
1144 | </wadl:doc> |
1145 | |
1146 | </wadl:param> |
1147 | - <wadl:param style="query" required="true" |
1148 | - name="title"> |
1149 | + <wadl:param style="query" name="tags" required="false"> |
1150 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1151 | -<p>Summary</p> |
1152 | -<p>A one-line summary of the problem.</p> |
1153 | +<p>Tags</p> |
1154 | +<p>String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'</p> |
1155 | |
1156 | </wadl:doc> |
1157 | |
1158 | </wadl:param> |
1159 | - <wadl:param style="query" required="false" |
1160 | - name="private"> |
1161 | + <wadl:param style="query" name="omit_duplicates" required="false"> |
1162 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1163 | -<p>This bug report should be private</p> |
1164 | -<p>Private bug reports are visible only to their subscribers.</p> |
1165 | - |
1166 | +Omit bugs marked as duplicate, |
1167 | </wadl:doc> |
1168 | |
1169 | </wadl:param> |
1170 | - <wadl:param style="query" required="true" |
1171 | - name="description"> |
1172 | + <wadl:param style="query" name="nominated_for" required="false"> |
1173 | + |
1174 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#distro_series"/> |
1175 | + </wadl:param> |
1176 | + <wadl:param style="query" name="modified_since" required="false" type="xsd:dateTime"> |
1177 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1178 | -<p>Description</p> |
1179 | -<dl class="rst-docutils"> |
1180 | -<dt>A detailed description of the problem,</dt> |
1181 | -<dd>including the steps required to reproduce it.</dd> |
1182 | -</dl> |
1183 | - |
1184 | +Search for bugs that have been modified since the given date. |
1185 | </wadl:doc> |
1186 | |
1187 | </wadl:param> |
1188 | - </wadl:representation> |
1189 | - </wadl:request> |
1190 | - <wadl:response> |
1191 | - <wadl:param name="Location" style="header"> |
1192 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#bug"/> |
1193 | - </wadl:param> |
1194 | - |
1195 | - </wadl:response> |
1196 | - </wadl:method> |
1197 | - </wadl:resource_type> |
1198 | - |
1199 | - |
1200 | - |
1201 | - <wadl:resource_type id="packagesets"> |
1202 | - <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1203 | -An interface for multiple package sets. |
1204 | -</wadl:doc> |
1205 | - <wadl:method name="GET" id="packagesets-get"> |
1206 | - <wadl:response> |
1207 | - <wadl:representation |
1208 | - href="https://api.launchpad.net/1.0/#packageset-page"/> |
1209 | - <wadl:representation |
1210 | - mediaType="application/vnd.sun.wadl+xml" |
1211 | - id="packagesets-wadl"/> |
1212 | - </wadl:response> |
1213 | - </wadl:method> |
1214 | - |
1215 | - <wadl:method id="packagesets-setsIncludingSource" |
1216 | - name="GET"> |
1217 | - <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1218 | -<p>Get the package sets that include this source package.</p> |
1219 | -<p>Return all package sets that directly or indirectly include the |
1220 | -given source package name.</p> |
1221 | -<table class="rst-docutils field-list" frame="void" rules="none"> |
1222 | -<col class="field-name" /> |
1223 | -<col class="field-body" /> |
1224 | -<tbody valign="top"> |
1225 | -<tr class="rst-field"><th class="rst-field-name" colspan="2">param sourcepackagename:</th></tr> |
1226 | -<tr><td> </td><td class="rst-field-body">the included source package name; can be |
1227 | -either a string or a ISourcePackageName.</td> |
1228 | -</tr> |
1229 | -<tr class="rst-field"><th class="rst-field-name" colspan="2">param distroseries:</th></tr> |
1230 | -<tr><td> </td><td class="rst-field-body">the IDistroSeries in which to look for sets. |
1231 | -If omitted, matching package sets from all series will be |
1232 | -returned.</td> |
1233 | -</tr> |
1234 | -<tr class="rst-field"><th class="rst-field-name" colspan="2">param direct_inclusion:</th></tr> |
1235 | -<tr><td> </td><td class="rst-field-body">if this flag is set to True, then only |
1236 | -package sets that directly include this source package name will |
1237 | -be considered.</td> |
1238 | -</tr> |
1239 | -<tr class="rst-field"><th class="rst-field-name" colspan="2">raises NoSuchSourcePackageName:</th></tr> |
1240 | -<tr><td> </td><td class="rst-field-body">if a source package with the given |
1241 | -name cannot be found.</td> |
1242 | -</tr> |
1243 | -<tr class="rst-field"><th class="rst-field-name">return:</th><td class="rst-field-body">A (potentially empty) sequence of IPackageset instances.</td> |
1244 | -</tr> |
1245 | -</tbody> |
1246 | -</table> |
1247 | - |
1248 | + <wadl:param style="query" name="structural_subscriber" required="false"> |
1249 | + |
1250 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#person"/> |
1251 | + </wadl:param> |
1252 | + <wadl:param style="query" name="owner" required="false"> |
1253 | + |
1254 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#person"/> |
1255 | + </wadl:param> |
1256 | + <wadl:param style="query" name="created_since" required="false" type="xsd:dateTime"> |
1257 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1258 | +Search for bugs that have been created since the given date. |
1259 | </wadl:doc> |
1260 | - <wadl:request> |
1261 | - |
1262 | - <wadl:param style="query" name="ws.op" |
1263 | - required="true" |
1264 | - fixed="setsIncludingSource"> |
1265 | - <wadl:doc>The name of the operation being invoked.</wadl:doc> |
1266 | + |
1267 | </wadl:param> |
1268 | - <wadl:param style="query" required="true" |
1269 | - name="sourcepackagename"> |
1270 | + <wadl:param style="query" name="has_patch" required="false"> |
1271 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1272 | -Source package name |
1273 | +Show only bugs with patches available. |
1274 | </wadl:doc> |
1275 | |
1276 | </wadl:param> |
1277 | - <wadl:param style="query" required="false" |
1278 | - name="distroseries"> |
1279 | + <wadl:param style="query" name="bug_commenter" required="false"> |
1280 | + |
1281 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#person"/> |
1282 | + </wadl:param> |
1283 | + <wadl:param style="query" name="assignee" required="false"> |
1284 | + |
1285 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#person"/> |
1286 | + </wadl:param> |
1287 | + <wadl:param style="query" name="status" required="false"> |
1288 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1289 | -<p>Distribution series</p> |
1290 | -<p>The distroseries to which this package set is related.</p> |
1291 | +<p>Status</p> |
1292 | +<p>Show only bugs with the given status value or list of values.</p> |
1293 | |
1294 | </wadl:doc> |
1295 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#distro_series"/> |
1296 | + |
1297 | </wadl:param> |
1298 | - <wadl:param style="query" required="false" |
1299 | - name="direct_inclusion"> |
1300 | + <wadl:param style="query" name="affected_user" required="false"> |
1301 | |
1302 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#person"/> |
1303 | + </wadl:param> |
1304 | + <wadl:param style="query" name="search_text" required="false"> |
1305 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1306 | +Bug ID or search text. |
1307 | +</wadl:doc> |
1308 | |
1309 | </wadl:param> |
1310 | - |
1311 | - </wadl:request> |
1312 | - <wadl:response> |
1313 | - |
1314 | - <wadl:representation |
1315 | - href="https://api.launchpad.net/1.0/#packageset-page"/> |
1316 | - </wadl:response> |
1317 | - </wadl:method> |
1318 | - <wadl:method id="packagesets-getByName" name="GET"> |
1319 | - <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1320 | -<p>Return the single package set with the given name (if any).</p> |
1321 | -<table class="rst-docutils field-list" frame="void" rules="none"> |
1322 | -<col class="field-name" /> |
1323 | -<col class="field-body" /> |
1324 | -<tbody valign="top"> |
1325 | -<tr class="rst-field"><th class="rst-field-name">param name:</th><td class="rst-field-body">the name of the package set sought.</td> |
1326 | -</tr> |
1327 | -<tr class="rst-field"><th class="rst-field-name" colspan="2">param distroseries:</th></tr> |
1328 | -<tr><td> </td><td class="rst-field-body">the distroseries to which the new packageset |
1329 | -is related. Defaults to the current Ubuntu series.</td> |
1330 | -</tr> |
1331 | -<tr class="rst-field"><th class="rst-field-name">return:</th><td class="rst-field-body">An IPackageset instance.</td> |
1332 | -</tr> |
1333 | -<tr class="rst-field"><th class="rst-field-name" colspan="2">raise NoSuchPackageSet:</th></tr> |
1334 | -<tr><td> </td><td class="rst-field-body">if no package set is found.</td> |
1335 | -</tr> |
1336 | -</tbody> |
1337 | -</table> |
1338 | + <wadl:param style="query" name="order_by" required="false"> |
1339 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1340 | +List of fields by which the results are ordered. |
1341 | +</wadl:doc> |
1342 | + |
1343 | + </wadl:param> |
1344 | + <wadl:param style="query" name="bug_supervisor" required="false"> |
1345 | + |
1346 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#person"/> |
1347 | + </wadl:param> |
1348 | + <wadl:param style="query" name="tags_combinator" required="false"> |
1349 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1350 | +<p>Tags combination</p> |
1351 | +<p>Search for any or all of the tags specified.</p> |
1352 | |
1353 | </wadl:doc> |
1354 | - <wadl:request> |
1355 | - |
1356 | - <wadl:param style="query" name="ws.op" |
1357 | - required="true" fixed="getByName"> |
1358 | - <wadl:doc>The name of the operation being invoked.</wadl:doc> |
1359 | + |
1360 | + <wadl:option value="Any"/> |
1361 | + <wadl:option value="All"/> |
1362 | </wadl:param> |
1363 | - <wadl:param style="query" required="false" |
1364 | - name="distroseries"> |
1365 | + <wadl:param style="query" name="component" required="false"> |
1366 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1367 | -<p>Distroseries</p> |
1368 | -<p>The distribution series to which the packageset is related.</p> |
1369 | +<p>Component</p> |
1370 | +<p>Distribution package archive grouping. E.g. main, universe, multiverse</p> |
1371 | |
1372 | </wadl:doc> |
1373 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#distro_series"/> |
1374 | + |
1375 | </wadl:param> |
1376 | - <wadl:param style="query" required="true" |
1377 | - name="name"> |
1378 | + <wadl:param style="query" name="importance" required="false"> |
1379 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1380 | -Package set name |
1381 | +<p>Importance</p> |
1382 | +<p>Show only bugs with the given importance or list of importances.</p> |
1383 | + |
1384 | </wadl:doc> |
1385 | |
1386 | </wadl:param> |
1387 | - |
1388 | - </wadl:request> |
1389 | - <wadl:response> |
1390 | - |
1391 | - <wadl:representation |
1392 | - href="https://api.launchpad.net/1.0/#packageset-full"/> |
1393 | - </wadl:response> |
1394 | - </wadl:method> |
1395 | - <wadl:method id="packagesets-getBySeries" name="GET"> |
1396 | - <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1397 | -<p>Return the package sets associated with the given distroseries.</p> |
1398 | -<table class="rst-docutils field-list" frame="void" rules="none"> |
1399 | -<col class="field-name" /> |
1400 | -<col class="field-body" /> |
1401 | -<tbody valign="top"> |
1402 | -<tr class="rst-field"><th class="rst-field-name" colspan="2">param distroseries:</th></tr> |
1403 | -<tr><td> </td><td class="rst-field-body">A DistroSeries.</td> |
1404 | -</tr> |
1405 | -<tr class="rst-field"><th class="rst-field-name">return:</th><td class="rst-field-body">An iterable collection of IPackageset instances.</td> |
1406 | -</tr> |
1407 | -</tbody> |
1408 | -</table> |
1409 | + <wadl:param style="query" name="information_type" required="false"> |
1410 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1411 | +<p>Information Type</p> |
1412 | +<p>Show only bugs with the given information type or list of information types.</p> |
1413 | |
1414 | </wadl:doc> |
1415 | - <wadl:request> |
1416 | - |
1417 | - <wadl:param style="query" name="ws.op" |
1418 | - required="true" fixed="getBySeries"> |
1419 | - <wadl:doc>The name of the operation being invoked.</wadl:doc> |
1420 | + |
1421 | </wadl:param> |
1422 | - <wadl:param style="query" required="true" |
1423 | - name="distroseries"> |
1424 | + <wadl:param style="query" name="created_before" required="false" type="xsd:dateTime"> |
1425 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1426 | -<p>Distribution series</p> |
1427 | -<p>The distroseries to which this package set is related.</p> |
1428 | +Search for bugs that were created before the given date. |
1429 | +</wadl:doc> |
1430 | + |
1431 | + </wadl:param> |
1432 | + <wadl:param style="query" name="milestone" required="false"> |
1433 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1434 | +<p>Milestone</p> |
1435 | +<p>Show only bug tasks targeted to this milestone.</p> |
1436 | |
1437 | </wadl:doc> |
1438 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#distro_series"/> |
1439 | + |
1440 | + </wadl:param> |
1441 | + <wadl:param style="query" name="linked_branches" required="false"> |
1442 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1443 | +Search for bugs that are linked to branches or for bugs that are not linked to branches. |
1444 | +</wadl:doc> |
1445 | + |
1446 | + <wadl:option value="Show all bugs"/> |
1447 | + <wadl:option value="Show only Bugs with linked Branches"/> |
1448 | + <wadl:option value="Show only Bugs without linked Branches"/> |
1449 | + </wadl:param> |
1450 | + <wadl:param style="query" name="has_no_package" required="false"> |
1451 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1452 | +Exclude bugs with packages specified |
1453 | +</wadl:doc> |
1454 | + |
1455 | </wadl:param> |
1456 | |
1457 | </wadl:request> |
1458 | <wadl:response> |
1459 | |
1460 | - <wadl:representation |
1461 | - href="https://api.launchpad.net/1.0/#packageset-page"/> |
1462 | + <wadl:representation href="https://api.launchpad.test/1.0/#bug_task-page"/> |
1463 | </wadl:response> |
1464 | </wadl:method> |
1465 | - <wadl:method id="packagesets-new" name="POST"> |
1466 | + <wadl:method id="bugs-createBug" name="POST"> |
1467 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1468 | -<p>Create a new package set.</p> |
1469 | +<p>Create a bug (with an appropriate bugtask) and return it.</p> |
1470 | <table class="rst-docutils field-list" frame="void" rules="none"> |
1471 | <col class="field-name" /> |
1472 | <col class="field-body" /> |
1473 | <tbody valign="top"> |
1474 | -<tr class="rst-field"><th class="rst-field-name">param name:</th><td class="rst-field-body">the name of the package set to be created.</td> |
1475 | +<tr class="rst-field"><th class="rst-field-name">param target:</th><td class="rst-field-body">The Project, Distribution or DistributionSourcePackage |
1476 | +affected by this bug.</td> |
1477 | </tr> |
1478 | -<tr class="rst-field"><th class="rst-field-name" colspan="2">param description:</th></tr> |
1479 | -<tr><td> </td><td class="rst-field-body">the description for the package set to be created.</td> |
1480 | +<tr class="rst-field"><th class="rst-field-name">param title:</th><td class="rst-field-body">The title shown in bug listings.</td> |
1481 | </tr> |
1482 | -<tr class="rst-field"><th class="rst-field-name">param owner:</th><td class="rst-field-body">the owner of the package set to be created.</td> |
1483 | +<tr class="rst-field"><th class="rst-field-name" colspan="2">param description:</th></tr> |
1484 | +<tr class="rst-field"><td> </td><td class="rst-field-body">The description of the issue.</td> |
1485 | </tr> |
1486 | -<tr class="rst-field"><th class="rst-field-name" colspan="2">param distroseries:</th></tr> |
1487 | -<tr><td> </td><td class="rst-field-body">the distroseries to which the new packageset |
1488 | -is related. Defaults to the current Ubuntu series.</td> |
1489 | +<tr class="rst-field"><th class="rst-field-name" colspan="2">param information_type:</th></tr> |
1490 | +<tr class="rst-field"><td> </td><td class="rst-field-body">Set the bug's information type to one |
1491 | +different from the project's default. The type must conform |
1492 | +to the project's bug sharing policy. (optional)</td> |
1493 | </tr> |
1494 | -<tr class="rst-field"><th class="rst-field-name" colspan="2">param related_set:</th></tr> |
1495 | -<tr><td> </td><td class="rst-field-body">the newly created package set is to be related to |
1496 | -related_set (by being placed in the same package group).</td> |
1497 | +<tr class="rst-field"><th class="rst-field-name">param tags:</th><td class="rst-field-body">A list of bug tags. (optional)</td> |
1498 | </tr> |
1499 | -<tr class="rst-field"><th class="rst-field-name" colspan="2">raises DuplicatePackagesetName:</th></tr> |
1500 | -<tr><td> </td><td class="rst-field-body">if a package set with the same name |
1501 | -exists in distroseries already.</td> |
1502 | +<tr class="rst-field"><th class="rst-field-name" colspan="2">param security_related:</th></tr> |
1503 | +<tr class="rst-field"><td> </td><td class="rst-field-body">Is this bug's information type |
1504 | +Private Security? (deprecated)</td> |
1505 | </tr> |
1506 | -<tr class="rst-field"><th class="rst-field-name">return:</th><td class="rst-field-body">a newly created IPackageset.</td> |
1507 | +<tr class="rst-field"><th class="rst-field-name">param tags:</th><td class="rst-field-body">Is this bug's information type Private |
1508 | +user data. (deprecated)</td> |
1509 | </tr> |
1510 | </tbody> |
1511 | </table> |
1512 | +<p>Things to note when using this factory:</p> |
1513 | +<blockquote> |
1514 | +<ul class="rst-simple"> |
1515 | +<li>The reporter will be subscribed to the bug.</li> |
1516 | +<li>Only people that the project shares with will see the bug |
1517 | +when the bug's information type is Proprietary, Private, or |
1518 | +Private Security.</li> |
1519 | +</ul> |
1520 | +</blockquote> |
1521 | |
1522 | </wadl:doc> |
1523 | <wadl:request> |
1524 | - <wadl:representation |
1525 | - mediaType="application/x-www-form-urlencoded"> |
1526 | - <wadl:param style="query" name="ws.op" |
1527 | - required="true" fixed="new"> |
1528 | + <wadl:representation mediaType="application/x-www-form-urlencoded"> |
1529 | + <wadl:param style="query" name="ws.op" required="true" fixed="createBug"> |
1530 | <wadl:doc>The name of the operation being invoked.</wadl:doc> |
1531 | </wadl:param> |
1532 | - <wadl:param style="query" required="true" |
1533 | - name="owner"> |
1534 | + <wadl:param style="query" name="title" required="true"> |
1535 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1536 | -<p>Person</p> |
1537 | -<p>The person who owns this package set.</p> |
1538 | +<p>Summary</p> |
1539 | +<p>A one-line summary of the problem.</p> |
1540 | |
1541 | </wadl:doc> |
1542 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#person"/> |
1543 | + |
1544 | </wadl:param> |
1545 | - <wadl:param style="query" required="false" |
1546 | - name="distroseries"> |
1547 | + <wadl:param style="query" name="description" required="true"> |
1548 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1549 | -<p>Distroseries</p> |
1550 | -<p>The distribution series to which the packageset is related.</p> |
1551 | +<p>Description</p> |
1552 | +<p>A detailed description of the problem, |
1553 | +including the steps required to reproduce it.</p> |
1554 | |
1555 | </wadl:doc> |
1556 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#distro_series"/> |
1557 | + |
1558 | </wadl:param> |
1559 | - <wadl:param style="query" required="true" |
1560 | - name="description"> |
1561 | + <wadl:param style="query" name="tags" required="false"> |
1562 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1563 | -Package set description |
1564 | +<p>Tags</p> |
1565 | +<p>Space-separated keywords for classifying this bug report.</p> |
1566 | + |
1567 | </wadl:doc> |
1568 | |
1569 | </wadl:param> |
1570 | - <wadl:param style="query" required="true" |
1571 | - name="name"> |
1572 | + <wadl:param style="query" name="information_type" required="false"> |
1573 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1574 | -Valid package set name |
1575 | +<p>Information Type</p> |
1576 | +<p>The type of information contained in this bug report.</p> |
1577 | + |
1578 | </wadl:doc> |
1579 | |
1580 | + <wadl:option value="Public"/> |
1581 | + <wadl:option value="Public Security"/> |
1582 | + <wadl:option value="Private Security"/> |
1583 | + <wadl:option value="Private"/> |
1584 | + <wadl:option value="Proprietary"/> |
1585 | + <wadl:option value="Embargoed"/> |
1586 | </wadl:param> |
1587 | - <wadl:param style="query" required="false" |
1588 | - name="related_set"> |
1589 | + <wadl:param style="query" name="security_related" required="false"> |
1590 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1591 | -<p>Related package set</p> |
1592 | -<p>The new package set will share the package set group with this one.</p> |
1593 | +This bug is a security vulnerability. |
1594 | +</wadl:doc> |
1595 | + |
1596 | + </wadl:param> |
1597 | + <wadl:param style="query" name="private" required="false"> |
1598 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1599 | +<p>This bug report should be private</p> |
1600 | +<p>Private bug reports are visible only to their subscribers.</p> |
1601 | |
1602 | </wadl:doc> |
1603 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#packageset"/> |
1604 | + |
1605 | + </wadl:param> |
1606 | + <wadl:param style="query" name="target" required="true"> |
1607 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1608 | +The project, distribution or source package that has this bug. |
1609 | +</wadl:doc> |
1610 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#bug_target"/> |
1611 | </wadl:param> |
1612 | </wadl:representation> |
1613 | </wadl:request> |
1614 | <wadl:response> |
1615 | <wadl:param name="Location" style="header"> |
1616 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#packageset"/> |
1617 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#bug"/> |
1618 | </wadl:param> |
1619 | |
1620 | </wadl:response> |
1621 | @@ -1042,66 +1016,55 @@ Valid package set name |
1622 | |
1623 | |
1624 | |
1625 | - <wadl:resource_type id="people"> |
1626 | + <wadl:resource_type id="packagesets"> |
1627 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1628 | -The set of Persons. |
1629 | +An interface for multiple package sets. |
1630 | </wadl:doc> |
1631 | - <wadl:method name="GET" id="people-get"> |
1632 | + <wadl:method name="GET" id="packagesets-get"> |
1633 | <wadl:response> |
1634 | - <wadl:representation |
1635 | - href="https://api.launchpad.net/1.0/#person-page"/> |
1636 | - <wadl:representation |
1637 | - mediaType="application/vnd.sun.wadl+xml" |
1638 | - id="people-wadl"/> |
1639 | + <wadl:representation href="https://api.launchpad.test/1.0/#packageset-page"/> |
1640 | + <wadl:representation mediaType="application/vnd.sun.wadl+xml" id="packagesets-wadl"/> |
1641 | </wadl:response> |
1642 | </wadl:method> |
1643 | |
1644 | - <wadl:method id="people-findPerson" name="GET"> |
1645 | + <wadl:method id="packagesets-getByName" name="GET"> |
1646 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1647 | -<p>Return all non-merged Persons with at least one email address whose |
1648 | -name, displayname or email address match <text>.</p> |
1649 | -<p>If text is an empty string, all persons with at least one email |
1650 | -address will be returned.</p> |
1651 | -<p>The results will be ordered using the default ordering specified in |
1652 | -Person._defaultOrder.</p> |
1653 | -<p>If exclude_inactive_accounts is True, any accounts whose |
1654 | -account_status is any of INACTIVE_ACCOUNT_STATUSES will not be in the |
1655 | -returned set.</p> |
1656 | -<p>If must_have_email is True, only people with one or more email |
1657 | -addresses are returned.</p> |
1658 | -<p>While we don't have Full Text Indexes in the emailaddress table, we'll |
1659 | -be trying to match the text only against the beginning of an email |
1660 | -address.</p> |
1661 | -<p>If created_before or created_after are not None, they are used to |
1662 | -restrict the search to the dates provided.</p> |
1663 | +<p>Return the single package set with the given name (if any).</p> |
1664 | +<table class="rst-docutils field-list" frame="void" rules="none"> |
1665 | +<col class="field-name" /> |
1666 | +<col class="field-body" /> |
1667 | +<tbody valign="top"> |
1668 | +<tr class="rst-field"><th class="rst-field-name" colspan="2">param distroseries:</th></tr> |
1669 | +<tr class="rst-field"><td> </td><td class="rst-field-body">the distroseries to which the new packageset |
1670 | +is related.</td> |
1671 | +</tr> |
1672 | +<tr class="rst-field"><th class="rst-field-name">param name:</th><td class="rst-field-body">the name of the package set sought.</td> |
1673 | +</tr> |
1674 | +<tr class="rst-field"><th class="rst-field-name">return:</th><td class="rst-field-body">An IPackageset instance.</td> |
1675 | +</tr> |
1676 | +<tr class="rst-field"><th class="rst-field-name" colspan="2">raise NoSuchPackageSet:</th></tr> |
1677 | +<tr class="rst-field"><td> </td><td class="rst-field-body">if no package set is found.</td> |
1678 | +</tr> |
1679 | +</tbody> |
1680 | +</table> |
1681 | |
1682 | </wadl:doc> |
1683 | <wadl:request> |
1684 | |
1685 | - <wadl:param style="query" name="ws.op" |
1686 | - required="true" fixed="findPerson"> |
1687 | + <wadl:param style="query" name="ws.op" required="true" fixed="getByName"> |
1688 | <wadl:doc>The name of the operation being invoked.</wadl:doc> |
1689 | </wadl:param> |
1690 | - <wadl:param style="query" required="true" |
1691 | - name="text"> |
1692 | - <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1693 | -Search text |
1694 | -</wadl:doc> |
1695 | - |
1696 | - </wadl:param> |
1697 | - <wadl:param style="query" required="false" |
1698 | - type="xsd:dateTime" |
1699 | - name="created_before"> |
1700 | + <wadl:param style="query" name="distroseries" required="true"> |
1701 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1702 | -Created before |
1703 | +<p>Distribution series</p> |
1704 | +<p>The distroseries to which this package set is related.</p> |
1705 | + |
1706 | </wadl:doc> |
1707 | - |
1708 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#distro_series"/> |
1709 | </wadl:param> |
1710 | - <wadl:param style="query" required="false" |
1711 | - type="xsd:dateTime" |
1712 | - name="created_after"> |
1713 | + <wadl:param style="query" name="name" required="true"> |
1714 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1715 | -Created after |
1716 | +Valid package set name |
1717 | </wadl:doc> |
1718 | |
1719 | </wadl:param> |
1720 | @@ -1109,86 +1072,323 @@ Created after |
1721 | </wadl:request> |
1722 | <wadl:response> |
1723 | |
1724 | - <wadl:representation |
1725 | - href="https://api.launchpad.net/1.0/#person-page"/> |
1726 | + <wadl:representation href="https://api.launchpad.test/1.0/#packageset-full"/> |
1727 | </wadl:response> |
1728 | </wadl:method> |
1729 | - <wadl:method id="people-getByEmail" name="GET"> |
1730 | + <wadl:method id="packagesets-getBySeries" name="GET"> |
1731 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1732 | -<p>Return the person with the given email address.</p> |
1733 | -<p>Return None if there is no person with the given email address.</p> |
1734 | +<p>Return the package sets associated with the given distroseries.</p> |
1735 | +<table class="rst-docutils field-list" frame="void" rules="none"> |
1736 | +<col class="field-name" /> |
1737 | +<col class="field-body" /> |
1738 | +<tbody valign="top"> |
1739 | +<tr class="rst-field"><th class="rst-field-name" colspan="2">param distroseries:</th></tr> |
1740 | +<tr class="rst-field"><td> </td><td class="rst-field-body">A DistroSeries.</td> |
1741 | +</tr> |
1742 | +<tr class="rst-field"><th class="rst-field-name">return:</th><td class="rst-field-body">An iterable collection of IPackageset instances.</td> |
1743 | +</tr> |
1744 | +</tbody> |
1745 | +</table> |
1746 | |
1747 | </wadl:doc> |
1748 | <wadl:request> |
1749 | |
1750 | - <wadl:param style="query" name="ws.op" |
1751 | - required="true" fixed="getByEmail"> |
1752 | + <wadl:param style="query" name="ws.op" required="true" fixed="getBySeries"> |
1753 | <wadl:doc>The name of the operation being invoked.</wadl:doc> |
1754 | </wadl:param> |
1755 | - <wadl:param style="query" required="true" |
1756 | - name="email"> |
1757 | - |
1758 | - |
1759 | + <wadl:param style="query" name="distroseries" required="true"> |
1760 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1761 | +<p>Distribution series</p> |
1762 | +<p>The distroseries to which this package set is related.</p> |
1763 | + |
1764 | +</wadl:doc> |
1765 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#distro_series"/> |
1766 | </wadl:param> |
1767 | |
1768 | </wadl:request> |
1769 | <wadl:response> |
1770 | |
1771 | - <wadl:representation |
1772 | - href="https://api.launchpad.net/1.0/#person-full"/> |
1773 | + <wadl:representation href="https://api.launchpad.test/1.0/#packageset-page"/> |
1774 | </wadl:response> |
1775 | </wadl:method> |
1776 | - <wadl:method id="people-find" name="GET"> |
1777 | + <wadl:method id="packagesets-setsIncludingSource" name="GET"> |
1778 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1779 | -<p>Return all non-merged Persons and Teams whose name, displayname or |
1780 | -email address match <text>.</p> |
1781 | -<p>The results will be ordered using the default ordering specified in |
1782 | -Person._defaultOrder.</p> |
1783 | -<p>While we don't have Full Text Indexes in the emailaddress table, we'll |
1784 | -be trying to match the text only against the beginning of an email |
1785 | -address.</p> |
1786 | +<p>Get the package sets that include this source package.</p> |
1787 | +<p>Return all package sets that directly or indirectly include the |
1788 | +given source package name.</p> |
1789 | +<table class="rst-docutils field-list" frame="void" rules="none"> |
1790 | +<col class="field-name" /> |
1791 | +<col class="field-body" /> |
1792 | +<tbody valign="top"> |
1793 | +<tr class="rst-field"><th class="rst-field-name" colspan="2">param sourcepackagename:</th></tr> |
1794 | +<tr class="rst-field"><td> </td><td class="rst-field-body">the included source package name; can be |
1795 | +either a string or a ISourcePackageName.</td> |
1796 | +</tr> |
1797 | +<tr class="rst-field"><th class="rst-field-name" colspan="2">param distroseries:</th></tr> |
1798 | +<tr class="rst-field"><td> </td><td class="rst-field-body">the IDistroSeries in which to look for sets. |
1799 | +If omitted, matching package sets from all series will be |
1800 | +returned.</td> |
1801 | +</tr> |
1802 | +<tr class="rst-field"><th class="rst-field-name" colspan="2">param direct_inclusion:</th></tr> |
1803 | +<tr class="rst-field"><td> </td><td class="rst-field-body">if this flag is set to True, then only |
1804 | +package sets that directly include this source package name will |
1805 | +be considered.</td> |
1806 | +</tr> |
1807 | +<tr class="rst-field"><th class="rst-field-name" colspan="2">raises NoSuchSourcePackageName:</th></tr> |
1808 | +<tr class="rst-field"><td> </td><td class="rst-field-body">if a source package with the given |
1809 | +name cannot be found.</td> |
1810 | +</tr> |
1811 | +<tr class="rst-field"><th class="rst-field-name">return:</th><td class="rst-field-body">A (potentially empty) sequence of IPackageset instances.</td> |
1812 | +</tr> |
1813 | +</tbody> |
1814 | +</table> |
1815 | |
1816 | </wadl:doc> |
1817 | <wadl:request> |
1818 | |
1819 | - <wadl:param style="query" name="ws.op" |
1820 | - required="true" fixed="find"> |
1821 | + <wadl:param style="query" name="ws.op" required="true" fixed="setsIncludingSource"> |
1822 | <wadl:doc>The name of the operation being invoked.</wadl:doc> |
1823 | </wadl:param> |
1824 | - <wadl:param style="query" required="true" |
1825 | - name="text"> |
1826 | + <wadl:param style="query" name="sourcepackagename" required="true"> |
1827 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1828 | -Search text |
1829 | +Source package name |
1830 | +</wadl:doc> |
1831 | + |
1832 | + </wadl:param> |
1833 | + <wadl:param style="query" name="distroseries" required="false"> |
1834 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1835 | +<p>Distribution series</p> |
1836 | +<p>The distroseries to which this package set is related.</p> |
1837 | + |
1838 | </wadl:doc> |
1839 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#distro_series"/> |
1840 | + </wadl:param> |
1841 | + <wadl:param style="query" name="direct_inclusion" required="false"> |
1842 | + |
1843 | |
1844 | </wadl:param> |
1845 | |
1846 | </wadl:request> |
1847 | <wadl:response> |
1848 | |
1849 | - <wadl:representation |
1850 | - href="https://api.launchpad.net/1.0/#person-page"/> |
1851 | + <wadl:representation href="https://api.launchpad.test/1.0/#packageset-page"/> |
1852 | </wadl:response> |
1853 | </wadl:method> |
1854 | - <wadl:method id="people-findTeam" name="GET"> |
1855 | + <wadl:method id="packagesets-new" name="POST"> |
1856 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1857 | -<p>Return all Teams whose name, displayname or email address |
1858 | -match <text>.</p> |
1859 | -<p>The results will be ordered using the default ordering specified in |
1860 | -Person._defaultOrder.</p> |
1861 | -<p>While we don't have Full Text Indexes in the emailaddress table, we'll |
1862 | -be trying to match the text only against the beginning of an email |
1863 | -address.</p> |
1864 | +<p>Create a new package set.</p> |
1865 | +<table class="rst-docutils field-list" frame="void" rules="none"> |
1866 | +<col class="field-name" /> |
1867 | +<col class="field-body" /> |
1868 | +<tbody valign="top"> |
1869 | +<tr class="rst-field"><th class="rst-field-name">param name:</th><td class="rst-field-body">the name of the package set to be created.</td> |
1870 | +</tr> |
1871 | +<tr class="rst-field"><th class="rst-field-name" colspan="2">param description:</th></tr> |
1872 | +<tr class="rst-field"><td> </td><td class="rst-field-body">the description for the package set to be created.</td> |
1873 | +</tr> |
1874 | +<tr class="rst-field"><th class="rst-field-name">param owner:</th><td class="rst-field-body">the owner of the package set to be created.</td> |
1875 | +</tr> |
1876 | +<tr class="rst-field"><th class="rst-field-name" colspan="2">param distroseries:</th></tr> |
1877 | +<tr class="rst-field"><td> </td><td class="rst-field-body">the distroseries to which the new packageset |
1878 | +is related.</td> |
1879 | +</tr> |
1880 | +<tr class="rst-field"><th class="rst-field-name" colspan="2">param related_set:</th></tr> |
1881 | +<tr class="rst-field"><td> </td><td class="rst-field-body">the newly created package set is to be related to |
1882 | +related_set (by being placed in the same package group).</td> |
1883 | +</tr> |
1884 | +<tr class="rst-field"><th class="rst-field-name" colspan="2">raises DuplicatePackagesetName:</th></tr> |
1885 | +<tr class="rst-field"><td> </td><td class="rst-field-body">if a package set with the same name |
1886 | +exists in distroseries already.</td> |
1887 | +</tr> |
1888 | +<tr class="rst-field"><th class="rst-field-name">return:</th><td class="rst-field-body">a newly created IPackageset.</td> |
1889 | +</tr> |
1890 | +</tbody> |
1891 | +</table> |
1892 | + |
1893 | +</wadl:doc> |
1894 | + <wadl:request> |
1895 | + <wadl:representation mediaType="application/x-www-form-urlencoded"> |
1896 | + <wadl:param style="query" name="ws.op" required="true" fixed="new"> |
1897 | + <wadl:doc>The name of the operation being invoked.</wadl:doc> |
1898 | + </wadl:param> |
1899 | + <wadl:param style="query" name="description" required="true"> |
1900 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1901 | +Package set description |
1902 | +</wadl:doc> |
1903 | + |
1904 | + </wadl:param> |
1905 | + <wadl:param style="query" name="owner" required="true"> |
1906 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1907 | +<p>Person</p> |
1908 | +<p>The person who owns this package set.</p> |
1909 | + |
1910 | +</wadl:doc> |
1911 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#person"/> |
1912 | + </wadl:param> |
1913 | + <wadl:param style="query" name="related_set" required="false"> |
1914 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1915 | +<p>Related package set</p> |
1916 | +<p>The new package set will share the package set group with this one.</p> |
1917 | + |
1918 | +</wadl:doc> |
1919 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#packageset"/> |
1920 | + </wadl:param> |
1921 | + <wadl:param style="query" name="distroseries" required="true"> |
1922 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1923 | +<p>Distroseries</p> |
1924 | +<p>The distribution series to which the packageset is related.</p> |
1925 | + |
1926 | +</wadl:doc> |
1927 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#distro_series"/> |
1928 | + </wadl:param> |
1929 | + <wadl:param style="query" name="name" required="true"> |
1930 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1931 | +Valid package set name |
1932 | +</wadl:doc> |
1933 | + |
1934 | + </wadl:param> |
1935 | + </wadl:representation> |
1936 | + </wadl:request> |
1937 | + <wadl:response> |
1938 | + <wadl:param name="Location" style="header"> |
1939 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#packageset"/> |
1940 | + </wadl:param> |
1941 | + |
1942 | + </wadl:response> |
1943 | + </wadl:method> |
1944 | + </wadl:resource_type> |
1945 | + |
1946 | + |
1947 | + |
1948 | + <wadl:resource_type id="people"> |
1949 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1950 | +Combined schema for operations on a group of Persons. |
1951 | +</wadl:doc> |
1952 | + <wadl:method name="GET" id="people-get"> |
1953 | + <wadl:response> |
1954 | + <wadl:representation href="https://api.launchpad.test/1.0/#person-page"/> |
1955 | + <wadl:representation mediaType="application/vnd.sun.wadl+xml" id="people-wadl"/> |
1956 | + </wadl:response> |
1957 | + </wadl:method> |
1958 | + |
1959 | + <wadl:method id="people-getByEmail" name="GET"> |
1960 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1961 | +<p>Return the person with the given email address.</p> |
1962 | +<p>Return None if there is no person with the given email address.</p> |
1963 | + |
1964 | +</wadl:doc> |
1965 | + <wadl:request> |
1966 | + |
1967 | + <wadl:param style="query" name="ws.op" required="true" fixed="getByEmail"> |
1968 | + <wadl:doc>The name of the operation being invoked.</wadl:doc> |
1969 | + </wadl:param> |
1970 | + <wadl:param style="query" name="email" required="true"> |
1971 | + |
1972 | + |
1973 | + </wadl:param> |
1974 | + |
1975 | + </wadl:request> |
1976 | + <wadl:response> |
1977 | + |
1978 | + <wadl:representation href="https://api.launchpad.test/1.0/#person-full"/> |
1979 | + </wadl:response> |
1980 | + </wadl:method> |
1981 | + <wadl:method id="people-findTeam" name="GET"> |
1982 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1983 | +<p>Return all Teams whose name, displayname or email address |
1984 | +match <text>.</p> |
1985 | +<p>The results will be ordered using the default ordering specified in |
1986 | +Person._defaultOrder.</p> |
1987 | +<p>While we don't have Full Text Indexes in the emailaddress table, we'll |
1988 | +be trying to match the text only against the beginning of an email |
1989 | +address.</p> |
1990 | + |
1991 | +</wadl:doc> |
1992 | + <wadl:request> |
1993 | + |
1994 | + <wadl:param style="query" name="ws.op" required="true" fixed="findTeam"> |
1995 | + <wadl:doc>The name of the operation being invoked.</wadl:doc> |
1996 | + </wadl:param> |
1997 | + <wadl:param style="query" name="text" required="true"> |
1998 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
1999 | +Search text |
2000 | +</wadl:doc> |
2001 | + |
2002 | + </wadl:param> |
2003 | + |
2004 | + </wadl:request> |
2005 | + <wadl:response> |
2006 | + |
2007 | + <wadl:representation href="https://api.launchpad.test/1.0/#person-page"/> |
2008 | + </wadl:response> |
2009 | + </wadl:method> |
2010 | + <wadl:method id="people-findPerson" name="GET"> |
2011 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2012 | +<p>Return all non-merged Persons with at least one email address whose |
2013 | +name, displayname or email address match <text>.</p> |
2014 | +<p>If text is an empty string, all persons with at least one email |
2015 | +address will be returned.</p> |
2016 | +<p>The results will be ordered using the default ordering specified in |
2017 | +Person._defaultOrder.</p> |
2018 | +<p>If exclude_inactive_accounts is True, any accounts whose |
2019 | +account_status is any of INACTIVE_ACCOUNT_STATUSES will not be in the |
2020 | +returned set.</p> |
2021 | +<p>If must_have_email is True, only people with one or more email |
2022 | +addresses are returned.</p> |
2023 | +<p>While we don't have Full Text Indexes in the emailaddress table, we'll |
2024 | +be trying to match the text only against the beginning of an email |
2025 | +address.</p> |
2026 | +<p>If created_before or created_after are not None, they are used to |
2027 | +restrict the search to the dates provided.</p> |
2028 | + |
2029 | +</wadl:doc> |
2030 | + <wadl:request> |
2031 | + |
2032 | + <wadl:param style="query" name="ws.op" required="true" fixed="findPerson"> |
2033 | + <wadl:doc>The name of the operation being invoked.</wadl:doc> |
2034 | + </wadl:param> |
2035 | + <wadl:param style="query" name="created_before" required="false" type="xsd:dateTime"> |
2036 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2037 | +Created before |
2038 | +</wadl:doc> |
2039 | + |
2040 | + </wadl:param> |
2041 | + <wadl:param style="query" name="text" required="true"> |
2042 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2043 | +Search text |
2044 | +</wadl:doc> |
2045 | + |
2046 | + </wadl:param> |
2047 | + <wadl:param style="query" name="created_after" required="false" type="xsd:dateTime"> |
2048 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2049 | +Created after |
2050 | +</wadl:doc> |
2051 | + |
2052 | + </wadl:param> |
2053 | + |
2054 | + </wadl:request> |
2055 | + <wadl:response> |
2056 | + |
2057 | + <wadl:representation href="https://api.launchpad.test/1.0/#person-page"/> |
2058 | + </wadl:response> |
2059 | + </wadl:method> |
2060 | + <wadl:method id="people-find" name="GET"> |
2061 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2062 | +<p>Return all non-merged Persons and Teams whose name, displayname or |
2063 | +email address match <text>.</p> |
2064 | +<p>The results will be ordered using the default ordering specified in |
2065 | +Person._defaultOrder.</p> |
2066 | +<p>While we don't have Full Text Indexes in the emailaddress table, we'll |
2067 | +be trying to match the text only against the beginning of an email |
2068 | +address.</p> |
2069 | |
2070 | </wadl:doc> |
2071 | <wadl:request> |
2072 | |
2073 | - <wadl:param style="query" name="ws.op" |
2074 | - required="true" fixed="findTeam"> |
2075 | + <wadl:param style="query" name="ws.op" required="true" fixed="find"> |
2076 | <wadl:doc>The name of the operation being invoked.</wadl:doc> |
2077 | </wadl:param> |
2078 | - <wadl:param style="query" required="true" |
2079 | - name="text"> |
2080 | + <wadl:param style="query" name="text" required="true"> |
2081 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2082 | Search text |
2083 | </wadl:doc> |
2084 | @@ -1198,8 +1398,7 @@ Search text |
2085 | </wadl:request> |
2086 | <wadl:response> |
2087 | |
2088 | - <wadl:representation |
2089 | - href="https://api.launchpad.net/1.0/#person-page"/> |
2090 | + <wadl:representation href="https://api.launchpad.test/1.0/#person-page"/> |
2091 | </wadl:response> |
2092 | </wadl:method> |
2093 | <wadl:method id="people-newTeam" name="POST"> |
2094 | @@ -1207,14 +1406,19 @@ Search text |
2095 | Create and return a new Team with given arguments. |
2096 | </wadl:doc> |
2097 | <wadl:request> |
2098 | - <wadl:representation |
2099 | - mediaType="application/x-www-form-urlencoded"> |
2100 | - <wadl:param style="query" name="ws.op" |
2101 | - required="true" fixed="newTeam"> |
2102 | + <wadl:representation mediaType="application/x-www-form-urlencoded"> |
2103 | + <wadl:param style="query" name="ws.op" required="true" fixed="newTeam"> |
2104 | <wadl:doc>The name of the operation being invoked.</wadl:doc> |
2105 | </wadl:param> |
2106 | - <wadl:param style="query" required="true" |
2107 | - name="display_name"> |
2108 | + <wadl:param style="query" name="name" required="true"> |
2109 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2110 | +<p>Name</p> |
2111 | +<p>A short unique name, beginning with a lower-case letter or number, and containing only letters, numbers, dots, hyphens, or plus signs.</p> |
2112 | + |
2113 | +</wadl:doc> |
2114 | + |
2115 | + </wadl:param> |
2116 | + <wadl:param style="query" name="display_name" required="true"> |
2117 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2118 | <p>Display Name</p> |
2119 | <p>Your name as you would like it displayed throughout Launchpad. Most people use their full name here.</p> |
2120 | @@ -1222,17 +1426,15 @@ Create and return a new Team with given arguments. |
2121 | </wadl:doc> |
2122 | |
2123 | </wadl:param> |
2124 | - <wadl:param style="query" required="true" |
2125 | - name="name"> |
2126 | + <wadl:param style="query" name="team_description" required="false"> |
2127 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2128 | -<p>Name</p> |
2129 | -<p>A short unique name, beginning with a lower-case letter or number, and containing only letters, numbers, dots, hyphens, or plus signs.</p> |
2130 | +<p>Team Description</p> |
2131 | +<p>Obsolete. Use description.</p> |
2132 | |
2133 | </wadl:doc> |
2134 | |
2135 | </wadl:param> |
2136 | - <wadl:param style="query" required="false" |
2137 | - name="default_membership_period"> |
2138 | + <wadl:param style="query" name="default_membership_period" required="false"> |
2139 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2140 | <p>Subscription period</p> |
2141 | <p>Number of days a new subscription lasts before expiring. You can customize the length of an individual subscription when approving it. Leave this empty or set to 0 for subscriptions to never expire.</p> |
2142 | @@ -1240,28 +1442,29 @@ Create and return a new Team with given arguments. |
2143 | </wadl:doc> |
2144 | |
2145 | </wadl:param> |
2146 | - <wadl:param style="query" required="false" |
2147 | - name="team_description"> |
2148 | + <wadl:param style="query" name="default_renewal_period" required="false"> |
2149 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2150 | -<p>Team Description</p> |
2151 | -<p>Details about the team's work, highlights, goals, and how to contribute. Use plain text, paragraphs are preserved and URLs are linked in pages.</p> |
2152 | +<p>Self renewal period</p> |
2153 | +<p>Number of days members can renew their own membership. The number can be from 1 to 3650 (10 years).</p> |
2154 | |
2155 | </wadl:doc> |
2156 | |
2157 | </wadl:param> |
2158 | - <wadl:param style="query" required="false" |
2159 | - name="default_renewal_period"> |
2160 | + <wadl:param style="query" name="subscription_policy" required="false"> |
2161 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2162 | -<p>Renewal period</p> |
2163 | -<p>Number of days a subscription lasts after being renewed. The number can be from 1 to 3650 (10 years). You can customize the lengths of individual renewals, but this is what's used for auto-renewed and user-renewed memberships.</p> |
2164 | +<p>Membership policy</p> |
2165 | +<p>Obsolete: use membership_policy</p> |
2166 | |
2167 | </wadl:doc> |
2168 | |
2169 | + <wadl:option value="Open Team"/> |
2170 | + <wadl:option value="Delegated Team"/> |
2171 | + <wadl:option value="Moderated Team"/> |
2172 | + <wadl:option value="Restricted Team"/> |
2173 | </wadl:param> |
2174 | - <wadl:param style="query" required="false" |
2175 | - name="subscription_policy"> |
2176 | + <wadl:param style="query" name="membership_policy" required="false"> |
2177 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2178 | -Subscription policy |
2179 | +Membership policy |
2180 | </wadl:doc> |
2181 | |
2182 | <wadl:option value="Open Team"/> |
2183 | @@ -1273,7 +1476,7 @@ Subscription policy |
2184 | </wadl:request> |
2185 | <wadl:response> |
2186 | <wadl:param name="Location" style="header"> |
2187 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#team"/> |
2188 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#team"/> |
2189 | </wadl:param> |
2190 | |
2191 | </wadl:response> |
2192 | @@ -1282,17 +1485,14 @@ Subscription policy |
2193 | |
2194 | |
2195 | |
2196 | - <wadl:resource_type id="processor_families"> |
2197 | + <wadl:resource_type id="polls"> |
2198 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2199 | -Operations related to ProcessorFamily instances. |
2200 | +The set of Poll objects. |
2201 | </wadl:doc> |
2202 | - <wadl:method name="GET" id="processor_families-get"> |
2203 | + <wadl:method name="GET" id="polls-get"> |
2204 | <wadl:response> |
2205 | - <wadl:representation |
2206 | - href="https://api.launchpad.net/1.0/#processor_family-page"/> |
2207 | - <wadl:representation |
2208 | - mediaType="application/vnd.sun.wadl+xml" |
2209 | - id="processor_families-wadl"/> |
2210 | + <wadl:representation href="https://api.launchpad.test/1.0/#poll-page"/> |
2211 | + <wadl:representation mediaType="application/vnd.sun.wadl+xml" id="polls-wadl"/> |
2212 | </wadl:response> |
2213 | </wadl:method> |
2214 | |
2215 | @@ -1306,11 +1506,8 @@ Operations related to Processor instances. |
2216 | </wadl:doc> |
2217 | <wadl:method name="GET" id="processors-get"> |
2218 | <wadl:response> |
2219 | - <wadl:representation |
2220 | - href="https://api.launchpad.net/1.0/#processor-page"/> |
2221 | - <wadl:representation |
2222 | - mediaType="application/vnd.sun.wadl+xml" |
2223 | - id="processors-wadl"/> |
2224 | + <wadl:representation href="https://api.launchpad.test/1.0/#processor-page"/> |
2225 | + <wadl:representation mediaType="application/vnd.sun.wadl+xml" id="processors-wadl"/> |
2226 | </wadl:response> |
2227 | </wadl:method> |
2228 | |
2229 | @@ -1322,141 +1519,83 @@ Operations related to Processor instances. |
2230 | |
2231 | <wadl:method name="GET" id="projects-get"> |
2232 | <wadl:response> |
2233 | - <wadl:representation |
2234 | - href="https://api.launchpad.net/1.0/#project-page"/> |
2235 | - <wadl:representation |
2236 | - mediaType="application/vnd.sun.wadl+xml" |
2237 | - id="projects-wadl"/> |
2238 | + <wadl:representation href="https://api.launchpad.test/1.0/#project-page"/> |
2239 | + <wadl:representation mediaType="application/vnd.sun.wadl+xml" id="projects-wadl"/> |
2240 | </wadl:response> |
2241 | </wadl:method> |
2242 | |
2243 | - <wadl:method id="projects-search" name="GET"> |
2244 | - <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2245 | -<p>Search through the Registry database for products that match the |
2246 | -query terms. text is a piece of text in the title / summary / |
2247 | -description fields of product.</p> |
2248 | -<p>This call eager loads data appropriate for web API; caution may be |
2249 | -needed for other callers.</p> |
2250 | - |
2251 | -</wadl:doc> |
2252 | - <wadl:request> |
2253 | - |
2254 | - <wadl:param style="query" name="ws.op" |
2255 | - required="true" fixed="search"> |
2256 | - <wadl:doc>The name of the operation being invoked.</wadl:doc> |
2257 | - </wadl:param> |
2258 | - <wadl:param style="query" required="false" |
2259 | - name="text"> |
2260 | - <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2261 | -Search text |
2262 | -</wadl:doc> |
2263 | - |
2264 | - </wadl:param> |
2265 | - |
2266 | - </wadl:request> |
2267 | - <wadl:response> |
2268 | - |
2269 | - <wadl:representation |
2270 | - href="https://api.launchpad.net/1.0/#project-page"/> |
2271 | - </wadl:response> |
2272 | - </wadl:method> |
2273 | <wadl:method id="projects-licensing_search" name="GET"> |
2274 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2275 | Return an iterator over products that need to be reviewed. |
2276 | </wadl:doc> |
2277 | <wadl:request> |
2278 | |
2279 | - <wadl:param style="query" name="ws.op" |
2280 | - required="true" |
2281 | - fixed="licensing_search"> |
2282 | + <wadl:param style="query" name="ws.op" required="true" fixed="licensing_search"> |
2283 | <wadl:doc>The name of the operation being invoked.</wadl:doc> |
2284 | </wadl:param> |
2285 | - <wadl:param style="query" required="false" |
2286 | - type="xsd:date" |
2287 | - name="subscription_modified_after"> |
2288 | + <wadl:param style="query" name="active" required="false"> |
2289 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2290 | -Subscription modified after |
2291 | +Is the project active |
2292 | </wadl:doc> |
2293 | |
2294 | </wadl:param> |
2295 | - <wadl:param style="query" required="false" |
2296 | - name="license_info_is_empty"> |
2297 | + <wadl:param style="query" name="subscription_expires_before" required="false" type="xsd:date"> |
2298 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2299 | -License info is empty |
2300 | +Subscription expired before |
2301 | </wadl:doc> |
2302 | |
2303 | </wadl:param> |
2304 | - <wadl:param style="query" required="false" |
2305 | - name="search_text"> |
2306 | + <wadl:param style="query" name="has_subscription" required="false"> |
2307 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2308 | -Search text |
2309 | +Has a commercial subscription |
2310 | </wadl:doc> |
2311 | |
2312 | </wadl:param> |
2313 | - <wadl:param style="query" required="false" |
2314 | - name="project_reviewed"> |
2315 | + <wadl:param style="query" name="project_reviewed" required="false"> |
2316 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2317 | -Is the project license reviewed |
2318 | +Is the project licence reviewed |
2319 | </wadl:doc> |
2320 | |
2321 | </wadl:param> |
2322 | - <wadl:param style="query" required="false" |
2323 | - type="xsd:date" |
2324 | - name="subscription_expires_after"> |
2325 | + <wadl:param style="query" name="created_after" required="false" type="xsd:date"> |
2326 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2327 | -Subscription expires after |
2328 | +Created after date |
2329 | </wadl:doc> |
2330 | |
2331 | </wadl:param> |
2332 | - <wadl:param style="query" required="false" |
2333 | - name="active"> |
2334 | + <wadl:param style="query" name="subscription_modified_after" required="false" type="xsd:date"> |
2335 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2336 | -Is the project active |
2337 | +Subscription modified after |
2338 | </wadl:doc> |
2339 | |
2340 | </wadl:param> |
2341 | - <wadl:param style="query" required="false" |
2342 | - type="xsd:date" |
2343 | - name="subscription_modified_before"> |
2344 | + <wadl:param style="query" name="created_before" required="false" type="xsd:date"> |
2345 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2346 | -Subscription modified before |
2347 | +Created before date |
2348 | </wadl:doc> |
2349 | |
2350 | </wadl:param> |
2351 | - <wadl:param style="query" required="false" |
2352 | - type="xsd:date" name="created_after"> |
2353 | + <wadl:param style="query" name="subscription_modified_before" required="false" type="xsd:date"> |
2354 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2355 | -Created after date |
2356 | +Subscription modified before |
2357 | </wadl:doc> |
2358 | |
2359 | </wadl:param> |
2360 | - <wadl:param style="query" required="false" |
2361 | - name="licenses"> |
2362 | + <wadl:param style="query" name="licenses" required="false"> |
2363 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2364 | Licenses |
2365 | </wadl:doc> |
2366 | |
2367 | </wadl:param> |
2368 | - <wadl:param style="query" required="false" |
2369 | - type="xsd:date" |
2370 | - name="subscription_expires_before"> |
2371 | - <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2372 | -Subscription expired before |
2373 | -</wadl:doc> |
2374 | - |
2375 | - </wadl:param> |
2376 | - <wadl:param style="query" required="false" |
2377 | - type="xsd:date" |
2378 | - name="created_before"> |
2379 | + <wadl:param style="query" name="search_text" required="false"> |
2380 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2381 | -Created before date |
2382 | +Search text |
2383 | </wadl:doc> |
2384 | |
2385 | </wadl:param> |
2386 | - <wadl:param style="query" required="false" |
2387 | - name="has_zero_licenses"> |
2388 | + <wadl:param style="query" name="subscription_expires_after" required="false" type="xsd:date"> |
2389 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2390 | -Has zero licenses |
2391 | +Subscription expires after |
2392 | </wadl:doc> |
2393 | |
2394 | </wadl:param> |
2395 | @@ -1464,13 +1603,13 @@ Has zero licenses |
2396 | </wadl:request> |
2397 | <wadl:response> |
2398 | |
2399 | - <wadl:representation |
2400 | - href="https://api.launchpad.net/1.0/#project-page"/> |
2401 | + <wadl:representation href="https://api.launchpad.test/1.0/#project-page"/> |
2402 | </wadl:response> |
2403 | </wadl:method> |
2404 | <wadl:method id="projects-latest" name="GET"> |
2405 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2406 | <p>Return the latest projects registered in Launchpad.</p> |
2407 | +<p>The supplied user determines which objects are visible.</p> |
2408 | <p>If the quantity is not specified or is a value that is not 'None' |
2409 | then the set of projects returned is limited to that value (the |
2410 | default quantity is 5). If quantity is 'None' then all projects are |
2411 | @@ -1480,78 +1619,72 @@ quantity, so all projects are returned, latest first.</p> |
2412 | </wadl:doc> |
2413 | <wadl:request> |
2414 | |
2415 | - <wadl:param style="query" name="ws.op" |
2416 | - required="true" fixed="latest"> |
2417 | + <wadl:param style="query" name="ws.op" required="true" fixed="latest"> |
2418 | <wadl:doc>The name of the operation being invoked.</wadl:doc> |
2419 | </wadl:param> |
2420 | |
2421 | </wadl:request> |
2422 | <wadl:response> |
2423 | |
2424 | - <wadl:representation |
2425 | - href="https://api.launchpad.net/1.0/#project-page"/> |
2426 | + <wadl:representation href="https://api.launchpad.test/1.0/#project-page"/> |
2427 | </wadl:response> |
2428 | </wadl:method> |
2429 | - <wadl:method id="projects-new_project" name="POST"> |
2430 | + <wadl:method id="projects-search" name="GET"> |
2431 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2432 | -<p>Create and return a brand new Product.</p> |
2433 | -<p>See IProduct for a description of the parameters.</p> |
2434 | +<p>Search through the Registry database for products that match the |
2435 | +query terms. text is a piece of text in the title / summary / |
2436 | +description fields of product.</p> |
2437 | +<p>This call eager loads data appropriate for web API; caution may be |
2438 | +needed for other callers.</p> |
2439 | |
2440 | </wadl:doc> |
2441 | <wadl:request> |
2442 | - <wadl:representation |
2443 | - mediaType="application/x-www-form-urlencoded"> |
2444 | - <wadl:param style="query" name="ws.op" |
2445 | - required="true" fixed="new_project"> |
2446 | + |
2447 | + <wadl:param style="query" name="ws.op" required="true" fixed="search"> |
2448 | <wadl:doc>The name of the operation being invoked.</wadl:doc> |
2449 | </wadl:param> |
2450 | - <wadl:param style="query" required="false" |
2451 | - name="wiki_url"> |
2452 | + <wadl:param style="query" name="text" required="false"> |
2453 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2454 | -<p>Wiki URL</p> |
2455 | -<dl class="rst-docutils"> |
2456 | -<dt>The full URL of this project's wiki, if it has</dt> |
2457 | -<dd>one. Please include the <a class="rst-reference external" href="http://" target="_top">http://</a></dd> |
2458 | -</dl> |
2459 | - |
2460 | +Search text |
2461 | </wadl:doc> |
2462 | |
2463 | </wadl:param> |
2464 | - <wadl:param style="query" required="false" |
2465 | - name="download_url"> |
2466 | - <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2467 | -<p>Download URL</p> |
2468 | -<dl class="rst-docutils"> |
2469 | -<dt>The full URL where downloads for this project</dt> |
2470 | -<dd>are located, if available. Please include the <a class="rst-reference external" href="http://" target="_top">http://</a></dd> |
2471 | -</dl> |
2472 | - |
2473 | -</wadl:doc> |
2474 | - |
2475 | + |
2476 | + </wadl:request> |
2477 | + <wadl:response> |
2478 | + |
2479 | + <wadl:representation href="https://api.launchpad.test/1.0/#project-page"/> |
2480 | + </wadl:response> |
2481 | + </wadl:method> |
2482 | + <wadl:method id="projects-new_project" name="POST"> |
2483 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2484 | +<p>Create and return a brand new Product.</p> |
2485 | +<p>See IProduct for a description of the parameters.</p> |
2486 | + |
2487 | +</wadl:doc> |
2488 | + <wadl:request> |
2489 | + <wadl:representation mediaType="application/x-www-form-urlencoded"> |
2490 | + <wadl:param style="query" name="ws.op" required="true" fixed="new_project"> |
2491 | + <wadl:doc>The name of the operation being invoked.</wadl:doc> |
2492 | </wadl:param> |
2493 | - <wadl:param style="query" required="true" |
2494 | - name="display_name"> |
2495 | + <wadl:param style="query" name="name" required="true"> |
2496 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2497 | -<p>Display Name</p> |
2498 | -<dl class="rst-docutils"> |
2499 | -<dt>The name of the project as it would appear in a</dt> |
2500 | -<dd>paragraph.</dd> |
2501 | -</dl> |
2502 | +<p>Name</p> |
2503 | +<p>At least one lowercase letter or number, followed by letters, numbers, dots, hyphens or pluses. Keep this name short; it is used in URLs as shown above.</p> |
2504 | |
2505 | </wadl:doc> |
2506 | |
2507 | </wadl:param> |
2508 | - <wadl:param style="query" required="false" |
2509 | - name="description"> |
2510 | + <wadl:param style="query" name="display_name" required="true"> |
2511 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2512 | -<p>Description</p> |
2513 | -<p>Details about the project's work, highlights, goals, and how to contribute. Use plain text, paragraphs are preserved and URLs are linked in pages. Don't repeat the Summary.</p> |
2514 | +<p>Display Name</p> |
2515 | +<p>The name of the project as it would appear in a |
2516 | +paragraph.</p> |
2517 | |
2518 | </wadl:doc> |
2519 | |
2520 | </wadl:param> |
2521 | - <wadl:param style="query" required="true" |
2522 | - name="title"> |
2523 | + <wadl:param style="query" name="title" required="true"> |
2524 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2525 | <p>Title</p> |
2526 | <p>The project title. Should be just a few words.</p> |
2527 | @@ -1559,132 +1692,144 @@ quantity, so all projects are returned, latest first.</p> |
2528 | </wadl:doc> |
2529 | |
2530 | </wadl:param> |
2531 | - <wadl:param style="query" required="false" |
2532 | - name="project_reviewed"> |
2533 | + <wadl:param style="query" name="summary" required="true"> |
2534 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2535 | -<p>Project reviewed</p> |
2536 | -<p>Whether or not this project has been reviewed. If you looked at the project and how it uses Launchpad, you reviewed it.</p> |
2537 | +<p>Summary</p> |
2538 | +<p>A short paragraph to introduce the project's work.</p> |
2539 | |
2540 | </wadl:doc> |
2541 | |
2542 | </wadl:param> |
2543 | - <wadl:param style="query" required="true" |
2544 | - name="summary"> |
2545 | + <wadl:param style="query" name="description" required="false"> |
2546 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2547 | -<p>Summary</p> |
2548 | -<p>A short paragraph to introduce the project's work.</p> |
2549 | +<p>Description</p> |
2550 | +<p>Details about the project's work, highlights, goals, and how to contribute. Use plain text, paragraphs are preserved and URLs are linked in pages. Don't repeat the Summary.</p> |
2551 | |
2552 | </wadl:doc> |
2553 | |
2554 | </wadl:param> |
2555 | - <wadl:param style="query" required="false" |
2556 | - name="project_group"> |
2557 | + <wadl:param style="query" name="project_group" required="false"> |
2558 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2559 | <p>Part of</p> |
2560 | <p>Project group. This is an overarching initiative that includes several related projects. For example, the Mozilla Project produces Firefox, Thunderbird and Gecko. This information is used to group those projects in a coherent way. If you make this project part of a group, the group preferences and decisions around bug tracking, translation and security policy will apply to this project.</p> |
2561 | |
2562 | </wadl:doc> |
2563 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#project_group"/> |
2564 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#project_group"/> |
2565 | </wadl:param> |
2566 | - <wadl:param style="query" required="false" |
2567 | - name="licenses"> |
2568 | + <wadl:param style="query" name="home_page_url" required="false"> |
2569 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2570 | -Licenses |
2571 | +<p>Homepage URL</p> |
2572 | +<p>The project home page. Please include |
2573 | +the <a class="rst-reference external" href="http://" target="_top">http://</a></p> |
2574 | + |
2575 | +</wadl:doc> |
2576 | + |
2577 | + </wadl:param> |
2578 | + <wadl:param style="query" name="screenshots_url" required="false"> |
2579 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2580 | +<p>Screenshots URL</p> |
2581 | +<p>The full URL for screenshots of this project, |
2582 | +if available. Please include the <a class="rst-reference external" href="http://" target="_top">http://</a></p> |
2583 | + |
2584 | +</wadl:doc> |
2585 | + |
2586 | + </wadl:param> |
2587 | + <wadl:param style="query" name="download_url" required="false"> |
2588 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2589 | +<p>Download URL</p> |
2590 | +<p>The full URL where downloads for this project |
2591 | +are located, if available. Please include the <a class="rst-reference external" href="http://" target="_top">http://</a></p> |
2592 | + |
2593 | </wadl:doc> |
2594 | |
2595 | </wadl:param> |
2596 | - <wadl:param style="query" required="false" |
2597 | - name="freshmeat_project"> |
2598 | + <wadl:param style="query" name="freshmeat_project" required="false"> |
2599 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2600 | <p>Freshmeat Project</p> |
2601 | -<dl class="rst-docutils"> |
2602 | -<dt>The Freshmeat project name for</dt> |
2603 | -<dd>this project, if it is in freshmeat.</dd> |
2604 | -</dl> |
2605 | +<p>The Freshmeat project name for |
2606 | +this project, if it is in freshmeat. [DEPRECATED]</p> |
2607 | + |
2608 | +</wadl:doc> |
2609 | + |
2610 | + </wadl:param> |
2611 | + <wadl:param style="query" name="wiki_url" required="false"> |
2612 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2613 | +<p>Wiki URL</p> |
2614 | +<p>The full URL of this project's wiki, if it has |
2615 | +one. Please include the <a class="rst-reference external" href="http://" target="_top">http://</a></p> |
2616 | |
2617 | </wadl:doc> |
2618 | |
2619 | </wadl:param> |
2620 | - <wadl:param style="query" required="false" |
2621 | - name="sourceforge_project"> |
2622 | + <wadl:param style="query" name="sourceforge_project" required="false"> |
2623 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2624 | <p>Sourceforge Project</p> |
2625 | -<dl class="rst-docutils"> |
2626 | -<dt>The SourceForge project name for</dt> |
2627 | -<dd>this project, if it is in sourceforge.</dd> |
2628 | -</dl> |
2629 | +<p>The SourceForge project name for |
2630 | +this project, if it is in sourceforge.</p> |
2631 | |
2632 | </wadl:doc> |
2633 | |
2634 | </wadl:param> |
2635 | - <wadl:param style="query" required="false" |
2636 | - name="programming_lang"> |
2637 | + <wadl:param style="query" name="programming_lang" required="false"> |
2638 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2639 | <p>Programming Languages</p> |
2640 | -<dl class="rst-docutils"> |
2641 | -<dt>A comma delimited list of programming</dt> |
2642 | -<dd>languages used for this project.</dd> |
2643 | -</dl> |
2644 | +<p>A comma delimited list of programming |
2645 | +languages used for this project.</p> |
2646 | |
2647 | </wadl:doc> |
2648 | |
2649 | </wadl:param> |
2650 | - <wadl:param style="query" required="false" |
2651 | - name="screenshots_url"> |
2652 | + <wadl:param style="query" name="project_reviewed" required="false"> |
2653 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2654 | -<p>Screenshots URL</p> |
2655 | -<dl class="rst-docutils"> |
2656 | -<dt>The full URL for screenshots of this project,</dt> |
2657 | -<dd>if available. Please include the <a class="rst-reference external" href="http://" target="_top">http://</a></dd> |
2658 | -</dl> |
2659 | +<p>Project reviewed</p> |
2660 | +<p>Whether or not this project has been reviewed. If you looked at the project and how it uses Launchpad, you reviewed it.</p> |
2661 | |
2662 | </wadl:doc> |
2663 | |
2664 | </wadl:param> |
2665 | - <wadl:param style="query" required="false" |
2666 | - name="license_info"> |
2667 | + <wadl:param style="query" name="licenses" required="false"> |
2668 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2669 | -<p>Description of additional licenses</p> |
2670 | -<p>Description of licenses that do not appear in the list above.</p> |
2671 | - |
2672 | +Licences |
2673 | </wadl:doc> |
2674 | |
2675 | </wadl:param> |
2676 | - <wadl:param style="query" required="false" |
2677 | - name="home_page_url"> |
2678 | + <wadl:param style="query" name="license_info" required="false"> |
2679 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2680 | -<p>Homepage URL</p> |
2681 | -<dl class="rst-docutils"> |
2682 | -<dt>The project home page. Please include</dt> |
2683 | -<dd>the <a class="rst-reference external" href="http://" target="_top">http://</a></dd> |
2684 | -</dl> |
2685 | +<p>Description of additional licences</p> |
2686 | +<p>Description of licences that do not appear in the list above.</p> |
2687 | |
2688 | </wadl:doc> |
2689 | |
2690 | </wadl:param> |
2691 | - <wadl:param style="query" required="false" |
2692 | - name="registrant"> |
2693 | + <wadl:param style="query" name="registrant" required="false"> |
2694 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2695 | <p>Registrant</p> |
2696 | <p>This person registered the project in Launchpad.</p> |
2697 | |
2698 | </wadl:doc> |
2699 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#person"/> |
2700 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#person"/> |
2701 | </wadl:param> |
2702 | - <wadl:param style="query" required="true" |
2703 | - name="name"> |
2704 | + <wadl:param style="query" name="bug_supervisor" required="false"> |
2705 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2706 | -<p>Name</p> |
2707 | -<p>At least one lowercase letter or number, followed by letters, numbers, dots, hyphens or pluses. Keep this name short; it is used in URLs as shown above.</p> |
2708 | +<p>Bug Supervisor</p> |
2709 | +<p>The Launchpad id of the person or team (preferred) responsible for bug management.</p> |
2710 | |
2711 | </wadl:doc> |
2712 | - |
2713 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#person"/> |
2714 | + </wadl:param> |
2715 | + <wadl:param style="query" name="driver" required="false"> |
2716 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2717 | +<p>Driver</p> |
2718 | +<p>This person or team will be able to set feature goals for and approve bug targeting or backporting for ANY major series in this project. You might want to leave this blank and just appoint a team for each specific series, rather than having one project team that does it all.</p> |
2719 | + |
2720 | +</wadl:doc> |
2721 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#person"/> |
2722 | </wadl:param> |
2723 | </wadl:representation> |
2724 | </wadl:request> |
2725 | <wadl:response> |
2726 | <wadl:param name="Location" style="header"> |
2727 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#project"/> |
2728 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#project"/> |
2729 | </wadl:param> |
2730 | |
2731 | </wadl:response> |
2732 | @@ -1699,11 +1844,8 @@ The collection of projects. |
2733 | </wadl:doc> |
2734 | <wadl:method name="GET" id="project_groups-get"> |
2735 | <wadl:response> |
2736 | - <wadl:representation |
2737 | - href="https://api.launchpad.net/1.0/#project_group-page"/> |
2738 | - <wadl:representation |
2739 | - mediaType="application/vnd.sun.wadl+xml" |
2740 | - id="project_groups-wadl"/> |
2741 | + <wadl:representation href="https://api.launchpad.test/1.0/#project_group-page"/> |
2742 | + <wadl:representation mediaType="application/vnd.sun.wadl+xml" id="project_groups-wadl"/> |
2743 | </wadl:response> |
2744 | </wadl:method> |
2745 | |
2746 | @@ -1718,12 +1860,10 @@ applications. |
2747 | </wadl:doc> |
2748 | <wadl:request> |
2749 | |
2750 | - <wadl:param style="query" name="ws.op" |
2751 | - required="true" fixed="search"> |
2752 | + <wadl:param style="query" name="ws.op" required="true" fixed="search"> |
2753 | <wadl:doc>The name of the operation being invoked.</wadl:doc> |
2754 | </wadl:param> |
2755 | - <wadl:param style="query" required="false" |
2756 | - name="text"> |
2757 | + <wadl:param style="query" name="text" required="false"> |
2758 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2759 | Search text |
2760 | </wadl:doc> |
2761 | @@ -1733,8 +1873,7 @@ Search text |
2762 | </wadl:request> |
2763 | <wadl:response> |
2764 | |
2765 | - <wadl:representation |
2766 | - href="https://api.launchpad.net/1.0/#project_group-page"/> |
2767 | + <wadl:representation href="https://api.launchpad.test/1.0/#project_group-page"/> |
2768 | </wadl:response> |
2769 | </wadl:method> |
2770 | </wadl:resource_type> |
2771 | @@ -1747,11 +1886,68 @@ A utility that contain all the questions published in Launchpad. |
2772 | </wadl:doc> |
2773 | <wadl:method name="GET" id="questions-get"> |
2774 | <wadl:response> |
2775 | - <wadl:representation |
2776 | - href="https://api.launchpad.net/1.0/#question-page"/> |
2777 | - <wadl:representation |
2778 | - mediaType="application/vnd.sun.wadl+xml" |
2779 | - id="questions-wadl"/> |
2780 | + <wadl:representation href="https://api.launchpad.test/1.0/#question-page"/> |
2781 | + <wadl:representation mediaType="application/vnd.sun.wadl+xml" id="questions-wadl"/> |
2782 | + </wadl:response> |
2783 | + </wadl:method> |
2784 | + |
2785 | + </wadl:resource_type> |
2786 | + |
2787 | + |
2788 | + |
2789 | + <wadl:resource_type id="snap_bases"> |
2790 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2791 | +Interface representing the set of bases for snaps. |
2792 | +</wadl:doc> |
2793 | + <wadl:method name="GET" id="snap_bases-get"> |
2794 | + <wadl:response> |
2795 | + <wadl:representation href="https://api.launchpad.test/1.0/#snap_base-page"/> |
2796 | + <wadl:representation mediaType="application/vnd.sun.wadl+xml" id="snap_bases-wadl"/> |
2797 | + </wadl:response> |
2798 | + </wadl:method> |
2799 | + |
2800 | + </wadl:resource_type> |
2801 | + |
2802 | + |
2803 | + |
2804 | + <wadl:resource_type id="snaps"> |
2805 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2806 | +A utility to create and access snap packages. |
2807 | +</wadl:doc> |
2808 | + <wadl:method name="GET" id="snaps-get"> |
2809 | + <wadl:response> |
2810 | + <wadl:representation href="https://api.launchpad.test/1.0/#snap-page"/> |
2811 | + <wadl:representation mediaType="application/vnd.sun.wadl+xml" id="snaps-wadl"/> |
2812 | + </wadl:response> |
2813 | + </wadl:method> |
2814 | + |
2815 | + </wadl:resource_type> |
2816 | + |
2817 | + |
2818 | + |
2819 | + <wadl:resource_type id="snappy_serieses"> |
2820 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2821 | +Interface representing the set of snappy series. |
2822 | +</wadl:doc> |
2823 | + <wadl:method name="GET" id="snappy_serieses-get"> |
2824 | + <wadl:response> |
2825 | + <wadl:representation href="https://api.launchpad.test/1.0/#snappy_series-page"/> |
2826 | + <wadl:representation mediaType="application/vnd.sun.wadl+xml" id="snappy_serieses-wadl"/> |
2827 | + </wadl:response> |
2828 | + </wadl:method> |
2829 | + |
2830 | + </wadl:resource_type> |
2831 | + |
2832 | + |
2833 | + |
2834 | + <wadl:resource_type id="specifications"> |
2835 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2836 | +A container for specifications. |
2837 | +</wadl:doc> |
2838 | + <wadl:method name="GET" id="specifications-get"> |
2839 | + <wadl:response> |
2840 | + <wadl:representation href="https://api.launchpad.test/1.0/#specification-page"/> |
2841 | + <wadl:representation mediaType="application/vnd.sun.wadl+xml" id="specifications-wadl"/> |
2842 | </wadl:response> |
2843 | </wadl:method> |
2844 | |
2845 | @@ -1765,11 +1961,8 @@ A tool to create temporary blobs. |
2846 | </wadl:doc> |
2847 | <wadl:method name="GET" id="temporary_blobs-get"> |
2848 | <wadl:response> |
2849 | - <wadl:representation |
2850 | - href="https://api.launchpad.net/1.0/#temporary_blob-page"/> |
2851 | - <wadl:representation |
2852 | - mediaType="application/vnd.sun.wadl+xml" |
2853 | - id="temporary_blobs-wadl"/> |
2854 | + <wadl:representation href="https://api.launchpad.test/1.0/#temporary_blob-page"/> |
2855 | + <wadl:representation mediaType="application/vnd.sun.wadl+xml" id="temporary_blobs-wadl"/> |
2856 | </wadl:response> |
2857 | </wadl:method> |
2858 | |
2859 | @@ -1779,12 +1972,10 @@ Retrieve a TemporaryBlobStorage by uuid. |
2860 | </wadl:doc> |
2861 | <wadl:request> |
2862 | |
2863 | - <wadl:param style="query" name="ws.op" |
2864 | - required="true" fixed="fetch"> |
2865 | + <wadl:param style="query" name="ws.op" required="true" fixed="fetch"> |
2866 | <wadl:doc>The name of the operation being invoked.</wadl:doc> |
2867 | </wadl:param> |
2868 | - <wadl:param style="query" required="true" |
2869 | - name="token"> |
2870 | + <wadl:param style="query" name="token" required="true"> |
2871 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2872 | UUID |
2873 | </wadl:doc> |
2874 | @@ -1804,11 +1995,8 @@ A container for translation groups. |
2875 | </wadl:doc> |
2876 | <wadl:method name="GET" id="translation_groups-get"> |
2877 | <wadl:response> |
2878 | - <wadl:representation |
2879 | - href="https://api.launchpad.net/1.0/#translation_group-page"/> |
2880 | - <wadl:representation |
2881 | - mediaType="application/vnd.sun.wadl+xml" |
2882 | - id="translation_groups-wadl"/> |
2883 | + <wadl:representation href="https://api.launchpad.test/1.0/#translation_group-page"/> |
2884 | + <wadl:representation mediaType="application/vnd.sun.wadl+xml" id="translation_groups-wadl"/> |
2885 | </wadl:response> |
2886 | </wadl:method> |
2887 | |
2888 | @@ -1820,19 +2008,45 @@ A container for translation groups. |
2889 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2890 | A set of files to be imported into Rosetta. |
2891 | </wadl:doc> |
2892 | - <wadl:method name="GET" |
2893 | - id="translation_import_queue_entries-get"> |
2894 | + <wadl:method name="GET" id="translation_import_queue_entries-get"> |
2895 | <wadl:response> |
2896 | - <wadl:representation |
2897 | - href="https://api.launchpad.net/1.0/#translation_import_queue_entry-page"/> |
2898 | - <wadl:representation |
2899 | - mediaType="application/vnd.sun.wadl+xml" |
2900 | - id="translation_import_queue_entries-wadl"/> |
2901 | + <wadl:representation href="https://api.launchpad.test/1.0/#translation_import_queue_entry-page"/> |
2902 | + <wadl:representation mediaType="application/vnd.sun.wadl+xml" id="translation_import_queue_entries-wadl"/> |
2903 | </wadl:response> |
2904 | </wadl:method> |
2905 | |
2906 | - <wadl:method id="translation_import_queue_entries-getAllEntries" |
2907 | - name="GET"> |
2908 | + <wadl:method id="translation_import_queue_entries-getFirstEntryToImport" name="GET"> |
2909 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2910 | +<p>Return the first entry of the queue ready to be imported.</p> |
2911 | +<table class="rst-docutils field-list" frame="void" rules="none"> |
2912 | +<col class="field-name" /> |
2913 | +<col class="field-body" /> |
2914 | +<tbody valign="top"> |
2915 | +<tr class="rst-field"><th class="rst-field-name">param target:</th><td class="rst-field-body">IPerson, IProduct, IProductSeries, IDistribution, |
2916 | +IDistroSeries or ISourcePackage the import entries are attached to |
2917 | +or None to get all entries available.</td> |
2918 | +</tr> |
2919 | +</tbody> |
2920 | +</table> |
2921 | + |
2922 | +</wadl:doc> |
2923 | + <wadl:request> |
2924 | + |
2925 | + <wadl:param style="query" name="ws.op" required="true" fixed="getFirstEntryToImport"> |
2926 | + <wadl:doc>The name of the operation being invoked.</wadl:doc> |
2927 | + </wadl:param> |
2928 | + <wadl:param style="query" name="target" required="false"> |
2929 | + |
2930 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#object_with_translation_imports"/> |
2931 | + </wadl:param> |
2932 | + |
2933 | + </wadl:request> |
2934 | + <wadl:response> |
2935 | + |
2936 | + <wadl:representation href="https://api.launchpad.test/1.0/#translation_import_queue_entry-full"/> |
2937 | + </wadl:response> |
2938 | + </wadl:method> |
2939 | + <wadl:method id="translation_import_queue_entries-getAllEntries" name="GET"> |
2940 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2941 | <p>Return all entries this import queue has.</p> |
2942 | <table class="rst-docutils field-list" frame="void" rules="none"> |
2943 | @@ -1844,10 +2058,10 @@ IDistroSeries or ISourcePackage the import entries are attached to |
2944 | or None to get all entries available.</td> |
2945 | </tr> |
2946 | <tr class="rst-field"><th class="rst-field-name" colspan="2">arg import_status:</th></tr> |
2947 | -<tr><td> </td><td class="rst-field-body">RosettaImportStatus entry.</td> |
2948 | +<tr class="rst-field"><td> </td><td class="rst-field-body">RosettaImportStatus entry.</td> |
2949 | </tr> |
2950 | <tr class="rst-field"><th class="rst-field-name" colspan="2">arg file_extensions:</th></tr> |
2951 | -<tr><td> </td><td class="rst-field-body">Sequence of filename suffixes to match, usually |
2952 | +<tr class="rst-field"><td> </td><td class="rst-field-body">Sequence of filename suffixes to match, usually |
2953 | 'po' or 'pot'.</td> |
2954 | </tr> |
2955 | </tbody> |
2956 | @@ -1858,13 +2072,10 @@ entries are filtered based on those values.</p> |
2957 | </wadl:doc> |
2958 | <wadl:request> |
2959 | |
2960 | - <wadl:param style="query" name="ws.op" |
2961 | - required="true" |
2962 | - fixed="getAllEntries"> |
2963 | + <wadl:param style="query" name="ws.op" required="true" fixed="getAllEntries"> |
2964 | <wadl:doc>The name of the operation being invoked.</wadl:doc> |
2965 | </wadl:param> |
2966 | - <wadl:param style="query" required="false" |
2967 | - name="import_status"> |
2968 | + <wadl:param style="query" name="import_status" required="false"> |
2969 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2970 | The status of the import. |
2971 | </wadl:doc> |
2972 | @@ -1881,12 +2092,10 @@ The status of the import. |
2973 | </wadl:request> |
2974 | <wadl:response> |
2975 | |
2976 | - <wadl:representation |
2977 | - href="https://api.launchpad.net/1.0/#translation_import_queue_entry-page"/> |
2978 | + <wadl:representation href="https://api.launchpad.test/1.0/#translation_import_queue_entry-page"/> |
2979 | </wadl:response> |
2980 | </wadl:method> |
2981 | - <wadl:method id="translation_import_queue_entries-getRequestTargets" |
2982 | - name="GET"> |
2983 | + <wadl:method id="translation_import_queue_entries-getRequestTargets" name="GET"> |
2984 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
2985 | <p>List Product`s and `DistroSeries with pending imports.</p> |
2986 | <table class="rst-docutils field-list" frame="void" rules="none"> |
2987 | @@ -1902,13 +2111,10 @@ The status of the import. |
2988 | </wadl:doc> |
2989 | <wadl:request> |
2990 | |
2991 | - <wadl:param style="query" name="ws.op" |
2992 | - required="true" |
2993 | - fixed="getRequestTargets"> |
2994 | + <wadl:param style="query" name="ws.op" required="true" fixed="getRequestTargets"> |
2995 | <wadl:doc>The name of the operation being invoked.</wadl:doc> |
2996 | </wadl:param> |
2997 | - <wadl:param style="query" required="false" |
2998 | - name="status"> |
2999 | + <wadl:param style="query" name="status" required="false"> |
3000 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
3001 | The status of the import. |
3002 | </wadl:doc> |
3003 | @@ -1925,44 +2131,7 @@ The status of the import. |
3004 | </wadl:request> |
3005 | <wadl:response> |
3006 | |
3007 | - <wadl:representation |
3008 | - href="https://api.launchpad.net/1.0/#object_with_translation_imports-page"/> |
3009 | - </wadl:response> |
3010 | - </wadl:method> |
3011 | - <wadl:method id="translation_import_queue_entries-getFirstEntryToImport" |
3012 | - name="GET"> |
3013 | - <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
3014 | -<p>Return the first entry of the queue ready to be imported.</p> |
3015 | -<table class="rst-docutils field-list" frame="void" rules="none"> |
3016 | -<col class="field-name" /> |
3017 | -<col class="field-body" /> |
3018 | -<tbody valign="top"> |
3019 | -<tr class="rst-field"><th class="rst-field-name">param target:</th><td class="rst-field-body">IPerson, IProduct, IProductSeries, IDistribution, |
3020 | -IDistroSeries or ISourcePackage the import entries are attached to |
3021 | -or None to get all entries available.</td> |
3022 | -</tr> |
3023 | -</tbody> |
3024 | -</table> |
3025 | - |
3026 | -</wadl:doc> |
3027 | - <wadl:request> |
3028 | - |
3029 | - <wadl:param style="query" name="ws.op" |
3030 | - required="true" |
3031 | - fixed="getFirstEntryToImport"> |
3032 | - <wadl:doc>The name of the operation being invoked.</wadl:doc> |
3033 | - </wadl:param> |
3034 | - <wadl:param style="query" required="false" |
3035 | - name="target"> |
3036 | - |
3037 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#object_with_translation_imports"/> |
3038 | - </wadl:param> |
3039 | - |
3040 | - </wadl:request> |
3041 | - <wadl:response> |
3042 | - |
3043 | - <wadl:representation |
3044 | - href="https://api.launchpad.net/1.0/#translation_import_queue_entry-full"/> |
3045 | + <wadl:representation href="https://api.launchpad.test/1.0/#object_with_translation_imports-page"/> |
3046 | </wadl:response> |
3047 | </wadl:method> |
3048 | </wadl:resource_type> |
3049 | @@ -1973,35 +2142,27 @@ or None to get all entries available.</td> |
3050 | <!--Begin representation and resource_type definitions for entry |
3051 | resources and the collections that contain them. --> |
3052 | |
3053 | - <wadl:resource_type id="archive_dependency"> |
3054 | + <wadl:resource_type id="access_token"> |
3055 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
3056 | -ArchiveDependency interface. |
3057 | +A personal access token for the webservice API. |
3058 | </wadl:doc> |
3059 | - <wadl:method name="GET" id="archive_dependency-get"> |
3060 | + <wadl:method name="GET" id="access_token-get"> |
3061 | <wadl:response> |
3062 | - <wadl:representation |
3063 | - href="https://api.launchpad.net/1.0/#archive_dependency-full"/> |
3064 | - <wadl:representation |
3065 | - mediaType="application/xhtml+xml" |
3066 | - id="archive_dependency-xhtml"/> |
3067 | - <wadl:representation |
3068 | - mediaType="application/vnd.sun.wadl+xml" |
3069 | - id="archive_dependency-wadl"/> |
3070 | + <wadl:representation href="https://api.launchpad.test/1.0/#access_token-full"/> |
3071 | + <wadl:representation mediaType="application/xhtml+xml" id="access_token-xhtml"/> |
3072 | + <wadl:representation mediaType="application/vnd.sun.wadl+xml" id="access_token-wadl"/> |
3073 | </wadl:response> |
3074 | </wadl:method> |
3075 | |
3076 | - <wadl:method name="PUT" id="archive_dependency-put"> |
3077 | + <wadl:method name="PUT" id="access_token-put"> |
3078 | <wadl:request> |
3079 | - <wadl:representation |
3080 | - href="https://api.launchpad.net/1.0/#archive_dependency-full"/> |
3081 | + <wadl:representation href="https://api.launchpad.test/1.0/#access_token-full"/> |
3082 | </wadl:request> |
3083 | </wadl:method> |
3084 | |
3085 | - <wadl:method name="PATCH" |
3086 | - id="archive_dependency-patch"> |
3087 | + <wadl:method name="PATCH" id="access_token-patch"> |
3088 | <wadl:request> |
3089 | - <wadl:representation |
3090 | - href="https://api.launchpad.net/1.0/#archive_dependency-diff"/> |
3091 | + <wadl:representation href="https://api.launchpad.test/1.0/#access_token-diff"/> |
3092 | </wadl:request> |
3093 | </wadl:method> |
3094 | |
3095 | @@ -2010,13 +2171,17 @@ ArchiveDependency interface. |
3096 | </wadl:resource_type> |
3097 | |
3098 | |
3099 | - <wadl:representation mediaType="application/json" |
3100 | - id="archive_dependency-full"> |
3101 | + <wadl:representation mediaType="application/json" id="access_token-full"> |
3102 | <wadl:param style="plain" name="self_link" path="$['self_link']"> |
3103 | <wadl:doc>The canonical link to this resource.</wadl:doc> |
3104 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#archive_dependency"/> |
3105 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#access_token"/> |
3106 | + </wadl:param> |
3107 | + <wadl:param style="plain" name="web_link" path="$['web_link']"> |
3108 | + <wadl:doc> |
3109 | + The canonical human-addressable web link to this resource. |
3110 | + </wadl:doc> |
3111 | + <wadl:link/> |
3112 | </wadl:param> |
3113 | - |
3114 | <wadl:param style="plain" name="resource_type_link" path="$['resource_type_link']"> |
3115 | <wadl:doc> |
3116 | The link to the WADL description of this resource. |
3117 | @@ -2028,78 +2193,93 @@ ArchiveDependency interface. |
3118 | The value of the HTTP ETag for this resource. |
3119 | </wadl:doc> |
3120 | </wadl:param> |
3121 | - <wadl:param style="plain" required="true" |
3122 | - path="$['archive_link']" |
3123 | - name="archive_link"> |
3124 | + <wadl:param style="plain" required="true" name="date_created" path="$['date_created']" type="xsd:dateTime"> |
3125 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
3126 | -<p>Target archive</p> |
3127 | -<p>The archive affected by this dependecy.</p> |
3128 | +<p>Creation date</p> |
3129 | +<p>When the token was created.</p> |
3130 | |
3131 | </wadl:doc> |
3132 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#archive"/> |
3133 | + |
3134 | </wadl:param> |
3135 | - <wadl:param style="plain" required="true" |
3136 | - path="$['component_name']" |
3137 | - name="component_name"> |
3138 | + <wadl:param style="plain" required="true" name="date_expires" path="$['date_expires']" type="xsd:dateTime"> |
3139 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
3140 | -Component name |
3141 | +<p>Expiry date</p> |
3142 | +<p>When the token should expire or was revoked.</p> |
3143 | + |
3144 | </wadl:doc> |
3145 | |
3146 | </wadl:param> |
3147 | - <wadl:param style="plain" required="true" |
3148 | - path="$['date_created']" |
3149 | - type="xsd:dateTime" name="date_created"> |
3150 | + <wadl:param style="plain" required="true" name="date_last_used" path="$['date_last_used']" type="xsd:dateTime"> |
3151 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
3152 | -Instant when the dependency was created. |
3153 | +<p>Date last used</p> |
3154 | +<p>When the token was last used.</p> |
3155 | + |
3156 | </wadl:doc> |
3157 | |
3158 | </wadl:param> |
3159 | - <wadl:param style="plain" required="true" |
3160 | - path="$['dependency_link']" |
3161 | - name="dependency_link"> |
3162 | + <wadl:param style="plain" required="true" name="description" path="$['description']"> |
3163 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
3164 | -The archive set as a dependency. |
3165 | +<p>Description</p> |
3166 | +<p>A short description of the token.</p> |
3167 | + |
3168 | </wadl:doc> |
3169 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#archive"/> |
3170 | + |
3171 | </wadl:param> |
3172 | - <wadl:param style="plain" required="true" |
3173 | - path="$['pocket']" name="pocket"> |
3174 | + <wadl:param style="plain" required="true" name="owner_link" path="$['owner_link']"> |
3175 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
3176 | |
3177 | +<p>Owner</p> |
3178 | +<p>The person who created the token.</p> |
3179 | + |
3180 | </wadl:doc> |
3181 | - |
3182 | - <wadl:option value="Release"/> |
3183 | - <wadl:option value="Security"/> |
3184 | - <wadl:option value="Updates"/> |
3185 | - <wadl:option value="Proposed"/> |
3186 | - <wadl:option value="Backports"/> |
3187 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#person"/> |
3188 | </wadl:param> |
3189 | - <wadl:param style="plain" required="true" |
3190 | - path="$['title']" name="title"> |
3191 | + <wadl:param style="plain" required="true" name="revoked_by_link" path="$['revoked_by_link']"> |
3192 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
3193 | -Archive dependency title. |
3194 | +<p>Revoked by</p> |
3195 | +<p>The person who revoked the token, if any.</p> |
3196 | + |
3197 | +</wadl:doc> |
3198 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#person"/> |
3199 | + </wadl:param> |
3200 | + <wadl:param style="plain" required="true" name="scopes" path="$['scopes']"> |
3201 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
3202 | +<p>Scopes</p> |
3203 | +<p>A list of scopes granted by the token.</p> |
3204 | + |
3205 | </wadl:doc> |
3206 | |
3207 | </wadl:param> |
3208 | + <wadl:param style="plain" required="true" name="target_link" path="$['target_link']"> |
3209 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
3210 | +<p>Target</p> |
3211 | +<p>The target for which the token was issued.</p> |
3212 | + |
3213 | +</wadl:doc> |
3214 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#access_token_target"/> |
3215 | + </wadl:param> |
3216 | </wadl:representation> |
3217 | |
3218 | - <wadl:representation mediaType="application/json" |
3219 | - id="archive_dependency-diff"> |
3220 | + <wadl:representation mediaType="application/json" id="access_token-diff"> |
3221 | + <wadl:param style="plain" required="false" name="description" path="$['description']"> |
3222 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
3223 | +<p>Description</p> |
3224 | +<p>A short description of the token.</p> |
3225 | + |
3226 | +</wadl:doc> |
3227 | + |
3228 | + </wadl:param> |
3229 | </wadl:representation> |
3230 | |
3231 | <!--Collection page for this type of entry--> |
3232 | - <wadl:resource_type id="archive_dependency-page-resource"> |
3233 | - <wadl:method name="GET" |
3234 | - id="archive_dependency-page-resource-get"> |
3235 | + <wadl:resource_type id="access_token-page-resource"> |
3236 | + <wadl:method name="GET" id="access_token-page-resource-get"> |
3237 | <wadl:response> |
3238 | - <wadl:representation |
3239 | - href="#archive_dependency-page"/> |
3240 | + <wadl:representation href="#access_token-page"/> |
3241 | </wadl:response> |
3242 | </wadl:method> |
3243 | </wadl:resource_type> |
3244 | |
3245 | - <wadl:representation mediaType="application/json" |
3246 | - id="archive_dependency-page"> |
3247 | + <wadl:representation mediaType="application/json" id="access_token-page"> |
3248 | |
3249 | <wadl:param style="plain" name="resource_type_link" path="$['resource_type_link']"> |
3250 | <wadl:link/> |
3251 | @@ -2107,164 +2287,344 @@ Archive dependency title. |
3252 | |
3253 | |
3254 | |
3255 | - <wadl:param style="plain" name="total_size" |
3256 | - path="$['total_size']" required="true"/> |
3257 | + <wadl:param style="plain" name="total_size" path="$['total_size']" required="true"/> |
3258 | |
3259 | |
3260 | |
3261 | <wadl:param style="plain" name="start" path="$['start']" required="true"/> |
3262 | |
3263 | <wadl:param style="plain" name="next_collection_link" path="$['next_collection_link']"> |
3264 | - <wadl:link resource_type="#archive_dependency-page-resource"/> |
3265 | + <wadl:link resource_type="#access_token-page-resource"/> |
3266 | </wadl:param> |
3267 | |
3268 | <wadl:param style="plain" name="prev_collection_link" path="$['prev_collection_link']"> |
3269 | - <wadl:link resource_type="#archive_dependency-page-resource"/> |
3270 | + <wadl:link resource_type="#access_token-page-resource"/> |
3271 | </wadl:param> |
3272 | |
3273 | <wadl:param style="plain" name="entries" path="$['entries']" required="true"/> |
3274 | |
3275 | <wadl:param style="plain" name="entry_links" path="$['entries'][*]['self_link']"> |
3276 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#archive_dependency"/> |
3277 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#access_token"/> |
3278 | </wadl:param> |
3279 | </wadl:representation> |
3280 | |
3281 | |
3282 | |
3283 | - <wadl:resource_type id="archive"> |
3284 | + <wadl:resource_type id="access_token_target"> |
3285 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
3286 | -Main Archive interface. |
3287 | +An object that can be a target for access tokens. |
3288 | </wadl:doc> |
3289 | - <wadl:method name="GET" id="archive-get"> |
3290 | + <wadl:method name="GET" id="access_token_target-get"> |
3291 | <wadl:response> |
3292 | - <wadl:representation |
3293 | - href="https://api.launchpad.net/1.0/#archive-full"/> |
3294 | - <wadl:representation |
3295 | - mediaType="application/xhtml+xml" id="archive-xhtml"/> |
3296 | - <wadl:representation |
3297 | - mediaType="application/vnd.sun.wadl+xml" |
3298 | - id="archive-wadl"/> |
3299 | + <wadl:representation href="https://api.launchpad.test/1.0/#access_token_target-full"/> |
3300 | + <wadl:representation mediaType="application/xhtml+xml" id="access_token_target-xhtml"/> |
3301 | + <wadl:representation mediaType="application/vnd.sun.wadl+xml" id="access_token_target-wadl"/> |
3302 | </wadl:response> |
3303 | </wadl:method> |
3304 | |
3305 | - <wadl:method name="PUT" id="archive-put"> |
3306 | + <wadl:method name="PUT" id="access_token_target-put"> |
3307 | <wadl:request> |
3308 | - <wadl:representation |
3309 | - href="https://api.launchpad.net/1.0/#archive-full"/> |
3310 | + <wadl:representation href="https://api.launchpad.test/1.0/#access_token_target-full"/> |
3311 | </wadl:request> |
3312 | </wadl:method> |
3313 | |
3314 | - <wadl:method name="PATCH" id="archive-patch"> |
3315 | + <wadl:method name="PATCH" id="access_token_target-patch"> |
3316 | <wadl:request> |
3317 | - <wadl:representation |
3318 | - href="https://api.launchpad.net/1.0/#archive-diff"/> |
3319 | + <wadl:representation href="https://api.launchpad.test/1.0/#access_token_target-diff"/> |
3320 | </wadl:request> |
3321 | </wadl:method> |
3322 | |
3323 | |
3324 | |
3325 | - <wadl:method id="archive-isSourceUploadAllowed" |
3326 | - name="GET"> |
3327 | - <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
3328 | -<p>True if the person is allowed to upload the given source package.</p> |
3329 | -<dl class="rst-docutils"> |
3330 | -<dt>Return True if there exists a permission that combines</dt> |
3331 | -<dd><ul class="rst-first rst-last rst-simple"> |
3332 | -<li>this archive</li> |
3333 | -<li>a package set that includes the given source package name</li> |
3334 | -<li>the given person or a team he is a member of</li> |
3335 | -</ul> |
3336 | -</dd> |
3337 | -</dl> |
3338 | -<p>If the source package name is included by <em>any</em> package set with |
3339 | -an explicit permission then only such explicit permissions will |
3340 | -be considered.</p> |
3341 | -<table class="rst-docutils field-list" frame="void" rules="none"> |
3342 | -<col class="field-name" /> |
3343 | -<col class="field-body" /> |
3344 | -<tbody valign="top"> |
3345 | -<tr class="rst-field"><th class="rst-field-name" colspan="2">param sourcepackagename:</th></tr> |
3346 | -<tr><td> </td><td class="rst-field-body">the source package name; can be |
3347 | -either a string or a ISourcePackageName.</td> |
3348 | -</tr> |
3349 | -<tr class="rst-field"><th class="rst-field-name">param person:</th><td class="rst-field-body">An IPerson for whom you want to find out which |
3350 | -package sets he has access to.</td> |
3351 | -</tr> |
3352 | -<tr class="rst-field"><th class="rst-field-name" colspan="2">param distroseries:</th></tr> |
3353 | -<tr><td> </td><td class="rst-field-body">The IDistroSeries for which to check |
3354 | -permissions. If none is supplied then currentseries in |
3355 | -Ubuntu is assumed.</td> |
3356 | -</tr> |
3357 | -<tr class="rst-field"><th class="rst-field-name" colspan="2">raises NoSuchSourcePackageName:</th></tr> |
3358 | -<tr><td> </td><td class="rst-field-body">if a source package with the |
3359 | -given name could not be found.</td> |
3360 | -</tr> |
3361 | -<tr class="rst-field"><th class="rst-field-name">return:</th><td class="rst-field-body">True if the person is allowed to upload the source package.</td> |
3362 | -</tr> |
3363 | -</tbody> |
3364 | -</table> |
3365 | + </wadl:resource_type> |
3366 | |
3367 | -</wadl:doc> |
3368 | + |
3369 | + <wadl:representation mediaType="application/json" id="access_token_target-full"> |
3370 | + <wadl:param style="plain" name="self_link" path="$['self_link']"> |
3371 | + <wadl:doc>The canonical link to this resource.</wadl:doc> |
3372 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#access_token_target"/> |
3373 | + </wadl:param> |
3374 | + <wadl:param style="plain" name="web_link" path="$['web_link']"> |
3375 | + <wadl:doc> |
3376 | + The canonical human-addressable web link to this resource. |
3377 | + </wadl:doc> |
3378 | + <wadl:link/> |
3379 | + </wadl:param> |
3380 | + <wadl:param style="plain" name="resource_type_link" path="$['resource_type_link']"> |
3381 | + <wadl:doc> |
3382 | + The link to the WADL description of this resource. |
3383 | + </wadl:doc> |
3384 | + <wadl:link/> |
3385 | + </wadl:param> |
3386 | + <wadl:param style="plain" name="http_etag" path="$['http_etag']"> |
3387 | + <wadl:doc> |
3388 | + The value of the HTTP ETag for this resource. |
3389 | + </wadl:doc> |
3390 | + </wadl:param> |
3391 | + </wadl:representation> |
3392 | + |
3393 | + <wadl:representation mediaType="application/json" id="access_token_target-diff"> |
3394 | + </wadl:representation> |
3395 | + |
3396 | + <!--Collection page for this type of entry--> |
3397 | + <wadl:resource_type id="access_token_target-page-resource"> |
3398 | + <wadl:method name="GET" id="access_token_target-page-resource-get"> |
3399 | + <wadl:response> |
3400 | + <wadl:representation href="#access_token_target-page"/> |
3401 | + </wadl:response> |
3402 | + </wadl:method> |
3403 | + </wadl:resource_type> |
3404 | + |
3405 | + <wadl:representation mediaType="application/json" id="access_token_target-page"> |
3406 | + |
3407 | + <wadl:param style="plain" name="resource_type_link" path="$['resource_type_link']"> |
3408 | + <wadl:link/> |
3409 | + </wadl:param> |
3410 | + |
3411 | + |
3412 | + |
3413 | + <wadl:param style="plain" name="total_size" path="$['total_size']" required="true"/> |
3414 | + |
3415 | + |
3416 | + |
3417 | + <wadl:param style="plain" name="start" path="$['start']" required="true"/> |
3418 | + |
3419 | + <wadl:param style="plain" name="next_collection_link" path="$['next_collection_link']"> |
3420 | + <wadl:link resource_type="#access_token_target-page-resource"/> |
3421 | + </wadl:param> |
3422 | + |
3423 | + <wadl:param style="plain" name="prev_collection_link" path="$['prev_collection_link']"> |
3424 | + <wadl:link resource_type="#access_token_target-page-resource"/> |
3425 | + </wadl:param> |
3426 | + |
3427 | + <wadl:param style="plain" name="entries" path="$['entries']" required="true"/> |
3428 | + |
3429 | + <wadl:param style="plain" name="entry_links" path="$['entries'][*]['self_link']"> |
3430 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#access_token_target"/> |
3431 | + </wadl:param> |
3432 | + </wadl:representation> |
3433 | + |
3434 | + |
3435 | + |
3436 | + <wadl:resource_type id="archive_dependency"> |
3437 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
3438 | +ArchiveDependency interface. |
3439 | +</wadl:doc> |
3440 | + <wadl:method name="GET" id="archive_dependency-get"> |
3441 | + <wadl:response> |
3442 | + <wadl:representation href="https://api.launchpad.test/1.0/#archive_dependency-full"/> |
3443 | + <wadl:representation mediaType="application/xhtml+xml" id="archive_dependency-xhtml"/> |
3444 | + <wadl:representation mediaType="application/vnd.sun.wadl+xml" id="archive_dependency-wadl"/> |
3445 | + </wadl:response> |
3446 | + </wadl:method> |
3447 | + |
3448 | + <wadl:method name="PUT" id="archive_dependency-put"> |
3449 | <wadl:request> |
3450 | - |
3451 | - <wadl:param style="query" name="ws.op" |
3452 | - required="true" |
3453 | - fixed="isSourceUploadAllowed"/> |
3454 | - <wadl:param style="query" required="true" |
3455 | - name="person"> |
3456 | - |
3457 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#person"/> |
3458 | - </wadl:param> |
3459 | - <wadl:param style="query" required="false" |
3460 | - name="distroseries"> |
3461 | - <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
3462 | -The distro series |
3463 | + <wadl:representation href="https://api.launchpad.test/1.0/#archive_dependency-full"/> |
3464 | + </wadl:request> |
3465 | + </wadl:method> |
3466 | + |
3467 | + <wadl:method name="PATCH" id="archive_dependency-patch"> |
3468 | + <wadl:request> |
3469 | + <wadl:representation href="https://api.launchpad.test/1.0/#archive_dependency-diff"/> |
3470 | + </wadl:request> |
3471 | + </wadl:method> |
3472 | + |
3473 | + |
3474 | + |
3475 | + </wadl:resource_type> |
3476 | + |
3477 | + |
3478 | + <wadl:representation mediaType="application/json" id="archive_dependency-full"> |
3479 | + <wadl:param style="plain" name="self_link" path="$['self_link']"> |
3480 | + <wadl:doc>The canonical link to this resource.</wadl:doc> |
3481 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#archive_dependency"/> |
3482 | + </wadl:param> |
3483 | + |
3484 | + <wadl:param style="plain" name="resource_type_link" path="$['resource_type_link']"> |
3485 | + <wadl:doc> |
3486 | + The link to the WADL description of this resource. |
3487 | + </wadl:doc> |
3488 | + <wadl:link/> |
3489 | + </wadl:param> |
3490 | + <wadl:param style="plain" name="http_etag" path="$['http_etag']"> |
3491 | + <wadl:doc> |
3492 | + The value of the HTTP ETag for this resource. |
3493 | + </wadl:doc> |
3494 | + </wadl:param> |
3495 | + <wadl:param style="plain" required="true" name="archive_link" path="$['archive_link']"> |
3496 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
3497 | +<p>Target archive</p> |
3498 | +<p>The archive that has this dependency.</p> |
3499 | + |
3500 | </wadl:doc> |
3501 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#distro_series"/> |
3502 | - </wadl:param> |
3503 | - <wadl:param style="query" required="true" |
3504 | - name="sourcepackagename"> |
3505 | - <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
3506 | -Source package name |
3507 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#archive"/> |
3508 | + </wadl:param> |
3509 | + <wadl:param style="plain" required="true" name="component_name" path="$['component_name']"> |
3510 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
3511 | +Component name |
3512 | +</wadl:doc> |
3513 | + |
3514 | + </wadl:param> |
3515 | + <wadl:param style="plain" required="true" name="date_created" path="$['date_created']" type="xsd:dateTime"> |
3516 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
3517 | +Instant when the dependency was created. |
3518 | +</wadl:doc> |
3519 | + |
3520 | + </wadl:param> |
3521 | + <wadl:param style="plain" required="true" name="dependency_link" path="$['dependency_link']"> |
3522 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
3523 | +The archive set as a dependency. |
3524 | +</wadl:doc> |
3525 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#archive"/> |
3526 | + </wadl:param> |
3527 | + <wadl:param style="plain" required="true" name="pocket" path="$['pocket']"> |
3528 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
3529 | |
3530 | +</wadl:doc> |
3531 | + |
3532 | + <wadl:option value="Release"/> |
3533 | + <wadl:option value="Security"/> |
3534 | + <wadl:option value="Updates"/> |
3535 | + <wadl:option value="Proposed"/> |
3536 | + <wadl:option value="Backports"/> |
3537 | + </wadl:param> |
3538 | + <wadl:param style="plain" required="true" name="snap_base_link" path="$['snap_base_link']"> |
3539 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
3540 | +<p>Target snap base</p> |
3541 | +<p>The snap base that has this dependency.</p> |
3542 | + |
3543 | +</wadl:doc> |
3544 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#snap_base"/> |
3545 | + </wadl:param> |
3546 | + <wadl:param style="plain" required="true" name="title" path="$['title']"> |
3547 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
3548 | +Archive dependency title. |
3549 | </wadl:doc> |
3550 | - |
3551 | - </wadl:param> |
3552 | - |
3553 | - </wadl:request> |
3554 | |
3555 | + </wadl:param> |
3556 | + </wadl:representation> |
3557 | + |
3558 | + <wadl:representation mediaType="application/json" id="archive_dependency-diff"> |
3559 | + </wadl:representation> |
3560 | + |
3561 | + <!--Collection page for this type of entry--> |
3562 | + <wadl:resource_type id="archive_dependency-page-resource"> |
3563 | + <wadl:method name="GET" id="archive_dependency-page-resource-get"> |
3564 | + <wadl:response> |
3565 | + <wadl:representation href="#archive_dependency-page"/> |
3566 | + </wadl:response> |
3567 | </wadl:method> |
3568 | - <wadl:method id="archive-getBuildCounters" name="GET"> |
3569 | + </wadl:resource_type> |
3570 | + |
3571 | + <wadl:representation mediaType="application/json" id="archive_dependency-page"> |
3572 | + |
3573 | + <wadl:param style="plain" name="resource_type_link" path="$['resource_type_link']"> |
3574 | + <wadl:link/> |
3575 | + </wadl:param> |
3576 | + |
3577 | + |
3578 | + |
3579 | + <wadl:param style="plain" name="total_size" path="$['total_size']" required="true"/> |
3580 | + |
3581 | + |
3582 | + |
3583 | + <wadl:param style="plain" name="start" path="$['start']" required="true"/> |
3584 | + |
3585 | + <wadl:param style="plain" name="next_collection_link" path="$['next_collection_link']"> |
3586 | + <wadl:link resource_type="#archive_dependency-page-resource"/> |
3587 | + </wadl:param> |
3588 | + |
3589 | + <wadl:param style="plain" name="prev_collection_link" path="$['prev_collection_link']"> |
3590 | + <wadl:link resource_type="#archive_dependency-page-resource"/> |
3591 | + </wadl:param> |
3592 | + |
3593 | + <wadl:param style="plain" name="entries" path="$['entries']" required="true"/> |
3594 | + |
3595 | + <wadl:param style="plain" name="entry_links" path="$['entries'][*]['self_link']"> |
3596 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#archive_dependency"/> |
3597 | + </wadl:param> |
3598 | + </wadl:representation> |
3599 | + |
3600 | + |
3601 | + |
3602 | + <wadl:resource_type id="archive"> |
3603 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
3604 | +Main Archive interface. |
3605 | +</wadl:doc> |
3606 | + <wadl:method name="GET" id="archive-get"> |
3607 | + <wadl:response> |
3608 | + <wadl:representation href="https://api.launchpad.test/1.0/#archive-full"/> |
3609 | + <wadl:representation mediaType="application/xhtml+xml" id="archive-xhtml"/> |
3610 | + <wadl:representation mediaType="application/vnd.sun.wadl+xml" id="archive-wadl"/> |
3611 | + </wadl:response> |
3612 | + </wadl:method> |
3613 | + |
3614 | + <wadl:method name="PUT" id="archive-put"> |
3615 | + <wadl:request> |
3616 | + <wadl:representation href="https://api.launchpad.test/1.0/#archive-full"/> |
3617 | + </wadl:request> |
3618 | + </wadl:method> |
3619 | + |
3620 | + <wadl:method name="PATCH" id="archive-patch"> |
3621 | + <wadl:request> |
3622 | + <wadl:representation href="https://api.launchpad.test/1.0/#archive-diff"/> |
3623 | + </wadl:request> |
3624 | + </wadl:method> |
3625 | + |
3626 | + |
3627 | + |
3628 | + <wadl:method id="archive-getPublishedBinaries" name="GET"> |
3629 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
3630 | -<p>Return a dictionary containing the build counters for an archive.</p> |
3631 | -<p>This is necessary currently because the IArchive.failed_builds etc. |
3632 | -counters are not in use.</p> |
3633 | -<p>The returned dictionary contains the follwoing keys and values:</p> |
3634 | -<blockquote> |
3635 | -<ul class="rst-simple"> |
3636 | -<li>'total': total number of builds (includes SUPERSEDED);</li> |
3637 | -<li>'pending': number of builds in BUILDING or NEEDSBUILD state;</li> |
3638 | -<li>'failed': number of builds in FAILEDTOBUILD, MANUALDEPWAIT, |
3639 | -CHROOTWAIT and FAILEDTOUPLOAD state;</li> |
3640 | -<li>'succeeded': number of SUCCESSFULLYBUILT builds.</li> |
3641 | -<li>'superseded': number of SUPERSEDED builds.</li> |
3642 | -</ul> |
3643 | -</blockquote> |
3644 | +<p>All IBinaryPackagePublishingHistory target to this archive.</p> |
3645 | <table class="rst-docutils field-list" frame="void" rules="none"> |
3646 | <col class="field-name" /> |
3647 | <col class="field-body" /> |
3648 | <tbody valign="top"> |
3649 | -<tr class="rst-field"><th class="rst-field-name" colspan="2">param include_needsbuild:</th></tr> |
3650 | -<tr><td> </td><td class="rst-field-body">Indicates whether to include builds with |
3651 | -the status NEEDSBUILD in the pending and total counts. This is |
3652 | -useful in situations where a build that hasn't started isn't |
3653 | -considered a build by the user.</td> |
3654 | +<tr class="rst-field"><th class="rst-field-name">param name:</th><td class="rst-field-body">binary name filter (exact match or SQL LIKE controlled |
3655 | +by 'exact_match' argument).</td> |
3656 | </tr> |
3657 | -<tr class="rst-field"><th class="rst-field-name" colspan="2">type include_needsbuild:</th></tr> |
3658 | -<tr><td> </td><td class="rst-field-body"><tt class="rst-docutils literal"><span class="pre">bool</span></tt></td> |
3659 | +<tr class="rst-field"><th class="rst-field-name">param version:</th><td class="rst-field-body">binary version filter (always exact match).</td> |
3660 | </tr> |
3661 | -<tr class="rst-field"><th class="rst-field-name">return:</th><td class="rst-field-body">a dictionary with the 4 keys specified above.</td> |
3662 | +<tr class="rst-field"><th class="rst-field-name">param status:</th><td class="rst-field-body">PackagePublishingStatus filter, can be a list.</td> |
3663 | +</tr> |
3664 | +<tr class="rst-field"><th class="rst-field-name" colspan="2">param distroarchseries:</th></tr> |
3665 | +<tr class="rst-field"><td> </td><td class="rst-field-body">IDistroArchSeries filter, can be a list.</td> |
3666 | </tr> |
3667 | -<tr class="rst-field"><th class="rst-field-name">rtype:</th><td class="rst-field-body"><tt class="rst-docutils literal"><span class="pre">dict</span></tt>.</td> |
3668 | +<tr class="rst-field"><th class="rst-field-name">param pocket:</th><td class="rst-field-body">PackagePublishingPocket filter.</td> |
3669 | +</tr> |
3670 | +<tr class="rst-field"><th class="rst-field-name" colspan="2">param exact_match:</th></tr> |
3671 | +<tr class="rst-field"><td> </td><td class="rst-field-body">either or not filter source names by exact |
3672 | +matching.</td> |
3673 | +</tr> |
3674 | +<tr class="rst-field"><th class="rst-field-name" colspan="2">param created_since_date:</th></tr> |
3675 | +<tr class="rst-field"><td> </td><td class="rst-field-body">Only return publications created on or |
3676 | +after this date.</td> |
3677 | +</tr> |
3678 | +<tr class="rst-field"><th class="rst-field-name">param ordered:</th><td class="rst-field-body">Normally publications are ordered by binary package |
3679 | +name and then ID order (creation order). If this parameter is |
3680 | +False then the results will be unordered. This will make the |
3681 | +operation much quicker to return results if you don't care about |
3682 | +ordering.</td> |
3683 | +</tr> |
3684 | +<tr class="rst-field"><th class="rst-field-name" colspan="2">param order_by_date:</th></tr> |
3685 | +<tr class="rst-field"><td> </td><td class="rst-field-body">Order publications by descending creation date |
3686 | +and then by descending ID. This is suitable for applications |
3687 | +that need to catch up with publications since their last run.</td> |
3688 | +</tr> |
3689 | +<tr class="rst-field"><th class="rst-field-name" colspan="2">param include_removed:</th></tr> |
3690 | +<tr class="rst-field"><td> </td><td class="rst-field-body">If True, include publications that have been |
3691 | +removed from disk as well as those that have not.</td> |
3692 | +</tr> |
3693 | +<tr class="rst-field"><th class="rst-field-name" colspan="2">param only_unpublished:</th></tr> |
3694 | +<tr class="rst-field"><td> </td><td class="rst-field-body">If True, only include publications that |
3695 | +have never been published to disk.</td> |
3696 | +</tr> |
3697 | +<tr class="rst-field"><th class="rst-field-name" colspan="2">param component_name:</th></tr> |
3698 | +<tr class="rst-field"><td> </td><td class="rst-field-body">component filter. Only return binaries that are |
3699 | +in this component.</td> |
3700 | +</tr> |
3701 | +<tr class="rst-field"><th class="rst-field-name">return:</th><td class="rst-field-body">A collection containing BinaryPackagePublishingHistory.</td> |
3702 | </tr> |
3703 | </tbody> |
3704 | </table> |
3705 | @@ -2272,91 +2632,162 @@ considered a build by the user.</td> |
3706 | </wadl:doc> |
3707 | <wadl:request> |
3708 | |
3709 | - <wadl:param style="query" name="ws.op" |
3710 | - required="true" |
3711 | - fixed="getBuildCounters"/> |
3712 | - <wadl:param style="query" required="false" |
3713 | - name="include_needsbuild"> |
3714 | + <wadl:param style="query" name="ws.op" required="true" fixed="getPublishedBinaries"/> |
3715 | + <wadl:param style="query" name="version" required="false"> |
3716 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
3717 | -Include builds with state NEEDSBUILD |
3718 | +Version |
3719 | </wadl:doc> |
3720 | |
3721 | </wadl:param> |
3722 | - |
3723 | - </wadl:request> |
3724 | - |
3725 | - </wadl:method> |
3726 | - <wadl:method id="archive-getComponentsForQueueAdmin" |
3727 | - name="GET"> |
3728 | - <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
3729 | -<p>Return IArchivePermission for the person's queue admin |
3730 | -components.</p> |
3731 | -<table class="rst-docutils field-list" frame="void" rules="none"> |
3732 | -<col class="field-name" /> |
3733 | -<col class="field-body" /> |
3734 | -<tbody valign="top"> |
3735 | -<tr class="rst-field"><th class="rst-field-name">param person:</th><td class="rst-field-body">An IPerson.</td> |
3736 | -</tr> |
3737 | -<tr class="rst-field"><th class="rst-field-name">return:</th><td class="rst-field-body">A list of IArchivePermission records.</td> |
3738 | -</tr> |
3739 | -</tbody> |
3740 | -</table> |
3741 | + <wadl:param style="query" name="binary_name" required="false"> |
3742 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
3743 | +Binary Package Name |
3744 | +</wadl:doc> |
3745 | + |
3746 | + </wadl:param> |
3747 | + <wadl:param style="query" name="status" required="false"> |
3748 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
3749 | +<p>Package Publishing Status</p> |
3750 | +<p>The status of this publishing record</p> |
3751 | |
3752 | </wadl:doc> |
3753 | - <wadl:request> |
3754 | - |
3755 | - <wadl:param style="query" name="ws.op" |
3756 | - required="true" |
3757 | - fixed="getComponentsForQueueAdmin"/> |
3758 | - <wadl:param style="query" required="true" |
3759 | - name="person"> |
3760 | |
3761 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#person"/> |
3762 | + <wadl:option value="Pending"/> |
3763 | + <wadl:option value="Published"/> |
3764 | + <wadl:option value="Superseded"/> |
3765 | + <wadl:option value="Deleted"/> |
3766 | + <wadl:option value="Obsolete"/> |
3767 | </wadl:param> |
3768 | - |
3769 | - </wadl:request> |
3770 | - <wadl:response> |
3771 | - |
3772 | - <wadl:representation |
3773 | - href="https://api.launchpad.net/1.0/#archive_permission-page"/> |
3774 | - </wadl:response> |
3775 | - </wadl:method> |
3776 | - <wadl:method id="archive-checkUpload" name="GET"> |
3777 | - <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
3778 | -Wrapper around checkUpload for the web service API. |
3779 | + <wadl:param style="query" name="component_name" required="false"> |
3780 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
3781 | +Component name |
3782 | </wadl:doc> |
3783 | - <wadl:request> |
3784 | - |
3785 | - <wadl:param style="query" name="ws.op" |
3786 | - required="true" fixed="checkUpload"/> |
3787 | - <wadl:param style="query" required="true" |
3788 | - name="person"> |
3789 | |
3790 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#person"/> |
3791 | </wadl:param> |
3792 | - <wadl:param style="query" required="true" |
3793 | - name="distroseries"> |
3794 | + <wadl:param style="query" name="distro_arch_series" required="false"> |
3795 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
3796 | -The distro series |
3797 | +Distro Arch Series |
3798 | </wadl:doc> |
3799 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#distro_series"/> |
3800 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#distro_arch_series"/> |
3801 | </wadl:param> |
3802 | - <wadl:param style="query" required="true" |
3803 | - name="component"> |
3804 | + <wadl:param style="query" name="ordered" required="false"> |
3805 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
3806 | -Component |
3807 | +<p>Ordered</p> |
3808 | +<p>Return ordered results by default, but specifying False will return results more quickly.</p> |
3809 | + |
3810 | </wadl:doc> |
3811 | |
3812 | </wadl:param> |
3813 | - <wadl:param style="query" required="false" |
3814 | - name="strict_component"> |
3815 | + <wadl:param style="query" name="pocket" required="false"> |
3816 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
3817 | -Strict component |
3818 | +<p>Pocket</p> |
3819 | +<p>The pocket into which this entry is published</p> |
3820 | + |
3821 | +</wadl:doc> |
3822 | + |
3823 | + <wadl:option value="Release"/> |
3824 | + <wadl:option value="Security"/> |
3825 | + <wadl:option value="Updates"/> |
3826 | + <wadl:option value="Proposed"/> |
3827 | + <wadl:option value="Backports"/> |
3828 | + </wadl:param> |
3829 | + <wadl:param style="query" name="created_since_date" required="false" type="xsd:dateTime"> |
3830 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
3831 | +<p>Created Since Date</p> |
3832 | +<p>Return entries whose date_created is greater than or equal to this date.</p> |
3833 | + |
3834 | +</wadl:doc> |
3835 | + |
3836 | + </wadl:param> |
3837 | + <wadl:param style="query" name="exact_match" required="false"> |
3838 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
3839 | +Whether or not to filter binary names by exact matching. |
3840 | +</wadl:doc> |
3841 | + |
3842 | + </wadl:param> |
3843 | + <wadl:param style="query" name="order_by_date" required="false"> |
3844 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
3845 | +<p>Order by creation date</p> |
3846 | +<p>Return newest results first. This is recommended for applications that need to catch up with publications since their last run.</p> |
3847 | + |
3848 | +</wadl:doc> |
3849 | + |
3850 | + </wadl:param> |
3851 | + |
3852 | + </wadl:request> |
3853 | + <wadl:response> |
3854 | + |
3855 | + <wadl:representation href="https://api.launchpad.test/1.0/#binary_package_publishing_history-page"/> |
3856 | + </wadl:response> |
3857 | + </wadl:method> |
3858 | + <wadl:method id="archive-getBuildRecords" name="GET"> |
3859 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
3860 | +<p>Return build records in the context it is implemented.</p> |
3861 | +<p>It excludes build records generated by Gina (imported from a external |
3862 | +repository), where IBuild.datebuilt is null and IBuild.buildstate |
3863 | +is BuildStatus.FULLYBUILT.</p> |
3864 | +<p>The result is simply not filtered if the optional filters are omitted |
3865 | +by call sites.</p> |
3866 | +<table class="rst-docutils field-list" frame="void" rules="none"> |
3867 | +<col class="field-name" /> |
3868 | +<col class="field-body" /> |
3869 | +<tbody valign="top"> |
3870 | +<tr class="rst-field"><th class="rst-field-name" colspan="2">param build_state:</th></tr> |
3871 | +<tr class="rst-field"><td> </td><td class="rst-field-body">optional BuildStatus value for filtering build |
3872 | +records;</td> |
3873 | +</tr> |
3874 | +<tr class="rst-field"><th class="rst-field-name">param name:</th><td class="rst-field-body">optional string for filtering build source package name. |
3875 | +Sub-string matching is allowed via SQL LIKE.</td> |
3876 | +</tr> |
3877 | +<tr class="rst-field"><th class="rst-field-name">param pocket:</th><td class="rst-field-body">optional PackagePublishingPocket value for filtering |
3878 | +build records;</td> |
3879 | +</tr> |
3880 | +<tr class="rst-field"><th class="rst-field-name">param arch_tag:</th><td class="rst-field-body">optional string for filtering build source packages |
3881 | +by their architecture tag;</td> |
3882 | +</tr> |
3883 | +<tr class="rst-field"><th class="rst-field-name">param user:</th><td class="rst-field-body">optional IPerson corresponding to the user performing |
3884 | +the request. It will filter out build records for which the user |
3885 | +have no 'view' permission.</td> |
3886 | +</tr> |
3887 | +<tr class="rst-field"><th class="rst-field-name" colspan="2">param binary_only:</th></tr> |
3888 | +<tr class="rst-field"><td> </td><td class="rst-field-body">optional boolean indicating whether only |
3889 | +BinaryPackageBuild objects should be returned, or more general |
3890 | +PackageBuild objects (which may include, for example, |
3891 | +SourcePackageRecipeBuild objects.</td> |
3892 | +</tr> |
3893 | +<tr class="rst-field"><th class="rst-field-name">return:</th><td class="rst-field-body">a result set containing IPackageBuild records ordered by |
3894 | +descending IPackageBuild.date_finished except when builds are |
3895 | +filtered by BuildStatus.NEEDSBUILD, in this case records |
3896 | +are ordered by descending BuildQueue.lastscore |
3897 | +(dispatching order).</td> |
3898 | +</tr> |
3899 | +</tbody> |
3900 | +</table> |
3901 | + |
3902 | +</wadl:doc> |
3903 | + <wadl:request> |
3904 | + |
3905 | + <wadl:param style="query" name="ws.op" required="true" fixed="getBuildRecords"/> |
3906 | + <wadl:param style="query" name="build_state" required="false"> |
3907 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
3908 | +<p>Build status</p> |
3909 | +<p>The status of this build record</p> |
3910 | + |
3911 | </wadl:doc> |
3912 | |
3913 | + <wadl:option value="Needs building"/> |
3914 | + <wadl:option value="Successfully built"/> |
3915 | + <wadl:option value="Failed to build"/> |
3916 | + <wadl:option value="Dependency wait"/> |
3917 | + <wadl:option value="Chroot problem"/> |
3918 | + <wadl:option value="Build for superseded Source"/> |
3919 | + <wadl:option value="Currently building"/> |
3920 | + <wadl:option value="Failed to upload"/> |
3921 | + <wadl:option value="Uploading build"/> |
3922 | + <wadl:option value="Cancelling build"/> |
3923 | + <wadl:option value="Cancelled build"/> |
3924 | </wadl:param> |
3925 | - <wadl:param style="query" required="true" |
3926 | - name="pocket"> |
3927 | + <wadl:param style="query" name="pocket" required="false"> |
3928 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
3929 | <p>Pocket</p> |
3930 | <p>The pocket into which this entry is published</p> |
3931 | @@ -2369,8 +2800,7 @@ Strict component |
3932 | <wadl:option value="Proposed"/> |
3933 | <wadl:option value="Backports"/> |
3934 | </wadl:param> |
3935 | - <wadl:param style="query" required="true" |
3936 | - name="sourcepackagename"> |
3937 | + <wadl:param style="query" name="source_name" required="false"> |
3938 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
3939 | Source package name |
3940 | </wadl:doc> |
3941 | @@ -2378,21 +2808,22 @@ Source package name |
3942 | </wadl:param> |
3943 | |
3944 | </wadl:request> |
3945 | - |
3946 | + <wadl:response> |
3947 | + |
3948 | + <wadl:representation href="https://api.launchpad.test/1.0/#build-page"/> |
3949 | + </wadl:response> |
3950 | </wadl:method> |
3951 | - <wadl:method id="archive-getArchiveDependency" |
3952 | - name="GET"> |
3953 | + <wadl:method id="archive-getComponentsForQueueAdmin" name="GET"> |
3954 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
3955 | -<p>Return the IArchiveDependency object for the given dependency.</p> |
3956 | +<p>Return IArchivePermission for the person's queue admin |
3957 | +components.</p> |
3958 | <table class="rst-docutils field-list" frame="void" rules="none"> |
3959 | <col class="field-name" /> |
3960 | <col class="field-body" /> |
3961 | <tbody valign="top"> |
3962 | -<tr class="rst-field"><th class="rst-field-name" colspan="2">param dependency:</th></tr> |
3963 | -<tr><td> </td><td class="rst-field-body">is an IArchive object.</td> |
3964 | +<tr class="rst-field"><th class="rst-field-name">param person:</th><td class="rst-field-body">An IPerson.</td> |
3965 | </tr> |
3966 | -<tr class="rst-field"><th class="rst-field-name">return:</th><td class="rst-field-body">IArchiveDependency or None if a corresponding object |
3967 | -could not be found.</td> |
3968 | +<tr class="rst-field"><th class="rst-field-name">return:</th><td class="rst-field-body">A list of IArchivePermission records.</td> |
3969 | </tr> |
3970 | </tbody> |
3971 | </table> |
3972 | @@ -2400,55 +2831,28 @@ could not be found.</td> |
3973 | </wadl:doc> |
3974 | <wadl:request> |
3975 | |
3976 | - <wadl:param style="query" name="ws.op" |
3977 | - required="true" |
3978 | - fixed="getArchiveDependency"/> |
3979 | - <wadl:param style="query" required="true" |
3980 | - name="dependency"> |
3981 | + <wadl:param style="query" name="ws.op" required="true" fixed="getComponentsForQueueAdmin"/> |
3982 | + <wadl:param style="query" name="person" required="true"> |
3983 | |
3984 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#archive"/> |
3985 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#person"/> |
3986 | </wadl:param> |
3987 | |
3988 | </wadl:request> |
3989 | <wadl:response> |
3990 | |
3991 | - <wadl:representation |
3992 | - href="https://api.launchpad.net/1.0/#archive_dependency-full"/> |
3993 | + <wadl:representation href="https://api.launchpad.test/1.0/#archive_permission-page"/> |
3994 | </wadl:response> |
3995 | </wadl:method> |
3996 | - <wadl:method id="archive-getPublishedSources" |
3997 | - name="GET"> |
3998 | + <wadl:method id="archive-getPermissionsForPerson" name="GET"> |
3999 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
4000 | -<p>All ISourcePackagePublishingHistory target to this archive.</p> |
4001 | +<p>Return the IArchivePermission records applicable to the person.</p> |
4002 | <table class="rst-docutils field-list" frame="void" rules="none"> |
4003 | <col class="field-name" /> |
4004 | <col class="field-body" /> |
4005 | <tbody valign="top"> |
4006 | -<tr class="rst-field"><th class="rst-field-name">param name:</th><td class="rst-field-body">source name filter (exact match or SQL LIKE controlled |
4007 | -by 'exact_match' argument). |
4008 | -Name can be a single string or a list of strings.</td> |
4009 | -</tr> |
4010 | -<tr class="rst-field"><th class="rst-field-name">param version:</th><td class="rst-field-body">source version filter (always exact match).</td> |
4011 | -</tr> |
4012 | -<tr class="rst-field"><th class="rst-field-name">param status:</th><td class="rst-field-body">PackagePublishingStatus filter, can be a sequence.</td> |
4013 | -</tr> |
4014 | -<tr class="rst-field"><th class="rst-field-name" colspan="2">param distroseries:</th></tr> |
4015 | -<tr><td> </td><td class="rst-field-body">IDistroSeries filter.</td> |
4016 | -</tr> |
4017 | -<tr class="rst-field"><th class="rst-field-name">param pocket:</th><td class="rst-field-body">PackagePublishingPocket filter. This may be an |
4018 | -iterable of more than one pocket or a single pocket.</td> |
4019 | -</tr> |
4020 | -<tr class="rst-field"><th class="rst-field-name" colspan="2">param exact_match:</th></tr> |
4021 | -<tr><td> </td><td class="rst-field-body">either or not filter source names by exact |
4022 | -matching.</td> |
4023 | -</tr> |
4024 | -<tr class="rst-field"><th class="rst-field-name" colspan="2">param created_since_date:</th></tr> |
4025 | -<tr><td> </td><td class="rst-field-body">Only return results whose date_created |
4026 | -is greater than or equal to this date.</td> |
4027 | +<tr class="rst-field"><th class="rst-field-name">param person:</th><td class="rst-field-body">An IPerson</td> |
4028 | </tr> |
4029 | -<tr class="rst-field"><th class="rst-field-name">return:</th><td class="rst-field-body">SelectResults containing ISourcePackagePublishingHistory, |
4030 | -ordered by name. If there are multiple results for the same |
4031 | -name then they are sub-ordered newest first.</td> |
4032 | +<tr class="rst-field"><th class="rst-field-name">return:</th><td class="rst-field-body">A list of IArchivePermission records.</td> |
4033 | </tr> |
4034 | </tbody> |
4035 | </table> |
4036 | @@ -2456,48 +2860,63 @@ name then they are sub-ordered newest first.</td> |
4037 | </wadl:doc> |
4038 | <wadl:request> |
4039 | |
4040 | - <wadl:param style="query" name="ws.op" |
4041 | - required="true" |
4042 | - fixed="getPublishedSources"/> |
4043 | - <wadl:param style="query" required="false" |
4044 | - name="status"> |
4045 | + <wadl:param style="query" name="ws.op" required="true" fixed="getPermissionsForPerson"/> |
4046 | + <wadl:param style="query" name="person" required="true"> |
4047 | + |
4048 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#person"/> |
4049 | + </wadl:param> |
4050 | + |
4051 | + </wadl:request> |
4052 | + <wadl:response> |
4053 | + |
4054 | + <wadl:representation href="https://api.launchpad.test/1.0/#archive_permission-page"/> |
4055 | + </wadl:response> |
4056 | + </wadl:method> |
4057 | + <wadl:method id="archive-getPublishedSources" name="GET"> |
4058 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
4059 | +All ISourcePackagePublishingHistory target to this archive. |
4060 | +</wadl:doc> |
4061 | + <wadl:request> |
4062 | + |
4063 | + <wadl:param style="query" name="ws.op" required="true" fixed="getPublishedSources"/> |
4064 | + <wadl:param style="query" name="version" required="false"> |
4065 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
4066 | -<p>Package Publishing Status</p> |
4067 | -<p>The status of this publishing record</p> |
4068 | - |
4069 | +Version |
4070 | </wadl:doc> |
4071 | |
4072 | - <wadl:option value="Pending"/> |
4073 | - <wadl:option value="Published"/> |
4074 | - <wadl:option value="Superseded"/> |
4075 | - <wadl:option value="Deleted"/> |
4076 | - <wadl:option value="Obsolete"/> |
4077 | </wadl:param> |
4078 | - <wadl:param style="query" required="false" |
4079 | - name="source_name"> |
4080 | + <wadl:param style="query" name="source_name" required="false"> |
4081 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
4082 | Source package name |
4083 | </wadl:doc> |
4084 | |
4085 | </wadl:param> |
4086 | - <wadl:param style="query" required="false" |
4087 | - name="distro_series"> |
4088 | + <wadl:param style="query" name="distro_series" required="false"> |
4089 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
4090 | Distroseries name |
4091 | </wadl:doc> |
4092 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#distro_series"/> |
4093 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#distro_series"/> |
4094 | </wadl:param> |
4095 | - <wadl:param style="query" required="false" |
4096 | - name="exact_match"> |
4097 | + <wadl:param style="query" name="status" required="false"> |
4098 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
4099 | -<p>Exact Match</p> |
4100 | -<p>Whether or not to filter source names by exact matching.</p> |
4101 | +<p>Package Publishing Status</p> |
4102 | +<p>The status of this publishing record</p> |
4103 | |
4104 | </wadl:doc> |
4105 | |
4106 | + <wadl:option value="Pending"/> |
4107 | + <wadl:option value="Published"/> |
4108 | + <wadl:option value="Superseded"/> |
4109 | + <wadl:option value="Deleted"/> |
4110 | + <wadl:option value="Obsolete"/> |
4111 | + </wadl:param> |
4112 | + <wadl:param style="query" name="component_name" required="false"> |
4113 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
4114 | +Component name |
4115 | +</wadl:doc> |
4116 | + |
4117 | </wadl:param> |
4118 | - <wadl:param style="query" required="false" |
4119 | - name="pocket"> |
4120 | + <wadl:param style="query" name="pocket" required="false"> |
4121 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
4122 | <p>Pocket</p> |
4123 | <p>The pocket into which this entry is published</p> |
4124 | @@ -2510,16 +2929,7 @@ Distroseries name |
4125 | <wadl:option value="Proposed"/> |
4126 | <wadl:option value="Backports"/> |
4127 | </wadl:param> |
4128 | - <wadl:param style="query" required="false" |
4129 | - name="version"> |
4130 | - <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
4131 | -Version |
4132 | -</wadl:doc> |
4133 | - |
4134 | - </wadl:param> |
4135 | - <wadl:param style="query" required="false" |
4136 | - type="xsd:dateTime" |
4137 | - name="created_since_date"> |
4138 | + <wadl:param style="query" name="created_since_date" required="false" type="xsd:dateTime"> |
4139 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
4140 | <p>Created Since Date</p> |
4141 | <p>Return entries whose date_created is greater than or equal to this date.</p> |
4142 | @@ -2527,53 +2937,19 @@ Version |
4143 | </wadl:doc> |
4144 | |
4145 | </wadl:param> |
4146 | - |
4147 | - </wadl:request> |
4148 | - <wadl:response> |
4149 | - |
4150 | - <wadl:representation |
4151 | - href="https://api.launchpad.net/1.0/#source_package_publishing_history-page"/> |
4152 | - </wadl:response> |
4153 | - </wadl:method> |
4154 | - <wadl:method id="archive-getUploadersForPackageset" |
4155 | - name="GET"> |
4156 | - <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
4157 | -<p>The ArchivePermission records for uploaders to the package set.</p> |
4158 | -<table class="rst-docutils field-list" frame="void" rules="none"> |
4159 | -<col class="field-name" /> |
4160 | -<col class="field-body" /> |
4161 | -<tbody valign="top"> |
4162 | -<tr class="rst-field"><th class="rst-field-name" colspan="2">param packageset:</th></tr> |
4163 | -<tr><td> </td><td class="rst-field-body">An IPackageset.</td> |
4164 | -</tr> |
4165 | -<tr class="rst-field"><th class="rst-field-name" colspan="2">param direct_permissions:</th></tr> |
4166 | -<tr><td> </td><td class="rst-field-body">If True, only consider permissions granted |
4167 | -directly for the package set at hand. Otherwise, include any |
4168 | -uploaders for package sets that include this one.</td> |
4169 | -</tr> |
4170 | -<tr class="rst-field"><th class="rst-field-name">return:</th><td class="rst-field-body">ArchivePermission records for all the uploaders who are |
4171 | -authorized to upload to the named source package set.</td> |
4172 | -</tr> |
4173 | -</tbody> |
4174 | -</table> |
4175 | - |
4176 | -</wadl:doc> |
4177 | - <wadl:request> |
4178 | - |
4179 | - <wadl:param style="query" name="ws.op" |
4180 | - required="true" |
4181 | - fixed="getUploadersForPackageset"/> |
4182 | - <wadl:param style="query" required="true" |
4183 | - name="packageset"> |
4184 | + <wadl:param style="query" name="exact_match" required="false"> |
4185 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
4186 | -Package set |
4187 | +<p>Exact Match</p> |
4188 | +<p>Whether or not to filter source names by exact matching.</p> |
4189 | + |
4190 | </wadl:doc> |
4191 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#packageset"/> |
4192 | + |
4193 | </wadl:param> |
4194 | - <wadl:param style="query" required="false" |
4195 | - name="direct_permissions"> |
4196 | + <wadl:param style="query" name="order_by_date" required="false"> |
4197 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
4198 | -Ignore package set hierarchy |
4199 | +<p>Order by creation date</p> |
4200 | +<p>Return newest results first. This is recommended for applications that need to catch up with publications since their last run. If not specified, results are ordered by source package name (lexicographically), then by descending version and then descending ID.</p> |
4201 | + |
4202 | </wadl:doc> |
4203 | |
4204 | </wadl:param> |
4205 | @@ -2581,37 +2957,46 @@ Ignore package set hierarchy |
4206 | </wadl:request> |
4207 | <wadl:response> |
4208 | |
4209 | - <wadl:representation |
4210 | - href="https://api.launchpad.net/1.0/#archive_permission-page"/> |
4211 | + <wadl:representation href="https://api.launchpad.test/1.0/#source_package_publishing_history-page"/> |
4212 | </wadl:response> |
4213 | </wadl:method> |
4214 | - <wadl:method id="archive-getPackagesetsForSource" |
4215 | - name="GET"> |
4216 | + <wadl:method id="archive-getPackagesetsForSourceUploader" name="GET"> |
4217 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
4218 | -<p>All package set based permissions for the given source.</p> |
4219 | -<p>This method is meant to aid the process of "debugging" package set |
4220 | -based archive permission since It allows the listing of permissions |
4221 | -for the given source package in this archive (irrespective of the |
4222 | -principal).</p> |
4223 | +<p>The package set based permissions for a given source and uploader.</p> |
4224 | +<dl class="rst-docutils"> |
4225 | +<dt>Return the IArchivePermission records that</dt> |
4226 | +<dd><ul class="rst-first rst-last rst-simple"> |
4227 | +<li>apply to this archive</li> |
4228 | +<li><dl class="rst-first rst-docutils"> |
4229 | +<dt>relate to</dt> |
4230 | +<dd><ul class="rst-first rst-last"> |
4231 | +<li>package sets that include the given source package name</li> |
4232 | +<li>the given person</li> |
4233 | +</ul> |
4234 | +</dd> |
4235 | +</dl> |
4236 | +</li> |
4237 | +</ul> |
4238 | +</dd> |
4239 | +</dl> |
4240 | <table class="rst-docutils field-list" frame="void" rules="none"> |
4241 | <col class="field-name" /> |
4242 | <col class="field-body" /> |
4243 | <tbody valign="top"> |
4244 | <tr class="rst-field"><th class="rst-field-name" colspan="2">param sourcepackagename:</th></tr> |
4245 | -<tr><td> </td><td class="rst-field-body">the source package name; can be |
4246 | +<tr class="rst-field"><td> </td><td class="rst-field-body">the source package name; can be |
4247 | either a string or a ISourcePackageName.</td> |
4248 | </tr> |
4249 | -<tr class="rst-field"><th class="rst-field-name" colspan="2">param direct_permissions:</th></tr> |
4250 | -<tr><td> </td><td class="rst-field-body">If set only package sets that directly |
4251 | -include the given source will be considered.</td> |
4252 | +<tr class="rst-field"><th class="rst-field-name">param person:</th><td class="rst-field-body">An IPerson for whom you want to find out which |
4253 | +package sets they have access to.</td> |
4254 | </tr> |
4255 | <tr class="rst-field"><th class="rst-field-name" colspan="2">raises NoSuchSourcePackageName:</th></tr> |
4256 | -<tr><td> </td><td class="rst-field-body">if a source package with the |
4257 | +<tr class="rst-field"><td> </td><td class="rst-field-body">if a source package with the |
4258 | given name could not be found.</td> |
4259 | </tr> |
4260 | <tr class="rst-field"><th class="rst-field-name">return:</th><td class="rst-field-body">ArchivePermission records for the package sets that |
4261 | -include the given source package name and apply to the |
4262 | -archive in question.</td> |
4263 | +include the given source package name and to which the given |
4264 | +person may upload.</td> |
4265 | </tr> |
4266 | </tbody> |
4267 | </table> |
4268 | @@ -2619,71 +3004,36 @@ archive in question.</td> |
4269 | </wadl:doc> |
4270 | <wadl:request> |
4271 | |
4272 | - <wadl:param style="query" name="ws.op" |
4273 | - required="true" |
4274 | - fixed="getPackagesetsForSource"/> |
4275 | - <wadl:param style="query" required="true" |
4276 | - name="sourcepackagename"> |
4277 | + <wadl:param style="query" name="ws.op" required="true" fixed="getPackagesetsForSourceUploader"/> |
4278 | + <wadl:param style="query" name="sourcepackagename" required="true"> |
4279 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
4280 | Source package name |
4281 | </wadl:doc> |
4282 | |
4283 | </wadl:param> |
4284 | - <wadl:param style="query" required="false" |
4285 | - name="direct_permissions"> |
4286 | - <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
4287 | -Ignore package set hierarchy |
4288 | -</wadl:doc> |
4289 | + <wadl:param style="query" name="person" required="true"> |
4290 | |
4291 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#person"/> |
4292 | </wadl:param> |
4293 | |
4294 | </wadl:request> |
4295 | <wadl:response> |
4296 | |
4297 | - <wadl:representation |
4298 | - href="https://api.launchpad.net/1.0/#archive_permission-page"/> |
4299 | + <wadl:representation href="https://api.launchpad.test/1.0/#archive_permission-page"/> |
4300 | </wadl:response> |
4301 | </wadl:method> |
4302 | - <wadl:method id="archive-getBuildRecords" name="GET"> |
4303 | + <wadl:method id="archive-getArchiveDependency" name="GET"> |
4304 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
4305 | -<p>Return build records in the context it is implemented.</p> |
4306 | -<p>It excludes build records generated by Gina (imported from a external |
4307 | -repository), where IBuild.datebuilt is null and IBuild.buildstate |
4308 | -is BuildStatus.FULLYBUILT.</p> |
4309 | -<p>The result is simply not filtered if the optional filters are omitted |
4310 | -by call sites.</p> |
4311 | +<p>Return the IArchiveDependency object for the given dependency.</p> |
4312 | <table class="rst-docutils field-list" frame="void" rules="none"> |
4313 | <col class="field-name" /> |
4314 | <col class="field-body" /> |
4315 | <tbody valign="top"> |
4316 | -<tr class="rst-field"><th class="rst-field-name" colspan="2">param build_state:</th></tr> |
4317 | -<tr><td> </td><td class="rst-field-body">optional BuildStatus value for filtering build |
4318 | -records;</td> |
4319 | -</tr> |
4320 | -<tr class="rst-field"><th class="rst-field-name">param name:</th><td class="rst-field-body">optional string for filtering build source package name. |
4321 | -Sub-string matching is allowed via SQL LIKE.</td> |
4322 | -</tr> |
4323 | -<tr class="rst-field"><th class="rst-field-name">param pocket:</th><td class="rst-field-body">optional PackagePublishingPocket value for filtering |
4324 | -build records;</td> |
4325 | -</tr> |
4326 | -<tr class="rst-field"><th class="rst-field-name">param arch_tag:</th><td class="rst-field-body">optional string for filtering build source packages |
4327 | -by their architecture tag;</td> |
4328 | -</tr> |
4329 | -<tr class="rst-field"><th class="rst-field-name">param user:</th><td class="rst-field-body">optional IPerson corresponding to the user performing |
4330 | -the request. It will filter out build records for which the user |
4331 | -have no 'view' permission.</td> |
4332 | -</tr> |
4333 | -<tr class="rst-field"><th class="rst-field-name" colspan="2">param binary_only:</th></tr> |
4334 | -<tr><td> </td><td class="rst-field-body">optional boolean indicating whether only |
4335 | -BinaryPackageBuild objects should be returned, or more general |
4336 | -PackageBuild objects (which may include, for example, |
4337 | -SourcePackageRecipeBuild objects.</td> |
4338 | +<tr class="rst-field"><th class="rst-field-name" colspan="2">param dependency:</th></tr> |
4339 | +<tr class="rst-field"><td> </td><td class="rst-field-body">is an IArchive object.</td> |
4340 | </tr> |
4341 | -<tr class="rst-field"><th class="rst-field-name">return:</th><td class="rst-field-body">a result set containing IPackageBuild records ordered by |
4342 | -descending IPackageBuild.date_finished except when builds are |
4343 | -filtered by BuildStatus.NEEDSBUILD, in this case records |
4344 | -are ordered by descending BuildQueue.lastscore |
4345 | -(dispatching order).</td> |
4346 | +<tr class="rst-field"><th class="rst-field-name">return:</th><td class="rst-field-body">IArchiveDependency or None if a corresponding object |
4347 | +could not be found.</td> |
4348 | </tr> |
4349 | </tbody> |
4350 | </table> |
4351 | @@ -2691,79 +3041,54 @@ are ordered by descending BuildQueue.lastscore |
4352 | </wadl:doc> |
4353 | <wadl:request> |
4354 | |
4355 | - <wadl:param style="query" name="ws.op" |
4356 | - required="true" |
4357 | - fixed="getBuildRecords"/> |
4358 | - <wadl:param style="query" required="false" |
4359 | - name="pocket"> |
4360 | - <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
4361 | -<p>Pocket</p> |
4362 | -<p>The pocket into which this entry is published</p> |
4363 | - |
4364 | -</wadl:doc> |
4365 | - |
4366 | - <wadl:option value="Release"/> |
4367 | - <wadl:option value="Security"/> |
4368 | - <wadl:option value="Updates"/> |
4369 | - <wadl:option value="Proposed"/> |
4370 | - <wadl:option value="Backports"/> |
4371 | - </wadl:param> |
4372 | - <wadl:param style="query" required="false" |
4373 | - name="build_state"> |
4374 | - <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
4375 | -<p>Build status</p> |
4376 | -<p>The status of this build record</p> |
4377 | - |
4378 | -</wadl:doc> |
4379 | - |
4380 | - <wadl:option value="Needs building"/> |
4381 | - <wadl:option value="Successfully built"/> |
4382 | - <wadl:option value="Failed to build"/> |
4383 | - <wadl:option value="Dependency wait"/> |
4384 | - <wadl:option value="Chroot problem"/> |
4385 | - <wadl:option value="Build for superseded Source"/> |
4386 | - <wadl:option value="Currently building"/> |
4387 | - <wadl:option value="Failed to upload"/> |
4388 | - <wadl:option value="Uploading build"/> |
4389 | - </wadl:param> |
4390 | - <wadl:param style="query" required="false" |
4391 | - name="source_name"> |
4392 | - <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
4393 | -Source package name |
4394 | -</wadl:doc> |
4395 | + <wadl:param style="query" name="ws.op" required="true" fixed="getArchiveDependency"/> |
4396 | + <wadl:param style="query" name="dependency" required="true"> |
4397 | |
4398 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#archive"/> |
4399 | </wadl:param> |
4400 | |
4401 | </wadl:request> |
4402 | <wadl:response> |
4403 | |
4404 | - <wadl:representation |
4405 | - href="https://api.launchpad.net/1.0/#build-page"/> |
4406 | + <wadl:representation href="https://api.launchpad.test/1.0/#archive_dependency-full"/> |
4407 | </wadl:response> |
4408 | </wadl:method> |
4409 | - <wadl:method id="archive-getPublishedBinaries" |
4410 | - name="GET"> |
4411 | + <wadl:method id="archive-isSourceUploadAllowed" name="GET"> |
4412 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
4413 | -<p>All IBinaryPackagePublishingHistory target to this archive.</p> |
4414 | +<p>True if the person is allowed to upload the given source package.</p> |
4415 | +<dl class="rst-docutils"> |
4416 | +<dt>Return True if there exists a permission that combines</dt> |
4417 | +<dd><ul class="rst-first rst-last rst-simple"> |
4418 | +<li>this archive</li> |
4419 | +<li>a package set that includes the given source package name</li> |
4420 | +<li>the given person or a team they are a member of</li> |
4421 | +</ul> |
4422 | +</dd> |
4423 | +</dl> |
4424 | +<p>If the source package name is included by <em>any</em> package set with |
4425 | +an explicit permission then only such explicit permissions will |
4426 | +be considered.</p> |
4427 | <table class="rst-docutils field-list" frame="void" rules="none"> |
4428 | <col class="field-name" /> |
4429 | <col class="field-body" /> |
4430 | <tbody valign="top"> |
4431 | -<tr class="rst-field"><th class="rst-field-name">param:</th><td class="rst-field-body">name: binary name filter (exact match or SQL LIKE controlled |
4432 | -by 'exact_match' argument).</td> |
4433 | -</tr> |
4434 | -<tr class="rst-field"><th class="rst-field-name">param:</th><td class="rst-field-body">version: binary version filter (always exact match).</td> |
4435 | -</tr> |
4436 | -<tr class="rst-field"><th class="rst-field-name">param:</th><td class="rst-field-body">status: PackagePublishingStatus filter, can be a list.</td> |
4437 | +<tr class="rst-field"><th class="rst-field-name" colspan="2">param sourcepackagename:</th></tr> |
4438 | +<tr class="rst-field"><td> </td><td class="rst-field-body">the source package name; can be |
4439 | +either a string or a ISourcePackageName.</td> |
4440 | </tr> |
4441 | -<tr class="rst-field"><th class="rst-field-name">param:</th><td class="rst-field-body">distroarchseries: IDistroArchSeries filter, can be a list.</td> |
4442 | +<tr class="rst-field"><th class="rst-field-name">param person:</th><td class="rst-field-body">An IPerson for whom you want to find out which |
4443 | +package sets they have access to.</td> |
4444 | </tr> |
4445 | -<tr class="rst-field"><th class="rst-field-name">param:</th><td class="rst-field-body">pocket: PackagePublishingPocket filter.</td> |
4446 | +<tr class="rst-field"><th class="rst-field-name" colspan="2">param distroseries:</th></tr> |
4447 | +<tr class="rst-field"><td> </td><td class="rst-field-body">The IDistroSeries for which to check |
4448 | +permissions. If none is supplied then currentseries in |
4449 | +the archive's distribution is assumed.</td> |
4450 | </tr> |
4451 | -<tr class="rst-field"><th class="rst-field-name">param:</th><td class="rst-field-body">exact_match: either or not filter source names by exact |
4452 | -matching.</td> |
4453 | +<tr class="rst-field"><th class="rst-field-name" colspan="2">raises NoSuchSourcePackageName:</th></tr> |
4454 | +<tr class="rst-field"><td> </td><td class="rst-field-body">if a source package with the |
4455 | +given name could not be found.</td> |
4456 | </tr> |
4457 | -<tr class="rst-field"><th class="rst-field-name">return:</th><td class="rst-field-body">A collection containing BinaryPackagePublishingHistory.</td> |
4458 | +<tr class="rst-field"><th class="rst-field-name">return:</th><td class="rst-field-body">True if the person is allowed to upload the source package.</td> |
4459 | </tr> |
4460 | </tbody> |
4461 | </table> |
4462 | @@ -2771,86 +3096,86 @@ matching.</td> |
4463 | </wadl:doc> |
4464 | <wadl:request> |
4465 | |
4466 | - <wadl:param style="query" name="ws.op" |
4467 | - required="true" |
4468 | - fixed="getPublishedBinaries"/> |
4469 | - <wadl:param style="query" required="false" |
4470 | - name="status"> |
4471 | + <wadl:param style="query" name="ws.op" required="true" fixed="isSourceUploadAllowed"/> |
4472 | + <wadl:param style="query" name="distroseries" required="false"> |
4473 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
4474 | -<p>Package Publishing Status</p> |
4475 | -<p>The status of this publishing record</p> |
4476 | - |
4477 | +The distro series |
4478 | </wadl:doc> |
4479 | - |
4480 | - <wadl:option value="Pending"/> |
4481 | - <wadl:option value="Published"/> |
4482 | - <wadl:option value="Superseded"/> |
4483 | - <wadl:option value="Deleted"/> |
4484 | - <wadl:option value="Obsolete"/> |
4485 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#distro_series"/> |
4486 | </wadl:param> |
4487 | - <wadl:param style="query" required="false" |
4488 | - name="binary_name"> |
4489 | - <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
4490 | -Binary Package Name |
4491 | -</wadl:doc> |
4492 | + <wadl:param style="query" name="person" required="true"> |
4493 | |
4494 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#person"/> |
4495 | </wadl:param> |
4496 | - <wadl:param style="query" required="false" |
4497 | - name="exact_match"> |
4498 | + <wadl:param style="query" name="sourcepackagename" required="true"> |
4499 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
4500 | -Whether or not to filter binary names by exact matching. |
4501 | +Source package name |
4502 | </wadl:doc> |
4503 | |
4504 | </wadl:param> |
4505 | - <wadl:param style="query" required="false" |
4506 | - name="pocket"> |
4507 | - <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
4508 | -<p>Pocket</p> |
4509 | -<p>The pocket into which this entry is published</p> |
4510 | + |
4511 | + </wadl:request> |
4512 | + |
4513 | + </wadl:method> |
4514 | + <wadl:method id="archive-getUploadersForComponent" name="GET"> |
4515 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
4516 | +<p>Return IArchivePermission records for the component's uploaders.</p> |
4517 | +<table class="rst-docutils field-list" frame="void" rules="none"> |
4518 | +<col class="field-name" /> |
4519 | +<col class="field-body" /> |
4520 | +<tbody valign="top"> |
4521 | +<tr class="rst-field"><th class="rst-field-name" colspan="2">param component_name:</th></tr> |
4522 | +<tr class="rst-field"><td> </td><td class="rst-field-body">An IComponent or textual name for the |
4523 | +component.</td> |
4524 | +</tr> |
4525 | +<tr class="rst-field"><th class="rst-field-name">return:</th><td class="rst-field-body">A list of IArchivePermission records.</td> |
4526 | +</tr> |
4527 | +</tbody> |
4528 | +</table> |
4529 | |
4530 | </wadl:doc> |
4531 | - |
4532 | - <wadl:option value="Release"/> |
4533 | - <wadl:option value="Security"/> |
4534 | - <wadl:option value="Updates"/> |
4535 | - <wadl:option value="Proposed"/> |
4536 | - <wadl:option value="Backports"/> |
4537 | - </wadl:param> |
4538 | - <wadl:param style="query" required="false" |
4539 | - name="version"> |
4540 | + <wadl:request> |
4541 | + |
4542 | + <wadl:param style="query" name="ws.op" required="true" fixed="getUploadersForComponent"/> |
4543 | + <wadl:param style="query" name="component_name" required="false"> |
4544 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
4545 | -Version |
4546 | +Component Name |
4547 | </wadl:doc> |
4548 | |
4549 | </wadl:param> |
4550 | - <wadl:param style="query" required="false" |
4551 | - name="distro_arch_series"> |
4552 | - <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
4553 | -Distro Arch Series |
4554 | -</wadl:doc> |
4555 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#distro_arch_series"/> |
4556 | - </wadl:param> |
4557 | |
4558 | </wadl:request> |
4559 | <wadl:response> |
4560 | |
4561 | - <wadl:representation |
4562 | - href="https://api.launchpad.net/1.0/#binary_package_publishing_history-page"/> |
4563 | + <wadl:representation href="https://api.launchpad.test/1.0/#archive_permission-page"/> |
4564 | </wadl:response> |
4565 | </wadl:method> |
4566 | - <wadl:method id="archive-getUploadersForComponent" |
4567 | - name="GET"> |
4568 | + <wadl:method id="archive-getPackagesetsForSource" name="GET"> |
4569 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
4570 | -<p>Return IArchivePermission records for the component's uploaders.</p> |
4571 | +<p>All package set based permissions for the given source.</p> |
4572 | +<p>This method is meant to aid the process of "debugging" package set |
4573 | +based archive permission since It allows the listing of permissions |
4574 | +for the given source package in this archive (irrespective of the |
4575 | +principal).</p> |
4576 | <table class="rst-docutils field-list" frame="void" rules="none"> |
4577 | <col class="field-name" /> |
4578 | <col class="field-body" /> |
4579 | <tbody valign="top"> |
4580 | -<tr class="rst-field"><th class="rst-field-name" colspan="2">param component_name:</th></tr> |
4581 | -<tr><td> </td><td class="rst-field-body">An IComponent or textual name for the |
4582 | -component.</td> |
4583 | +<tr class="rst-field"><th class="rst-field-name" colspan="2">param sourcepackagename:</th></tr> |
4584 | +<tr class="rst-field"><td> </td><td class="rst-field-body">the source package name; can be |
4585 | +either a string or a ISourcePackageName.</td> |
4586 | </tr> |
4587 | -<tr class="rst-field"><th class="rst-field-name">return:</th><td class="rst-field-body">A list of IArchivePermission records.</td> |
4588 | +<tr class="rst-field"><th class="rst-field-name" colspan="2">param direct_permissions:</th></tr> |
4589 | +<tr class="rst-field"><td> </td><td class="rst-field-body">If set only package sets that directly |
4590 | +include the given source will be considered.</td> |
4591 | +</tr> |
4592 | +<tr class="rst-field"><th class="rst-field-name" colspan="2">raises NoSuchSourcePackageName:</th></tr> |
4593 | +<tr class="rst-field"><td> </td><td class="rst-field-body">if a source package with the |
4594 | +given name could not be found.</td> |
4595 | +</tr> |
4596 | +<tr class="rst-field"><th class="rst-field-name">return:</th><td class="rst-field-body">ArchivePermission records for the package sets that |
4597 | +include the given source package name and apply to the |
4598 | +archive in question.</td> |
4599 | </tr> |
4600 | </tbody> |
4601 | </table> |
4602 | @@ -2858,13 +3183,16 @@ component.</td> |
4603 | </wadl:doc> |
4604 | <wadl:request> |
4605 | |
4606 | - <wadl:param style="query" name="ws.op" |
4607 | - required="true" |
4608 | - fixed="getUploadersForComponent"/> |
4609 | - <wadl:param style="query" required="false" |
4610 | - name="component_name"> |
4611 | + <wadl:param style="query" name="ws.op" required="true" fixed="getPackagesetsForSource"/> |
4612 | + <wadl:param style="query" name="sourcepackagename" required="true"> |
4613 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
4614 | -Component Name |
4615 | +Source package name |
4616 | +</wadl:doc> |
4617 | + |
4618 | + </wadl:param> |
4619 | + <wadl:param style="query" name="direct_permissions" required="false"> |
4620 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
4621 | +Ignore package set hierarchy |
4622 | </wadl:doc> |
4623 | |
4624 | </wadl:param> |
4625 | @@ -2872,23 +3200,26 @@ Component Name |
4626 | </wadl:request> |
4627 | <wadl:response> |
4628 | |
4629 | - <wadl:representation |
4630 | - href="https://api.launchpad.net/1.0/#archive_permission-page"/> |
4631 | + <wadl:representation href="https://api.launchpad.test/1.0/#archive_permission-page"/> |
4632 | </wadl:response> |
4633 | </wadl:method> |
4634 | - <wadl:method id="archive-getUploadersForPackage" |
4635 | - name="GET"> |
4636 | + <wadl:method id="archive-getUploadersForPackageset" name="GET"> |
4637 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
4638 | -<p>Return IArchivePermission records for the package's uploaders.</p> |
4639 | +<p>The ArchivePermission records for uploaders to the package set.</p> |
4640 | <table class="rst-docutils field-list" frame="void" rules="none"> |
4641 | <col class="field-name" /> |
4642 | <col class="field-body" /> |
4643 | <tbody valign="top"> |
4644 | -<tr class="rst-field"><th class="rst-field-name" colspan="2">param source_package_name:</th></tr> |
4645 | -<tr><td> </td><td class="rst-field-body">An ISourcePackageName or textual name |
4646 | -for the source package.</td> |
4647 | +<tr class="rst-field"><th class="rst-field-name" colspan="2">param packageset:</th></tr> |
4648 | +<tr class="rst-field"><td> </td><td class="rst-field-body">An IPackageset.</td> |
4649 | </tr> |
4650 | -<tr class="rst-field"><th class="rst-field-name">return:</th><td class="rst-field-body">A list of IArchivePermission records.</td> |
4651 | +<tr class="rst-field"><th class="rst-field-name" colspan="2">param direct_permissions:</th></tr> |
4652 | +<tr class="rst-field"><td> </td><td class="rst-field-body">If True, only consider permissions granted |
4653 | +directly for the package set at hand. Otherwise, include any |
4654 | +uploaders for package sets that include this one.</td> |
4655 | +</tr> |
4656 | +<tr class="rst-field"><th class="rst-field-name">return:</th><td class="rst-field-body">ArchivePermission records for all the uploaders who are |
4657 | +authorized to upload to the named source package set.</td> |
4658 | </tr> |
4659 | </tbody> |
4660 | </table> |
4661 | @@ -2896,13 +3227,16 @@ for the source package.</td> |
4662 | </wadl:doc> |
4663 | <wadl:request> |
4664 | |
4665 | - <wadl:param style="query" name="ws.op" |
4666 | - required="true" |
4667 | - fixed="getUploadersForPackage"/> |
4668 | - <wadl:param style="query" required="true" |
4669 | - name="source_package_name"> |
4670 | + <wadl:param style="query" name="ws.op" required="true" fixed="getUploadersForPackageset"/> |
4671 | + <wadl:param style="query" name="packageset" required="true"> |
4672 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
4673 | -Source Package Name |
4674 | +Package set |
4675 | +</wadl:doc> |
4676 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#packageset"/> |
4677 | + </wadl:param> |
4678 | + <wadl:param style="query" name="direct_permissions" required="false"> |
4679 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
4680 | +Ignore package set hierarchy |
4681 | </wadl:doc> |
4682 | |
4683 | </wadl:param> |
4684 | @@ -2910,12 +3244,10 @@ Source Package Name |
4685 | </wadl:request> |
4686 | <wadl:response> |
4687 | |
4688 | - <wadl:representation |
4689 | - href="https://api.launchpad.net/1.0/#archive_permission-page"/> |
4690 | + <wadl:representation href="https://api.launchpad.test/1.0/#archive_permission-page"/> |
4691 | </wadl:response> |
4692 | </wadl:method> |
4693 | - <wadl:method id="archive-getBuildSummariesForSourceIds" |
4694 | - name="GET"> |
4695 | + <wadl:method id="archive-getBuildSummariesForSourceIds" name="GET"> |
4696 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
4697 | <p>Return a dictionary containing a summary of the build statuses.</p> |
4698 | <p>Only information for sources belonging to the current archive will |
4699 | @@ -2927,10 +3259,10 @@ details.</p> |
4700 | <col class="field-body" /> |
4701 | <tbody valign="top"> |
4702 | <tr class="rst-field"><th class="rst-field-name" colspan="2">param source_ids:</th></tr> |
4703 | -<tr><td> </td><td class="rst-field-body">A list of source publishing history record ids.</td> |
4704 | +<tr class="rst-field"><td> </td><td class="rst-field-body">A list of source publishing history record ids.</td> |
4705 | </tr> |
4706 | <tr class="rst-field"><th class="rst-field-name" colspan="2">type source_ids:</th></tr> |
4707 | -<tr><td> </td><td class="rst-field-body"><tt class="rst-docutils literal"><span class="pre">list</span></tt></td> |
4708 | +<tr class="rst-field"><td> </td><td class="rst-field-body"><tt class="rst-docutils literal">list</tt></td> |
4709 | </tr> |
4710 | <tr class="rst-field"><th class="rst-field-name">return:</th><td class="rst-field-body">A dict consisting of the overall status summaries for the |
4711 | given ids that belong in the archive.</td> |
4712 | @@ -2941,11 +3273,8 @@ given ids that belong in the archive.</td> |
4713 | </wadl:doc> |
4714 | <wadl:request> |
4715 | |
4716 | - <wadl:param style="query" name="ws.op" |
4717 | - required="true" |
4718 | - fixed="getBuildSummariesForSourceIds"/> |
4719 | - <wadl:param style="query" required="true" |
4720 | - name="source_ids"> |
4721 | + <wadl:param style="query" name="ws.op" required="true" fixed="getBuildSummariesForSourceIds"/> |
4722 | + <wadl:param style="query" name="source_ids" required="true"> |
4723 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
4724 | A list of source publishing history record ids. |
4725 | </wadl:doc> |
4726 | @@ -2955,19 +3284,18 @@ A list of source publishing history record ids. |
4727 | </wadl:request> |
4728 | |
4729 | </wadl:method> |
4730 | - <wadl:method id="archive-getQueueAdminsForComponent" |
4731 | - name="GET"> |
4732 | + <wadl:method id="archive-getPackagesetsForUploader" name="GET"> |
4733 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
4734 | -<p>Return IArchivePermission records for authorised queue admins.</p> |
4735 | +<p>The ArchivePermission records for the person's package sets.</p> |
4736 | <table class="rst-docutils field-list" frame="void" rules="none"> |
4737 | <col class="field-name" /> |
4738 | <col class="field-body" /> |
4739 | <tbody valign="top"> |
4740 | -<tr class="rst-field"><th class="rst-field-name" colspan="2">param component_name:</th></tr> |
4741 | -<tr><td> </td><td class="rst-field-body">An IComponent or textual name for the |
4742 | -component.</td> |
4743 | +<tr class="rst-field"><th class="rst-field-name">param person:</th><td class="rst-field-body">An IPerson for whom you want to find out which |
4744 | +package sets they have access to.</td> |
4745 | </tr> |
4746 | -<tr class="rst-field"><th class="rst-field-name">return:</th><td class="rst-field-body">A list of IArchivePermission records.</td> |
4747 | +<tr class="rst-field"><th class="rst-field-name">return:</th><td class="rst-field-body">ArchivePermission records for all the package sets that |
4748 | +'person' is allowed to upload to.</td> |
4749 | </tr> |
4750 | </tbody> |
4751 | </table> |
4752 | @@ -2975,33 +3303,28 @@ component.</td> |
4753 | </wadl:doc> |
4754 | <wadl:request> |
4755 | |
4756 | - <wadl:param style="query" name="ws.op" |
4757 | - required="true" |
4758 | - fixed="getQueueAdminsForComponent"/> |
4759 | - <wadl:param style="query" required="true" |
4760 | - name="component_name"> |
4761 | - <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
4762 | -Component Name |
4763 | -</wadl:doc> |
4764 | + <wadl:param style="query" name="ws.op" required="true" fixed="getPackagesetsForUploader"/> |
4765 | + <wadl:param style="query" name="person" required="true"> |
4766 | |
4767 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#person"/> |
4768 | </wadl:param> |
4769 | |
4770 | </wadl:request> |
4771 | <wadl:response> |
4772 | |
4773 | - <wadl:representation |
4774 | - href="https://api.launchpad.net/1.0/#archive_permission-page"/> |
4775 | + <wadl:representation href="https://api.launchpad.test/1.0/#archive_permission-page"/> |
4776 | </wadl:response> |
4777 | </wadl:method> |
4778 | - <wadl:method id="archive-getPermissionsForPerson" |
4779 | - name="GET"> |
4780 | + <wadl:method id="archive-getUploadersForPackage" name="GET"> |
4781 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
4782 | -<p>Return the IArchivePermission records applicable to the person.</p> |
4783 | +<p>Return IArchivePermission records for the package's uploaders.</p> |
4784 | <table class="rst-docutils field-list" frame="void" rules="none"> |
4785 | <col class="field-name" /> |
4786 | <col class="field-body" /> |
4787 | <tbody valign="top"> |
4788 | -<tr class="rst-field"><th class="rst-field-name">param person:</th><td class="rst-field-body">An IPerson</td> |
4789 | +<tr class="rst-field"><th class="rst-field-name" colspan="2">param source_package_name:</th></tr> |
4790 | +<tr class="rst-field"><td> </td><td class="rst-field-body">An ISourcePackageName or textual name |
4791 | +for the source package.</td> |
4792 | </tr> |
4793 | <tr class="rst-field"><th class="rst-field-name">return:</th><td class="rst-field-body">A list of IArchivePermission records.</td> |
4794 | </tr> |
4795 | @@ -3011,104 +3334,104 @@ Component Name |
4796 | </wadl:doc> |
4797 | <wadl:request> |
4798 | |
4799 | - <wadl:param style="query" name="ws.op" |
4800 | - required="true" |
4801 | - fixed="getPermissionsForPerson"/> |
4802 | - <wadl:param style="query" required="true" |
4803 | - name="person"> |
4804 | + <wadl:param style="query" name="ws.op" required="true" fixed="getUploadersForPackage"/> |
4805 | + <wadl:param style="query" name="source_package_name" required="true"> |
4806 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
4807 | +Source Package Name |
4808 | +</wadl:doc> |
4809 | |
4810 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#person"/> |
4811 | </wadl:param> |
4812 | |
4813 | </wadl:request> |
4814 | <wadl:response> |
4815 | |
4816 | - <wadl:representation |
4817 | - href="https://api.launchpad.net/1.0/#archive_permission-page"/> |
4818 | + <wadl:representation href="https://api.launchpad.test/1.0/#archive_permission-page"/> |
4819 | </wadl:response> |
4820 | </wadl:method> |
4821 | - <wadl:method id="archive-getPackagesetsForSourceUploader" |
4822 | - name="GET"> |
4823 | + <wadl:method id="archive-checkUpload" name="GET"> |
4824 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
4825 | -<p>The package set based permissions for a given source and uploader.</p> |
4826 | -<dl class="rst-docutils"> |
4827 | -<dt>Return the IArchivePermission records that</dt> |
4828 | -<dd><ul class="rst-first rst-last"> |
4829 | -<li><p class="rst-first">apply to this archive</p> |
4830 | -</li> |
4831 | -<li><dl class="rst-first rst-docutils"> |
4832 | -<dt>relate to</dt> |
4833 | -<dd><ul class="rst-first rst-last rst-simple"> |
4834 | -<li>package sets that include the given source package name</li> |
4835 | -<li>the given person</li> |
4836 | -</ul> |
4837 | -</dd> |
4838 | -</dl> |
4839 | -</li> |
4840 | -</ul> |
4841 | -</dd> |
4842 | -</dl> |
4843 | -<table class="rst-docutils field-list" frame="void" rules="none"> |
4844 | -<col class="field-name" /> |
4845 | -<col class="field-body" /> |
4846 | -<tbody valign="top"> |
4847 | -<tr class="rst-field"><th class="rst-field-name" colspan="2">param sourcepackagename:</th></tr> |
4848 | -<tr><td> </td><td class="rst-field-body">the source package name; can be |
4849 | -either a string or a ISourcePackageName.</td> |
4850 | -</tr> |
4851 | -<tr class="rst-field"><th class="rst-field-name">param person:</th><td class="rst-field-body">An IPerson for whom you want to find out which |
4852 | -package sets he has access to.</td> |
4853 | -</tr> |
4854 | -<tr class="rst-field"><th class="rst-field-name" colspan="2">raises NoSuchSourcePackageName:</th></tr> |
4855 | -<tr><td> </td><td class="rst-field-body">if a source package with the |
4856 | -given name could not be found.</td> |
4857 | -</tr> |
4858 | -<tr class="rst-field"><th class="rst-field-name">return:</th><td class="rst-field-body">ArchivePermission records for the package sets that |
4859 | -include the given source package name and to which the given |
4860 | -person may upload.</td> |
4861 | -</tr> |
4862 | -</tbody> |
4863 | -</table> |
4864 | - |
4865 | +Wrapper around checkUpload for the web service API. |
4866 | </wadl:doc> |
4867 | <wadl:request> |
4868 | |
4869 | - <wadl:param style="query" name="ws.op" |
4870 | - required="true" |
4871 | - fixed="getPackagesetsForSourceUploader"/> |
4872 | - <wadl:param style="query" required="true" |
4873 | - name="person"> |
4874 | + <wadl:param style="query" name="ws.op" required="true" fixed="checkUpload"/> |
4875 | + <wadl:param style="query" name="distroseries" required="true"> |
4876 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
4877 | +The distro series |
4878 | +</wadl:doc> |
4879 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#distro_series"/> |
4880 | + </wadl:param> |
4881 | + <wadl:param style="query" name="component" required="true"> |
4882 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
4883 | +Component |
4884 | +</wadl:doc> |
4885 | |
4886 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#person"/> |
4887 | </wadl:param> |
4888 | - <wadl:param style="query" required="true" |
4889 | - name="sourcepackagename"> |
4890 | + <wadl:param style="query" name="strict_component" required="false"> |
4891 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
4892 | -Source package name |
4893 | +Strict component |
4894 | </wadl:doc> |
4895 | |
4896 | </wadl:param> |
4897 | - |
4898 | - </wadl:request> |
4899 | - <wadl:response> |
4900 | - |
4901 | - <wadl:representation |
4902 | - href="https://api.launchpad.net/1.0/#archive_permission-page"/> |
4903 | - </wadl:response> |
4904 | + <wadl:param style="query" name="pocket" required="true"> |
4905 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
4906 | +<p>Pocket</p> |
4907 | +<p>The pocket into which this entry is published</p> |
4908 | + |
4909 | +</wadl:doc> |
4910 | + |
4911 | + <wadl:option value="Release"/> |
4912 | + <wadl:option value="Security"/> |
4913 | + <wadl:option value="Updates"/> |
4914 | + <wadl:option value="Proposed"/> |
4915 | + <wadl:option value="Backports"/> |
4916 | + </wadl:param> |
4917 | + <wadl:param style="query" name="sourcepackagename" required="true"> |
4918 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
4919 | +Source package name |
4920 | +</wadl:doc> |
4921 | + |
4922 | + </wadl:param> |
4923 | + <wadl:param style="query" name="person" required="true"> |
4924 | + |
4925 | + <wadl:link resource_type="https://api.launchpad.test/1.0/#person"/> |
4926 | + </wadl:param> |
4927 | + |
4928 | + </wadl:request> |
4929 | + |
4930 | </wadl:method> |
4931 | - <wadl:method id="archive-getPackagesetsForUploader" |
4932 | - name="GET"> |
4933 | + <wadl:method id="archive-getBuildCounters" name="GET"> |
4934 | <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
4935 | -<p>The ArchivePermission records for the person's package sets.</p> |
4936 | +<p>Return a dictionary containing the build counters for an archive.</p> |
4937 | +<p>This is necessary currently because the IArchive.failed_builds etc. |
4938 | +counters are not in use.</p> |
4939 | +<p>The returned dictionary contains the follwoing keys and values:</p> |
4940 | +<blockquote> |
4941 | +<ul class="rst-simple"> |
4942 | +<li>'total': total number of builds (includes SUPERSEDED);</li> |
4943 | +<li>'pending': number of builds in BUILDING or NEEDSBUILD state;</li> |
4944 | +<li>'failed': number of builds in FAILEDTOBUILD, MANUALDEPWAIT, |
4945 | +CHROOTWAIT and FAILEDTOUPLOAD state;</li> |
4946 | +<li>'succeeded': number of SUCCESSFULLYBUILT builds.</li> |
4947 | +<li>'superseded': number of SUPERSEDED builds.</li> |
4948 | +</ul> |
4949 | +</blockquote> |
4950 | <table class="rst-docutils field-list" frame="void" rules="none"> |
4951 | <col class="field-name" /> |
4952 | <col class="field-body" /> |
4953 | <tbody valign="top"> |
4954 | -<tr class="rst-field"><th class="rst-field-name">param person:</th><td class="rst-field-body">An IPerson for whom you want to find out which |
4955 | -package sets he has access to.</td> |
4956 | +<tr class="rst-field"><th class="rst-field-name" colspan="2">param include_needsbuild:</th></tr> |
4957 | +<tr class="rst-field"><td> </td><td class="rst-field-body">Indicates whether to include builds with |
4958 | +the status NEEDSBUILD in the pending and total counts. This is |
4959 | +useful in situations where a build that hasn't started isn't |
4960 | +considered a build by the user.</td> |
4961 | </tr> |
4962 | -<tr class="rst-field"><th class="rst-field-name">return:</th><td class="rst-field-body">ArchivePermission records for all the package sets that |
4963 | -'person' is allowed to upload to.</td> |
4964 | +<tr class="rst-field"><th class="rst-field-name" colspan="2">type include_needsbuild:</th></tr> |
4965 | +<tr class="rst-field"><td> </td><td class="rst-field-body"><tt class="rst-docutils literal">bool</tt></td> |
4966 | +</tr> |
4967 | +<tr class="rst-field"><th class="rst-field-name">return:</th><td class="rst-field-body">a dictionary with the 4 keys specified above.</td> |
4968 | +</tr> |
4969 | +<tr class="rst-field"><th class="rst-field-name">rtype:</th><td class="rst-field-body"><tt class="rst-docutils literal">dict</tt>.</td> |
4970 | </tr> |
4971 | </tbody> |
4972 | </table> |
4973 | @@ -3116,118 +3439,49 @@ package sets he has access to.</td> |
4974 | </wadl:doc> |
4975 | <wadl:request> |
4976 | |
4977 | - <wadl:param style="query" name="ws.op" |
4978 | - required="true" |
4979 | - fixed="getPackagesetsForUploader"/> |
4980 | - <wadl:param style="query" required="true" |
4981 | - name="person"> |
4982 | + <wadl:param style="query" name="ws.op" required="true" fixed="getBuildCounters"/> |
4983 | + <wadl:param style="query" name="include_needsbuild" required="false"> |
4984 | + <wadl:doc xmlns="http://www.w3.org/1999/xhtml"> |
4985 | +Include builds with state NEEDSBUILD |
4986 | +</wadl:doc> |
4987 | |
4988 | - <wadl:link resource_type="https://api.launchpad.net/1.0/#person"/> |
4989 | </wadl:param> |
4990 | |
4991 | </wadl:request> |
4992 | - <wadl:response> |
4993 | - |
4994 | - <wadl:representation |
4995 | - href="https://api.launchpad.net/1.0/#archive_permission-page"/> |
4996 | - </wadl:response> |
4997 | + |
4998 | </wadl:method> |
4999 | - <wadl:method id="archive-syncSource" name="POST"> |
5000 | + <wadl:method id="archive-getQueueAdminsForComponent" name="GET"> |
The diff has been truncated for viewing.
Thanks for the review! I replied to all comments, but it looks like the only thing to do is to replace the devel with the 1.0 version. Which I will do in a min.