aboutsummaryrefslogtreecommitdiffstats
path: root/products/onap-dublin/features/sdc/src/main/resources/open-cli-schema
diff options
context:
space:
mode:
authorItohan Ukponmwan <itohan.ukponmwan@intel.com>2019-03-22 17:45:23 +0000
committerItohan Ukponmwan <itohan.ukponmwan@intel.com>2019-03-22 18:10:33 +0000
commitb8d11d348759878663e7a4d7d1da05bc3b1c7443 (patch)
treeb560c879699c9aadb49dff335d5da5f0cdebf51c /products/onap-dublin/features/sdc/src/main/resources/open-cli-schema
parent618482352bbfdfb225bdee0ba377a4ab71ce5135 (diff)
VSP Schema files for onap-dublin CLI
Change-Id: I196668acdb3770e2b295aeb6424cdd9d8cc953e8 Issue-ID: CLI-136 Signed-off-by: Itohan Ukponmwan <itohan.ukponmwan@intel.com>
Diffstat (limited to 'products/onap-dublin/features/sdc/src/main/resources/open-cli-schema')
-rw-r--r--products/onap-dublin/features/sdc/src/main/resources/open-cli-schema/vsp/vsp-add-artifact-schema-dublin.yaml54
-rw-r--r--products/onap-dublin/features/sdc/src/main/resources/open-cli-schema/vsp/vsp-create-schema-dublin.yaml38
-rw-r--r--products/onap-dublin/features/sdc/src/main/resources/open-cli-schema/vsp/vsp-package-schema-dublin.yaml51
-rw-r--r--products/onap-dublin/features/sdc/src/main/resources/open-cli-schema/vsp/vsp-submit-schema-dublin.yaml49
-rw-r--r--products/onap-dublin/features/sdc/src/main/resources/open-cli-schema/vsp/vsp-validate-schema-dublin.yaml65
5 files changed, 240 insertions, 17 deletions
diff --git a/products/onap-dublin/features/sdc/src/main/resources/open-cli-schema/vsp/vsp-add-artifact-schema-dublin.yaml b/products/onap-dublin/features/sdc/src/main/resources/open-cli-schema/vsp/vsp-add-artifact-schema-dublin.yaml
new file mode 100644
index 00000000..42c92f37
--- /dev/null
+++ b/products/onap-dublin/features/sdc/src/main/resources/open-cli-schema/vsp/vsp-add-artifact-schema-dublin.yaml
@@ -0,0 +1,54 @@
+# Copyright © Intel Corporation 2019
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+open_cli_schema_version: 1.0
+name: vsp-add-artifact
+description: Upload the CSAR/ZIP file to VSP
+
+info:
+ product: onap-dublin
+ service: sdc
+ author: ONAP CLI Team onap-discuss@lists.onap.org
+
+parameters:
+ - name: vsp-id
+ description: Onap VSP ID
+ type: string
+ short_option: x
+ long_option: vsp-id
+ is_optional: false
+ - name: vsp-version
+ description: Onap VSP version
+ type: string
+ short_option: y
+ long_option: vsp-version
+ is_optional: false
+ - name: vsp-file
+ description: CSAR File path
+ type: binary
+ short_option: z
+ long_option: vsp-file
+ is_optional: false
+http:
+ request:
+ uri: /onboarding-api/v1.0/vendor-software-products/${vsp-id}/versions/${vsp-version}/orchestration-template-candidate
+ method: POST
+ body: '${vsp-file}'
+ multipart_entity_name: 'upload'
+ headers:
+ Content-type: 'multipart/form-data'
+ Accept: '*/*'
+ USER_ID: "${host-username}"
+ success_codes:
+ - 200
diff --git a/products/onap-dublin/features/sdc/src/main/resources/open-cli-schema/vsp/vsp-create-schema-dublin.yaml b/products/onap-dublin/features/sdc/src/main/resources/open-cli-schema/vsp/vsp-create-schema-dublin.yaml
index 84c67820..19c92393 100644
--- a/products/onap-dublin/features/sdc/src/main/resources/open-cli-schema/vsp/vsp-create-schema-dublin.yaml
+++ b/products/onap-dublin/features/sdc/src/main/resources/open-cli-schema/vsp/vsp-create-schema-dublin.yaml
@@ -34,20 +34,6 @@ parameters:
short_option: y
long_option: vsp-description
is_optional: true
- - name: vsp-category
- description: Category of the VSP
- type: string
- long_option: vsp-category
- short_option: z
- is_optional: true
- default_value: resourceNewCategory.generic
- - name: vsp-subcategory
- description: Sub Category of VSP
- type: string
- long_option: vsp-subcategory
- short_option: b
- is_optional: true
- default_value: resourceNewCategory.generic.abstract
- name: vlm-version
description: License version
type: string
@@ -79,6 +65,13 @@ parameters:
long_option: vlm-feature-group-id
short_option: j
is_optional: false
+ - name: onboarding-method
+ description: Method to be used for onboarding (Manual or NetworkPackage)
+ type: string
+ long_option: onboarding-method
+ short_option: o
+ is_optional: false
+
results:
direction: portrait
attributes:
@@ -99,9 +92,20 @@ http:
request:
uri: /onboarding-api/v1.0/vendor-software-products
method: POST
- body: '{"category": "${vsp-category}", "vendorId": "${vlm-id}", "subCategory": "${vsp-subcategory}", "description": "${vsp-description}", "licensingVersion": "${vlm-version}", "licensingData": {"featureGroups": ["${vlm-feature-group-id}"], "licenseAgreement": "${vlm-agreement-id}"}, "icon": "icon", "onboardingMethod": "Manual", "vendorName": "${vlm-vendor}", "name": "${vsp-name}"}'
+ body: '{
+ "category": "resourceNewCategory.generic",
+ "vendorId": "${vlm-id}",
+ "subCategory": "resourceNewCategory.generic.abstract",
+ "description": "${vsp-description}",
+ "licensingVersion": "${vlm-version}",
+ "licensingData": {"featureGroups": ["${vlm-feature-group-id}"], "licenseAgreement": "${vlm-agreement-id}"},
+ "icon": "icon",
+ "onboardingMethod": "${onboarding-method}",
+ "vendorName": "${vlm-vendor}",
+ "name": "${vsp-name}"
+ }'
success_codes:
- 200
result_map:
- ID: $b{$.vspId}
- version: $b{$.version.id} \ No newline at end of file
+ ID: $b{$.itemId}
+ version: $b{$.version.id}
diff --git a/products/onap-dublin/features/sdc/src/main/resources/open-cli-schema/vsp/vsp-package-schema-dublin.yaml b/products/onap-dublin/features/sdc/src/main/resources/open-cli-schema/vsp/vsp-package-schema-dublin.yaml
new file mode 100644
index 00000000..6cd48e87
--- /dev/null
+++ b/products/onap-dublin/features/sdc/src/main/resources/open-cli-schema/vsp/vsp-package-schema-dublin.yaml
@@ -0,0 +1,51 @@
+# Copyright © Intel Corporation 2019
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+open_cli_schema_version: 1.0
+name: vsp-package
+description: Package Vendor Software Product
+
+info:
+ product: onap-dublin
+ service: sdc
+ author: ONAP CLI Team onap-discuss@lists.onap.org
+
+parameters:
+ - name: vsp-id
+ description: Onap VSP ID
+ type: string
+ short_option: x
+ long_option: vsp-id
+ is_optional: false
+ - name: vsp-version
+ description: VSP version
+ type: string
+ short_option: y
+ long_option: vsp-version
+ is_optional: false
+http:
+ service:
+ name: sdc
+ version: v1.0
+ auth: basic
+ mode: direct
+ request:
+ uri: /onboarding-api/v1.0/vendor-software-products/${vsp-id}/versions/${vsp-version}/actions
+ method: PUT
+ body: '{"action": "Create_Package"}'
+ success_codes:
+ - 201
+ - 200
+ sample_response:
+ body: ''
diff --git a/products/onap-dublin/features/sdc/src/main/resources/open-cli-schema/vsp/vsp-submit-schema-dublin.yaml b/products/onap-dublin/features/sdc/src/main/resources/open-cli-schema/vsp/vsp-submit-schema-dublin.yaml
new file mode 100644
index 00000000..6d46f6fa
--- /dev/null
+++ b/products/onap-dublin/features/sdc/src/main/resources/open-cli-schema/vsp/vsp-submit-schema-dublin.yaml
@@ -0,0 +1,49 @@
+# Copyright © Intel Corporation 2019
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+open_cli_schema_version: 1.0
+name: vsp-submit
+description: Submit Vendor Software Product
+
+info:
+ product: onap-dublin
+ service: sdc
+ author: ONAP CLI Team onap-discuss@lists.onap.org
+
+parameters:
+ - name: vsp-id
+ description: Onap VSP ID
+ type: string
+ short_option: x
+ long_option: vsp-id
+ is_optional: false
+ - name: vsp-version
+ description: VSP version
+ type: string
+ short_option: y
+ long_option: vsp-version
+ is_optional: false
+http:
+ service:
+ name: sdc
+ version: v1.0
+ auth: basic
+ mode: direct
+ request:
+ uri: /onboarding-api/v1.0/vendor-software-products/${vsp-id}/versions/${vsp-version}/actions
+ method: PUT
+ body: '{"action": "Submit"}'
+ success_codes:
+ - 201
+ - 200
diff --git a/products/onap-dublin/features/sdc/src/main/resources/open-cli-schema/vsp/vsp-validate-schema-dublin.yaml b/products/onap-dublin/features/sdc/src/main/resources/open-cli-schema/vsp/vsp-validate-schema-dublin.yaml
new file mode 100644
index 00000000..41f1fea1
--- /dev/null
+++ b/products/onap-dublin/features/sdc/src/main/resources/open-cli-schema/vsp/vsp-validate-schema-dublin.yaml
@@ -0,0 +1,65 @@
+# Copyright © Intel Corporation 2019
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+open_cli_schema_version: 1.0
+name: vsp-validate
+description: Validate the uploaded Vendor Software Product
+
+info:
+ product: onap-dublin
+ service: sdc
+ author: ONAP CLI Team onap-discuss@lists.onap.org
+
+parameters:
+ - name: vsp-id
+ description: Onap VSP ID
+ type: string
+ short_option: x
+ long_option: vsp-id
+ is_optional: false
+ - name: vsp-version
+ description: VSP version
+ type: string
+ short_option: y
+ long_option: vsp-version
+ is_optional: false
+
+results:
+ direction: portrait
+ attributes:
+ - name: status
+ description: Validation status
+ scope: short
+ type: string
+ - name: errors
+ description: Validation messages
+ scope: short
+ type: json
+
+http:
+ service:
+ name: sdc
+ version: v1.0
+ auth: basic
+ mode: direct
+ request:
+ uri: /onboarding-api/v1.0/vendor-software-products/${vsp-id}/versions/${vsp-version}/orchestration-template-candidate/process
+ method: PUT
+ body: '{}'
+ success_codes:
+ - 201
+ - 200
+ result_map:
+ status: $b{$.status}
+ errors: $b{$.errors}