gerrit.onap Code Review - cli.git/blob

   1 open_cli_schema_version: 1.0
   2 name: vf-list
   3 description: List created VF instances for a service instance
   4
   5 info:
   6   product: onap-1.1
   7   service: aai
   8   author: ONAP CLI Team onap-discuss@lists.onap.org
   9
  10 parameters:
  11   - name: customer-name
  12     description: customer name
  13     type: string
  14     short_option: x
  15     long_option: customer-name
  16     is_optional: false
  17   - name: service-type
  18     description: service subscription type
  19     type: string
  20     short_option: y
  21     long_option: service-type
  22     is_optional: false
  23   - name: service-id
  24     description: service ID
  25     type: string
  26     short_option: z
  27     long_option: service-id
  28     is_optional: false
  29
  30 results:
  31   direction: landscape
  32   attributes:
  33     - name: vf-id
  34       description: VF ID for the given service
  35       scope: short
  36       type: string
  37     - name: vf-name
  38       description: VF name
  39       scope: short
  40       type: string
  41
  42 http:
  43   service:
  44     name: aai
  45     version: v11
  46     auth: basic
  47     mode: direct
  48
  49   request:
  50     uri: /aai/v11/business/customers/customer/${customer-name}/service-subscriptions/service-subscription/${service-type}/service-instances/service-instance/${service-id}
  51     method: GET
  52   success_codes:
  53     - 200
  54   result_map:
  55     vf-id: $b{relationship-list.relationship.[*].relationship-data[?(@.relationship-key=='generic-vnf.vnf-id')].relationship-value}
  56     vf-name: $b{relationship-list.relationship.[*].related-to-property.[?(@.property-key == 'generic-vnf.vnf-name')].property-value}
  57   sample_response:
  58     body: '{"service-instance": [{"service-instance-id": "${service-id}","service-instance-name": "${service-name}","description": "${description}","model-invariant-id": "${model-invariant-id}","model-version-id": "${model-uuid}"}]}'