From 1e99054e01bf22c0c45190bee1e16c5390811ccf Mon Sep 17 00:00:00 2001 From: alphayax Date: Sat, 11 Jun 2016 22:17:19 +0200 Subject: [PATCH] Tests documentation generation --- docs/AirMedia/AirMedia.md | 6 +- docs/Call/Call.md | 11 +++- docs/Call/Contact/Contact.md | 12 +++- docs/FileSystem/FileSystem.md | 30 ++++++---- docs/ParentalControl/ParentalControl.md | 6 +- docs/RRD/RRD.md | 4 +- docs/Storage/Storage.md | 12 ++-- docs/config/Connection/Connection.md | 15 ++++- docs/config/Connection/DynDns/DynDns.md | 8 ++- docs/config/LAN/LAN.md | 6 +- docs/config/NAT/NAT.md | 8 ++- docs/config/NetworkShare/NetworkShare.md | 6 +- docs/config/SwitchPort/SwitchPort.md | 8 ++- docs/config/UPnP/UPnP.md | 6 +- docs/config/VPN/Client/Client.md | 6 +- docs/config/VPN/Server/Server.md | 10 +++- docs/config/VPN/VPN.md | 12 +++- docs/config/WiFi/WiFi.md | 15 ++++- docs/config/config.md | 61 ++++++++++++++++--- docs/download/download.md | 44 +++++++------- docs/login/login.md | 6 +- docs/services.md | 75 +++++++++++++++++++++++- 22 files changed, 295 insertions(+), 72 deletions(-) diff --git a/docs/AirMedia/AirMedia.md b/docs/AirMedia/AirMedia.md index 8a7b2ec..55c9fac 100644 --- a/docs/AirMedia/AirMedia.md +++ b/docs/AirMedia/AirMedia.md @@ -1,7 +1,10 @@ - # AirMedia +- [AirMediaReceiver](#AirMediaReceiver) +- [Config](#Config) + +" ## AirMediaReceiver **Namespace** : alphayax\freebox\api\v3\services\AirMedia @@ -13,6 +16,7 @@ | `getAll` | Get the list of AirMediaReceiver connected to the Freebox Server | | `sendRequest` | Sending a request to an AirMedia receiver | +" ## Config **Namespace** : alphayax\freebox\api\v3\services\AirMedia diff --git a/docs/Call/Call.md b/docs/Call/Call.md index ff6fc06..a39a8f2 100644 --- a/docs/Call/Call.md +++ b/docs/Call/Call.md @@ -1,8 +1,15 @@ - # Call -- [Contact](./Call/Contact/Contact.md) +- [Contact](./Contact/Contact.md) + - [ContactAddress](#ContactAddress) + - [ContactEmail](#ContactEmail) + - [ContactEntry](#ContactEntry) + - [ContactNumber](#ContactNumber) + - [ContactUrl](#ContactUrl) +- [CallEntry](#CallEntry) + +" ## CallEntry **Namespace** : alphayax\freebox\api\v3\services\Call diff --git a/docs/Call/Contact/Contact.md b/docs/Call/Contact/Contact.md index 55406cd..1e18c6f 100644 --- a/docs/Call/Contact/Contact.md +++ b/docs/Call/Contact/Contact.md @@ -1,7 +1,13 @@ - # Contact +- [ContactAddress](#ContactAddress) +- [ContactEmail](#ContactEmail) +- [ContactEntry](#ContactEntry) +- [ContactNumber](#ContactNumber) +- [ContactUrl](#ContactUrl) + +" ## ContactAddress **Namespace** : alphayax\freebox\api\v3\services\Call\Contact @@ -16,6 +22,7 @@ | `deleteFromId` | Remove an address (with the given id) | | `update` | Update an address | +" ## ContactEmail **Namespace** : alphayax\freebox\api\v3\services\Call\Contact @@ -30,6 +37,7 @@ | `deleteFromId` | Remove an email contact (with the given id) | | `update` | Update an email contact | +" ## ContactEntry **Namespace** : alphayax\freebox\api\v3\services\Call\Contact @@ -49,6 +57,7 @@ | `getContactEmailsFromContactId` | Get all email addresses associated to a given contact id | | `getContactUrlsFromContactId` | Get all URLs associated to a given contact id | +" ## ContactNumber **Namespace** : alphayax\freebox\api\v3\services\Call\Contact @@ -63,6 +72,7 @@ | `deleteFromId` | Remove a contact number (with the specified id) | | `update` | Update a contact number | +" ## ContactUrl **Namespace** : alphayax\freebox\api\v3\services\Call\Contact diff --git a/docs/FileSystem/FileSystem.md b/docs/FileSystem/FileSystem.md index 4f9487c..644d68b 100644 --- a/docs/FileSystem/FileSystem.md +++ b/docs/FileSystem/FileSystem.md @@ -1,7 +1,13 @@ - # FileSystem +- [FileSharingLink](#FileSharingLink) +- [FileSystemListing](#FileSystemListing) +- [FileSystemOperation](#FileSystemOperation) +- [FileSystemTask](#FileSystemTask) +- [FileUpload](#FileUpload) + +" ## FileSharingLink **Namespace** : alphayax\freebox\api\v3\services\FileSystem @@ -12,10 +18,10 @@ |---|---| | `getAll` | Retrieve a File Sharing link | | `getFromToken` | | -| `deleteFromToken` | Delete a File Sharing link -Deletes the ShareLink task with the given token, if the task was running, stop it. | +| `deleteFromToken` | Delete a File Sharing link Deletes the ShareLink task with the given token, if the task was running, stop it. | | `create` | Create a File Sharing link | +" ## FileSystemListing **Namespace** : alphayax\freebox\api\v3\services\FileSystem @@ -27,6 +33,7 @@ Deletes the ShareLink task with the given token, if the task was running, stop i | `getFilesFromDirectory` | | | `getFileInformation` | Get file information | +" ## FileSystemOperation **Namespace** : alphayax\freebox\api\v3\services\FileSystem @@ -42,16 +49,13 @@ Deletes the ShareLink task with the given token, if the task was running, stop i | `archive` | Create an archive | | `extract` | Extract an archive | | `repair` | Repair files from a .par2 | -| `computeHash` | Hash a file. This operation can take some time. To get the hash value, -the returned task must have succeed and be in the state “done”. | -| `getHashValue` | Get the hash value -To get the hash, the task must have succeed and be in the state “done”. | -| `createDirectory` | Create a directory -Contrary to other file system tasks, this operation is done synchronously. | -| `rename` | Rename a file/folder -Contrary to other file system tasks, this operation is done synchronously. | +| `computeHash` | Hash a file. This operation can take some time. To get the hash value, the returned task must have succeed and be in the state “done”. | +| `getHashValue` | Get the hash value To get the hash, the task must have succeed and be in the state “done”. | +| `createDirectory` | Create a directory Contrary to other file system tasks, this operation is done synchronously. | +| `rename` | Rename a file/folder Contrary to other file system tasks, this operation is done synchronously. | | `download` | Download a file from the freebox server | +" ## FileSystemTask **Namespace** : alphayax\freebox\api\v3\services\FileSystem @@ -66,6 +70,7 @@ Contrary to other file system tasks, this operation is done synchronously. | | `deleteTaskById` | | | `updateTask` | | +" ## FileUpload **Namespace** : alphayax\freebox\api\v3\services\FileSystem @@ -78,7 +83,6 @@ Contrary to other file system tasks, this operation is done synchronously. | | `uploadFile` | Send the content of the FileUpload task | | `getAll` | Get the list of uploads | | `getFromId` | Track an upload status | -| `cancelFromId` | Cancel the given FileUpload closing the connection -The upload status must be in_progress | +| `cancelFromId` | Cancel the given FileUpload closing the connection The upload status must be in_progress | | `deleteFromId` | Delete the given FileUpload closing the connection if needed | | `cleanTerminated` | Deletes all the FileUpload not in_progress | diff --git a/docs/ParentalControl/ParentalControl.md b/docs/ParentalControl/ParentalControl.md index 0a10033..2c1641e 100644 --- a/docs/ParentalControl/ParentalControl.md +++ b/docs/ParentalControl/ParentalControl.md @@ -1,7 +1,10 @@ - # ParentalControl +- [Filter](#Filter) +- [FilterPlanning](#FilterPlanning) + +" ## Filter **Namespace** : alphayax\freebox\api\v3\services\ParentalControl @@ -19,6 +22,7 @@ | `deleteFromId` | | | `add` | | +" ## FilterPlanning **Namespace** : alphayax\freebox\api\v3\services\ParentalControl diff --git a/docs/RRD/RRD.md b/docs/RRD/RRD.md index abae177..4b3f9d3 100644 --- a/docs/RRD/RRD.md +++ b/docs/RRD/RRD.md @@ -1,7 +1,9 @@ - # RRD +- [Fetch](#Fetch) + +" ## Fetch **Namespace** : alphayax\freebox\api\v3\services\RRD diff --git a/docs/Storage/Storage.md b/docs/Storage/Storage.md index 7d1ae82..86c34c6 100644 --- a/docs/Storage/Storage.md +++ b/docs/Storage/Storage.md @@ -1,7 +1,10 @@ - # Storage +- [Disk](#Disk) +- [Partition](#Partition) + +" ## Disk **Namespace** : alphayax\freebox\api\v3\services\Storage @@ -13,9 +16,9 @@ | `getAll` | Get the list of disks | | `getFromId` | Get a given disk info | | `update` | Update a disk state | -| `format` | Format the disk with the given id -There will be one partition using all the available space on disk. All previous data will be lost. | +| `format` | Format the disk with the given id There will be one partition using all the available space on disk. All previous data will be lost. | +" ## Partition **Namespace** : alphayax\freebox\api\v3\services\Storage @@ -26,5 +29,4 @@ There will be one partition using all the available space on disk. All previous |---|---| | `getAll` | Get the list of partitions | | `getFromId` | Get a given partition info | -| `check` | Checks the partition with the given id -*NOTE* once started you can monitor the fsck process getting the partition information | +| `check` | Checks the partition with the given id *NOTE* once started you can monitor the fsck process getting the partition information | diff --git a/docs/config/Connection/Connection.md b/docs/config/Connection/Connection.md index be4b4c7..b23e9ec 100644 --- a/docs/config/Connection/Connection.md +++ b/docs/config/Connection/Connection.md @@ -1,8 +1,16 @@ - # Connection -- [DynDns](./config/Connection/DynDns/DynDns.md) +- [DynDns](./DynDns/DynDns.md) + - [DynDns](#DynDns) + - [NoIP](#NoIP) + - [Ovh](#Ovh) +- [Connection](#Connection) +- [DynDns](#DynDns) +- [Ftth](#Ftth) +- [Xdsl](#Xdsl) + +" ## Connection **Namespace** : alphayax\freebox\api\v3\services\config\Connection @@ -17,6 +25,7 @@ | `getIPv6Configuration` | Get the current IPv6 Connection configuration | | `setIPv6Configuration` | Update the IPv6 Connection configuration | +" ## DynDns **Namespace** : alphayax\freebox\api\v3\services\config\Connection @@ -29,6 +38,7 @@ | `getConfig` | Get the current DDns Configuration | | `setConfig` | Set the DDns Configuration | +" ## Ftth **Namespace** : alphayax\freebox\api\v3\services\config\Connection @@ -39,6 +49,7 @@ |---|---| | `getStatus` | Get the current Connection status | +" ## Xdsl **Namespace** : alphayax\freebox\api\v3\services\config\Connection diff --git a/docs/config/Connection/DynDns/DynDns.md b/docs/config/Connection/DynDns/DynDns.md index 757a501..8099e9f 100644 --- a/docs/config/Connection/DynDns/DynDns.md +++ b/docs/config/Connection/DynDns/DynDns.md @@ -1,7 +1,11 @@ - # DynDns +- [DynDns](#DynDns) +- [NoIP](#NoIP) +- [Ovh](#Ovh) + +" ## DynDns **Namespace** : alphayax\freebox\api\v3\services\config\Connection\DynDns @@ -14,6 +18,7 @@ | `getConfig` | | | `setConfig` | | +" ## NoIP **Namespace** : alphayax\freebox\api\v3\services\config\Connection\DynDns @@ -26,6 +31,7 @@ | `getConfig` | | | `setConfig` | | +" ## Ovh **Namespace** : alphayax\freebox\api\v3\services\config\Connection\DynDns diff --git a/docs/config/LAN/LAN.md b/docs/config/LAN/LAN.md index 063d1f2..003eb3b 100644 --- a/docs/config/LAN/LAN.md +++ b/docs/config/LAN/LAN.md @@ -1,7 +1,10 @@ - # LAN +- [Browser](#Browser) +- [LAN](#LAN) + +" ## Browser **Namespace** : alphayax\freebox\api\v3\services\config\LAN @@ -17,6 +20,7 @@ | `updateHostFromInterfaceId` | | | `wakeOnLan` | Send Wake ok Lan packet to an host | +" ## LAN **Namespace** : alphayax\freebox\api\v3\services\config\LAN diff --git a/docs/config/NAT/NAT.md b/docs/config/NAT/NAT.md index 76346c0..7dcd6f7 100644 --- a/docs/config/NAT/NAT.md +++ b/docs/config/NAT/NAT.md @@ -1,7 +1,11 @@ - # NAT +- [DMZ](#DMZ) +- [IncomingPort](#IncomingPort) +- [PortForwarding](#PortForwarding) + +" ## DMZ **Namespace** : alphayax\freebox\api\v3\services\config\NAT @@ -13,6 +17,7 @@ | `getConfiguration` | Get the current Dmz configuration | | `setConfiguration` | Update the current Dmz configuration | +" ## IncomingPort **Namespace** : alphayax\freebox\api\v3\services\config\NAT @@ -25,6 +30,7 @@ | `getById` | Getting a specific incoming port | | `update` | Updating an incoming port | +" ## PortForwarding **Namespace** : alphayax\freebox\api\v3\services\config\NAT diff --git a/docs/config/NetworkShare/NetworkShare.md b/docs/config/NetworkShare/NetworkShare.md index a6a22dc..edbe14b 100644 --- a/docs/config/NetworkShare/NetworkShare.md +++ b/docs/config/NetworkShare/NetworkShare.md @@ -1,7 +1,10 @@ - # NetworkShare +- [Afp](#Afp) +- [Samba](#Samba) + +" ## Afp **Namespace** : alphayax\freebox\api\v3\services\config\NetworkShare @@ -13,6 +16,7 @@ | `getConfiguration` | Get the current Afp configuration | | `setConfiguration` | Update the Afp configuration | +" ## Samba **Namespace** : alphayax\freebox\api\v3\services\config\NetworkShare diff --git a/docs/config/SwitchPort/SwitchPort.md b/docs/config/SwitchPort/SwitchPort.md index 1b11848..89c25d8 100644 --- a/docs/config/SwitchPort/SwitchPort.md +++ b/docs/config/SwitchPort/SwitchPort.md @@ -1,7 +1,11 @@ - # SwitchPort +- [Config](#Config) +- [Stats](#Stats) +- [Status](#Status) + +" ## Config **Namespace** : alphayax\freebox\api\v3\services\config\SwitchPort @@ -13,6 +17,7 @@ | `getFromPortId` | Get a port configuration | | `update` | Update a port configuration | +" ## Stats **Namespace** : alphayax\freebox\api\v3\services\config\SwitchPort @@ -23,6 +28,7 @@ |---|---| | `getFromPortId` | Get a port configuration | +" ## Status **Namespace** : alphayax\freebox\api\v3\services\config\SwitchPort diff --git a/docs/config/UPnP/UPnP.md b/docs/config/UPnP/UPnP.md index f2d87cb..d834ccc 100644 --- a/docs/config/UPnP/UPnP.md +++ b/docs/config/UPnP/UPnP.md @@ -1,7 +1,10 @@ - # UPnP +- [AV](#AV) +- [IGD](#IGD) + +" ## AV **Namespace** : alphayax\freebox\api\v3\services\config\UPnP @@ -13,6 +16,7 @@ | `getConfiguration` | Get the current UPnP AV configuration | | `setConfiguration` | Update the UPnP AV configuration | +" ## IGD **Namespace** : alphayax\freebox\api\v3\services\config\UPnP diff --git a/docs/config/VPN/Client/Client.md b/docs/config/VPN/Client/Client.md index 483c946..3d409bf 100644 --- a/docs/config/VPN/Client/Client.md +++ b/docs/config/VPN/Client/Client.md @@ -1,7 +1,10 @@ - # Client +- [Config](#Config) +- [Status](#Status) + +" ## Config **Namespace** : alphayax\freebox\api\v3\services\config\VPN\Client @@ -17,6 +20,7 @@ | `deleteFromId` | | | `update` | | +" ## Status **Namespace** : alphayax\freebox\api\v3\services\config\VPN\Client diff --git a/docs/config/VPN/Server/Server.md b/docs/config/VPN/Server/Server.md index b6213b9..5e6523d 100644 --- a/docs/config/VPN/Server/Server.md +++ b/docs/config/VPN/Server/Server.md @@ -1,7 +1,12 @@ - # Server +- [Config](#Config) +- [Connection](#Connection) +- [IpPool](#IpPool) +- [User](#User) + +" ## Config **Namespace** : alphayax\freebox\api\v3\services\config\VPN\Server @@ -13,6 +18,7 @@ | `getConfigurationFromId` | Get a VPN config | | `setConfiguration` | Update the VPN configuration | +" ## Connection **Namespace** : alphayax\freebox\api\v3\services\config\VPN\Server @@ -24,6 +30,7 @@ | `getAll` | Get the list of connections | | `closeFromId` | Close a given connection | +" ## IpPool **Namespace** : alphayax\freebox\api\v3\services\config\VPN\Server @@ -34,6 +41,7 @@ |---|---| | `getReservations` | Get the VPN server IP pool reservations | +" ## User **Namespace** : alphayax\freebox\api\v3\services\config\VPN\Server diff --git a/docs/config/VPN/VPN.md b/docs/config/VPN/VPN.md index ed66772..9a86535 100644 --- a/docs/config/VPN/VPN.md +++ b/docs/config/VPN/VPN.md @@ -1,5 +1,11 @@ - # VPN -- [Client](./config/VPN/Client/Client.md) -- [Server](./config/VPN/Server/Server.md) +- [Client](./Client/Client.md) + - [Config](#Config) + - [Status](#Status) +- [Server](./Server/Server.md) + - [Config](#Config) + - [Connection](#Connection) + - [IpPool](#IpPool) + - [User](#User) + diff --git a/docs/config/WiFi/WiFi.md b/docs/config/WiFi/WiFi.md index ee99ee8..f0cecf6 100644 --- a/docs/config/WiFi/WiFi.md +++ b/docs/config/WiFi/WiFi.md @@ -1,7 +1,13 @@ - # WiFi +- [AccessPoint](#AccessPoint) +- [Bss](#Bss) +- [Config](#Config) +- [MacFilter](#MacFilter) +- [Planning](#Planning) + +" ## AccessPoint **Namespace** : alphayax\freebox\api\v3\services\config\WiFi @@ -16,10 +22,10 @@ | `getStationsFromId` | To be able to allow user to pick a valid channel combination for a given AP you should use the following api to retrieve the list of allowed channel combination. | | `update` | | | `getNeighborsFromId` | Get the list of Neighbor seen by the AP | -| `refreshNeighborsScan` | WARNING during the scan the AP will be unavailable. Therefore, you should ask for user confirmation prior to launching a scan. -Once launched you should wait until the ap state comes back from scanning to get updated info. | +| `refreshNeighborsScan` | WARNING during the scan the AP will be unavailable. Therefore, you should ask for user confirmation prior to launching a scan. Once launched you should wait until the ap state comes back from scanning to get updated info. | | `getChannelUsageFromId` | List Wi-Fi channels usage | +" ## Bss **Namespace** : alphayax\freebox\api\v3\services\config\WiFi @@ -32,6 +38,7 @@ Once launched you should wait until the ap state comes back from scanning to get | `getFromId` | Get the list of Freebox Access Points | | `update` | Get the list of Freebox Access Points | +" ## Config **Namespace** : alphayax\freebox\api\v3\services\config\WiFi @@ -44,6 +51,7 @@ Once launched you should wait until the ap state comes back from scanning to get | `setConfiguration` | | | `resetConfiguration` | Reset Wifi to default configuration | +" ## MacFilter **Namespace** : alphayax\freebox\api\v3\services\config\WiFi @@ -59,6 +67,7 @@ Once launched you should wait until the ap state comes back from scanning to get | `deleteFromId` | | | `add` | | +" ## Planning **Namespace** : alphayax\freebox\api\v3\services\config\WiFi diff --git a/docs/config/config.md b/docs/config/config.md index b6f2e7e..53ed6ce 100644 --- a/docs/config/config.md +++ b/docs/config/config.md @@ -1,15 +1,54 @@ - # config -- [Connection](./config/Connection/Connection.md) -- [LAN](./config/LAN/LAN.md) -- [NAT](./config/NAT/NAT.md) -- [NetworkShare](./config/NetworkShare/NetworkShare.md) -- [SwitchPort](./config/SwitchPort/SwitchPort.md) -- [UPnP](./config/UPnP/UPnP.md) -- [VPN](./config/VPN/VPN.md) -- [WiFi](./config/WiFi/WiFi.md) +- [Connection](./Connection/Connection.md) + - [DynDns](./DynDns/DynDns.md) + - [DynDns](#DynDns) + - [NoIP](#NoIP) + - [Ovh](#Ovh) + - [Connection](#Connection) + - [DynDns](#DynDns) + - [Ftth](#Ftth) + - [Xdsl](#Xdsl) +- [LAN](./LAN/LAN.md) + - [Browser](#Browser) + - [LAN](#LAN) +- [NAT](./NAT/NAT.md) + - [DMZ](#DMZ) + - [IncomingPort](#IncomingPort) + - [PortForwarding](#PortForwarding) +- [NetworkShare](./NetworkShare/NetworkShare.md) + - [Afp](#Afp) + - [Samba](#Samba) +- [SwitchPort](./SwitchPort/SwitchPort.md) + - [Config](#Config) + - [Stats](#Stats) + - [Status](#Status) +- [UPnP](./UPnP/UPnP.md) + - [AV](#AV) + - [IGD](#IGD) +- [VPN](./VPN/VPN.md) + - [Client](./Client/Client.md) + - [Config](#Config) + - [Status](#Status) + - [Server](./Server/Server.md) + - [Config](#Config) + - [Connection](#Connection) + - [IpPool](#IpPool) + - [User](#User) +- [WiFi](./WiFi/WiFi.md) + - [AccessPoint](#AccessPoint) + - [Bss](#Bss) + - [Config](#Config) + - [MacFilter](#MacFilter) + - [Planning](#Planning) +- [DHCP](#DHCP) +- [FTP](#FTP) +- [Freeplug](#Freeplug) +- [LCD](#LCD) +- [System](#System) + +" ## DHCP **Namespace** : alphayax\freebox\api\v3\services\config @@ -21,6 +60,7 @@ | `getConfiguration` | | | `setConfiguration` | | +" ## FTP **Namespace** : alphayax\freebox\api\v3\services\config @@ -32,6 +72,7 @@ | `getConfiguration` | | | `setConfiguration` | | +" ## Freeplug **Namespace** : alphayax\freebox\api\v3\services\config @@ -44,6 +85,7 @@ | `getFromId` | Get a particular Freeplug information | | `resetFromId` | Reset a Freeplug | +" ## LCD **Namespace** : alphayax\freebox\api\v3\services\config @@ -55,6 +97,7 @@ | `getConfiguration` | | | `setConfiguration` | | +" ## System **Namespace** : alphayax\freebox\api\v3\services\config diff --git a/docs/download/download.md b/docs/download/download.md index 3a2f3c8..2939ac5 100644 --- a/docs/download/download.md +++ b/docs/download/download.md @@ -1,7 +1,14 @@ - # download +- [BlackList](#BlackList) +- [Configuration](#Configuration) +- [Download](#Download) +- [Feed](#Feed) +- [Peer](#Peer) +- [Tracker](#Tracker) + +" ## BlackList **Namespace** : alphayax\freebox\api\v3\services\download @@ -10,13 +17,12 @@ | Method | Description | |---|---| -| `getAllFromDownloadTaskId` | Get the list of blacklist entries for a given download -Attempting to call this method on a download other than bittorent will fail. | -| `emptyBlackListFromDownloadId` | Empty the blacklist for a given download -This call allow to remove all global entries, and entries related to the given download | +| `getAllFromDownloadTaskId` | Get the list of blacklist entries for a given download Attempting to call this method on a download other than bittorent will fail. | +| `emptyBlackListFromDownloadId` | Empty the blacklist for a given download This call allow to remove all global entries, and entries related to the given download | | `removeBlackListEntry` | Delete a particular blacklist entry | | `addBlackListEntry` | Add a blacklist entry | +" ## Configuration **Namespace** : alphayax\freebox\api\v3\services\download @@ -27,9 +33,9 @@ This call allow to remove all global entries, and entries related to the given d |---|---| | `getConfiguration` | Get the current Download configuration | | `setConfiguration` | Update the Download configuration | -| `updateThrottlingMode` | You can force the throttling mode using this method. -You can use any of the throttling modes defined in DlThrottlingConfig. | +| `updateThrottlingMode` | You can force the throttling mode using this method. You can use any of the throttling modes defined in DlThrottlingConfig. | +" ## Download **Namespace** : alphayax\freebox\api\v3\services\download @@ -47,6 +53,7 @@ You can use any of the throttling modes defined in DlThrottlingConfig. | | `getStats` | Returns the Download task with the given id | | `getFilesFromId` | Returns the Download task with the given id | +" ## Feed **Namespace** : alphayax\freebox\api\v3\services\download @@ -60,15 +67,14 @@ You can use any of the throttling modes defined in DlThrottlingConfig. | | `addFeed` | Add a Download Feed | | `removeFeed` | Delete a Download Feed | | `updateFeed` | Update a Download Feed | -| `refreshFeed` | Remotely fetches the RSS feed and updates it. -Note that if the remote feed specifies a TTL, trying to update before the ttl will result in feed_is_recent error | -| `refreshFeeds` | Remotely fetches the RSS feed and updates it. -Note that if the remote feed specifies a TTL, trying to update before the ttl will result in feed_is_recent error | +| `refreshFeed` | Remotely fetches the RSS feed and updates it. Note that if the remote feed specifies a TTL, trying to update before the ttl will result in feed_is_recent error | +| `refreshFeeds` | Remotely fetches the RSS feed and updates it. Note that if the remote feed specifies a TTL, trying to update before the ttl will result in feed_is_recent error | | `getFeedItems` | Returns the collection of all DownloadFeedItems for a given DownloadFeed | | `updateFeedItem` | Returns the collection of all DownloadFeedItems for a given DownloadFeed | | `downloadFeedItem` | Returns the collection of all DownloadFeedItems for a given DownloadFeed | | `markFeedAsRead` | Returns the collection of all DownloadFeedItems for a given DownloadFeed | +" ## Peer **Namespace** : alphayax\freebox\api\v3\services\download @@ -77,9 +83,9 @@ Note that if the remote feed specifies a TTL, trying to update before the ttl wi | Method | Description | |---|---| -| `getAll` | Get the list of peers for a given Download -Attempting to call this method on a download other than bittorent will fail | +| `getAll` | Get the list of peers for a given Download Attempting to call this method on a download other than bittorent will fail | +" ## Tracker **Namespace** : alphayax\freebox\api\v3\services\download @@ -88,11 +94,7 @@ Attempting to call this method on a download other than bittorent will fail | | Method | Description | |---|---| -| `getAll` | Each torrent Download task has one or more DownloadTracker. -Each tracker is identified by its announce URL. | -| `add` | Add a new tracker -Attempting to call this method on a download other than bittorent will fail | -| `remove` | Remove a tracker -Attempting to call this method on a download other than bittorent will fail | -| `update` | Update a tracker -Attempting to call this method on a download other than bittorent will fail | +| `getAll` | Each torrent Download task has one or more DownloadTracker. Each tracker is identified by its announce URL. | +| `add` | Add a new tracker Attempting to call this method on a download other than bittorent will fail | +| `remove` | Remove a tracker Attempting to call this method on a download other than bittorent will fail | +| `update` | Update a tracker Attempting to call this method on a download other than bittorent will fail | diff --git a/docs/login/login.md b/docs/login/login.md index 081c73d..e645b56 100644 --- a/docs/login/login.md +++ b/docs/login/login.md @@ -1,7 +1,10 @@ - # login +- [Authorize](#Authorize) +- [Session](#Session) + +" ## Authorize **Namespace** : alphayax\freebox\api\v3\services\login @@ -16,6 +19,7 @@ | `getStatus` | | | `getAppToken` | | +" ## Session **Namespace** : alphayax\freebox\api\v3\services\login diff --git a/docs/services.md b/docs/services.md index f623c13..11b382f 100644 --- a/docs/services.md +++ b/docs/services.md @@ -1,12 +1,85 @@ - # services - [FileSystem](./FileSystem/FileSystem.md) + - [FileSharingLink](#FileSharingLink) + - [FileSystemListing](#FileSystemListing) + - [FileSystemOperation](#FileSystemOperation) + - [FileSystemTask](#FileSystemTask) + - [FileUpload](#FileUpload) - [ParentalControl](./ParentalControl/ParentalControl.md) + - [Filter](#Filter) + - [FilterPlanning](#FilterPlanning) - [RRD](./RRD/RRD.md) + - [Fetch](#Fetch) - [Storage](./Storage/Storage.md) + - [Disk](#Disk) + - [Partition](#Partition) - [AirMedia](./AirMedia/AirMedia.md) + - [AirMediaReceiver](#AirMediaReceiver) + - [Config](#Config) - [Call](./Call/Call.md) + - [Contact](./Contact/Contact.md) + - [ContactAddress](#ContactAddress) + - [ContactEmail](#ContactEmail) + - [ContactEntry](#ContactEntry) + - [ContactNumber](#ContactNumber) + - [ContactUrl](#ContactUrl) + - [CallEntry](#CallEntry) - [config](./config/config.md) + - [Connection](./Connection/Connection.md) + - [DynDns](./DynDns/DynDns.md) + - [DynDns](#DynDns) + - [NoIP](#NoIP) + - [Ovh](#Ovh) + - [Connection](#Connection) + - [DynDns](#DynDns) + - [Ftth](#Ftth) + - [Xdsl](#Xdsl) + - [LAN](./LAN/LAN.md) + - [Browser](#Browser) + - [LAN](#LAN) + - [NAT](./NAT/NAT.md) + - [DMZ](#DMZ) + - [IncomingPort](#IncomingPort) + - [PortForwarding](#PortForwarding) + - [NetworkShare](./NetworkShare/NetworkShare.md) + - [Afp](#Afp) + - [Samba](#Samba) + - [SwitchPort](./SwitchPort/SwitchPort.md) + - [Config](#Config) + - [Stats](#Stats) + - [Status](#Status) + - [UPnP](./UPnP/UPnP.md) + - [AV](#AV) + - [IGD](#IGD) + - [VPN](./VPN/VPN.md) + - [Client](./Client/Client.md) + - [Config](#Config) + - [Status](#Status) + - [Server](./Server/Server.md) + - [Config](#Config) + - [Connection](#Connection) + - [IpPool](#IpPool) + - [User](#User) + - [WiFi](./WiFi/WiFi.md) + - [AccessPoint](#AccessPoint) + - [Bss](#Bss) + - [Config](#Config) + - [MacFilter](#MacFilter) + - [Planning](#Planning) + - [DHCP](#DHCP) + - [FTP](#FTP) + - [Freeplug](#Freeplug) + - [LCD](#LCD) + - [System](#System) - [download](./download/download.md) + - [BlackList](#BlackList) + - [Configuration](#Configuration) + - [Download](#Download) + - [Feed](#Feed) + - [Peer](#Peer) + - [Tracker](#Tracker) - [login](./login/login.md) + - [Authorize](#Authorize) + - [Session](#Session) +