gerrit.onap Code Review - cli.git/blob

   1 # Copyright 2018 Huawei Technologies Co., Ltd.\r
   2 #\r
   3 # Licensed under the Apache License, Version 2.0 (the "License");\r
   4 # you may not use this file except in compliance with the License.\r
   5 # You may obtain a copy of the License at\r
   6 #\r
   7 #     http://www.apache.org/licenses/LICENSE-2.0\r
   8 #\r
   9 # Unless required by applicable law or agreed to in writing, software\r
  10 # distributed under the License is distributed on an "AS IS" BASIS,\r
  11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  12 # See the License for the specific language governing permissions and\r
  13 # limitations under the License.\r
  14 \r
  15 open_cli_schema_version: 1.0\r
  16 name: generic-search\r
  17 description: generic-search \r
  18 #sample:  https://172.19.44.123:8443/aai/v11/search/generic-query?key=customer.global-customer-id:Orange&include=all&start-node-type=customer&depth=6 \r
  19 \r
  20 info:\r
  21   product: onap-beijing\r
  22   service: aai\r
  23   author: ONAP CLI Team onap-discuss@lists.onap.org\r
  24 \r
  25 parameters:\r
  26   - name: key\r
  27     description: key\r
  28     type: string\r
  29     short_option: k\r
  30     long_option: key\r
  31     is_optional: false\r
  32   - name: value\r
  33     description: value\r
  34     type: string\r
  35     short_option: z\r
  36     long_option: value\r
  37     is_optional: false\r
  38   - name: start-node-type\r
  39     description: start-node-type\r
  40     type: string\r
  41     short_option: r\r
  42     long_option: start-node-type\r
  43     is_optional: false\r
  44   - name: depth\r
  45     description: search depth\r
  46     type: digit\r
  47     short_option: e\r
  48     long_option: depth\r
  49     is_optional: false\r
  50 results:\r
  51   direction: landscape\r
  52   attributes:\r
  53     - name: resource-type\r
  54       description: Onap result-type\r
  55       scope: short\r
  56       type: string\r
  57     - name: resource-link\r
  58       description: Onap resource-link\r
  59       scope: short\r
  60       type: string\r
  61     \r
  62 http:\r
  63   service:\r
  64     auth: basic\r
  65     mode: direct\r
  66   request:\r
  67     uri: /aai/v11/search/generic-query?key=${key}:${value}&include=all&start-node-type=${start-node-type}&depth=${depth}\r
  68     method: GET\r
  69   success_codes:\r
  70     - 200\r
  71     - 201\r
  72   result_map:\r
  73     resource-type: $b{result-data.[*].resource-type}\r
  74     resource-link: $b{result-data.[*].resource-link}\r
  75     \r