aboutsummaryrefslogtreecommitdiffstats
path: root/plugins/so/src/main/resources/onap-cli-schema/services
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/so/src/main/resources/onap-cli-schema/services')
-rw-r--r--plugins/so/src/main/resources/onap-cli-schema/services/service-create-schema-1.1.yaml63
-rw-r--r--plugins/so/src/main/resources/onap-cli-schema/services/service-delete-schema-1.1.yaml51
-rw-r--r--plugins/so/src/main/resources/onap-cli-schema/services/vf-create-schema-1.1.yaml108
-rw-r--r--plugins/so/src/main/resources/onap-cli-schema/services/vnf-create-schema-1.1.yaml74
4 files changed, 198 insertions, 98 deletions
diff --git a/plugins/so/src/main/resources/onap-cli-schema/services/service-create-schema-1.1.yaml b/plugins/so/src/main/resources/onap-cli-schema/services/service-create-schema-1.1.yaml
index 03d57582..a4593644 100644
--- a/plugins/so/src/main/resources/onap-cli-schema/services/service-create-schema-1.1.yaml
+++ b/plugins/so/src/main/resources/onap-cli-schema/services/service-create-schema-1.1.yaml
@@ -4,23 +4,47 @@ description: Create a service instance using MSO
version: onap-1.1
service:
name: mso
- version: v2
+ version: v3
auth: basic
mode: direct
parameters:
- - name: global-subscriber-id
+ - name: cloud-region
+ description: cloud region identifier
+ type: string
+ long_option: cloud-region
+ is_optional: false
+ - name: tenant-id
+ description: tenant id
+ type: string
+ long_option: tenant-id
+ is_optional: false
+ - name: model-invariant-id
+ description: model invariant id generated by ASDC.
+ type: string
+ long_option: model-invariant-id
+ is_optional: false
+ - name: model-uuid
+ description: model uuid generated by ASDC.
+ type: string
+ long_option: model-uuid
+ is_optional: false
+ - name: model-name
+ description: model name as provided in ASDC design time.
+ type: string
+ long_option: model-name
+ is_optional: false
+ - name: model-version
+ description: model-version
+ type: string
+ long_option: model-version
+ is_optional: false
+ - name: customer
description: unique id for customer
type: string
short_option: c
- long_option: global-subscriber-id
+ long_option: customer
is_optional: false
- - name: subscriber-name
- description: subscriber name
- type: string
- short_option: b
- long_option: subscriber-name
- is_optional: true
- name: instance-name
description: service instance name
type: string
@@ -33,11 +57,16 @@ parameters:
short_option: r
long_option: supress-rollback
is_optional: true
+ - name: service-type
+ description: subscription service type
+ type: string
+ long_option: service-type
+ is_optional: false
results:
direction: portrait
- attribute:
- - name: instance-id
+ attributes:
+ - name: service-id
description: instance id for the created service.
type: string
scope: short
@@ -45,13 +74,13 @@ results:
http:
request:
- uri: ecomp/mso/infra/serviceInstances/v2
- method: PUT
- body: '{"requestDetails": {"modelInfo": {"modelType": "service","modelInvariantId": "ff3514e3-5a33-55df-13ab-12abad84e7ff","modelNameVersionId": "fe6985cd-ea33-3346-ac12-ab121484a3fe","modelName": "Test","modelVersion": "1.0"},"subscriberInfo": {"globalSubscriberId": "${global-subscriber-id}","subscriberName": "${subscriber-name}"},"requestInfo": {"instanceName": "${instance-name}","source": "VID","suppressRollback": "${supress-rollback}"},"requestParameters": {"subscriptionServiceType": "MOG"}}}'
+ uri: /ecomp/mso/infra/serviceInstances/v3
+ method: POST
+ body: '{"requestDetails": {"cloudConfiguration" : {"lcpCloudRegionId": "${cloud-region}","tenantId": "${tenant-id}"},"modelInfo": {"modelType": "service","modelInvariantId": "${model-invariant-id}","modelNameVersionId": "${model-uuid}","modelName": "${model-name}","modelVersion": "${model-version}"},"subscriberInfo": {"globalSubscriberId": "${customer}"},"requestInfo": {"instanceName": "${instance-name}","source": "VID","suppressRollback": "${supress-rollback}"},"requestParameters": {"subscriptionServiceType": "${service-type}"}}}'
success_codes:
- 202
- result_mpa:
- instance-id: $b{$.instance-id}
+ result_map:
+ service-id: $b{$.requestReferences.instanceId}
sample_response:
- body: '{"instance-id":"234567AB"}'
+ body: '{"requestReferences":{"instanceId":"${instance-id}","requestId":"375ba428-65e7-4f2b-afb9-74735ac6bfd0"}}'
diff --git a/plugins/so/src/main/resources/onap-cli-schema/services/service-delete-schema-1.1.yaml b/plugins/so/src/main/resources/onap-cli-schema/services/service-delete-schema-1.1.yaml
index e7791d56..4c6e4a92 100644
--- a/plugins/so/src/main/resources/onap-cli-schema/services/service-delete-schema-1.1.yaml
+++ b/plugins/so/src/main/resources/onap-cli-schema/services/service-delete-schema-1.1.yaml
@@ -1,25 +1,62 @@
open_cli_schema_version: 1.0
name: service-delete
-description: Delete a service instance
+description: Delete service instance
version: onap-1.1
service:
- name: so
- version: v2
+ name: mso
+ version: v3
auth: basic
mode: direct
parameters:
- - name: service-instance-id
+ - name: service-id
description: unique id for service instance
type: string
short_option: x
long_option: service-instace-id
is_optional: false
+ - name: model-invariant-id
+ description: model invariant id for service in SDC catalog
+ type: string
+ long_option: model-invariant-id
+ is_optional: false
+ - name: model-uuid
+ description: model uuid for service in SDC catalog
+ type: string
+ long_option: model-uuid
+ is_optional: false
+ - name: model-name
+ description: model name available in SDC catalog
+ type: string
+ long_option: model-name
+ is_optional: false
+ - name: model-version
+ description: model version of service (eg. 1.0)
+ type: string
+ long_option: model-version
+ is_optional: false
+ - name: customer-name
+ description: unique id for customer
+ type: string
+ short_option: c
+ long_option: customer-name
+ is_optional: false
+ - name: cloud-region
+ description: cloud region id
+ type: string
+ long_option: cloud-region
+ is_optional: false
+ - name: tenant-id
+ description: tenant id
+ type: string
+ long_option: tenant-id
+ is_optional: false
http:
request:
- uri: /ecomp/mso/infra/serviceInstances/v2/${service-instance-id}
+ uri: /ecomp/mso/infra/serviceInstances/v3/${service-id}
method: DELETE
- body: '{"requestDetails": {"modelInfo": {"modelType": "service", "modelInvariantId": "ff3514e3-5a33-55df-13ab-12abad84e7ff", "modelName": "Test","modelVersion": "1.0"}, "requestInfo":{"source": "VID"}}}'
+ body: '{"requestDetails": {"modelInfo": {"modelType": "service","modelInvariantId": "${model-invariant-id}","modelVersionId": "${model-uuid}","modelName": "${model-name}","modelVersion": "${model-version}"},"cloudConfiguration" : {"lcpCloudRegionId": "${cloud-region}","tenantId": "${tenant-id}"},"subscriberInfo": {"globalSubscriberId": "${customer-name}"},"requestInfo": {"source": "VID"}}}'
+
success_codes:
- - 204 \ No newline at end of file
+ - 202 \ No newline at end of file
diff --git a/plugins/so/src/main/resources/onap-cli-schema/services/vf-create-schema-1.1.yaml b/plugins/so/src/main/resources/onap-cli-schema/services/vf-create-schema-1.1.yaml
new file mode 100644
index 00000000..8b1d4af7
--- /dev/null
+++ b/plugins/so/src/main/resources/onap-cli-schema/services/vf-create-schema-1.1.yaml
@@ -0,0 +1,108 @@
+open_cli_schema_version: 1.0
+name: vf-create
+description: Create a VF
+version: onap-1.1
+service:
+ name: mso
+ version: v3
+ auth: basic
+ mode: direct
+
+parameters:
+ - name: cloud-region
+ description: cloud region identifier
+ type: string
+ short_option: l
+ long_option: cloud-region
+ is_optional: false
+ - name: tenant-id
+ description: openstack tenant id
+ type: string
+ short_option: z
+ long_option: tenant-id
+ is_optional: false
+ - name: product-family
+ description: service type for serivce (e.g. vLB)
+ type: string
+ short_option: w
+ long_option: product-family
+ is_optional: false
+ - name: instance-name
+ description: service instance name
+ type: string
+ short_option: i
+ long_option: instance-name
+ is_optional: false
+ - name: service-instance-id
+ description: unique id for service instance
+ type: string
+ short_option: y
+ long_option: service-instance-id
+ is_optional: false
+ - name: vf-model-invariant-id
+ description: vf model invariant id
+ type: string
+ long_option: vf-model-invariant-id
+ is_optional: false
+ - name: vf-model-uuid
+ description: model uuid for vf
+ type: string
+ long_option: vf-model-uuid
+ is_optional: false
+ - name: vf-model-name
+ description: vf model name
+ type: string
+ long_option: vf-model-name
+ is_optional: false
+ - name: vf-model-version
+ description: vf model version
+ type: string
+ long_option: vf-model-version
+ is_optional: false
+ - name: vf-model-customization-id
+ description: vf model customization id
+ type: string
+ long_option: vf-model-customization-id
+ is_optional: false
+ - name: service-model-invariant-id
+ description: model invariant id
+ type: string
+ long_option: service-model-invariant-id
+ is_optional: false
+ - name: service-model-uuid
+ description: model name version id
+ type: string
+ long_option: service-model-uuid
+ is_optional: false
+ - name: service-model-name
+ description: service model name
+ type: string
+ long_option: service-model-name
+ is_optional: false
+ - name: service-model-version
+ description: service model version
+ type: string
+ long_option: service-model-version
+ is_optional: false
+
+
+results:
+ direction: portrait
+ attributes:
+ - name: vf-id
+ description: id for the created vnf
+ type: string
+ scope: short
+
+http:
+ request:
+ uri: /ecomp/mso/infra/serviceInstances/v3/${service-instance-id}/vnfs
+ method: POST
+ body: '{"requestDetails": {"modelInfo": {"modelType": "vnf","modelInvariantId": "${vf-model-invariant-id}","modelVersionId": "${vf-model-uuid}","modelName": "${vf-model-name}","modelVersion": "${vf-model-version}","modelCustomizationId": "${vf-model-customization-id}"},"cloudConfiguration": {"lcpCloudRegionId": "${cloud-region}","tenantId": "${tenant-id}"},"requestInfo": {"instanceName": "${instance-name}","source": "VID","productFamilyId": "${product-family}" },"relatedInstanceList": [{"relatedInstance": {"instanceId": "${service-instance-id}","modelInfo": {"modelType": "service","modelInvariantId": "${service-model-invariant-id}","modelVersionId": "${service-model-uuid}","modelName": "${service-model-name}","modelVersion": "${service-model-version}"}}}],"requestParameters": {}}}'
+
+ success_codes:
+ - 202
+ result_map:
+ vf-id: $b{$.requestReferences.instanceId}
+ sample_response:
+ body: '{"requestReferences": {"instanceId": "2a152730-f6eb-4dc6-9b81-7a6f6f263d71","requestId": "6402628f-7f67-4605-9e60-0d8632616d02"}}'
diff --git a/plugins/so/src/main/resources/onap-cli-schema/services/vnf-create-schema-1.1.yaml b/plugins/so/src/main/resources/onap-cli-schema/services/vnf-create-schema-1.1.yaml
deleted file mode 100644
index 899be1bb..00000000
--- a/plugins/so/src/main/resources/onap-cli-schema/services/vnf-create-schema-1.1.yaml
+++ /dev/null
@@ -1,74 +0,0 @@
-open_cli_schema_version: 1.0
-name: vnf-create
-description: Create a VNF
-version: onap-1.1
-service:
- name: mso
- version: v2
- auth: basic
- mode: direct
-
-parameters:
- - name: lcp-cloudregion-id
- description: AIC LCP node location identifier
- type: string
- short_option: l
- long_option: lcp-cloudregion-id
- is_optional: false
- - name: tenant-id
- description: openstack tenant id (uuid)
- type: string
- short_option: z
- long_option: tenant-id
- is_optional: false
- - name: product-family-id
- description: UUID for product family (named service id in AAI)
- type: string
- short_option: w
- long_option: product-family-id
- is_optional: false
- - name: instance-name
- description: service instance name
- type: string
- short_option: i
- long_option: instance-name
- is_optional: false
- - name: supress-rollback
- description: rollback changes if instantiation fails.
- type: bool
- short_option: r
- long_option: supress-rollback
- is_optional: true
- - name: service-instance-id
- description: unique id for service instance
- type: string
- short_option: y
- long_option: service-instance-id
- is_optional: false
- - name: parenet-service-model
- description: parent service model name
- type: string
- short_option: x
- long_option: parenet-service-model
- is_optional: false
-
-results:
- direction: portrait
- attribute:
- - name: vnf-instance-id
- description: id for the created vnf
- type: string
- scope: short
-
-http:
- request:
- uri: ecomp/mso/infra/serviceInstances/v2/${service-instance-id}/vnfs
- method: PUT
- body: '{"requestDetails":{"modelInfo":{"modelType":"vnf","modelInvariantId":"ff5256d1-5a33-55df-13ab-12abad84e7ff","modelNameVersionId":"fe6478e4-ea33-3346-ac12-ab121484a3fe","modelName":"vSAMP12","modelVersion":"1.0","modelCustomizationName":"vSAMP12 1"},"cloudConfiguration":{"lcpCloudRegionId": "${lcp-cloudregion-id}","tenantId":"${tenant-id}"},"requestInfo":{"instanceName":"${instance-name}","productFamilyId":"${product-family-id}","source":"VID","suppressRollback":"${supress-rollback}"},"relatedInstanceList":[{"relatedInstance":{"instanceId":"${service-instance-id}","modelInfo":{"modelType":"service","modelInvariantId":"ff3514e3-5a33-55df-13ab-12abad84e7ff","modelNameVersionId":"fe6985cd-ea33-3346-ac12-ab121484a3fe","modelName":"${parenet-service-model}","modelVersion":"1.0"}}}],"requestParameters":{}}}'
-
- success_codes:
- - 202
- result_mpa:
- vnf-instance-id: $b{$.vnfInstanceId}
- sample_response:
- body: '{"vnfInstanceId":"234567AB"}'