Merge "vim schemas for onap-dublin CLI"

3 files changed, 292 insertions, 0 deletions

diff --git a/products/onap-dublin/features/aai/src/main/resources/open-cli-schema/esr/vim/vim-create-schema-dublin.yaml b/products/onap-dublin/features/aai/src/main/resources/open-cli-schema/esr/vim/vim-create-schema-dublin.yaml
new file mode 100644
index 00000000..c925e9d8
--- /dev/null
+++ b/products/onap-dublin/features/aai/src/main/resources/open-cli-schema/esr/vim/vim-create-schema-dublin.yaml
@@ -0,0 +1,122 @@
+# 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: vim-create
+description: Register a VIM under a given cloud region in Onap
+
+info:
+  product: onap-dublin
+  service: aai
+  author: ONAP CLI Team onap-discuss@lists.onap.org
+
+parameters:
+  - name: cloud-name
+    description: Onap cloud name
+    type: string
+    short_option: x
+    long_option: cloud-name
+    is_optional: false
+  - name: region-name
+    description: Onap  region name
+    type: string
+    short_option: y
+    long_option:  region-name
+    is_optional: false
+  - name: vim-id
+    description: Onap VIM unique id
+    type: uuid
+    short_option: z
+    long_option:  vim-id
+    is_optional: false
+  - name: name
+    description: Onap VIM name
+    type: string
+    short_option: b
+    long_option:  name
+    is_optional: false
+  - name: type
+    description: Onap VIM type
+    type: string
+    short_option: c
+    long_option:  type
+    is_optional: false
+  - name: vendor
+    description: Onap VIM vendor
+    type: string
+    short_option: e
+    long_option:  vendor
+    is_optional: false
+  - name: vim-version
+    description: Onap VIM version
+    type: string
+    short_option: q
+    long_option:  vim-version
+    is_optional: false
+  - name: url
+    description: Onap VIM URL
+    type: string
+    short_option: g
+    long_option:  url
+    is_optional: false
+  - name: username
+    description: Onap VIM username
+    type: string
+    short_option: i
+    long_option:  username
+    is_optional: false
+  - name: password
+    description: Onap VIM password
+    type: string
+    short_option: j
+    long_option:  password
+    is_optional: false
+  - name: ssl-cacert
+    description: Onap VIM SSL certificate
+    type: text
+    short_option: k
+    long_option:  ssl-cacert
+    is_optional: true
+  - name: ssl-insecure
+    description: Onap VIM insecure
+    type: bool
+    short_option: l
+    long_option:  ssl-insecure
+    is_optional: true
+    default: false
+  - name: cloud-domain
+    description: Onap VIM cloud domain
+    type: string
+    short_option: n
+    long_option:  cloud-domain
+    is_optional: false
+    default: default
+  - name: default-tenant
+    description: Onap VIM default tenant
+    type: string
+    short_option: o
+    long_option:  default-tenant
+    is_optional: false
+
+http:
+  service:
+    auth: basic
+    mode: direct
+  request:
+    uri: /aai/v13/cloud-infrastructure/cloud-regions/cloud-region/${cloud-name}/${region-name}/esr-system-info-list/esr-system-info/${vim-id}
+    method: PUT
+    body: '{"esr-system-info-id":"${vim-id}","system-name":"${name}","type":"${type}","vendor":"${vendor}","version":"${vim-version}","service-url":"${url}","user-name":"${username}","password":"${password}","system-type":"vim","protocal":"","ssl-cacert":"${ssl-cacert}","ssl-insecure":"${ssl-insecure}","ip-address":"","port":"","cloud-domain":"${cloud-domain}","default-tenant":"${default-tenant}"}'
+  success_codes:
+    - 201
+
diff --git a/products/onap-dublin/features/aai/src/main/resources/open-cli-schema/esr/vim/vim-delete-schema-dublin.yaml b/products/onap-dublin/features/aai/src/main/resources/open-cli-schema/esr/vim/vim-delete-schema-dublin.yaml
new file mode 100644
index 00000000..d5b76a1e
--- /dev/null
+++ b/products/onap-dublin/features/aai/src/main/resources/open-cli-schema/esr/vim/vim-delete-schema-dublin.yaml
@@ -0,0 +1,66 @@
+# 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: vim-delete
+
+description: Un-register a VIM under from cloud region in Onap
+
+
+info:
+  product: onap-dublin
+  service: aai
+  author: ONAP CLI Team onap-discuss@lists.onap.org
+
+parameters:
+  - name: cloud-name
+    description: Onap cloud name
+    type: string
+    short_option: x
+    long_option: cloud-name
+    is_optional: false
+  - name: region-name
+    description: Onap  region name
+    type: string
+    short_option: y
+    long_option:  region-name
+    is_optional: false
+  - name: vim-id
+    description: Onap VIM unique id
+    type: uuid
+    short_option: z
+    long_option:  vim-id
+    is_optional: false
+  - name: resource-version
+    description: Onap vim resource version
+    type: string
+    short_option: b
+    long_option: resource-version
+    is_optional: true
+
+http:
+  service:
+    auth: basic
+    mode: direct
+  request:
+    uri: /aai/v13/cloud-infrastructure/cloud-regions/cloud-region/${cloud-name}/${region-name}/esr-system-info-list/esr-system-info/${vim-id}?resource-version=${resource-version}
+    method: DELETE
+
+  success_codes:
+    - 204
+    - 404
+
+  sample_response:
+    body: ''
diff --git a/products/onap-dublin/features/aai/src/main/resources/open-cli-schema/esr/vim/vim-list-schema-dublin.yaml b/products/onap-dublin/features/aai/src/main/resources/open-cli-schema/esr/vim/vim-list-schema-dublin.yaml
new file mode 100644
index 00000000..9ac1cf91
--- /dev/null
+++ b/products/onap-dublin/features/aai/src/main/resources/open-cli-schema/esr/vim/vim-list-schema-dublin.yaml
@@ -0,0 +1,104 @@
+# 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: vim-list
+
+description: List the configured vims
+
+
+info:
+  product: onap-dublin
+  service: aai
+  author: ONAP CLI Team onap-discuss@lists.onap.org
+
+parameters:
+  - name: cloud-name
+    description: Onap cloud name
+    type: string
+    short_option: x
+    long_option: cloud-name
+    is_optional: false
+  - name: region-name
+    description: Onap  region name
+    type: string
+    short_option: y
+    long_option:  region-name
+    is_optional: false
+
+results:
+  direction: landscape
+  attributes:
+    - name: vim-id
+      description: Onap vim id
+      scope: short
+      type: string
+    - name: name
+      description: Onap vim name
+      scope: short
+      type: string
+    - name: type
+      description: Onap vim type
+      scope: long
+      type: string
+    - name: vendor
+      description: Onap vim vendor
+      scope: short
+      type: string
+    - name: version
+      description: Onap vim version
+      scope: long
+      type: string
+    - name: url
+      description: Onap vim url
+      scope: long
+      type: string
+    - name: username
+      description: Onap vim username
+      scope: long
+      type: string
+    - name: cloud-domain
+      description: Onap vim cloud domain
+      scope: long
+      type: string
+    - name: default-tenant
+      description: Onap vim tenant
+      scope: short
+      type: string
+    - name: resource-version
+      description: Onap vim resource version
+      scope: short
+      type: string
+
+http:
+  service:
+    auth: basic
+    mode: direct
+  request:
+    uri: /aai/v13/cloud-infrastructure/cloud-regions/cloud-region/${cloud-name}/${region-name}/esr-system-info-list
+    method: GET
+  success_codes:
+    - 200
+  result_map:
+    vim-id: $b{$.esr-system-info.[*].esr-system-info-id}
+    name: $b{$.esr-system-info.[*].system-name}
+    type: $b{$.esr-system-info.[*].type}
+    vendor: $b{$.esr-system-info.[*].vendor}
+    version: $b{$.esr-system-info.[*].version}
+    url: $b{$.esr-system-info.[*].service-url}
+    username: $b{$.esr-system-info.[*].user-name}
+    cloud-domain: $b{$.esr-system-info.[*].cloud-domain}
+    default-tenant: $b{$.esr-system-info.[*].default-tenant}
+    resource-version: $b{$.esr-system-info.[*].resource-version}