Merge lp:~jkakar/launchpadlib/fake-launchpad into lp:launchpadlib

Proposed by Jamu Kakar
Status: Merged
Merged at revision: 118
Proposed branch: lp:~jkakar/launchpadlib/fake-launchpad
Merge into: lp:launchpadlib
Diff against target: 33196 lines (+33156/-0)
6 files modified
.bzrignore (+1/-0)
setup.py (+1/-0)
src/launchpadlib/testing/launchpad-wadl.xml (+32229/-0)
src/launchpadlib/testing/launchpad.py (+464/-0)
src/launchpadlib/testing/resources.py (+46/-0)
src/launchpadlib/testing/tests/test_launchpad.py (+415/-0)
To merge this branch: bzr merge lp:~jkakar/launchpadlib/fake-launchpad
Reviewer Review Type Date Requested Status
LAZR Developers Pending
Review via email: mp+26391@code.launchpad.net

Description of the change

This branch is a continuation of the branch/merge proposal here:

https://code.edge.launchpad.net/~jkakar/launchpadlib/testing-support/+merge/14444

It's the same as the branch that was pushed for that merge proposal,
except that support for lp_save has been added. It could be
improved, as described in the prior merge proposal, but I feel that
it's at an adequate state for merging. I'd like to go ahead and
merge it and push improvements in subsequent branches.

To post a comment you must log in.
Revision history for this message
Jamu Kakar (jkakar) wrote :

You can get a readable diff with this command:

bzr diff -r ancestor:lp:launchpadlib `bzr st -S -r ancestor:lp:launchpadlib|cut -d ' ' -f 3|grep -v xml`|less

Revision history for this message
Robert Collins (lifeless) wrote :

NB: the adding of the lp wadl for testing makes the diff useless - look at this in a local branch :P

Revision history for this message
Robert Collins (lifeless) wrote :

Oh, and I'd like to suggest a related thing, that perhaps could be done as a pre-requisite branch.

If shipping a wadl, why not include the date-time when it was included, so that the very first http call to get a wadl can be an IMS :)

73. By Jamu Kakar

- Removed unnecessary Makefile.

Revision history for this message
Jamu Kakar (jkakar) wrote :

Does anyone have time to look at this? It'd be great to get it
landed.

Revision history for this message
Leonard Richardson (leonardr) wrote :

> Oh, and I'd like to suggest a related thing, that perhaps could be done as a
> pre-requisite branch.
>
> If shipping a wadl, why not include the date-time when it was included, so
> that the very first http call to get a wadl can be an IMS :)

What does IMS stand for?

We could use the packaged WADL to prepopulate a client cache, but it would only give any benefit until the next time we revved launchpad. Never more than a month, expected value two weeks (since the launchpadlib release cycle has nothing to do with the launchpad release cycle) and most users would never benefit since they use old packaged versions.

Revision history for this message
Leonard Richardson (leonardr) wrote :

> What does IMS stand for?

Never mind, it stands for If-Modified-Since.

Revision history for this message
Leonard Richardson (leonardr) wrote :

I've gone through this branch. It's pretty complicated and I'm not prepared to do a full review yet, but I can tell you that it's good enough to build on. Go ahead and make your improvements in a branch based on this one.

I do have some suggestions and questions, from large-scale to small-scale:

1. I would like most of this code to eventually live in lazr.restfulclient, since it mostly has nothing to do with Launchpad per se. The only code that needs to live in launchpadlib is a) the credential code, b) the Launchpad WADL file itself, c) any code for Launchpad-specific index lookup operations like launchpad.people['leonardr']. This doesn't need to happen right now, but I would like it to be easy to move that code out.

2. Similarly, I would like to see most of the tests use a small, custom-designed WADL file (or several small files) rather than the Launchpad WADL file. This will make the tests easy to understand and will ensure that they don't break when the Launchpad WADL changes. It will also make it easy to put the tests in lazr.restfulclient. wadllib takes the "one WADL file per feature" approach for most of the tests added since the original release, and I think it's quite comprehensible.

3. I don't like the way you use "FakeResource" to cover the service root resource and entry resource, but not the collection resource. It seems like "FakeResource" should be a generic superclass and you should specialize. Even if the FakeServiceRootResource and FakeEntryResource are just empty subclasses of FakeResource, the code would be easier to read.

4.

+ # This is a crappy heuristic that attempts to guess the name
+ # of the key to use for index lookups.

Put the index lookups in a later branch, when you can do them properly. What is "properly"? I thought you might be able to do introspection on the CollectionWithKeyBasedLookup subclasses like PersonSet and BugSet, but I'm a little doubtful now. You might have to re-implement the _get_url_from_id implementations.

5. I don't understand why "The result of a fake method" is always a FakeResource. Your test_callable_object_return_type defines a method that returns a collection. Shouldn't it be a FakeCollectionResource? Between this and #3 I am getting the impression that FakeResource really _is_ an all-in-one resource class and that FakeCollectionResource is only used in certain circumstances. But I still don't have a good grasp of the difference.

I'll work on a more detailed review tomorrow.

Revision history for this message
Jonathan Lange (jml) wrote :

This might be a stupid idea, but maybe it would be nice to build up the wadl with Python expressions and then have a convenience function that says "make me a pretend webservice here". This would be somewhat in line with 2, except programmers wouldn't have to learn wadl.

Revision history for this message
Jamu Kakar (jkakar) wrote :

Leonard:

[1]

Agreed. I didn't really realize that was the right place for this
when I started, but it would be great if lazr.restfulclient using
applications had access to something like this out-of-the-box.

Okay, so the index-based lookups are something special layered on
top of the WADL and not something that can be determined directly
from it, right?

[2]

Using a small purpose-built WADL file is a good idea. As for
Jonathan's suggestion to use Python, I think anyone hacking on this
code probably ought to know how WADL works or or at least make
random guesses like I did. That said, maybe a WADL builder would be
useful in other places and could be used here.

Two things would have been very helpful:

1. Having a model-based representation of the model, so that I
   didn't have to deal with XML directly.

2. Documentation describing, in simple terms, how the WADL file
   works. I mostly guessed and, I think, mostly got things right.

[3]

That's a good idea, it is confusing right now.

[4]

I'll have to check this out, thanks for the hint.

[5]

The FakeCollection is only used for parameters that end in
_collection_link. I think you're right though, the logic that wraps
method call return types in FakeResource should be smarter and
determine if the return type is a collection.

Thanks for taking the time to look at this.

Revision history for this message
Jamu Kakar (jkakar) wrote :

Leonard:

Do you have time to look at this? I'd like to get it landed sooner
than later, but I'm still not quite sure what the blockers are.

Revision history for this message
Graham Binns (gmb) wrote :

Hi Jamu, Leonard: Is this branch still under development?

Revision history for this message
Jamu Kakar (jkakar) wrote :

Graham:

I keep thinking about this but I've also kind of lost steam on it
since it's been sitting here for ages. I'd love for it to be merged
because the lack of testability in launchpadlib is a big problem. My
feeling is that the API exposed to users of the test class is good but
that the internal details could be improved, as Leonard points out.
I'd like to see it landed and improved with subsequent branches, since
it's already useful.

74. By Jamu Kakar

- Merged trunk.

Revision history for this message
Jamu Kakar (jkakar) wrote :

I've merged trunk and run the tests. The WADL file still needs to be
updated (or changed to get pulled whenever tests run).

Revision history for this message
Martin Pool (mbp) wrote :

Thanks for writing this, Jamu. This is such a big gap for anyone writing Launchpad clients. I do feel getting some thing into this gap, however imperfect, is better than nothing. It's a real shame this has been sitting here for 20 months.

Perhaps this should go into a separate project where it can evolve separately of lazr.restful/launchpadlib and be perhaps cross a lower barrier? As far as I can see it doesn't actually patch anything in launchpadlib; it only adds new classes.

The main thing I would like to see both as a reviewer and would-be user is just a README demonstrating how one could use it, and what kind of thing it's supposed to help you with.

People trying to catch up on the history of this should read https://code.edge.launchpad.net/~jkakar/launchpadlib/testing-support/+merge/14444

I'm not very familiar with the internals of the existing implementation but the code for this looks reasonable to me, at least to the point where I would not be afraid to change it. I would like to see the xml-parsing stuff split out a bit from the FakeResource, and perhaps changed to use lxml, but there's no reason that needs to be done in the first iteration.

+ def test_callable_object_return_type(self):
+ """
+ The result of a fake method is a L{FakeResource}, automatically
+ created from the object used to define the return object.
+ """
+ branches = dict(total_size="8")
+ self.launchpad.me = dict(getBranches=lambda statuses: branches)
+ branches = self.launchpad.me.getBranches([])
+ self.assertTrue(isinstance(branches, FakeResource))
+ self.assertEqual("8", branches.total_size)
+

I feel I would like this to make a bigger distinction between code that's running "behind the scenes" to set up the mock object, vs things being done on the front end of the mock object once they're set up. It seems like assigning to "me" is a behind-the-scenes setup thing and not something you can do on a real Launchpad, whereas accessing its attributes is pretending to be talking to a real one.

Maybe this is not a meaningful distinction for this library?

Revision history for this message
Martin Pool (mbp) wrote :

.. you've probably thought about this much more than me, but it seems to me you'd want

1- interfaces that can potentially be used against either a real launchpad or a fake one, assuming the code calling them makes no assumptions about the existence or nonexistence of particular data - for instance making a person and setting some attributes on them should be in that class

2- interfaces that simulate behaviour or state we could assume would already be present on the other end of a remote launchpad, like the existence of 'me' or searchTasks

3- interfaces that populate sample data more quickly/efficiently than talking to Launchpad

Why do I think I want this?

+ self.launchpad.me = dict(getBranches=lambda statuses: branches)
+ branches = self.launchpad.me.getBranches([])

This seems oddly nonpythonic. I can guess there is a getattr hack there, and that's fine for simulating the behaviour on 'me.getBranches', but it seems odd to also load things into it by assigning to a dict.

Secondly, I feel that if just assigning to things works, there is a risk people will have code that accidentally passes, when assigning to lplib proxy objects won't behave the same way. Maybe this isn't a real problem, and we just need to write some actual tests using this to see what happens.

Revision history for this message
Jamu Kakar (jkakar) wrote :

> Thanks for writing this, Jamu. This is such a big gap for anyone writing
> Launchpad clients. I do feel getting some thing into this gap, however
> imperfect, is better than nothing. It's a real shame this has been sitting
> here for 20 months.
>
> Perhaps this should go into a separate project where it can evolve separately
> of lazr.restful/launchpadlib and be perhaps cross a lower barrier? As far as
> I can see it doesn't actually patch anything in launchpadlib; it only adds new
> classes.

That's an interesting idea... though it feels like a compromise, but
maybe one worth making to get the code out and more easily accessible.

> The main thing I would like to see both as a reviewer and would-be user is
> just a README demonstrating how one could use it, and what kind of thing it's
> supposed to help you with.

Good call.

> People trying to catch up on the history of this should read
> https://code.edge.launchpad.net/~jkakar/launchpadlib/testing-
> support/+merge/14444
>
> I'm not very familiar with the internals of the existing implementation but
> the code for this looks reasonable to me, at least to the point where I would
> not be afraid to change it. I would like to see the xml-parsing stuff split
> out a bit from the FakeResource, and perhaps changed to use lxml, but there's
> no reason that needs to be done in the first iteration.
>
> + def test_callable_object_return_type(self):
> + """
> + The result of a fake method is a L{FakeResource}, automatically
> + created from the object used to define the return object.
> + """
> + branches = dict(total_size="8")
> + self.launchpad.me = dict(getBranches=lambda statuses: branches)
> + branches = self.launchpad.me.getBranches([])
> + self.assertTrue(isinstance(branches, FakeResource))
> + self.assertEqual("8", branches.total_size)
> +
>
> I feel I would like this to make a bigger distinction between code that's
> running "behind the scenes" to set up the mock object, vs things being done on
> the front end of the mock object once they're set up. It seems like assigning
> to "me" is a behind-the-scenes setup thing and not something you can do on a
> real Launchpad, whereas accessing its attributes is pretending to be talking
> to a real one.
>
> Maybe this is not a meaningful distinction for this library?

Yeah, so the way it works, and the reason for the weird dict()-based
interface is that you set fake data on the FakeLaunchpad
object... when that happens, it validates it against the WADL file to
make sure that what you're setting is actually possible. Each of
those dict()'s being set on the FakeLaunchpad instance represent
objects that would be exposed on the real Launchpad instance. When
you set an object, say to represent a person, you don't have to
provide all the attributes and methods the real version would have,
just the ones you care about for your test.

It really is a bit of a hack, but the best one I could think of. I
haven't used this code in a real project, so I can only guess that the
WADL validation will prevent silly problems.

Revision history for this message
Jamu Kakar (jkakar) wrote :

> .. you've probably thought about this much more than me, but it seems to me
> you'd want
>
> 1- interfaces that can potentially be used against either a real launchpad or
> a fake one, assuming the code calling them makes no assumptions about the
> existence or nonexistence of particular data - for instance making a person
> and setting some attributes on them should be in that class

Yes. If I understand correctly, that's basically what is in place,
except that the interface is some XML in a WADL file.

> 2- interfaces that simulate behaviour or state we could assume would already
> be present on the other end of a remote launchpad, like the existence of 'me'
> or searchTasks

Yes, these are basically defined in the WADL file.

> 3- interfaces that populate sample data more quickly/efficiently than talking
> to Launchpad

I don't think I really understand this...?

> Why do I think I want this?
>
> + self.launchpad.me = dict(getBranches=lambda statuses: branches)
> + branches = self.launchpad.me.getBranches([])
>
> This seems oddly nonpythonic. I can guess there is a getattr hack there, and
> that's fine for simulating the behaviour on 'me.getBranches', but it seems odd
> to also load things into it by assigning to a dict.
>
> Secondly, I feel that if just assigning to things works, there is a risk
> people will have code that accidentally passes, when assigning to lplib proxy
> objects won't behave the same way. Maybe this isn't a real problem, and we
> just need to write some actual tests using this to see what happens.

As above, the WADL validation should help. The real point of the
FakeLaunchpad instance is just to create a place to hang fake data
off. You then hand the fake into your application, as though it were
a real Launchpad instance, and, if you've provided all the right bits,
everything should work.

It's a bit tricky because launchpadlib doesn't have a set of
pre-defined interfaces. Almost everything it exposes is built based
on the WADL file.

Revision history for this message
Gavin Panella (allenap) wrote :

The signatures for some methods has changed in launchpadlib, so the
fakes are a little out of date.

For those methods with optional arguments I think it's okay if the
fake accepts a subset of the arguments - it will still be useful - but
they still must be in-sync with the real methods. We could add some
tests to automatically compare using inspect.getargspec.

If this small amount of work is done I think this code should be in
launchpadlib rather than going stale outside of it. Even if it's not
perfect (when are fakes perfect?) I think it's useful. It also
self-selects contributors: anyone using it will be perfectly capable
of contributing to it, and motivated to do so.

Revision history for this message
Jonathan Lange (jml) wrote :

On Thu, Apr 14, 2011 at 2:54 PM, Gavin Panella
<email address hidden> wrote:
...
> (when are fakes perfect?)

When the tests for the real thing also run against the fakes.

jml

Revision history for this message
Jamu Kakar (jkakar) wrote :

It's been awhile since I looked at this, so not surprised there's some
bitrot... I guess one issue is that there's an old WADL here, whereas
the WADL should probably be pulled dynamically. Does anyone know what
we need to do to get this landed...? It's not clear to me anymore.

I think my preference would be to fix the most important issues and
get this merged. After that, we can iterate to improve the logic
(it's a bit tricky in places).

Revision history for this message
Robert Collins (lifeless) wrote :

On Fri, Apr 15, 2011 at 2:13 AM, Jamu Kakar <email address hidden> wrote:
> It's been awhile since I looked at this, so not surprised there's some
> bitrot... I guess one issue is that there's an old WADL here, whereas
> the WADL should probably be pulled dynamically.  Does anyone know what
> we need to do to get this landed...?  It's not clear to me anymore.
>
> I think my preference would be to fix the most important issues and
> get this merged.  After that, we can iterate to improve the logic
> (it's a bit tricky in places).

+1

Revision history for this message
Gavin Panella (allenap) wrote :

> It's been awhile since I looked at this, so not surprised there's some
> bitrot... I guess one issue is that there's an old WADL here, whereas
> the WADL should probably be pulled dynamically. Does anyone know what
> we need to do to get this landed...? It's not clear to me anymore.

I think the signatures of the methods that are faked need to be
updated where they're out of date. It would be nice to have a test to
keep them in sync, but I don't think that should block landing.

Perhaps the WADL could be updated too. Not being able to get it
dynamically should not block landing either, IMO.

It might be worth issuing a warning when importing the new modules,
just to tell people that it's an alpha feature for now.

Revision history for this message
Jamu Kakar (jkakar) wrote :

Gavin:

The signatures of fakes are validated against the WADL, so the issue
isn't really in FakeLaunchpad as much as it's because the WADL is old.
Basically, FakeLaunchpad doesn't know anything about the data
model--it just verifies that fakes you create match the WADL.

Preview Diff

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

Subscribers

People subscribed via source and target branches