From 842a594ce38cd48374cf5d6021698ed7d215b173 Mon Sep 17 00:00:00 2001 From: dlavigne Date: Mon, 28 Mar 2016 14:08:53 -0400 Subject: [PATCH] Doc extra arguments to pkg_info. --- api/classes/pkg.rst | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/api/classes/pkg.rst b/api/classes/pkg.rst index 81077b2..e87e7ad 100644 --- a/api/classes/pkg.rst +++ b/api/classes/pkg.rst @@ -34,8 +34,17 @@ The rest of this section provides examples of the available *actions* for each t Package Information =================== -The "pkg_info" action reads the pkg database directly and returns any relevant information. The "repo" is optional as it defaults to "local". The "pkg_origins" is also optional; if it is -not specified, information for all installed packages will be listed. +The "pkg_info" action reads the pkg database directly and returns any relevant information. The following arguments are optional: + +* **"repo"**: unless specified, defaults to the local package repository. + +* **"pkg_origins"**: unless specified, information for all installed packages will be listed. + +* **"category"**: limits the results to packages within the specified category. + +* **"result"**: may be set to anything other than "full" to restrict the information output to just the basic/simple information. This will not include sub-categories of information such as + "dependencies","requires","depends", or "options". For example, a request that specifies *{"action":"pkg_info","category":"x11","result":"simple"}* will result in a basic listing of all + the packages within the "x11" category. **REST Request**