[backend] configure sync pool for arm
[opensuse:build-service.git] / docs / daii.txt
1 Directory App Integration Interface
2 ===================================
3
4 To attract projects to build in the Build Service we implement an
5 interface that returns pathes to binary packages according to one
6 project name and a list of package names.
7
8 The usecase is to invite application directory pages such as
9 http://kde-apps.org to offer their user the following service: If the
10 user builds in the OBS, the directory app takes an OBS project- and
11 package name. On the fly, the directory app uses the integration
12 interface of the OBS with these two parameters and gets a list of the
13 available binary packages for the package, see example structure
14 below. The directory app can render a nice download box for the
15 users to pick rpms from the OBS for their system.
16
17 Example communication:
18
19 Input: project, package names
20
21
22 Result-XML File:
23 <integrate project="home:kfreitag">
24   <ymp>
25     http://download.opensuse.org/repositories/home:/kfreitag/kraft.ymp
26   </ymp>
27   <system id="os11">
28     <name>openSUSE 11.0</name>
29     <icon width="16" height="16">http://opensuse.org/static/os11logo16.png"/>
30     <link>http://www.opensuse.org</link>
31
32     <pack name="kraft">
33       <summary lang="en">Kraft is software for people...</lang>  
34       <rpm>http://download.opensuse.org/repositories/home:/kfreitag/openSUSE_11.0/i586/kraft-0.25-6.4.i586.rpm</rpm>
35     </pack>
36
37     <pack name="trmltools">
38       <summary lang="en">Trmltools convert rml to pdf</lang>  
39       <rpm>http://download.opensuse.org/repositories/home:/kfreitag/Fedora9/noarch/trmltools-1.1-5.4.noarch.rpm</rpm>  
40     </pack>
41   </system>
42   <system id="fed9">
43     <name>Fedora 9</name>
44     <icon width="16" height="16">http://opensuse.org/static/fed9logo16.png"/>
45     <link>http://www.fedoraproject.org</link>
46
47     <pack name="kraft">
48       <summary lang="en">Kraft is software for people...</lang>  
49       <rpm>http://download.opensuse.org/repositories/home:/kfreitag/fedora9/i586/kraft-0.25-6.4.i586.rpm</rpm>
50     </pack>
51
52     <pack name="trmltools">
53       <summary lang="en">Trmltools convert rml to pdf</lang>  
54       <rpm>http://download.opensuse.org/repositories/home:/kfreitag/fedora9/i586/trmltools-1.1-5.4.noarch.rpm</rpm>  
55     </pack>
56   </system>
57 </integrate>