Merge "Schema files for msb in onap-dublin cli"

4 files changed, 339 insertions, 0 deletions

diff --git a/products/onap-dublin/features/msb/src/main/resources/open-cli-schema/microservice-create-schema.yaml b/products/onap-dublin/features/msb/src/main/resources/open-cli-schema/microservice-create-schema.yaml
new file mode 100644
index 00000000..461872a7
--- /dev/null
+++ b/products/onap-dublin/features/msb/src/main/resources/open-cli-schema/microservice-create-schema.yaml
@@ -0,0 +1,118 @@
+# 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: microservice-create
+description: Register microservice into Onap
+
+info:
+  product: onap-dublin
+  service: msb
+  author: ONAP CLI Team onap-discuss@lists.onap.org
+
+parameters:
+  - name: service-name
+    description: Onap service name
+    type: string
+    short_option: x
+    long_option: service-name
+    is_optional: false
+  - name: service-version
+    description: Onap service version
+    type: string
+    short_option: y
+    long_option: service-version
+    is_optional: false
+  - name: service-url
+    description: Onap service base url
+    type: url
+    short_option: r
+    long_option: service-url
+    is_optional: false
+  - name: enable-ssl
+    description: Onap service is enabled with https or not
+    type: string
+    short_option: b
+    long_option: enable-ssl
+    is_optional: true
+    default: false
+  - name: path
+    description: Onap service path
+    type: string
+    short_option: c
+    long_option: path
+    is_optional: true
+  - name: node-ip
+    description: Onap service running node IP
+    type: string
+  - name: node-port
+    description: Onap service running node port
+    type: string
+  - name: create-or-update
+    description: Onap service create or update
+    type: bool
+    default_value: true
+results:
+  direction: portrait
+  attributes:
+    - name: name
+      description: Onap service name
+      scope: short
+      type: string
+    - name: version
+      description: Onap service version
+      scope: short
+      type: string
+    - name: url
+      description: Onap service base url
+      scope: short
+      type: url
+    - name: status
+      description: Onap service status
+      scope: short
+      type: digit
+    - name: nodes
+      description: Onap service running nodes
+      scope: long
+      type: string
+    - name: enable-ssl
+      description: Onap service is enabled with https or not
+      scope: long
+      type: string
+    - name: path
+      description: Onap service path
+      scope: long
+      type: string
+http:
+  service:
+    auth: none
+    mode: direct
+  request:
+    uri: /api/microservices/v1/services
+    method: POST
+    body: '{"serviceName":"${service-name}","version":"${service-version}","path":"${path}","url":"${service-url}","protocol":"REST", "enable_ssl":"${enable-ssl}", "visualRange":"1","lb_policy":"ip_hash","nodes":[{"ip":"${node-ip}","port":"${node-port}","ttl":0}]}'
+    headers:
+    queries:
+      createOrUpdate: ${create-or-update}
+  success_codes:
+    - 201
+    - 200
+  result_map:
+    name: $b{$.serviceName}
+    version: $b{$.version}
+    url: $b{$.url}
+    status: $b{$.status}
+    enable-ssl: $b{$.enable_ssl}
+    path: $b{$.path}
+    nodes: $b{$.nodes[*].ip}:$b{$.nodes[*].port}
diff --git a/products/onap-dublin/features/msb/src/main/resources/open-cli-schema/microservice-delete-schema.yaml b/products/onap-dublin/features/msb/src/main/resources/open-cli-schema/microservice-delete-schema.yaml
new file mode 100644
index 00000000..04e3af57
--- /dev/null
+++ b/products/onap-dublin/features/msb/src/main/resources/open-cli-schema/microservice-delete-schema.yaml
@@ -0,0 +1,63 @@
+# 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: microservice-delete
+description: Deletes the micro service from Onap
+
+info:
+  product: onap-dublin
+  service: msb
+  author: ONAP CLI Team onap-discuss@lists.onap.org
+
+parameters:
+  - name: service-name
+    description: Onap service name
+    type: string
+    short_option: x
+    long_option: service-name
+    is_optional: false
+  - name: service-version
+    description: Onap service version
+    type: string
+    short_option: y
+    long_option: service-version
+    is_optional: false
+  - name: node-ip
+    description: Onap service running node IP
+    type: string
+    short_option: i
+    long_option: node-ip
+    is_optional: false
+  - name: node-port
+    description: Onap service running node port
+    type: string
+    short_option: r
+    long_option: node-port
+    is_optional: false
+http:
+  service:
+    auth: none
+    mode: direct
+  request:
+    uri: /api/microservices/v1/services/${service-name}/version/${service-version}/nodes/${node-ip}/${node-port}
+    method: DELETE
+  success_codes:
+    - 201
+    - 200
+    - 204
+    - 500
+
+
+
diff --git a/products/onap-dublin/features/msb/src/main/resources/open-cli-schema/microservice-list-schema.yaml b/products/onap-dublin/features/msb/src/main/resources/open-cli-schema/microservice-list-schema.yaml
new file mode 100644
index 00000000..97132a32
--- /dev/null
+++ b/products/onap-dublin/features/msb/src/main/resources/open-cli-schema/microservice-list-schema.yaml
@@ -0,0 +1,73 @@
+# 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: microservice-list
+description: Lists the registetred micro services in Onap
+
+
+info:
+  product: onap-dublin
+  service: msb
+  author: ONAP CLI Team onap-discuss@lists.onap.org
+
+results:
+  direction: landscape
+  attributes:
+    - name: name
+      description: Onap service name
+      scope: short
+      type: string
+    - name: version
+      description: Onap service version
+      scope: short
+      type: string
+    - name: url
+      description: Onap service base url
+      scope: short
+      type: url
+    - name: status
+      description: Onap service status
+      scope: short
+      type: digit
+    - name: nodes
+      description: Onap service running nodes
+      scope: long
+      type: json
+    - name: enable-ssl
+      description: Onap service is enabled with https or not
+      scope: long
+      type: string
+    - name: path
+      description: Onap service path
+      scope: long
+      type: string
+http:
+  service:
+    auth: none
+    mode: direct
+  request:
+    uri: /api/microservices/v1/services
+    method: GET
+  success_codes:
+    - 201
+    - 200
+  result_map:
+    name: $b{$.[*].serviceName}
+    version: $b{$.[*].version}
+    url: $b{$.[*].url}
+    status: $b{$.[*].status}
+    enable-ssl: $b{$.[*].enable_ssl}
+    path: $b{$.[*].path}
+    nodes: $b{$.[*].nodes[*].ip}:$b{$.[*].nodes[*].port}
diff --git a/products/onap-dublin/features/msb/src/main/resources/open-cli-schema/microservice-show-schema.yaml b/products/onap-dublin/features/msb/src/main/resources/open-cli-schema/microservice-show-schema.yaml
new file mode 100644
index 00000000..e8323bc0
--- /dev/null
+++ b/products/onap-dublin/features/msb/src/main/resources/open-cli-schema/microservice-show-schema.yaml
@@ -0,0 +1,85 @@
+# 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: microservice-show
+description: Details the registered microservice in Onap
+
+info:
+  product: onap-dublin
+  service: msb
+  author: ONAP CLI Team onap-discuss@lists.onap.org
+
+parameters:
+  - name: service-name
+    description: Onap service name
+    type: string
+    short_option: x
+    long_option: service-name
+    is_optional: false
+  - name: service-version
+    description: Onap service version
+    type: string
+    short_option: y
+    long_option: service-version
+    is_optional: false
+results:
+  direction: portrait
+  attributes:
+    - name: name
+      description: Onap service name
+      scope: short
+      type: string
+    - name: version
+      description: Onap service version
+      scope: short
+      type: string
+    - name: url
+      description: Onap service base url
+      scope: short
+      type: url
+    - name: status
+      description: Onap service status
+      scope: short
+      type: digit
+    - name: nodes
+      description: Onap service running nodes
+      scope: long
+      type: json
+    - name: enable-ssl
+      description: Onap service is enabled with https or not
+      scope: long
+      type: string
+    - name: path
+      description: Onap service path
+      scope: long
+      type: string
+http:
+  service:
+    auth: none
+    mode: direct
+  request:
+    uri: /api/microservices/v1/services/${service-name}/version/${service-version}
+    method: GET
+  success_codes:
+    - 201
+    - 200
+  result_map:
+    name: $b{$.serviceName}
+    version: $b{$.version}
+    url: $b{$.url}
+    status: $b{$.status}
+    enable-ssl: $b{$.enable_ssl}
+    path: $b{$.path}
+    nodes: $b{$.nodes[*].ip}:$b{$.nodes[*].port}