summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars-Dominik Braun <lars@6xq.net>2014-07-17 14:48:25 +0200
committerLars-Dominik Braun <lars@6xq.net>2014-07-17 14:48:25 +0200
commit14cd9baa6abf615c4b5ac2b25611b838ae2a0d4e (patch)
tree158b9d9bff8334e146d594bc873409ea48086a0c
parent29de6ef492cde0380f9ff03e4d73e4cd12541b01 (diff)
downloadpandora-apidoc-14cd9baa6abf615c4b5ac2b25611b838ae2a0d4e.tar.gz
pandora-apidoc-14cd9baa6abf615c4b5ac2b25611b838ae2a0d4e.tar.bz2
pandora-apidoc-14cd9baa6abf615c4b5ac2b25611b838ae2a0d4e.zip
Use “pair” for method index entries
-rw-r--r--json/account.rst14
-rw-r--r--json/authentication.rst6
-rw-r--r--json/bookmarks.rst6
-rw-r--r--json/index.rst5
-rw-r--r--json/play.rst8
-rw-r--r--json/stations.rst28
6 files changed, 33 insertions, 34 deletions
diff --git a/json/account.rst b/json/account.rst
index 7eaa8f2..7fdedc7 100644
--- a/json/account.rst
+++ b/json/account.rst
@@ -3,7 +3,7 @@ Account
.. index::
- single: user.validateUsername
+ pair: method; user.validateUsername
.. _user-validateUsername:
@@ -28,7 +28,7 @@ This method can be used before authenticating a user with
.. index::
- single: user.createUser
+ pair: method; user.createUser
.. _user-createUser:
@@ -94,7 +94,7 @@ The following settings are currently read/writeable:
.. index::
- single: user.getSettings
+ pair: method; user.getSettings
.. _user-getSettings:
@@ -112,7 +112,7 @@ See :ref:`settingkeys` for return values.
.. index::
- single: user.changeSettings
+ pair: method; user.changeSettings
.. _user-changeSettings:
@@ -133,7 +133,7 @@ body.
.. index::
- single: user.emailPassword
+ pair: method; user.emailPassword
.. _user-emailPassword:
@@ -151,7 +151,7 @@ Recover password
.. index::
- single: user.canSubscribe
+ pair: method; user.canSubscribe
.. _user-canSubscribe:
@@ -186,7 +186,7 @@ Can be useful to determine which :ref:`Partner password<partners>` to use.
.. index::
- single: user.getUsageInfo
+ pair: method; user.getUsageInfo
.. _user-getUsageInfo:
diff --git a/json/authentication.rst b/json/authentication.rst
index 28fdf00..e4ae48c 100644
--- a/json/authentication.rst
+++ b/json/authentication.rst
@@ -7,7 +7,7 @@ Authentication is divided into two steps: Partner and user login.
.. index::
- single: test.checkLicensing
+ pair: method; test.checkLicensing
.. _test-checkLicensing:
@@ -27,7 +27,7 @@ enforces this restriction. The request has no parameters.
.. index::
- single: auth.partnerLogin
+ pair: method; auth.partnerLogin
.. _auth-partnerLogin:
@@ -101,7 +101,7 @@ Code Description
.. index::
- single: auth.userLogin
+ pair: method; auth.userLogin
.. _auth-userLogin:
diff --git a/json/bookmarks.rst b/json/bookmarks.rst
index f8023e4..60b1e75 100644
--- a/json/bookmarks.rst
+++ b/json/bookmarks.rst
@@ -5,7 +5,7 @@ Users can bookmark artists or songs.
.. index::
- single: user.getBookmarks
+ pair: method; user.getBookmarks
.. _user-getBookmarks:
@@ -71,7 +71,7 @@ The request has no parameters.
.. index::
- single: bookmark.addArtistBookmark
+ pair: method; bookmark.addArtistBookmark
.. _bookmark-addArtistBookmark:
@@ -118,7 +118,7 @@ Add artist bookmark
.. index::
- single: bookmark.addSongBookmark
+ pair: method; bookmark.addSongBookmark
.. _bookmark-addSongBookmark:
diff --git a/json/index.rst b/json/index.rst
index 0fbdf6c..a7b0fea 100644
--- a/json/index.rst
+++ b/json/index.rst
@@ -15,8 +15,7 @@ The current JSON API version is 5. Two different endpoints are available:
.. index::
- single: bodyenc
- single: Blowfish encryption
+ Blowfish encryption, HTTP request
.. _bodyenc:
@@ -44,7 +43,7 @@ The following values must be present in every JSON request object (if available)
.. index::
- single: synctime
+ Time synchronization
.. _synctime:
diff --git a/json/play.rst b/json/play.rst
index 56508e0..a7de14c 100644
--- a/json/play.rst
+++ b/json/play.rst
@@ -5,7 +5,7 @@ Play
.. index::
- single: station.getPlaylist
+ pair: method; station.getPlaylist
.. _station-getPlaylist:
@@ -124,7 +124,7 @@ Usually a playlist contains four tracks.
.. index::
- single: station.addFeedback
+ pair: method; station.addFeedback
.. _station-addFeedback:
@@ -193,7 +193,7 @@ station. Banned songs are never played again on this particular station.
.. index::
- single: user.sleepSong
+ pair: method; user.sleepSong
.. _user-sleepSong:
@@ -221,7 +221,7 @@ Nothing is returned in the response.
.. index::
- single: track.explainTrack
+ pair: method; track.explainTrack
.. _track-explainTrack:
diff --git a/json/stations.rst b/json/stations.rst
index 54fee44..bb83826 100644
--- a/json/stations.rst
+++ b/json/stations.rst
@@ -9,7 +9,7 @@ play.
.. index::
- single: user.getStationList
+ pair: method; user.getStationList
.. _user-getStationList:
@@ -91,7 +91,7 @@ QuickMix stations additionally include a list of station ids
.. index::
- single: user.getStationListChecksum
+ pair: method; user.getStationListChecksum
.. _user-getStationListChecksum:
@@ -127,7 +127,7 @@ from a playlist.
.. index::
- single: music.search
+ pair: method; music.search
.. _music-search:
@@ -182,7 +182,7 @@ Matching songs and artists are returned in two separate list.
.. index::
- single: user.createStation
+ pair: method; user.createStation
.. _station-createStation:
@@ -205,7 +205,7 @@ should be used as seed.
.. index::
- single: station.addMusic
+ pair: method; station.addMusic
.. _station-addMusic:
@@ -262,7 +262,7 @@ station.
.. index::
- single: station.deleteMusic
+ pair: method; station.deleteMusic
.. _station-deleteMusic:
@@ -295,7 +295,7 @@ This method does not return data.
.. index::
- single: station.renameStation
+ pair: method; station.renameStation
.. _station-renameStation:
@@ -312,7 +312,7 @@ Rename station
.. index::
- single: station.deleteStation
+ pair: method; station.deleteStation
.. _station-deleteStation:
@@ -338,7 +338,7 @@ No data is returned in response.
.. index::
- single: station.getStation
+ pair: method; station.getStation
.. _station-getStation:
@@ -476,7 +476,7 @@ Extended station information includes seeds and feedback.
.. index::
- single: station.deleteFeedback
+ pair: method; station.deleteFeedback
.. _station-deleteFeedback:
@@ -504,7 +504,7 @@ This method has does not return data.
.. index::
- single: station.getGenreStations
+ pair: method; station.getGenreStations
.. _station-getGenreStations:
@@ -545,7 +545,7 @@ used as musicToken to create a new station with :ref:`station-createStation`.
.. index::
- single: station.getGenreStationsChecksum
+ pair: method; station.getGenreStationsChecksum
.. _station-getGenreStationsChecksum:
@@ -568,7 +568,7 @@ See :ref:`user-getStationListChecksum`.
.. index::
- single: station.transformSharedStation
+ pair: method; station.transformSharedStation
.. _station-transformSharedStation:
@@ -587,7 +587,7 @@ list. These stations cannot be modified (i.e. rate tracks) unless transformed.
.. index::
- single: user.setQuickMix
+ pair: method; user.setQuickMix
.. _user-setQuickMix: