1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
|
Working with Launchpad Answers over the API
===========================================
Users can work with question targets and questions over the api to
search and update questions. This demonstration will use a project, it's
contact, and asker, and three questions.
>>> from zope.component import getUtility
>>> from lp.testing.pages import webservice_for_person
>>> from lp.services.webapp.interfaces import OAuthPermission
>>> from lp.app.enums import ServiceUsage
>>> from lp.registry.interfaces.person import TeamSubscriptionPolicy
>>> from lp.services.worlddata.interfaces.language import ILanguageSet
>>> from lp.testing.sampledata import ADMIN_EMAIL
>>> lang_set = getUtility(ILanguageSet)
>>> login(ADMIN_EMAIL)
>>> _contact = factory.makePerson(name='contact')
>>> _project = factory.makeProduct(name='my-project', owner=_contact)
>>> _contact.addLanguage(lang_set['en'])
>>> _project.answers_usage = ServiceUsage.LAUNCHPAD
>>> success = _project.addAnswerContact(_contact, _contact)
>>> _team = factory.makeTeam(
... owner=_contact,
... name='my-team',
... subscription_policy=TeamSubscriptionPolicy.RESTRICTED)
>>> _team_project = factory.makeProduct(name='team-project', owner=_team)
>>> _asker = factory.makePerson(name='asker')
>>> _question_1 = factory.makeQuestion(
... target=_project, title="Q 1 great", owner=_asker)
>>> _question_2 = factory.makeQuestion(
... target=_project, title="Q 2 greater", owner=_asker)
>>> _question_3 = factory.makeQuestion(
... target=_team_project, title="Q 3 greatest", owner=_asker)
>>> _message = _question_1.giveAnswer(_contact, 'This is the answer')
>>> logout()
>>> contact_webservice = webservice_for_person(
... _contact, permission=OAuthPermission.WRITE_PUBLIC)
Answer contacts
---------------
Users can add or remove themselves as an answer contact for a project using
addAnswerContact and removeAnswerContact. The user must have a preferred
language. Scripts should call the canUserAlterAnswerContact method first to
verify that the person can changed.
>>> project = contact_webservice.get(
... '/my-project', api_version='devel').jsonBody()
>>> contact = contact_webservice.get(
... '/~contact', api_version='devel').jsonBody()
>>> contact_webservice.named_get(
... project['self_link'], 'canUserAlterAnswerContact',
... person=contact['self_link'], api_version='devel').jsonBody()
True
>>> contact_webservice.named_post(
... project['self_link'], 'removeAnswerContact',
... person=contact['self_link'], api_version='devel').jsonBody()
True
>>> contact_webservice.named_post(
... project['self_link'], 'addAnswerContact',
... person=contact['self_link'], api_version='devel').jsonBody()
True
Users can also make the teams they administer answer contacts using
addAnswerContact and removeAnswerContact if the team has a preferred language.
>>> team = contact_webservice.get(
... '/~my-team', api_version='devel').jsonBody()
>>> team_project = contact_webservice.get(
... '/team-project', api_version='devel').jsonBody()
>>> contact_webservice.named_get(
... team_project['self_link'], 'canUserAlterAnswerContact',
... person=team['self_link'], api_version='devel').jsonBody()
True
>>> contact_webservice.named_post(
... team['self_link'], 'addLanguage',
... language='/+languages/fr', api_version='devel').jsonBody()
>>> contact_webservice.named_post(
... team_project['self_link'], 'addAnswerContact',
... person=team['self_link'], api_version='devel').jsonBody()
True
Anyone can get the collection of languages spoken by at least one
answer contact by calling getSupportedLanguages.
>>> languages = anon_webservice.named_get(
... team_project['self_link'], 'getSupportedLanguages',
... api_version='devel').jsonBody()
>>> print_self_link_of_entries(languages)
http://.../+languages/en
http://.../+languages/fr
Anyone can retrieve the collection of answer contacts for a language using
getAnswerContactsForLanguage.
>>> english = anon_webservice.get(
... '/+languages/en', api_version='devel').jsonBody()
>>> contacts = anon_webservice.named_get(
... project['self_link'], 'getAnswerContactsForLanguage',
... language=english['self_link'], api_version='devel').jsonBody()
>>> print_self_link_of_entries(contacts)
http://.../~contact
Anyone can retrieve the collection of `IQuestionTarget`s that a person
is an answer contact for using getDirectAnswerQuestionTargets.
>>> targets = anon_webservice.named_get(
... contact['self_link'], 'getDirectAnswerQuestionTargets',
... api_version='devel').jsonBody()
>>> print_self_link_of_entries(targets)
http://api.launchpad.dev/devel/my-project
Anyone can retrieve the collection of `IQuestionTarget`s that a person's
teams is an answer contact for using getTeamAnswerQuestionTargets.
>>> targets = anon_webservice.named_get(
... contact['self_link'], 'getTeamAnswerQuestionTargets',
... api_version='devel').jsonBody()
>>> print_self_link_of_entries(targets)
http://api.launchpad.dev/devel/team-project
Question collections
--------------------
Anyone can retrieve a collection of questions from an `IQuestionTarget` with
searchQuestions. The question will that match the precise search criteria
called with searchQuestions.
>>> questions = anon_webservice.named_get(
... project['self_link'], 'searchQuestions',
... search_text='q great',
... status=['Open', 'Needs information', 'Answered'],
... language=[english['self_link']],
... sort='oldest first',
... api_version='devel').jsonBody()
>>> for question in questions['entries']:
... print question['title']
Q 1 great
>>> print questions['total_size']
1
Anyone can retrieve a collection of questions from an `IQuestionTarget` that
are similar to a phrase using findSimilarQuestions. A phrase one or more the
words that might appear in a question's title or description.
findSimilarQuestions uses natural language techniques to match the question.
>>> questions = anon_webservice.named_get(
... project['self_link'], 'findSimilarQuestions',
... phrase='q great',
... api_version='devel').jsonBody()
>>> for question in questions['entries']:
... print question['title']
Q 1 great
Q 2 greater
Anyone can retrieve a specific question from an `IQuestionTarget` calling
getQuestion with the question Id.
>>> question_1 = anon_webservice.named_get(
... project['self_link'], 'getQuestion', question_id=_question_1.id,
... api_version='devel').jsonBody()
>>> print question_1['title']
Q 1 great
Anyone can retrieve a collection of questions from an `IPerson` with
searchQuestions. The question will that match the precise search criteria
called with searchQuestions.
>>> questions = anon_webservice.named_get(
... contact['self_link'], 'searchQuestions',
... search_text='q great',
... status=['Open', 'Needs information', 'Answered'],
... language=[english['self_link']],
... needs_attention=False,
... sort='oldest first',
... api_version='devel').jsonBody()
>>> for question in questions['entries']:
... print question['title']
Q 1 great
A question
----------
A question has many exported attributes about the details of the question, its
state, the people involved, and the dates of important events. There is also
a link to retrieve the question's messages.
>>> from lazr.restful.testing.webservice import pprint_entry
>>> pprint_entry(question_1)
answer_link: None
answerer_link: None
assignee_link: None
date_created: u'20...+00:00'
date_due: None
date_last_query: u'20...+00:00'
date_last_response: u'20...+00:00'
date_solved: None
description: u'description...'
id: ...
language_link: u'http://api.launchpad.dev/devel/+languages/en'
messages_collection_link:
u'http://api.launchpad.dev/devel/my-project/+question/.../messages'
owner_link: u'http://api.launchpad.dev/devel/~asker'
resource_type_link: u'http://api.launchpad.dev/devel/#question'
self_link: u'http://api.launchpad.dev/devel/my-project/+question/...'
status: u'Answered'
target_link: u'http://api.launchpad.dev/devel/my-project'
title: u'Q 1 great'
web_link: u'http://answers.launchpad.dev/my-project/+question/...'
Question messages
-----------------
An `IQuestionMessage` provides the IMessage fields and additional fields
that indicate how the message changed the question.
>>> messages = anon_webservice.get(
... question_1['messages_collection_link'],
... api_version='devel').jsonBody()
>>> pprint_entry(messages['entries'][0])
action: u'Answer'
bug_attachments_collection_link: u'...'
content: u'This is the answer'
date_created: u'20...+00:00'
index: 1
new_status: u'Answered'
owner_link: u'http://api.launchpad.dev/devel/~contact'
parent_link: None
question_link: u'http://api.launchpad.dev/devel/my-project/+question/...'
resource_type_link: u'http://api.launchpad.dev/devel/#question_message'
self_link:
u'http://api.launchpad.dev/devel/my-project/+question/.../messages/1'
subject: u'Re: Q 1 great'
visible: True
web_link:
u'http://answers.launchpad.dev/my-project/+question/.../messages/1'
|