summaryrefslogtreecommitdiffstats
path: root/plugins/so/src/main/resources/open-cli-schema
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/so/src/main/resources/open-cli-schema')
-rw-r--r--plugins/so/src/main/resources/open-cli-schema/services/service-create-schema-1.1.yaml93
-rw-r--r--plugins/so/src/main/resources/open-cli-schema/services/service-delete-schema-1.1.yaml68
-rw-r--r--plugins/so/src/main/resources/open-cli-schema/services/vf-module-create-schema-1.1.yaml74
-rw-r--r--plugins/so/src/main/resources/open-cli-schema/services/vf-module-delete-schema-1.1.yaml68
-rw-r--r--plugins/so/src/main/resources/open-cli-schema/services/vnf-create-schema-1.1.yaml74
-rw-r--r--plugins/so/src/main/resources/open-cli-schema/services/vnf-delete-schema-1.1.yaml44
6 files changed, 421 insertions, 0 deletions
diff --git a/plugins/so/src/main/resources/open-cli-schema/services/service-create-schema-1.1.yaml b/plugins/so/src/main/resources/open-cli-schema/services/service-create-schema-1.1.yaml
new file mode 100644
index 00000000..96b7e036
--- /dev/null
+++ b/plugins/so/src/main/resources/open-cli-schema/services/service-create-schema-1.1.yaml
@@ -0,0 +1,93 @@
+open_cli_schema_version: 1.0
+name: service-create
+description: Create a service instance using MSO
+version: onap-1.1
+service:
+ name: so
+ 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: tenant id
+ type: string
+ short_option: b
+ long_option: tenant-id
+ is_optional: false
+ - name: model-invariant-id
+ description: model invariant id generated by ASDC.
+ type: string
+ short_option: e
+ long_option: model-invariant-id
+ is_optional: false
+ - name: model-uuid
+ description: model uuid generated by ASDC.
+ type: string
+ short_option: g
+ long_option: model-uuid
+ is_optional: false
+ - name: model-name
+ description: model name as provided in ASDC design time.
+ type: string
+ short_option: i
+ long_option: model-name
+ is_optional: false
+ - name: model-version
+ description: model-version
+ type: string
+ short_option: j
+ long_option: model-version
+ is_optional: false
+ - name: customer
+ description: unique id for customer
+ type: string
+ short_option: c
+ long_option: customer
+ is_optional: false
+ - name: instance-name
+ description: service instance name
+ type: string
+ short_option: k
+ 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-type
+ description: subscription service type
+ type: string
+ short_option: w
+ long_option: service-type
+ is_optional: false
+
+results:
+ direction: portrait
+ attributes:
+ - name: service-id
+ description: instance id for the created service.
+ type: string
+ scope: short
+
+
+http:
+ request:
+ 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_map:
+ service-id: $b{$.requestReferences.instanceId}
+ sample_response:
+ body: '{"requestReferences":{"instanceId":"${instance-id}","requestId":"375ba428-65e7-4f2b-afb9-74735ac6bfd0"}}'
diff --git a/plugins/so/src/main/resources/open-cli-schema/services/service-delete-schema-1.1.yaml b/plugins/so/src/main/resources/open-cli-schema/services/service-delete-schema-1.1.yaml
new file mode 100644
index 00000000..7ae110ed
--- /dev/null
+++ b/plugins/so/src/main/resources/open-cli-schema/services/service-delete-schema-1.1.yaml
@@ -0,0 +1,68 @@
+open_cli_schema_version: 1.0
+name: service-delete
+description: Delete service instance (experimental)
+version: onap-1.1
+service:
+ name: so
+ version: v3
+ auth: basic
+ mode: direct
+
+parameters:
+ - 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
+ short_option: b
+ long_option: model-invariant-id
+ is_optional: false
+ - name: model-uuid
+ description: model uuid for service in SDC catalog
+ type: string
+ short_option: i
+ long_option: model-uuid
+ is_optional: false
+ - name: model-name
+ description: model name available in SDC catalog
+ type: string
+ short_option: e
+ long_option: model-name
+ is_optional: false
+ - name: model-version
+ description: model version of service (eg. 1.0)
+ type: string
+ short_option: g
+ 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
+ short_option: j
+ long_option: cloud-region
+ is_optional: false
+ - name: tenant-id
+ description: tenant id
+ type: string
+ short_option: k
+ long_option: tenant-id
+ is_optional: false
+
+http:
+ request:
+ uri: /ecomp/mso/infra/serviceInstances/v3/${service-id}
+ method: DELETE
+ 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:
+ - 202 \ No newline at end of file
diff --git a/plugins/so/src/main/resources/open-cli-schema/services/vf-module-create-schema-1.1.yaml b/plugins/so/src/main/resources/open-cli-schema/services/vf-module-create-schema-1.1.yaml
new file mode 100644
index 00000000..170ba845
--- /dev/null
+++ b/plugins/so/src/main/resources/open-cli-schema/services/vf-module-create-schema-1.1.yaml
@@ -0,0 +1,74 @@
+open_cli_schema_version: 1.0
+name: vf-module-create
+description: Create a VF Module
+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: w
+ long_option: tenant-id
+ is_optional: false
+ - name: vnf-instance-id
+ description: vnf instance id
+ type: string
+ short_option: y
+ long_option: vnf-instace-id
+ is_optional: false
+ - name: service-instance-id
+ description: unique id for service instance
+ type: string
+ short_option: x
+ long_option: service-instace-id
+ is_optional: false
+ - name: parenet-service-model
+ description: parent service model name
+ type: string
+ short_option: z
+ long_option: parenet-service-model
+ 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: instance-name
+ description: service instance name
+ type: string
+ short_option: i
+ long_option: instance-name
+ is_optional: false
+
+results:
+ direction: portrait
+ attribute:
+ - name: vf-instance-id
+ description: id for the created vf
+ type: string
+ scope: short
+
+http:
+ request:
+ uri: ecomp/mso/infra/serviceInstances/v2/${service-instance-id}/vnfs/${vnf-instance-id}/vfModules
+ method: PUT
+ body: '{"requestDetails":{"modelInfo":{"modelType":"vfModule","modelInvariantId":"ff5256d2-5a33-55df-13ab-12abad84e7ff","modelNameVersionId":"fe6478e5-ea33-3346-ac12-ab121484a3fe","modelName":"vSAMP12..base..module-0","modelVersion":"1"},"cloudConfiguration":{"lcpCloudRegionId":"${lcp-cloudregion-id}","tenantId":"${tenant-id}"},"requestInfo":{"instanceName":"${instance-name}","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"}}},{"relatedInstance":{"instanceId":"${vnf-instance-id}","modelInfo":{"modelType":"vnf","modelInvariantId":"ff5256d1-5a33-55df-13ab-12abad84e7ff","modelNameVersionId":"fe6478e4-ea33-3346-ac12-ab121484a3fe","modelName":"vSAMP12","modelVersion":"1.0","modelCustomizationName":"vSAMP12 1"}}}],"requestParameters":{"userParams":[]}}}'
+
+ success_codes:
+ - 202
+ result_mpa:
+ vf-instance-id: $b{$.vfInstanceId}
+ sample_response:
+ body: '{"vfInstanceId":"234567AB"}'
diff --git a/plugins/so/src/main/resources/open-cli-schema/services/vf-module-delete-schema-1.1.yaml b/plugins/so/src/main/resources/open-cli-schema/services/vf-module-delete-schema-1.1.yaml
new file mode 100644
index 00000000..37754087
--- /dev/null
+++ b/plugins/so/src/main/resources/open-cli-schema/services/vf-module-delete-schema-1.1.yaml
@@ -0,0 +1,68 @@
+open_cli_schema_version: 1.0
+name: vfmodule-delete
+description: delete a VF module (experimental)
+version: onap-1.1
+service:
+ name: so
+ version: v3
+ auth: basic
+ mode: direct
+
+parameters:
+ - name: vfmodule-id
+ description: VF module Id
+ type: string
+ short_option: x
+ long_option: vfmodule-id
+ is_optional: false
+ - name: service-id
+ description: unique id for service
+ type: string
+ short_option: j
+ long_option: service-id
+ is_optional: false
+ - name: vf-id
+ description: unique id for related VF
+ type: string
+ short_option: y
+ long_option: vf-id
+ is_optional: false
+ - name: vf-model-invariant-id
+ description: vf model invariant id
+ type: string
+ short_option: k
+ long_option: vf-model-invariant-id
+ is_optional: false
+ - name: vfmodule-name
+ description: vfmodule model name
+ type: string
+ short_option: e
+ long_option: vfmodule-name
+ is_optional: false
+ - name: vfmodule-version
+ description: vf module version
+ type: string
+ short_option: g
+ long_option: vfmodule-version
+ is_optional: false
+ - 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
+ long_option: tenant-id
+ short_option: z
+ is_optional: false
+
+http:
+ request:
+ uri: /ecomp/mso/infra/serviceInstances/v3/${service-id}/vnfs/${vf-id}/vfModules/${vfmodule-id}
+ method: DELETE
+ body: '{"requestDetails":{"modelInfo":{"modelType":"vfModule","modelInvariantId":"${vf-model-invariant-id}","modelName":"${vfmodule-name}","modelVersion":"${vfmodule-version}"},"cloudConfiguration":{"lcpCloudRegionId":"${cloud-region}","tenantId":"${tenant-id}"},"requestInfo":{"source":"VID"}}}'
+
+ success_codes:
+ - 202 \ No newline at end of file
diff --git a/plugins/so/src/main/resources/open-cli-schema/services/vnf-create-schema-1.1.yaml b/plugins/so/src/main/resources/open-cli-schema/services/vnf-create-schema-1.1.yaml
new file mode 100644
index 00000000..899be1bb
--- /dev/null
+++ b/plugins/so/src/main/resources/open-cli-schema/services/vnf-create-schema-1.1.yaml
@@ -0,0 +1,74 @@
+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"}'
diff --git a/plugins/so/src/main/resources/open-cli-schema/services/vnf-delete-schema-1.1.yaml b/plugins/so/src/main/resources/open-cli-schema/services/vnf-delete-schema-1.1.yaml
new file mode 100644
index 00000000..08134f88
--- /dev/null
+++ b/plugins/so/src/main/resources/open-cli-schema/services/vnf-delete-schema-1.1.yaml
@@ -0,0 +1,44 @@
+open_cli_schema_version: 1.0
+name: vnf-delete
+description: delete a VNF
+version: onap-1.1
+service:
+ name: mso
+ version: v2
+ auth: basic
+ mode: direct
+
+parameters:
+ - name: vnf-instance-id
+ description: id for vnf
+ type: string
+ short_option: x
+ long_option: vnf-instace-id
+ is_optional: false
+ - name: service-instance-id
+ description: unique id for service instance
+ type: string
+ short_option: y
+ long_option: service-instace-id
+ is_optional: false
+ - 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
+
+http:
+ request:
+ uri: ecomp/mso/infra/serviceInstances/v2/${service-instance-id}/vnfs
+ method: DELETE
+ body: '{"requestDetails":{"modelInfo":{"modelType":"vnf","modelInvariantId":"ff5256d1-5a33-55df-13ab-12abad84e7ff","modelName":"vSAMP12","modelVersion":"1"},"cloudConfiguration":{"lcpCloudRegionId":"mdt1","tenantId":"88a6ca3ee0394ade9403f075db23167e"},"requestInfo":{"source":"VID"},"requestParameters":{"userParams":[]}}}'
+
+ success_codes:
+ - 202 \ No newline at end of file