summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKevin_Zheng <zhengzhenyu@huawei.com>2016-12-19 17:29:00 +0800
committerKevin_Zheng <zhengzhenyu@huawei.com>2016-12-21 21:24:11 +0800
commit85497f478f3a4ea1a06c2136d197ff479f47fb60 (patch)
treee524a848a142b7bdf78645d56db8a8f60050e5bb
parent136ffdeaf6a027cae7f7280a8a5312a59c587d4c (diff)
Add client doc details1.1.0
Notes
Notes (review): Code-Review+2: Lei Zhang <lei.a.zhang@intel.com> Code-Review+2: Li Yingjun <yingjun.li@kylin-cloud.com> Workflow+1: Li Yingjun <yingjun.li@kylin-cloud.com> Verified+2: Jenkins Submitted-by: Jenkins Submitted-at: Thu, 22 Dec 2016 06:24:16 +0000 Reviewed-on: https://review.openstack.org/412368 Project: openstack/python-searchlightclient Branch: refs/heads/master
-rw-r--r--doc/source/index.rst1
-rw-r--r--doc/source/man/search.rst78
2 files changed, 79 insertions, 0 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 33e699e..5095912 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -32,3 +32,4 @@ Man Page
32 :maxdepth: 1 32 :maxdepth: 1
33 33
34 man/openstack 34 man/openstack
35 man/search
diff --git a/doc/source/man/search.rst b/doc/source/man/search.rst
new file mode 100644
index 0000000..cbe1adf
--- /dev/null
+++ b/doc/source/man/search.rst
@@ -0,0 +1,78 @@
1======
2Search
3======
4
5search facet list
6-----------------
7
8List Searchlight Facets.
9
10.. program:: search facet list
11.. code:: bash
12
13 openstack search facet list
14 [--type <resource-type>]
15 [--limit-terms <limit>]
16 [--all-projects]
17
18.. option:: --type <resource-type>
19
20 Get facets for a particular resource type.
21
22.. option:: --limit-terms <limit>
23
24 Restricts the number of options returned for fields that
25 support facet terms.
26
27.. option:: --all-projects
28
29 Request facet terms for all projects (admin only).
30
31search resource type list
32-------------------------
33
34List Searchlight Resource Type (Plugin).
35
36.. program:: search resource type list
37.. code:: bash
38
39 openstack search resource type list
40
41search query
42------------
43
44Search Searchlight resource.
45
46.. program:: search query
47.. code:: bash
48
49 openstack search query
50 --type [<resource-type> [<resource-type> ...]]
51 --all-projects
52 --source [[<field>,...]]
53 --json
54 <query>
55
56.. option:: --type [<resource-type> [<resource-type> ...]]
57
58 One or more types to search. Uniquely identifies
59 resource types. Example: ``--type OS::Glance::Image
60 OS::Nova::Server``
61
62.. option:: --all-projects
63
64 By default searches are restricted to the current project
65 unless all_projects is set.
66
67.. option:: --source [[<field>,...]]
68
69 Whether to display the json source. If not specified,
70 it will not be displayed. If specified with no argument,
71 the full source will be displayed. Otherwise, specify
72 the fields combined with ',' to return the fields you want.
73 It is recommended that you use the ``--max-width`` argument
74 with this option.
75
76.. option:: --json
77
78 Treat the query argument as a JSON formatted DSL query.