products/onap-dublin/features/vfc/src/main/resources/open-cli-schema/nslcm/vfc-nslcm-get-jobid.yaml

   1 # Copyright (c) 2019, CMCC Technologies Co., Ltd.
   2 # Licensed under the Apache License, Version 2.0 (the "License")
   3 # you may not use this file except in compliance with the License.
   4 # You may obtain a copy of the License at
   5 # http://www.apache.org/licenses/LICENSE-2.0
   6 # Unless required by applicable law or agreed to in writing, software
   7 # distributed under the License is distributed on an "AS IS" BASIS,
   8 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   9 # See the License for the specific language governing permissions and
  10 # limitations under the License.
  11
  12 open_cli_schema_version: 1.0
  13 name: vfc-nslcm-get-jobid
  14 description: vfc nsclm get the jobid of  ns created job
  15
  16 info:
  17   product: onap-dublin
  18   service: vfc
  19   author: ONAP VFC Team (yangyanyj@chinamobile.com)
  20
  21 parameters:
  22   - name: ns-job-id
  23     description: ns job id
  24     type: string
  25     short_option: i
  26     long_option: ns-job-id
  27     is_optional: false
  28
  29 results:
  30   direction: portrait
  31   attributes:
  32     - name: ns-job-id
  33       description: ns job id
  34       scope: short
  35       type: string
  36
  37     - name: job-status
  38       description: job status
  39       scope: short
  40       type: string
  41
  42     - name: job-progress
  43       description: job progress
  44       scope: short
  45       type: string
  46
  47 http:
  48   service:
  49     auth: none
  50     mode: direct
  51   request:
  52     uri: /api/nslcm/v1/jobs/${ns-job-id}
  53     method: GET
  54     context:
  55       remove_empty_node: true
  56     body: '{}'
  57     headers:
  58       Content-Type: application/json
  59       Accept: application/json
  60   success_codes:
  61     - 200
  62
  63   result_map:
  64     ns-job-id: $b{$.jobId}
  65     job-status: $b{$.responseDescriptor.status}
  66     job-progress: $b{$.responseDescriptor.progress}