Feeds

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>/apsRepo.atom

Repository

<ROOT_URL>/<APSver>.atom

Vendor

<ROOT_URL>/<APSver>/<VendorName>.atom

Application

<ROOT_URL>/<APSver>/<VendorName>/<AppName>.atom

Application Version

<ROOT_URL>/<APSver>/<VendorName>/<AppName>/<AppVer>.atom

Package

<ROOT_URL>/<APSver>/<VendorName>/<AppName>/<AppVer>/updates.atom?packager=<Packager>

The placeholder strings mean the following:

In this section:

Sample

Elements Reference

Sample

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>

 

Elements Reference

This section contains description of elements nested in an APS Catalog feed.

OpenSearch 1.1 elements nested in a feed

 

Element

Description

/opensearch:totalResults

Total number of entries in a feed

/opensearch:startIndex

Index of the first entry in the current feed page

/opensearch:itemsPerPage

Number of entries per feed page

/link[@rel='search']

Link to a search description

 

[RFC5005] elements nested in a feed

 

Element

Description

/link[@rel='self']

Link to the current feed page

/link[@rel='first']

Link to the first feed page

/link[@rel='last']

Link to the last feed page

/link[@rel='next']

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

/entry/id

Package ID generated by APS Catalog

/entry/title

/sa:name

/entry/summary

/sa:summary

/entry/category/@term

/sa:categories/sa:category

/entry/author[@a:author-type='vendor']/name

/sa:vendor/sa:name

/entry/author[@a:author-type='vendor']/uri

/sa:vendor/sa:homepage

/entry/author[@a:author-type='packager']/name

N/A (APP-META does not state packager name at the moment)

/entry/author[@a:author-type='packager']/uri

/sa:package-homepage

/entry/content

/sa:description

/entry/link[@a:type='screenshot']

/sa:screenshot

 

APS Catalog elements mapping

 

Feed element

Package metadata element

/entry/a:name

/sa:name

/entry/a:summary

/sa:summary

/entry/a:categories

/sa:categories

/entry/a:version

/sa:version

/entry/a:release

/sa:release

/entry/a:description

/sa:description

 

APS Catalog service elements

 

Feed element

Description

entry/link[@a:type='aps']/a:checksum

Package digest. Digesting algorithm is specified by the /entry/link/a:checksum/@algorithm attribute. Recommended algorithm values are SHA1 and MD5.

entry/link[@a:type='meta']

Link to package metadata

entry/link[@a:type='aps']

Link to APS package

entry/link[@a:type='updates']

Link to Package Updates feed

entry/link[@a:type='resources']

Link to Package Resources index