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