The subsections of this section describe the XML structure of an APS Catalog feed.
Feed URLs
Each feed is available at one of the following URLs:
Feed name |
Feed URL |
Service |
<ROOT_URL> |
Repository |
<ROOT_URL> |
Vendor |
<ROOT_URL> |
Application |
<ROOT_URL> |
Application Version |
<ROOT_URL> |
Package |
<ROOT_URL> |
The placeholder strings mean the following:
This section provides a sample of an APS Catalog feed. For description of a specific feed element, refer to the Elements Reference section.
<feed xmlns="http://www.w3.org/2005/Atom" xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/">
<id>http://apscatalog.com/1.atom</id>
<title>{}</title>
<updated>2008-04-07T10:35:34Z</updated>
<!-- Derived from Opensearch 1.1 -->
<opensearch:totalResults>73</opensearch:totalResults>
<opensearch:startIndex>1</opensearch:startIndex>
<opensearch:itemsPerPage>10</opensearch:itemsPerPage>
<link rel="search" type="application/opensearchdescription+xml" href=""/>
<!-- Derived from RFC5005 -->
<link rel="self" href="http://apscatalog.com/1.atom"/>
<link rel="first" href="http://apscatalog.com/1.atom" />
<link rel="last" href="http://apscatalog.com/1.atom?page=8" />
<link rel="next" href="http://apscatalog.com/1.atom?page=2" />
<!-- Atom elements and APS Catalog extensions -->
<entry xmlns:a="http://apstandard.com/ns/repo/1" xmlns="http://www.w3.org/2005/Atom">
<!-- Package ID as described in "Unique package identification" section -->
<id>tag:example.org,2008-02-27:/1/opensource/tikiwiki/1.9.7-34/parallels</id>
<!-- Package name. sa:name value -->
<title>tikiwiki</title>
<!-- Summary. sa:summary value -->
<summary>tikiwiki</summary>
<!-- The moment the package was added -->
<updated>2003-12-13T18:30:02Z</updated>
<!-- Application category. Multiple categories are permitted -->
<category term="wiki" />
<author a:author-type="vendor">
<!-- Application vendor name -->
<name>opensource</name>
<!-- Application vendor URI -->
<uri>http://info.tikiwiki.org/tiki-index.php</uri>
</author>
<author a:author-type="packager">
<name>Parallels</name>
<uri>urn:uuid:60a76c80-d399-11d9-b91C-0003939e0af6</uri>
</author>
<!-- Application description. sa:description content -->
<content type="html">TikiWiki enable administrators and users to create, display ...</content>
<!-- URI of the package -->
<link rel="enclosure" type='application/zip' a:type="aps"
href="http://example.org/1/opensource/tikiwiki/1.9.7-34.aps?packager=parallels"
length="439144">
<!-- any number of a:checksum elements is allowed -->
<a:checksum algorithm="MD5">md5 digest</a:checksum>
<a:checksum algorithm="SHA1">sha1 digest</a:checksum>
</link>
<!-- Link to package metadata -->
<link rel="alternate" type="application/xml" a:type="meta" href="http://example.org/1/opensource/tikiwiki/1.9.7-34.meta?packager=parallels"/>
<!-- Self link -->
<link rel="self" type="application/xml" a:type="atom" href="http://example.org/1/opensource/tikiwiki/1.9.7-34.atom?packager=parallels"/>
<!-- Direct screenshot links -->
<link a:type="screenshot" rel="enclosure" type="image/png" href="http://media.example.org/1/opensource/tikiwiki/1.9.7-34/resources/images/screenshot1.png" />
<!-- Link to the Package Resources index: icons, screenshots, etc. -->
<link rel="related" type="application/xhtml+xml" a:type="resources" href="http://example.org/1/opensource/tikiwiki/1.9.7-34/resources/?packager=parallels"/>
<!-- Link to the Package Updates feed -->
<link rel="related" type="application/atom+xml" a:type="updates" href="http://example.org/1/opensource/tikiwiki/1.9.7-34/updates.atom?packager=parallels"/>
<a:name>tikiwiki</a:name>
<a:version>1.9.7</a:version>
<a:release>34</a:release>
<a:description>TikiWiki enable administrators and users to create, display ...</a:description>
<a:summary>tikiwiki</a:summary>
<a:vendor>opensource</a:vendor>
<a:packager>parallels</a:packager>
<a:categories>
<a:category>wiki</a:category>
</a:categories>
</entry>
</feed>
This section contains description of elements nested in an APS Catalog feed.
OpenSearch 1.1 elements nested in a feed
Element |
Description |
|
Total number of entries in a feed |
|
Index of the first entry in the current feed page |
|
Number of entries per feed page |
|
Link to a search description |
[RFC5005] elements nested in a feed
Element |
Description |
|
Link to the current feed page |
|
Link to the first feed page |
|
Link to the last feed page |
|
Link to the next feed page |
Other feed elements are divided into three groups:
For description of APS package metadata, see http://apsstandard.com/r/doc/package-format-specification-1.0.pdf.
Native Atom elements mapping
Feed element |
Package metadata element |
|
Package ID generated by APS Catalog |
|
|
|
|
|
|
|
|
|
|
|
N/A (APP-META does not state packager name at the moment) |
|
|
|
|
|
|
APS Catalog elements mapping
Feed element |
Package metadata element |
|
|
|
|
|
|
|
|
|
|
|
|
APS Catalog service elements
Feed element |
Description |
|
Package digest. Digesting algorithm is specified by the /entry/link/a:checksum/@algorithm attribute. Recommended algorithm values are SHA1 and MD5. |
|
Link to package metadata |
|
Link to APS package |
|
Link to Package Updates feed |
|
Link to Package Resources index |