Merge lp:~noise/tanuki-agent/api-ref-tweaks into lp:tanuki-agent

Proposed by Bret Barker on 2016-01-04
Status: Merged
Approved by: Roberto Alsina on 2016-01-04
Approved revision: 200
Merged at revision: 200
Proposed branch: lp:~noise/tanuki-agent/api-ref-tweaks
Merge into: lp:tanuki-agent
Diff against target: 113 lines (+21/-13)
1 file modified
docs/api-reference-products.md (+21/-13)
To merge this branch: bzr merge lp:~noise/tanuki-agent/api-ref-tweaks
Reviewer Review Type Date Requested Status
Roberto Alsina (community) 2016-01-04 Approve on 2016-01-04
Review via email: mp+281548@code.launchpad.net

Commit message

fix FIXMEs and replace IDs

To post a comment you must log in.
Roberto Alsina (ralsina) :
review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file 'docs/api-reference-products.md'
2--- docs/api-reference-products.md 2016-01-04 19:06:44 +0000
3+++ docs/api-reference-products.md 2016-01-04 20:11:51 +0000
4@@ -147,7 +147,12 @@
5 Product Management
6 ------------------
7
8-**FIXME ADD EXPLANATIONS**
9+Product Integration testing is centered around a Product that you
10+define. Products are tied to a ```primary_snap_name``` referring to a
11+package that you control and have published via
12+[MyApps](https://myapps.developer.ubuntu.com/dev/click-apps/upload/). The
13+primary snap will typically be either a Gadget snap or your main
14+Application snap.
15
16 A product contains the following fields:
17
18@@ -158,7 +163,8 @@
19 Maximum length is 200 characters.
20 - ```release``` snappy release series, e.g.
21 "15.04". Maximum length is 200 characters.
22-- ```primary_snap_name``` name of the snap used to control access to this product.
23+- ```primary_snap_name``` name of the snap used to control access to
24+ this product and associated tests.
25 - ```snaps``` list of snaps that make up the
26 product. This list will be used to for snappy based products to
27 trigger tests when new Snap revisions are made available.
28@@ -502,7 +508,9 @@
29 "name": unique (within the product) name of the Test
30 "test_payload": an arbitrary JSON value with all the information needed to run the test
31 (maximum size 4000 bytes), optional defaulting to null
32- "channel_combos": **FIXME DESCRIBE**
33+ "channel_combos": a list of dictionaries with keys "base" and "update",
34+ signifying the combinations of channels that should be monitored for changes
35+ and used to determine revisions for images and updates.
36 }
37 </pre>
38 <tr>
39@@ -856,8 +864,8 @@
40
41 HTTP 201
42 {
43-'ids': [{'test_opportunity_id': '7b6e755d-28c9-4663-bcfc-45c36eee6eb3',
44- 'image_unique_id': '5f88cc90-487b-4587-a633-b36e44b72b99'}]}
45+'ids': [{'test_opportunity_id': 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
46+ 'image_unique_id': 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'}]}
47 </pre>
48 </table>
49
50@@ -918,7 +926,7 @@
51 <td>Example <td>
52 <pre>
53 $ ./scripts/api_example.py conf.ini \
54-http://spi.canonical.com/orgs/e2e-org/tests/events?test_opportunity_id=d012edab-9dd1-4950-bdf6-21b94a956791
55+http://spi.canonical.com/orgs/e2e-org/tests/events?test_opportunity_id=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
56 HTTP 200
57 {
58 "event_logs": [
59@@ -927,7 +935,7 @@
60 "image_name": "e2e-imgf151a8cd9081404db54ed1d8dab1e140",
61 "queued_at": "2015-09-17T12:13:03.288000+00:00",
62 "updated_at": "2015-09-17T12:13:06.799000+00:00",
63- "image_unique_id": "3a9cf076-1c27-4b1c-8080-15cb2d24bea7",
64+ "image_unique_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
65 "events_seen": [
66 "QUEUED_FOR_AGENTS",
67 "PICKED_BY_AGENT",
68@@ -947,7 +955,7 @@
69 "platform": "amd64"
70 },
71 {
72- "result_id": "533050b7-054e-4a72-bf63-16db864451ea",
73+ "result_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
74 "test_status": "PASSED",
75 "agent_group": "e2e-group",
76 "event_type": "RESULT_POSTED",
77@@ -957,12 +965,12 @@
78 },
79 {
80 "event_type": "RESULT_STORED",
81- "result_id": "533050b7-054e-4a72-bf63-16db864451ea",
82+ "result_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
83 "test_status": "PASSED",
84 "timestamp": "2015-09-17T12:13:06.745000+00:00"
85 }
86 ],
87- "test_opportunity_id": "d012edab-9dd1-4950-bdf6-21b94a956791",
88+ "test_opportunity_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
89 "spec_name": "e2e-spec_13691451",
90 "test_opportunity": {
91
92@@ -1051,7 +1059,7 @@
93 "name": "e2e-spec_70600150",
94 "platform": "amd64",
95 "image_name": "e2e-img",
96- "id": "9e12839e-d9c1-4266-be33-27b5174d396f",
97+ "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
98 "created_at": "2015-08-26T00:00:20.297477",
99 "test_payload": "{'foo': 'bar'}"
100 },
101@@ -1131,10 +1139,10 @@
102 {
103 "test_results": [
104 {
105- "image_unique_id": "9e98346a-07e7-45a9-8105-b25b50bd6fa1",
106+ "image_unique_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
107 "test_status": "PASSED",
108 "agent-id": "e2e-id",
109- "id": "37383ba5-ff0b-4735-917a-ac4a4b8939c9",
110+ "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
111 "result_payload": {
112 "foo": "bar"
113 },

Subscribers

People subscribed via source and target branches

to all changes: