aboutsummaryrefslogtreecommitdiffstats
path: root/plugins/sdc/src/main/resources/open-cli-schema
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/sdc/src/main/resources/open-cli-schema')
-rw-r--r--plugins/sdc/src/main/resources/open-cli-schema/vsp/vsp-checkin-schema.yaml27
-rw-r--r--plugins/sdc/src/main/resources/open-cli-schema/vsp/vsp-checkout-schema.yaml28
-rw-r--r--plugins/sdc/src/main/resources/open-cli-schema/vsp/vsp-create-schema.yaml86
-rw-r--r--plugins/sdc/src/main/resources/open-cli-schema/vsp/vsp-list-schema.yaml32
-rw-r--r--plugins/sdc/src/main/resources/open-cli-schema/vsp/vsp-show-schema.yaml45
-rw-r--r--plugins/sdc/src/main/resources/open-cli-schema/vsp/vsp-submit-schema.yaml27
-rw-r--r--plugins/sdc/src/main/resources/open-cli-schema/vsp/vsp-upload-schema.yaml33
7 files changed, 278 insertions, 0 deletions
diff --git a/plugins/sdc/src/main/resources/open-cli-schema/vsp/vsp-checkin-schema.yaml b/plugins/sdc/src/main/resources/open-cli-schema/vsp/vsp-checkin-schema.yaml
new file mode 100644
index 00000000..4522b41d
--- /dev/null
+++ b/plugins/sdc/src/main/resources/open-cli-schema/vsp/vsp-checkin-schema.yaml
@@ -0,0 +1,27 @@
+open_cli_schema_version: 1.0
+name: vsp-checkin
+description: Checkin Vendor Software Product
+version: onap-1.0
+service:
+ name: sdc
+ version: v1.0
+ auth: basic
+ mode: direct
+
+parameters:
+ - name: vsp-id
+ description: Onap VSP ID
+ type: string
+ short_option: x
+ long_option: vsp-id
+ is_optional: false
+http:
+ request:
+ uri: /onboarding-api/v1.0/vendor-software-products/${vsp-id}/actions
+ method: PUT
+ body: '{"action": "Checkin"}'
+ success_codes:
+ - 201
+ - 200
+ sample_response:
+ body: ''
diff --git a/plugins/sdc/src/main/resources/open-cli-schema/vsp/vsp-checkout-schema.yaml b/plugins/sdc/src/main/resources/open-cli-schema/vsp/vsp-checkout-schema.yaml
new file mode 100644
index 00000000..d790ce55
--- /dev/null
+++ b/plugins/sdc/src/main/resources/open-cli-schema/vsp/vsp-checkout-schema.yaml
@@ -0,0 +1,28 @@
+open_cli_schema_version: 1.0
+name: vsp-checkout
+description: Checkout Vendor Software Product
+version: onap-1.1
+
+service:
+ name: sdc
+ version: v1.0
+ auth: basic
+ mode: direct
+
+parameters:
+ - name: vsp-id
+ description: Onap VSP ID
+ type: string
+ short_option: x
+ long_option: vsp-id
+ is_optional: false
+http:
+ request:
+ uri: /onboarding-api/v1.0/vendor-software-products/${vsp-id}/actions
+ method: PUT
+ body: '{"action": "Checkout"}'
+ success_codes:
+ - 201
+ - 200
+ sample_response:
+ body: ''
diff --git a/plugins/sdc/src/main/resources/open-cli-schema/vsp/vsp-create-schema.yaml b/plugins/sdc/src/main/resources/open-cli-schema/vsp/vsp-create-schema.yaml
new file mode 100644
index 00000000..4ce83d4b
--- /dev/null
+++ b/plugins/sdc/src/main/resources/open-cli-schema/vsp/vsp-create-schema.yaml
@@ -0,0 +1,86 @@
+open_cli_schema_version: 1.0
+name: vsp-create
+description: Create Vendor Software Product
+version: onap-1.0
+service:
+ name: sdc
+ version: v1.0
+ auth: basic
+ mode: direct
+
+parameters:
+ - name: vsp-name
+ description: Onap VSP Name
+ type: string
+ short_option: x
+ long_option: vsp-name
+ is_optional: false
+ - name: vsp-description
+ description: Description for VSP
+ type: string
+ short_option: y
+ long_option: vsp-description
+ is_optional: true
+ - name: vsp-category
+ description: Category of the VSP
+ type: string
+ short_option: b
+ long_option: vsp-category
+ is_optional: true
+ default_value: resourceNewCategory.generic
+ - name: vsp-subcategory
+ description: Sub Category of VSP
+ type: string
+ short_option: c
+ long_option: vsp-subcategory
+ is_optional: true
+ default_value: resourceNewCategory.generic.abstract
+ - name: vlm-version
+ description: License version
+ type: string
+ short_option: e
+ long_option: vlm-version
+ is_optional: true
+ default_value: 1.0
+ - name: vlm-vendor
+ description: License Model Name
+ type: string
+ short_option: g
+ long_option: vlm-vendor
+ is_optional: false
+ - name: vlm-id
+ description: License Model ID
+ type: string
+ short_option: i
+ long_option: vlm-id
+ is_optional: false
+ - name: vlm-agreement-id
+ description: License Agreement ID
+ type: string
+ short_option: j
+ long_option: vlm-agreement-id
+ is_optional: false
+ - name: vlm-feature-group-id
+ description: Feature Group ID
+ type: string
+ short_option: k
+ long_option: vlm-feature-group-id
+ is_optional: false
+results:
+ direction: portrait
+ attributes:
+ - name: ID
+ description: VSP ID
+ scope: short
+ type: string
+http:
+ request:
+ uri: /onboarding-api/v1.0/vendor-software-products
+ method: POST
+ body: '{"name": "${vsp-name}", "description": "${vsp-description}", "category": "${vsp-category}", "subCategory": "${vsp-subcategory}", "licensingVersion": "${vlm-version}", "vendorName": "${vlm-vendor}", "vendorId": "${vlm-id}", "icon": "icon", "licensingData": { "licenseAgreement": "${vlm-agreement-id}", "featureGroups": [ "${vlm-feature-group-id}" ]}}'
+ success_codes:
+ - 200
+ result_map:
+ ID: $b{$.vspId}
+ sample_response:
+ body: '{"vspId":"2DEB6CB4B082415BB7A697C9CD1273BA"}'
diff --git a/plugins/sdc/src/main/resources/open-cli-schema/vsp/vsp-list-schema.yaml b/plugins/sdc/src/main/resources/open-cli-schema/vsp/vsp-list-schema.yaml
new file mode 100644
index 00000000..f171b442
--- /dev/null
+++ b/plugins/sdc/src/main/resources/open-cli-schema/vsp/vsp-list-schema.yaml
@@ -0,0 +1,32 @@
+open_cli_schema_version: 1.0
+name: vsp-list
+description: List of the Vendor Software Products
+version: onap-1.0
+service:
+ name: sdc
+ version: v1.0
+ auth: basic
+ mode: direct
+
+results:
+ direction: landscape
+ attributes:
+ - name: ID
+ description: VSP ID
+ scope: short
+ type: string
+ - name: name
+ description: VSP Name
+ scope: short
+ type: string
+http:
+ request:
+ uri: /onboarding-api/v1.0/vendor-software-products
+ method: GET
+ success_codes:
+ - 200
+ result_map:
+ name: $b{results.[*].name}
+ ID: $b{results.[*].id}
+ sample_response:
+ body: '{"results":[{"name":"test-vsp1","description":"vendor software product","category":"resourceNewCategory.generic","subCategory":"resourceNewCategory.generic.abstract","vendorName":"5aa8a88c","vendorId":"DBB202617952486691C1E35C9621CD4E","licensingVersion":"1.0","licensingData":{"licenseAgreement":"E19DBDDB137B494385F9535325BFD585","featureGroups":["94835F096DAF4ED78781A394A4F22AD1"]},"id":"354BF3E32E494EAFBB15037CFAB262FF","version":"0.1","viewableVersions":["0.1"],"status":"Locked","lockingUser":"cs0008"},{"name":"test-vsp","description":"vendor software product","category":"resourceNewCategory.generic","subCategory":"resourceNewCategory.generic.abstract","vendorName":"5aa8a88c","vendorId":"DBB202617952486691C1E35C9621CD4E","licensingVersion":"1.0","licensingData":{"licenseAgreement":"E19DBDDB137B494385F9535325BFD585","featureGroups":["94835F096DAF4ED78781A394A4F22AD1"]},"id":"2DEB6CB4B082415BB7A697C9CD1273BA","version":"1.0","viewableVersions":["1.0"],"finalVersions":["1.0"],"status":"Final"}],"listCount":2}'
diff --git a/plugins/sdc/src/main/resources/open-cli-schema/vsp/vsp-show-schema.yaml b/plugins/sdc/src/main/resources/open-cli-schema/vsp/vsp-show-schema.yaml
new file mode 100644
index 00000000..47cc462e
--- /dev/null
+++ b/plugins/sdc/src/main/resources/open-cli-schema/vsp/vsp-show-schema.yaml
@@ -0,0 +1,45 @@
+open_cli_schema_version: 1.0
+name: vsp-show
+description: Details of the Vendor Software Product
+version: onap-1.0
+service:
+ name: sdc
+ version: v1.0
+ auth: basic
+ mode: direct
+
+parameters:
+ - name: vsp-id
+ description: Onap VSP ID
+ type: string
+ short_option: x
+ long_option: vsp-id
+ is_optional: false
+
+results:
+ direction: landscape
+ attributes:
+ - name: name
+ description: VSP Name
+ scope: short
+ type: string
+ - name: ID
+ description: VSP ID
+ scope: short
+ type: string
+ - name: description
+ description: Description for the VSP
+ scope: short
+ type: string
+http:
+ request:
+ uri: /onboarding-api/v1.0/vendor-software-products/${vsp-id}
+ method: GET
+ success_codes:
+ - 200
+ result_map:
+ name: $b{$.name}
+ ID: $b{$.id}
+ description: $b{$.description}
+ sample_response:
+ body: '{"name":"test-vsp1","description":"vendor software product","category":"resourceNewCategory.generic","subCategory":"resourceNewCategory.generic.abstract","vendorName":"5aa8a88c","vendorId":"DBB202617952486691C1E35C9621CD4E","licensingVersion":"1.0","licensingData":{"licenseAgreement":"E19DBDDB137B494385F9535325BFD585","featureGroups":["94835F096DAF4ED78781A394A4F22AD1"]},"id":"354BF3E32E494EAFBB15037CFAB262FF","version":"0.1","viewableVersions":["0.1"],"status":"Locked","lockingUser":"cs0008"}'
diff --git a/plugins/sdc/src/main/resources/open-cli-schema/vsp/vsp-submit-schema.yaml b/plugins/sdc/src/main/resources/open-cli-schema/vsp/vsp-submit-schema.yaml
new file mode 100644
index 00000000..d5f1733f
--- /dev/null
+++ b/plugins/sdc/src/main/resources/open-cli-schema/vsp/vsp-submit-schema.yaml
@@ -0,0 +1,27 @@
+open_cli_schema_version: 1.0
+name: vsp-submit
+description: Submit Vendor Software Product
+version: onap-1.0
+service:
+ name: sdc
+ version: v1.0
+ auth: basic
+ mode: direct
+
+parameters:
+ - name: vsp-id
+ description: Onap VSP ID
+ type: string
+ short_option: x
+ long_option: vsp-id
+ is_optional: false
+http:
+ request:
+ uri: /onboarding-api/v1.0/vendor-software-products/${vsp-id}/actions
+ method: PUT
+ body: '{"action": "Submit"}'
+ success_codes:
+ - 201
+ - 200
+ sample_response:
+ body: ''
diff --git a/plugins/sdc/src/main/resources/open-cli-schema/vsp/vsp-upload-schema.yaml b/plugins/sdc/src/main/resources/open-cli-schema/vsp/vsp-upload-schema.yaml
new file mode 100644
index 00000000..28d8c0a5
--- /dev/null
+++ b/plugins/sdc/src/main/resources/open-cli-schema/vsp/vsp-upload-schema.yaml
@@ -0,0 +1,33 @@
+open_cli_schema_version: 1.0
+name: vsp-upload
+description: Upload the CSAR file to VSP
+version: onap-1.0
+service:
+ name: sdc
+ version: v1.0
+ auth: basic
+ mode: direct
+
+parameters:
+ - name: vsp-id
+ description: Onap VSP ID
+ type: string
+ short_option: x
+ long_option: vsp-id
+ is_optional: false
+ - name: vsp-file
+ description: CSAR File path
+ type: binary
+ short_option: y
+ long_option: vsp-file
+ is_optional: false
+http:
+ request:
+ uri: /onboarding-api/v1.0/vendor-software-products/${vsp-id}/upload
+ method: POST
+ body: ${vsp-file}
+ multipart_entity_name: upload
+ success_codes:
+ - 200
+ sample_response:
+ body: ''