gerrit.onap Code Review - cli.git/blob

   1 # Copyright 2019 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: policy-list
  17 description: Retrieve all version details of a policy created for a particular policy type version
  18
  19 info:
  20   product: onap-elalto
  21   service: policy
  22   author: ONAP CLI Team onap-discuss@lists.onap.org
  23
  24 parameters:
  25   - name: policy-type-id
  26     description: Policy type ID
  27     type: string
  28     long_option: policy-type-id
  29     short_option: x
  30     is_optional: false
  31   - name: version-id
  32     description: Policy type version ID
  33     type: string
  34     long_option: version-id
  35     short_option: y
  36     is_optional: false
  37   - name: policy-id
  38     description: Policy ID
  39     type: string
  40     long_option: policy-id
  41     short_option: z
  42     is_optional: false
  43
  44 results:
  45   direction: landscape
  46   attributes:
  47     - name: Policy properties
  48       description: Policy properties
  49       scope: short
  50       type: json
  51
  52 http:
  53   service:
  54     name: policy
  55     version: v1.0
  56     auth: basic
  57     mode: direct
  58   request:
  59     uri: /policy/api/v1/policytypes/${policy-type-id}/versions/${version-id}/policies/${policy-id}
  60     method: GET
  61     headers:
  62       Accept: application/json
  63       Environment: TEST
  64
  65   success_codes:
  66     - 200
  67
  68   result_map:
  69     Policy properties: $b{$.[*]}