From a1a18f77a50804e0127dfa4b0f5240c49c541184 Mon Sep 17 00:00:00 2001
From: Scott Jackson <daneren2005@gmail.com>
Date: Mon, 2 Jul 2012 21:24:02 -0700
Subject: Initial Commit

---
 .../src/main/webapp/xsd/subsonic-rest-api.xsd      | 434 +++++++++++++++++++++
 1 file changed, 434 insertions(+)
 create mode 100644 subsonic-main/src/main/webapp/xsd/subsonic-rest-api.xsd

(limited to 'subsonic-main/src/main/webapp/xsd/subsonic-rest-api.xsd')

diff --git a/subsonic-main/src/main/webapp/xsd/subsonic-rest-api.xsd b/subsonic-main/src/main/webapp/xsd/subsonic-rest-api.xsd
new file mode 100644
index 00000000..449b49e8
--- /dev/null
+++ b/subsonic-main/src/main/webapp/xsd/subsonic-rest-api.xsd
@@ -0,0 +1,434 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
+           xmlns:sub="http://subsonic.org/restapi"
+           targetNamespace="http://subsonic.org/restapi"
+           attributeFormDefault="unqualified"
+           elementFormDefault="qualified"
+           version="1.8.0">
+
+    <xs:element name="subsonic-response" type="sub:Response"/>
+
+    <xs:complexType name="Response">
+        <xs:choice minOccurs="0" maxOccurs="1">
+            <xs:element name="musicFolders" type="sub:MusicFolders" minOccurs="1" maxOccurs="1"/>
+            <xs:element name="indexes" type="sub:Indexes" minOccurs="1" maxOccurs="1"/>
+            <xs:element name="directory" type="sub:Directory" minOccurs="1" maxOccurs="1"/>
+            <xs:element name="artists" type="sub:ArtistsID3" minOccurs="1" maxOccurs="1"/>
+            <xs:element name="artist" type="sub:ArtistWithAlbumsID3" minOccurs="1" maxOccurs="1"/>
+            <xs:element name="album" type="sub:AlbumWithSongsID3" minOccurs="1" maxOccurs="1"/>
+            <xs:element name="song" type="sub:Child" minOccurs="1" maxOccurs="1"/>
+            <xs:element name="videos" type="sub:Videos" minOccurs="1" maxOccurs="1"/>
+            <xs:element name="nowPlaying" type="sub:NowPlaying" minOccurs="1" maxOccurs="1"/>
+            <xs:element name="searchResult" type="sub:SearchResult" minOccurs="1" maxOccurs="1"/>
+            <xs:element name="searchResult2" type="sub:SearchResult2" minOccurs="1" maxOccurs="1"/>
+            <xs:element name="searchResult3" type="sub:SearchResult3" minOccurs="1" maxOccurs="1"/>
+            <xs:element name="playlists" type="sub:Playlists" minOccurs="1" maxOccurs="1"/>
+            <xs:element name="playlist" type="sub:PlaylistWithSongs" minOccurs="1" maxOccurs="1"/>
+            <xs:element name="jukeboxStatus" type="sub:JukeboxStatus" minOccurs="1" maxOccurs="1"/>
+            <xs:element name="jukeboxPlaylist" type="sub:JukeboxPlaylist" minOccurs="1" maxOccurs="1"/>
+            <xs:element name="license" type="sub:License" minOccurs="1" maxOccurs="1"/>
+            <xs:element name="user" type="sub:User" minOccurs="1" maxOccurs="1"/>
+            <xs:element name="chatMessages" type="sub:ChatMessages" minOccurs="1" maxOccurs="1"/>
+            <xs:element name="albumList" type="sub:AlbumList" minOccurs="1" maxOccurs="1"/>
+            <xs:element name="albumList2" type="sub:AlbumList2" minOccurs="1" maxOccurs="1"/>
+            <xs:element name="randomSongs" type="sub:RandomSongs" minOccurs="1" maxOccurs="1"/>
+            <xs:element name="lyrics" type="sub:Lyrics" minOccurs="1" maxOccurs="1"/>
+            <xs:element name="podcasts" type="sub:Podcasts" minOccurs="1" maxOccurs="1"/>
+            <xs:element name="shares" type="sub:Shares" minOccurs="1" maxOccurs="1"/>
+            <xs:element name="starred" type="sub:Starred" minOccurs="1" maxOccurs="1"/>
+            <xs:element name="starred2" type="sub:Starred2" minOccurs="1" maxOccurs="1"/>
+            <xs:element name="error" type="sub:Error" minOccurs="1" maxOccurs="1"/>
+        </xs:choice>
+        <xs:attribute name="status" type="sub:ResponseStatus" use="required"/>
+        <xs:attribute name="version" type="sub:Version" use="required"/>
+    </xs:complexType>
+
+    <xs:simpleType name="ResponseStatus">
+        <xs:restriction base="xs:string">
+            <xs:enumeration value="ok"/>
+            <xs:enumeration value="failed"/>
+        </xs:restriction>
+    </xs:simpleType>
+
+    <xs:simpleType name="Version">
+        <xs:restriction base="xs:string">
+            <xs:pattern value="\d+\.\d+\.\d+"/>
+        </xs:restriction>
+    </xs:simpleType>
+
+    <xs:complexType name="MusicFolders">
+        <xs:sequence>
+            <xs:element name="musicFolder" type="sub:MusicFolder" minOccurs="0" maxOccurs="unbounded"/>
+        </xs:sequence>
+    </xs:complexType>
+
+    <xs:complexType name="MusicFolder">
+            <xs:attribute name="id" type="xs:int" use="required"/>
+            <xs:attribute name="name" type="xs:string" use="optional"/>
+    </xs:complexType>
+
+    <xs:complexType name="Indexes">
+        <xs:sequence>
+            <xs:element name="shortcut" type="sub:Artist" minOccurs="0" maxOccurs="unbounded"/>
+            <xs:element name="index" type="sub:Index" minOccurs="0" maxOccurs="unbounded"/>
+            <xs:element name="child" type="sub:Child" minOccurs="0" maxOccurs="unbounded"/> <!-- Added in 1.7.0 -->
+        </xs:sequence>
+        <xs:attribute name="lastModified" type="xs:long" use="required"/>
+    </xs:complexType>
+
+    <xs:complexType name="Index">
+        <xs:sequence>
+            <xs:element name="artist" type="sub:Artist" minOccurs="0" maxOccurs="unbounded"/>
+        </xs:sequence>
+        <xs:attribute name="name" type="xs:string" use="required"/>
+    </xs:complexType>
+
+    <xs:complexType name="Artist">
+        <xs:attribute name="id" type="xs:string" use="required"/>
+        <xs:attribute name="name" type="xs:string" use="required"/>
+    </xs:complexType>
+
+    <xs:complexType name="ArtistsID3">
+        <xs:sequence>
+            <xs:element name="artist" type="sub:ArtistID3" minOccurs="0" maxOccurs="unbounded"/>
+        </xs:sequence>
+    </xs:complexType>
+
+    <xs:complexType name="ArtistID3">
+        <xs:attribute name="id" type="xs:string" use="required"/>
+        <xs:attribute name="name" type="xs:string" use="required"/>
+        <xs:attribute name="coverArt" type="xs:string" use="optional"/>
+        <xs:attribute name="albumCount" type="xs:int" use="required"/>
+        <xs:attribute name="starred" type="xs:dateTime" use="optional"/>
+    </xs:complexType>
+
+    <xs:complexType name="ArtistWithAlbumsID3">
+        <xs:complexContent>
+            <xs:extension base="sub:ArtistID3">
+                <xs:sequence>
+                    <xs:element name="album" type="sub:AlbumID3" minOccurs="0" maxOccurs="unbounded"/>
+                </xs:sequence>
+            </xs:extension>
+        </xs:complexContent>
+    </xs:complexType>
+
+    <xs:complexType name="AlbumID3">
+        <xs:attribute name="id" type="xs:string" use="required"/>
+        <xs:attribute name="name" type="xs:string" use="required"/>
+        <xs:attribute name="artist" type="xs:string" use="optional"/>
+        <xs:attribute name="artistId" type="xs:string" use="optional"/>
+        <xs:attribute name="coverArt" type="xs:string" use="optional"/>
+        <xs:attribute name="songCount" type="xs:int" use="required"/>
+        <xs:attribute name="duration" type="xs:int" use="required"/>
+        <xs:attribute name="created" type="xs:dateTime" use="required"/>
+        <xs:attribute name="starred" type="xs:dateTime" use="optional"/>
+    </xs:complexType>
+
+    <xs:complexType name="AlbumWithSongsID3">
+        <xs:complexContent>
+            <xs:extension base="sub:AlbumID3">
+                <xs:sequence>
+                    <xs:element name="song" type="sub:Child" minOccurs="0" maxOccurs="unbounded"/>
+                </xs:sequence>
+            </xs:extension>
+        </xs:complexContent>
+    </xs:complexType>
+
+    <xs:complexType name="Videos">
+        <xs:sequence>
+            <xs:element name="video" type="sub:Child" minOccurs="0" maxOccurs="unbounded"/>
+        </xs:sequence>
+    </xs:complexType>
+
+    <xs:complexType name="Directory">
+        <xs:sequence>
+            <xs:element name="child" type="sub:Child" minOccurs="0" maxOccurs="unbounded"/>
+        </xs:sequence>
+        <xs:attribute name="id" type="xs:string" use="required"/>
+        <xs:attribute name="parent" type="xs:string" use="optional"/>
+        <xs:attribute name="name" type="xs:string" use="required"/>
+    </xs:complexType>
+
+    <xs:complexType name="Child">
+        <xs:attribute name="id" type="xs:string" use="required"/>
+        <xs:attribute name="parent" type="xs:string" use="optional"/>
+        <xs:attribute name="isDir" type="xs:boolean" use="required"/>
+        <xs:attribute name="title" type="xs:string" use="required"/>
+        <xs:attribute name="album" type="xs:string" use="optional"/>
+        <xs:attribute name="artist" type="xs:string" use="optional"/>
+        <xs:attribute name="track" type="xs:int" use="optional"/>
+        <xs:attribute name="year" type="xs:int" use="optional"/>
+        <xs:attribute name="genre" type="xs:string" use="optional"/>
+        <xs:attribute name="coverArt" type="xs:string" use="optional"/>
+        <xs:attribute name="size" type="xs:long" use="optional"/>
+        <xs:attribute name="contentType" type="xs:string" use="optional"/>
+        <xs:attribute name="suffix" type="xs:string" use="optional"/>
+        <xs:attribute name="transcodedContentType" type="xs:string" use="optional"/>
+        <xs:attribute name="transcodedSuffix" type="xs:string" use="optional"/>
+        <xs:attribute name="duration" type="xs:int" use="optional"/>
+        <xs:attribute name="bitRate" type="xs:int" use="optional"/>
+        <xs:attribute name="path" type="xs:string" use="optional"/>
+        <xs:attribute name="isVideo" type="xs:boolean" use="optional"/>  <!-- Added in 1.4.1 -->
+        <xs:attribute name="userRating" type="sub:UserRating" use="optional"/>  <!-- Added in 1.6.0 -->
+        <xs:attribute name="averageRating" type="sub:AverageRating" use="optional"/>  <!-- Added in 1.6.0 -->
+        <xs:attribute name="discNumber" type="xs:int" use="optional"/>  <!-- Added in 1.8.0 -->
+        <xs:attribute name="created" type="xs:dateTime" use="optional"/>  <!-- Added in 1.8.0 -->
+        <xs:attribute name="starred" type="xs:dateTime" use="optional"/>  <!-- Added in 1.8.0 -->
+        <xs:attribute name="albumId" type="xs:string" use="optional"/>  <!-- Added in 1.8.0 -->
+        <xs:attribute name="artistId" type="xs:string" use="optional"/>  <!-- Added in 1.8.0 -->
+        <xs:attribute name="type" type="sub:MediaType" use="optional"/>  <!-- Added in 1.8.0 -->
+    </xs:complexType>
+
+    <xs:simpleType name="MediaType">
+        <xs:restriction base="xs:string">
+            <xs:enumeration value="music"/>
+            <xs:enumeration value="podcast"/>
+            <xs:enumeration value="audiobook"/>
+            <xs:enumeration value="video"/>
+        </xs:restriction>
+    </xs:simpleType>
+
+    <xs:simpleType name="UserRating">
+        <xs:restriction base="xs:int">
+            <xs:minInclusive value="1"/>
+            <xs:maxInclusive value="5"/>
+        </xs:restriction>
+    </xs:simpleType>
+
+    <xs:simpleType name="AverageRating">
+        <xs:restriction base="xs:double">
+            <xs:minInclusive value="1.0"/>
+            <xs:maxInclusive value="5.0"/>
+        </xs:restriction>
+    </xs:simpleType>
+
+    <xs:complexType name="NowPlaying">
+        <xs:sequence>
+            <xs:element name="entry" type="sub:NowPlayingEntry" minOccurs="0" maxOccurs="unbounded"/>
+        </xs:sequence>
+    </xs:complexType>
+
+    <xs:complexType name="NowPlayingEntry">
+        <xs:complexContent>
+            <xs:extension base="sub:Child">
+                <xs:attribute name="username" type="xs:string" use="required"/>
+                <xs:attribute name="minutesAgo" type="xs:int" use="required"/>
+                <xs:attribute name="playerId" type="xs:int" use="required"/>
+                <xs:attribute name="playerName" type="xs:string" use="optional"/>
+            </xs:extension>
+        </xs:complexContent>
+    </xs:complexType>
+
+    <!--Deprecated-->
+    <xs:complexType name="SearchResult">
+        <xs:sequence>
+            <xs:element name="match" type="sub:Child" minOccurs="0" maxOccurs="unbounded"/>
+        </xs:sequence>
+        <xs:attribute name="offset" type="xs:int" use="required"/>
+        <xs:attribute name="totalHits" type="xs:int" use="required"/>
+    </xs:complexType>
+
+    <xs:complexType name="SearchResult2">
+        <xs:sequence>
+            <xs:element name="artist" type="sub:Artist" minOccurs="0" maxOccurs="unbounded"/>
+            <xs:element name="album" type="sub:Child" minOccurs="0" maxOccurs="unbounded"/>
+            <xs:element name="song" type="sub:Child" minOccurs="0" maxOccurs="unbounded"/>
+        </xs:sequence>
+    </xs:complexType>
+
+    <xs:complexType name="SearchResult3">
+        <xs:sequence>
+            <xs:element name="artist" type="sub:ArtistID3" minOccurs="0" maxOccurs="unbounded"/>
+            <xs:element name="album" type="sub:AlbumID3" minOccurs="0" maxOccurs="unbounded"/>
+            <xs:element name="song" type="sub:Child" minOccurs="0" maxOccurs="unbounded"/>
+        </xs:sequence>
+    </xs:complexType>
+
+    <xs:complexType name="Playlists">
+        <xs:sequence>
+            <xs:element name="playlist" type="sub:Playlist" minOccurs="0" maxOccurs="unbounded"/>
+        </xs:sequence>
+    </xs:complexType>
+
+    <xs:complexType name="Playlist">
+        <xs:sequence>
+            <xs:element name="allowedUser" type="xs:string" minOccurs="0" maxOccurs="unbounded"/> <!--Added in 1.8.0-->
+        </xs:sequence>
+        <xs:attribute name="id" type="xs:string" use="required"/>
+        <xs:attribute name="name" type="xs:string" use="required"/>
+        <xs:attribute name="comment" type="xs:string" use="optional"/>   <!--Added in 1.8.0-->
+        <xs:attribute name="owner" type="xs:string" use="optional"/>    <!--Added in 1.8.0-->
+        <xs:attribute name="public" type="xs:boolean" use="optional"/>   <!--Added in 1.8.0-->
+        <xs:attribute name="songCount" type="xs:int" use="required"/>    <!--Added in 1.8.0-->
+        <xs:attribute name="duration" type="xs:int" use="required"/>     <!--Added in 1.8.0-->
+        <xs:attribute name="created" type="xs:dateTime" use="required"/> <!--Added in 1.8.0-->
+    </xs:complexType>
+
+    <xs:complexType name="PlaylistWithSongs">
+        <xs:complexContent>
+            <xs:extension base="sub:Playlist">
+                <xs:sequence>
+                    <xs:element name="entry" type="sub:Child" minOccurs="0" maxOccurs="unbounded"/>
+                </xs:sequence>
+            </xs:extension>
+        </xs:complexContent>
+    </xs:complexType>
+
+    <xs:complexType name="JukeboxStatus">
+        <xs:attribute name="currentIndex" type="xs:int" use="required"/>
+        <xs:attribute name="playing" type="xs:boolean" use="required"/>
+        <xs:attribute name="gain" type="xs:float" use="required"/>
+        <xs:attribute name="position" type="xs:int" use="optional"/> <!--Added in 1.7.0-->
+    </xs:complexType>
+
+    <xs:complexType name="JukeboxPlaylist">
+        <xs:complexContent>
+            <xs:extension base="sub:JukeboxStatus">
+                <xs:sequence>
+                    <xs:element name="entry" type="sub:Child" minOccurs="0" maxOccurs="unbounded"/>
+                </xs:sequence>
+            </xs:extension>
+        </xs:complexContent>
+    </xs:complexType>
+
+    <xs:complexType name="ChatMessages">
+        <xs:sequence>
+            <xs:element name="chatMessage" type="sub:ChatMessage" minOccurs="0" maxOccurs="unbounded"/>
+        </xs:sequence>
+    </xs:complexType>
+
+    <xs:complexType name="ChatMessage">
+        <xs:attribute name="username" type="xs:string" use="required"/>
+        <xs:attribute name="time" type="xs:long" use="required"/>
+        <xs:attribute name="message" type="xs:string" use="required"/>
+    </xs:complexType>
+
+    <xs:complexType name="AlbumList">
+        <xs:sequence>
+            <xs:element name="album" type="sub:Child" minOccurs="0" maxOccurs="unbounded"/>
+        </xs:sequence>
+    </xs:complexType>
+
+    <xs:complexType name="AlbumList2">
+        <xs:sequence>
+            <xs:element name="album" type="sub:AlbumID3" minOccurs="0" maxOccurs="unbounded"/>
+        </xs:sequence>
+    </xs:complexType>
+
+    <xs:complexType name="RandomSongs">
+        <xs:sequence>
+            <xs:element name="song" type="sub:Child" minOccurs="0" maxOccurs="unbounded"/>
+        </xs:sequence>
+    </xs:complexType>
+
+    <xs:complexType name="Lyrics" mixed="true">
+        <xs:attribute name="artist" type="xs:string" use="optional"/>
+        <xs:attribute name="title" type="xs:string" use="optional"/>
+    </xs:complexType>
+
+    <xs:complexType name="Podcasts">
+        <xs:sequence>
+            <xs:element name="channel" type="sub:PodcastChannel" minOccurs="0" maxOccurs="unbounded"/>
+        </xs:sequence>
+    </xs:complexType>
+
+    <xs:complexType name="PodcastChannel">
+        <xs:sequence>
+            <xs:element name="episode" type="sub:PodcastEpisode" minOccurs="0" maxOccurs="unbounded"/>
+        </xs:sequence>
+        <xs:attribute name="id" type="xs:string" use="required"/>
+        <xs:attribute name="url" type="xs:string" use="required"/>
+        <xs:attribute name="title" type="xs:string" use="optional"/>
+        <xs:attribute name="description" type="xs:string" use="optional"/>
+        <xs:attribute name="status" type="sub:PodcastStatus" use="required"/>
+        <xs:attribute name="errorMessage" type="xs:string" use="optional"/>
+    </xs:complexType>
+
+    <xs:complexType name="PodcastEpisode">
+        <xs:complexContent>
+            <xs:extension base="sub:Child">
+                <xs:attribute name="streamId" type="xs:string" use="optional"/> <!-- Use this ID for streaming the podcast. -->
+                <xs:attribute name="description" type="xs:string" use="optional"/>
+                <xs:attribute name="status" type="sub:PodcastStatus" use="required"/>
+                <xs:attribute name="publishDate" type="xs:dateTime" use="optional"/>
+            </xs:extension>
+        </xs:complexContent>
+    </xs:complexType>
+
+    <xs:simpleType name="PodcastStatus">
+        <xs:restriction base="xs:string">
+            <xs:enumeration value="new"/>
+            <xs:enumeration value="downloading"/>
+            <xs:enumeration value="completed"/>
+            <xs:enumeration value="error"/>
+            <xs:enumeration value="deleted"/>
+            <xs:enumeration value="skipped"/>
+        </xs:restriction>
+    </xs:simpleType>
+
+    <xs:complexType name="Shares">
+        <xs:sequence>
+            <xs:element name="share" type="sub:Share" minOccurs="0" maxOccurs="unbounded"/>
+        </xs:sequence>
+    </xs:complexType>
+
+    <xs:complexType name="Share">
+        <xs:sequence>
+            <xs:element name="entry" type="sub:Child" minOccurs="0" maxOccurs="unbounded"/>
+        </xs:sequence>
+        <xs:attribute name="id" type="xs:string" use="required"/>
+        <xs:attribute name="url" type="xs:string" use="required"/>
+        <xs:attribute name="description" type="xs:string" use="optional"/>
+        <xs:attribute name="username" type="xs:string" use="required"/>
+        <xs:attribute name="created" type="xs:dateTime" use="required"/>
+        <xs:attribute name="expires" type="xs:dateTime" use="optional"/>
+        <xs:attribute name="lastVisited" type="xs:dateTime" use="optional"/>
+        <xs:attribute name="visitCount" type="xs:int" use="required"/>
+    </xs:complexType>
+
+    <xs:complexType name="Starred">
+        <xs:sequence>
+            <xs:element name="artist" type="sub:Artist" minOccurs="0" maxOccurs="unbounded"/>
+            <xs:element name="album" type="sub:Child" minOccurs="0" maxOccurs="unbounded"/>
+            <xs:element name="song" type="sub:Child" minOccurs="0" maxOccurs="unbounded"/>
+        </xs:sequence>
+    </xs:complexType>
+
+    <xs:complexType name="Starred2">
+        <xs:sequence>
+            <xs:element name="artist" type="sub:ArtistID3" minOccurs="0" maxOccurs="unbounded"/>
+            <xs:element name="album" type="sub:AlbumID3" minOccurs="0" maxOccurs="unbounded"/>
+            <xs:element name="song" type="sub:Child" minOccurs="0" maxOccurs="unbounded"/>
+        </xs:sequence>
+    </xs:complexType>
+
+    <xs:complexType name="License">
+        <xs:attribute name="valid" type="xs:boolean" use="required"/>
+        <xs:attribute name="email" type="xs:string" use="optional"/>
+        <xs:attribute name="key" type="xs:string" use="optional"/>
+        <xs:attribute name="date" type="xs:dateTime" use="optional"/>
+    </xs:complexType>
+
+    <xs:complexType name="User">
+        <xs:attribute name="username" type="xs:string" use="required"/>
+        <xs:attribute name="email" type="xs:string" use="optional"/> <!-- Added in 1.6.0 --> 
+        <xs:attribute name="scrobblingEnabled" type="xs:boolean" use="required"/> <!-- Added in 1.7.0 -->
+        <xs:attribute name="adminRole" type="xs:boolean" use="required"/>
+        <xs:attribute name="settingsRole" type="xs:boolean" use="required"/>
+        <xs:attribute name="downloadRole" type="xs:boolean" use="required"/>
+        <xs:attribute name="uploadRole" type="xs:boolean" use="required"/>
+        <xs:attribute name="playlistRole" type="xs:boolean" use="required"/>
+        <xs:attribute name="coverArtRole" type="xs:boolean" use="required"/>
+        <xs:attribute name="commentRole" type="xs:boolean" use="required"/>
+        <xs:attribute name="podcastRole" type="xs:boolean" use="required"/>
+        <xs:attribute name="streamRole" type="xs:boolean" use="required"/>
+        <xs:attribute name="jukeboxRole" type="xs:boolean" use="required"/>
+        <xs:attribute name="shareRole" type="xs:boolean" use="required"/> <!-- Added in 1.7.0 -->
+    </xs:complexType>
+
+    <xs:complexType name="Error">
+        <xs:attribute name="code" type="xs:int" use="required"/>
+        <xs:attribute name="message" type="xs:string" use="optional"/>
+    </xs:complexType>
+
+</xs:schema>
\ No newline at end of file
-- 
cgit v1.2.3