diff options
Diffstat (limited to 'docs/api')
-rw-r--r-- | docs/api/components.rst | 18 | ||||
-rw-r--r-- | docs/api/datatypes.rst | 4 | ||||
-rw-r--r-- | docs/api/json_api.rst | 6 | ||||
-rw-r--r-- | docs/api/overview.rst | 6 |
4 files changed, 17 insertions, 17 deletions
diff --git a/docs/api/components.rst b/docs/api/components.rst index 116cfa90b..08560b535 100644 --- a/docs/api/components.rst +++ b/docs/api/components.rst @@ -9,12 +9,12 @@ of the available components listed by topic can be found below. .. autosummary:: :toctree: module - module.api.CoreApi.CoreApi - module.api.ConfigApi.ConfigApi - module.api.DownloadPreparingApi.DownloadPreparingApi - module.api.DownloadApi.DownloadApi - module.api.FileApi.FileApi - module.api.CollectorApi.CollectorApi - module.api.AccountApi.AccountApi - module.api.UserInteractionApi.UserInteractionApi - module.api.AddonApi.AddonApi
\ No newline at end of file + pyload.api.CoreApi.CoreApi + pyload.api.ConfigApi.ConfigApi + pyload.api.DownloadPreparingApi.DownloadPreparingApi + pyload.api.DownloadApi.DownloadApi + pyload.api.FileApi.FileApi + pyload.api.CollectorApi.CollectorApi + pyload.api.AccountApi.AccountApi + pyload.api.UserInteractionApi.UserInteractionApi + pyload.api.AddonApi.AddonApi
\ No newline at end of file diff --git a/docs/api/datatypes.rst b/docs/api/datatypes.rst index 5516189f3..cc07a5f28 100644 --- a/docs/api/datatypes.rst +++ b/docs/api/datatypes.rst @@ -4,12 +4,12 @@ Datatype Definition ******************* -Below you find a copy of :file:`module/remote/thriftbackend/pyload.thrift`, which is used to generate the data structs +Below you find a copy of :file:`pyload/remote/thriftbackend/pyload.thrift`, which is used to generate the data structs for various languages. It is also a good overview of avaible methods and return data. .. code-block:: c - .. [[[cog cog.out(open('module/remote/pyload.thrift', 'rb').read()) ]]] + .. [[[cog cog.out(open('pyload/remote/pyload.thrift', 'rb').read()) ]]] namespace java org.pyload.thrift typedef i32 FileID diff --git a/docs/api/json_api.rst b/docs/api/json_api.rst index 1f54e40aa..504de20bf 100644 --- a/docs/api/json_api.rst +++ b/docs/api/json_api.rst @@ -6,7 +6,7 @@ JSON API JSON [1]_ is a lightweight object notation and wrappers exists for nearly every programming language. Every modern browser is able to load JSON objects with JavaScript. Unlike other RPC methods you don't need to generate or precompile -any stub methods. The JSON :class:`Api <module.Api.Api>` is ready to be used in most languages and most JSON libraries are lightweight +any stub methods. The JSON :class:`Api <pyload.Api.Api>` is ready to be used in most languages and most JSON libraries are lightweight enough to build very small and performant scripts. Because of the builtin support, JSON is the first choice for all browser applications. @@ -28,7 +28,7 @@ so pyLoad can authenticate you. Calling Methods --------------- -In general you can use any method listed at the :class:`Api <module.Api.Api>` documentation, which is also available to +In general you can use any method listed at the :class:`Api <pyload.Api.Api>` documentation, which is also available to the thrift backend. Access works simply via ``http://pyload-core/api/methodName``, where ``pyload-core`` is the ip address @@ -43,7 +43,7 @@ Passing parameters To pass arguments you have two choices: Either use positional arguments, e.g.: ``http://pyload-core/api/getFileData/1``, where 1 is the FileID, or use keyword arguments supplied via GET or POST ``http://pyload-core/api/getFileData?fid=1``. You can find the argument names -in the :class:`Api <module.Api.Api>` documentation. +in the :class:`Api <pyload.Api.Api>` documentation. It is important that *all* arguments are in JSON format. So ``http://pyload-core/api/getFileData/1`` is valid because 1 represents an integer in json format. On the other hand if the method is expecting strings, this would be correct: diff --git a/docs/api/overview.rst b/docs/api/overview.rst index 99e7075ca..3b65a45b0 100644 --- a/docs/api/overview.rst +++ b/docs/api/overview.rst @@ -12,10 +12,10 @@ From Wikipedia, the free encyclopedia [1]_: .. rubric:: Motivation -The idea of the centralized pyLoad :class:`Api <module.Api.Api>` is to give uniform access to all integral parts +The idea of the centralized pyLoad :class:`Api <pyload.Api.Api>` is to give uniform access to all integral parts and plugins in pyLoad as well as other clients written in arbitrary programming languages. -Most of the :class:`Api <module.Api.Api>` functionality is exposed via HTTP or WebSocktes [2]_ as -simple JSON objects [3]_. In conclusion the :class:`Api <module.Api.Api>` is accessible via many programming languages, +Most of the :class:`Api <pyload.Api.Api>` functionality is exposed via HTTP or WebSocktes [2]_ as +simple JSON objects [3]_. In conclusion the :class:`Api <pyload.Api.Api>` is accessible via many programming languages, over network from remote machines and over browser with javascript. |