AAI customer schema files for onap-dublin 03/79803/1
authorItohan Ukponmwan <itohan.ukponmwan@intel.com>
Wed, 6 Mar 2019 19:31:49 +0000 (19:31 +0000)
committerItohan Ukponmwan <itohan.ukponmwan@intel.com>
Wed, 6 Mar 2019 19:31:49 +0000 (19:31 +0000)
Change-Id: I9f8f6213d52630d75b41181432b7070efbdfca73
Issue-ID: CLI-130
Signed-off-by: Itohan Ukponmwan <itohan.ukponmwan@intel.com>
products/onap-dublin/features/aai/src/main/resources/open-cli-schema/business/customer/customer-create-schema-dublin.yaml [new file with mode: 0644]
products/onap-dublin/features/aai/src/main/resources/open-cli-schema/business/customer/customer-delete-schema-dublin.yaml [new file with mode: 0644]
products/onap-dublin/features/aai/src/main/resources/open-cli-schema/business/customer/customer-list-schema-dublin.yaml [new file with mode: 0644]
products/onap-dublin/features/aai/src/main/resources/open-cli-schema/business/customer/customer-show-schema-dublin.yaml [new file with mode: 0644]

diff --git a/products/onap-dublin/features/aai/src/main/resources/open-cli-schema/business/customer/customer-create-schema-dublin.yaml b/products/onap-dublin/features/aai/src/main/resources/open-cli-schema/business/customer/customer-create-schema-dublin.yaml
new file mode 100644 (file)
index 0000000..70eb054
--- /dev/null
@@ -0,0 +1,47 @@
+# 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: customer-create
+description: Create a customer in Onap
+
+info:
+  product: onap-dublin
+  service: aai
+  author: ONAP CLI Team onap-discuss@lists.onap.org
+
+parameters:
+  - name: customer-name
+    description: Onap customer name
+    type: string
+    short_option: x
+    long_option: customer-name
+    is_optional: false
+  - name: subscriber-name
+    description: Onap subscriber name
+    type: string
+    short_option: y
+    long_option: subscriber-name
+    is_optional: false
+
+http:
+  service:
+    auth: basic
+    mode: direct
+  request:
+    uri: /aai/v13/business/customers/customer/${customer-name}
+    method: PUT
+    body: '{"global-customer-id": "${customer-name}", "subscriber-name": "${subscriber-name}", "subscriber-type": "INFRA"}'
+  success_codes:
+    - 201
diff --git a/products/onap-dublin/features/aai/src/main/resources/open-cli-schema/business/customer/customer-delete-schema-dublin.yaml b/products/onap-dublin/features/aai/src/main/resources/open-cli-schema/business/customer/customer-delete-schema-dublin.yaml
new file mode 100644 (file)
index 0000000..16edb53
--- /dev/null
@@ -0,0 +1,46 @@
+# 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: customer-delete
+description: Delete a customer from Onap
+
+info:
+  product: onap-dublin
+  service: aai
+  author: ONAP CLI Team onap-discuss@lists.onap.org
+
+parameters:
+  - name: customer-id
+    description: Onap customer id
+    type: string
+    short_option: x
+    long_option: customer-id
+    is_optional: false
+  - name: resource-version
+    description: Onap customer resource version
+    type: uuid
+    short_option: y
+    long_option: resource-version
+    is_optional: false
+http:
+  service:
+    auth: basic
+    mode: direct
+  request:
+    uri: /aai/v13/business/customers/customer/${customer-id}?resource-version=${resource-version}
+    method: DELETE
+  success_codes:
+    - 204
+    - 404
diff --git a/products/onap-dublin/features/aai/src/main/resources/open-cli-schema/business/customer/customer-list-schema-dublin.yaml b/products/onap-dublin/features/aai/src/main/resources/open-cli-schema/business/customer/customer-list-schema-dublin.yaml
new file mode 100644 (file)
index 0000000..f22d449
--- /dev/null
@@ -0,0 +1,47 @@
+# 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: customer-list
+description: Lists the registered customers in Onap
+
+info:
+  product: onap-dublin
+  service: aai
+  author: ONAP CLI Team onap-discuss@lists.onap.org
+
+results:
+  direction: landscape
+  attributes:
+    - name: name
+      description: Onap customer name
+      scope: short
+      type: string
+    - name: resource-version
+      description: Onap customer resource version
+      scope: short
+      type: string
+http:
+  service:
+    auth: basic
+    mode: direct
+  request:
+    uri: /aai/v13/business/customers
+    method: GET
+  success_codes:
+    - 200
+    - 404
+  result_map:
+    name: $b{customer.[*].global-customer-id}
+    resource-version: $b{customer.[*].resource-version}
diff --git a/products/onap-dublin/features/aai/src/main/resources/open-cli-schema/business/customer/customer-show-schema-dublin.yaml b/products/onap-dublin/features/aai/src/main/resources/open-cli-schema/business/customer/customer-show-schema-dublin.yaml
new file mode 100644 (file)
index 0000000..05d4176
--- /dev/null
@@ -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: customer-show
+description: Retrieves the given registered customer in Onap
+
+info:
+  product: onap-dublin
+  service: aai
+  author: ONAP CLI Team onap-discuss@lists.onap.org
+
+parameters:
+  - name: customer-name
+    description: Onap customer name
+    type: string
+    short_option: x
+    long_option: customer-name
+    is_optional: false
+
+results:
+  direction: landscape
+  attributes:
+    - name: name
+      description: Onap customer name
+      scope: short
+      type: string
+    - name: subscriber-name
+      description: Onap subscriber name
+      scope: short
+      type: string
+    - name: resource-version
+      description: Onap subscriber resource version
+      scope: long
+      type: string
+    - name: subscriber-type
+      description: Onap subscriber type
+      scope: long
+      type: string
+http:
+  service:
+    auth: basic
+    mode: direct
+  request:
+    uri: /aai/v13/business/customers/customer/${customer-name}
+    method: GET
+  success_codes:
+    - 200
+  result_map:
+    name: $b{$.global-customer-id}
+    subscriber-name: $b{$.subscriber-name}
+    subscriber-type: $b{$.subscriber-type}
+    resource-version: $b{$.resource-version}
+  sample_response:
+    body: '{"global-customer-id":"Linan","subscriber-name":"Linan","subscriber-type":"INFRA","resource-version":"1501768482","service-subscriptions":{"service-subscription":[{"service-type":"vFW","resource-version":"1501768482","relationship-list":{"relationship":[{"related-to":"tenant","related-link":"https://192.168.17.12:8443/aai/v8/cloud-infrastructure/cloud-regions/cloud-region/Rackspace/RegionOne/tenants/tenant/e69e6d64b44347509c3fc512391f34a6/","relationship-data":[{"relationship-key":"cloud-region.cloud-owner","relationship-value":"Rackspace"},{"relationship-key":"cloud-region.cloud-region-id","relationship-value":"RegionOne"},{"relationship-key":"tenant.tenant-id","relationship-value":"e69e6d64b44347509c3fc512391f34a6"}],"related-to-property":[{"property-key":"tenant.tenant-name","property-value":"onap"}]}]}},{"service-type":"vLB","resource-version":"1501768482","relationship-list":{"relationship":[{"related-to":"tenant","related-link":"https://192.168.17.12:8443/aai/v8/cloud-infrastructure/cloud-regions/cloud-region/Rackspace/RegionOne/tenants/tenant/e69e6d64b44347509c3fc512391f34a6/","relationship-data":[{"relationship-key":"cloud-region.cloud-owner","relationship-value":"Rackspace"},{"relationship-key":"cloud-region.cloud-region-id","relationship-value":"RegionOne"},{"relationship-key":"tenant.tenant-id","relationship-value":"e69e6d64b44347509c3fc512391f34a6"}],"related-to-property":[{"property-key":"tenant.tenant-name","property-value":"onap"}]}]}}]}}'