gerrit.onap Code Review - cli.git/blob

   1 # Copyright 2018 Huawei Technologies Co., Ltd.
   2 #
   3 # Licensed under the Apache License, Version 2.0 (the "License");
   4 # you may not use this file except in compliance with the License.
   5 # You may obtain a copy of the License at
   6 #
   7 #     http://www.apache.org/licenses/LICENSE-2.0
   8 #
   9 # Unless required by applicable law or agreed to in writing, software
  10 # distributed under the License is distributed on an "AS IS" BASIS,
  11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 # See the License for the specific language governing permissions and
  13 # limitations under the License.
  14
  15 open_cli_schema_version: 1.0
  16 name: microservice-list
  17 description: Lists the registetred micro services in Onap
  18
  19
  20 info:
  21   product: onap-casablanca
  22   service: msb
  23   author: ONAP CLI Team onap-discuss@lists.onap.org
  24
  25 results:
  26   direction: landscape
  27   attributes:
  28     - name: name
  29       description: Onap service name
  30       scope: short
  31       type: string
  32     - name: version
  33       description: Onap service version
  34       scope: short
  35       type: string
  36     - name: url
  37       description: Onap service base url
  38       scope: short
  39       type: url
  40     - name: status
  41       description: Onap service status
  42       scope: short
  43       type: digit
  44     - name: nodes
  45       description: Onap service running nodes
  46       scope: long
  47       type: json
  48     - name: enable-ssl
  49       description: Onap service is enabled with https or not
  50       scope: long
  51       type: string
  52     - name: path
  53       description: Onap service path
  54       scope: long
  55       type: string
  56 http:
  57   service:
  58     auth: none
  59     mode: direct
  60   request:
  61     uri: /api/microservices/v1/services
  62     method: GET
  63   success_codes:
  64     - 201
  65     - 200
  66   result_map:
  67     name: $b{$.[*].serviceName}
  68     version: $b{$.[*].version}
  69     url: $b{$.[*].url}
  70     status: $b{$.[*].status}
  71     enable-ssl: $b{$.[*].enable_ssl}
  72     path: $b{$.[*].path}
  73     nodes: $b{$.[*].nodes[*].ip}:$b{$.[*].nodes[*].port}
  74   sample_response:
  75     body: '[{"serviceName":"test","version":"v1","url":"/api/test/v1","protocol":"REST","visualRange":"1","lb_policy":"hash","nodes":[{"ip":"127.0.0.1","port":"8012","ttl":0,"nodeId":"test_127.0.0.1_8012","expiration":"2017-02-10T05:33:25Z","created_at":"2017-02-10T05:33:25Z","updated_at":"2017-02-10T05:33:25Z"}],"status":"1"}]'
  76
  77
  78
  79