plugins/msb/src/main/resources/onap-cli-schema/microservice-show-schema.yaml

   1 open_cli_schema_version: 1.0
   2 name: microservice-show
   3 description: Details the registered microservice in Onap
   4 version: onap-1.1
   5 service:
   6   name: msb
   7   version: v1
   8   auth: none
   9 parameters:
  10   - name: service-name
  11     description: Onap service name
  12     type: string
  13     short_option: x
  14     long_option: service-name
  15     is_optional: false
  16   - name: service-version
  17     description: Onap service version
  18     type: string
  19     short_option: y
  20     long_option: service-version
  21     is_optional: false
  22 results:
  23   direction: portrait
  24   attributes:
  25     - name: name
  26       description: Onap service name
  27       scope: short
  28       type: string
  29     - name: version
  30       description: Onap service version
  31       scope: short
  32       type: string
  33     - name: url
  34       description: Onap service base url
  35       scope: short
  36       type: url
  37     - name: status
  38       description: Onap service status
  39       scope: short
  40       type: digit
  41     - name: nodes
  42       description: Onap service running nodes
  43       scope: long
  44       type: json
  45     - name: enable-ssl
  46       description: Onap service is enabled with https or not
  47       scope: long
  48       type: string
  49     - name: path
  50       description: Onap service path
  51       scope: long
  52       type: string
  53 http:
  54   request:
  55     uri: /services/${service-name}/version/${service-version}
  56     method: GET
  57   success_codes:
  58     - 201
  59     - 200
  60   result_map:
  61     name: $b{$.serviceName}
  62     version: $b{$.version}
  63     url: $b{$.url}
  64     status: $b{$.status}
  65     enable-ssl: $b{$.enable_ssl}
  66     path: $b{$.path}
  67     nodes: $b{$.nodes[*].ip}:$b{$.nodes[*].port}
  68   sample_response:
  69     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"}'
  70
  71
  72
  73