gerrit.onap Code Review - cli.git/blob

   1 open_cli_schema_version: 1.0
   2
   3 name: vim-list
   4
   5 description: List the configured vims
   6
   7
   8 info:
   9   product: onap-amsterdam
  10   service: aai
  11   author: ONAP CLI Team onap-discuss@lists.onap.org
  12
  13 parameters:
  14   - name: cloud-name
  15     description: Onap cloud name
  16     type: string
  17     short_option: x
  18     long_option: cloud-name
  19     is_optional: false
  20   - name: region-name
  21     description: Onap  region name
  22     type: string
  23     short_option: y
  24     long_option:  region-name
  25     is_optional: false
  26
  27 results:
  28   direction: landscape
  29   attributes:
  30     - name: vim-id
  31       description: Onap vim id
  32       scope: short
  33       type: string
  34     - name: name
  35       description: Onap vim name
  36       scope: short
  37       type: string
  38     - name: type
  39       description: Onap vim type
  40       scope: long
  41       type: string
  42     - name: vendor
  43       description: Onap vim vendor
  44       scope: short
  45       type: string
  46     - name: version
  47       description: Onap vim version
  48       scope: long
  49       type: string
  50     - name: url
  51       description: Onap vim url
  52       scope: long
  53       type: string
  54     - name: username
  55       description: Onap vim username
  56       scope: long
  57       type: string
  58     - name: cloud-domain
  59       description: Onap vim cloud domain
  60       scope: long
  61       type: string
  62     - name: default-tenant
  63       description: Onap vim tenant
  64       scope: short
  65       type: string
  66     - name: resource-version
  67       description: Onap vim resource version
  68       scope: short
  69       type: string
  70
  71 http:
  72   service:
  73     auth: basic
  74     mode: direct
  75   request:
  76     uri: /aai/v11/cloud-infrastructure/cloud-regions/cloud-region/${cloud-name}/${region-name}/esr-system-info-list
  77     method: GET
  78   success_codes:
  79     - 200
  80   result_map:
  81     vim-id: $b{$.esr-system-info.[*].esr-system-info-id}
  82     name: $b{$.esr-system-info.[*].system-name}
  83     type: $b{$.esr-system-info.[*].type}
  84     vendor: $b{$.esr-system-info.[*].vendor}
  85     version: $b{$.esr-system-info.[*].version}
  86     url: $b{$.esr-system-info.[*].service-url}
  87     username: $b{$.esr-system-info.[*].user-name}
  88     cloud-domain: $b{$.esr-system-info.[*].cloud-domain}
  89     default-tenant: $b{$.esr-system-info.[*].default-tenant}
  90     resource-version: $b{$.esr-system-info.[*].resource-version}
  91
  92   sample_response:
  93     body: '{esr-system-info":[{"esr-system-info-id":"example-esr-system-info-id-val-62966","system-name":"example-system-name-val-76894","type":"example-type-val-32301","vendor":"example-vendor-val-38139","version":"example-version-val-42345","service-url":"example-service-url-val-33729","user-name":"example-user-name-val-32122","password":"example-password-val-56539","system-type":"example-system-type-val-80707","protocal":"example-protocal-val-30105","ssl-cacert":"example-ssl-cacert-val-52110","ssl-insecure":true,"ip-address":"example-ip-address-val-10140","port":"example-port-val-26369","cloud-domain":"example-cloud-domain-val-22303","default-tenant":"example-default-tenant-val-26326"}]}'