summaryrefslogtreecommitdiffstats
path: root/framework/src/main/resources/open-cli-schema
diff options
context:
space:
mode:
Diffstat (limited to 'framework/src/main/resources/open-cli-schema')
-rw-r--r--framework/src/main/resources/open-cli-schema/default_input_parameters.yaml1
-rw-r--r--framework/src/main/resources/open-cli-schema/execution/execution-list.yaml114
-rw-r--r--framework/src/main/resources/open-cli-schema/execution/execution-show.yaml74
-rw-r--r--framework/src/main/resources/open-cli-schema/open-cli-registry.yaml40
-rw-r--r--framework/src/main/resources/open-cli-schema/product/product-list.yaml35
-rw-r--r--framework/src/main/resources/open-cli-schema/product/service-list.yaml43
-rw-r--r--framework/src/main/resources/open-cli-schema/schema/schema-list.yaml (renamed from framework/src/main/resources/open-cli-schema/schema-list.yaml)23
-rw-r--r--framework/src/main/resources/open-cli-schema/schema/schema-refresh.yaml (renamed from framework/src/main/resources/open-cli-schema/schema-refresh.yaml)8
-rw-r--r--framework/src/main/resources/open-cli-schema/schema/schema-show.yaml51
-rw-r--r--framework/src/main/resources/open-cli-schema/schema/schema-switch.yaml37
-rw-r--r--framework/src/main/resources/open-cli-schema/schema/schema-validate.yaml (renamed from framework/src/main/resources/open-cli-schema/schema-validate.yaml)4
11 files changed, 416 insertions, 14 deletions
diff --git a/framework/src/main/resources/open-cli-schema/default_input_parameters.yaml b/framework/src/main/resources/open-cli-schema/default_input_parameters.yaml
index aab74986..d1a074d7 100644
--- a/framework/src/main/resources/open-cli-schema/default_input_parameters.yaml
+++ b/framework/src/main/resources/open-cli-schema/default_input_parameters.yaml
@@ -72,5 +72,4 @@ parameters:
short_option: D
long_option: context
is_default_param: true
- is_optional: true
is_optional: true \ No newline at end of file
diff --git a/framework/src/main/resources/open-cli-schema/execution/execution-list.yaml b/framework/src/main/resources/open-cli-schema/execution/execution-list.yaml
new file mode 100644
index 00000000..55ac6ca0
--- /dev/null
+++ b/framework/src/main/resources/open-cli-schema/execution/execution-list.yaml
@@ -0,0 +1,114 @@
+# Copyright 2018 Huawei Technologies Co., Ltd.
+#
+# 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: execution-list
+description: List the executions of the given command so far
+
+info:
+ product: open-cli
+ service: execution
+ type: cmd
+ author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
+
+parameters:
+ - name: request-id
+ type: string
+ description: Request id
+ short_option: e
+ long_option: request-id
+ is_optional: true
+ - name: product
+ type: string
+ description: For a given product version
+ short_option: l
+ long_option: product
+ is_optional: true
+ - name: service
+ type: string
+ description: For a given service
+ short_option: b
+ long_option: service
+ is_optional: true
+ - name: profile
+ type: string
+ description: For a given profile
+ short_option: c
+ long_option: profile
+ is_optional: true
+ - name: command
+ type: string
+ description: For a given command
+ short_option: n
+ long_option: command
+ is_optional: true
+ - name: start-time
+ type: string
+ description: From start time
+ short_option: x
+ long_option: start-time
+ is_optional: true
+ - name: end-time
+ type: string
+ description: Till end time
+ short_option: y
+ long_option: end-time
+ is_optional: true
+results:
+ direction: landscape
+ attributes:
+ - name: request-id
+ description: Request id
+ scope: short
+ type: string
+ - name: execution-id
+ description: Execution id
+ scope: short
+ type: string
+ - name: product
+ description: Product
+ scope: short
+ type: string
+ - name: service
+ description: service
+ scope: short
+ type: string
+ - name: command
+ description: command
+ scope: short
+ type: string
+ - name: profile
+ description: Profile
+ scope: short
+ type: string
+ - name: status
+ description: Execution status
+ scope: short
+ type: string
+ - name: start-time
+ description: Command execution starting Time
+ scope: short
+ type: string
+ - name: end-time
+ description: Command execution finishing Time
+ scope: short
+ type: string
+ - name: input
+ description: Input
+ scope: long
+ type: string
+ - name: output
+ description: Output
+ scope: long
+ type: string \ No newline at end of file
diff --git a/framework/src/main/resources/open-cli-schema/execution/execution-show.yaml b/framework/src/main/resources/open-cli-schema/execution/execution-show.yaml
new file mode 100644
index 00000000..7b4bd599
--- /dev/null
+++ b/framework/src/main/resources/open-cli-schema/execution/execution-show.yaml
@@ -0,0 +1,74 @@
+# Copyright 2018 Huawei Technologies Co., Ltd.
+#
+# 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: execution-show
+description: Show the complete executions for the given request id
+
+info:
+ product: open-cli
+ service: execution
+ type: cmd
+ author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
+
+parameters:
+ - name: execution-id
+ type: string
+ description: Execution id
+ short_option: l
+ long_option: execution-id
+ is_optional: false
+results:
+ direction: portrait
+ attributes:
+ - name: request-id
+ type: string
+ description: Request id
+ scope: short
+ - name: product
+ description: Product
+ scope: short
+ type: string
+ - name: service
+ description: service
+ scope: short
+ type: string
+ - name: command
+ description: command
+ scope: short
+ type: string
+ - name: profile
+ description: Profile
+ scope: short
+ type: string
+ - name: input
+ description: Input
+ scope: short
+ type: string
+ - name: status
+ description: Execution status
+ scope: short
+ type: string
+ - name: start-time
+ description: Command execution starting Time
+ scope: short
+ type: string
+ - name: end-time
+ description: Command execution finishing Time
+ scope: short
+ type: string
+ - name: output
+ description: Output
+ scope: short
+ type: string \ No newline at end of file
diff --git a/framework/src/main/resources/open-cli-schema/open-cli-registry.yaml b/framework/src/main/resources/open-cli-schema/open-cli-registry.yaml
new file mode 100644
index 00000000..9b988b4e
--- /dev/null
+++ b/framework/src/main/resources/open-cli-schema/open-cli-registry.yaml
@@ -0,0 +1,40 @@
+# Copyright 2018 Huawei Technologies Co., Ltd.
+#
+# 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
+
+product:
+ name: OPEN CLI
+
+ version: 1.0
+
+ description: |
+ OPEN CLI PLATFORM provides a dynamic platform to load and execute commands
+ based on the Open Command Specification (OCS) 1.0.
+
+contact: Kanagaraj Manickam kanagaraj.manickam@huawei.com
+
+services:
+ - name: product
+ description: Product and service searching abilities
+ - name: schema
+ description: OCS schema management
+ - name: profile
+ description: Profile management
+ - name: artifact
+ description: Artifact management
+ - name: execution
+ description: Execution management
+ - name: rpc
+ description: RPC management across OCLIP \ No newline at end of file
diff --git a/framework/src/main/resources/open-cli-schema/product/product-list.yaml b/framework/src/main/resources/open-cli-schema/product/product-list.yaml
new file mode 100644
index 00000000..6b0d49b5
--- /dev/null
+++ b/framework/src/main/resources/open-cli-schema/product/product-list.yaml
@@ -0,0 +1,35 @@
+# Copyright 2018 Huawei Technologies Co., Ltd.
+#
+# 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: product-list
+description: List available products registered in OCLIP
+
+info:
+ product: open-cli
+ service: product
+ type: cmd
+ author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
+
+results:
+ direction: landscape
+ attributes:
+ - name: product
+ description: Product name
+ scope: short
+ type: string
+ - name: description
+ description: Product description
+ scope: short
+ type: string \ No newline at end of file
diff --git a/framework/src/main/resources/open-cli-schema/product/service-list.yaml b/framework/src/main/resources/open-cli-schema/product/service-list.yaml
new file mode 100644
index 00000000..8a84b257
--- /dev/null
+++ b/framework/src/main/resources/open-cli-schema/product/service-list.yaml
@@ -0,0 +1,43 @@
+# Copyright 2019 Huawei Technologies Co., Ltd.
+#
+# 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: service-list
+description: List the services in given product registered in OCLIP
+
+info:
+ product: open-cli
+ service: product
+ type: cmd
+ author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
+
+parameters:
+ - name: product
+ type: string
+ description: For a given product version
+ short_option: l
+ long_option: product
+ is_optional: false
+
+results:
+ direction: landscape
+ attributes:
+ - name: service
+ description: Service name
+ scope: short
+ type: string
+ - name: description
+ description: Product description
+ scope: short
+ type: string \ No newline at end of file
diff --git a/framework/src/main/resources/open-cli-schema/schema-list.yaml b/framework/src/main/resources/open-cli-schema/schema/schema-list.yaml
index 44172d75..4f971ce2 100644
--- a/framework/src/main/resources/open-cli-schema/schema-list.yaml
+++ b/framework/src/main/resources/open-cli-schema/schema/schema-list.yaml
@@ -29,20 +29,25 @@ parameters:
short_option: l
long_option: product
is_optional: false
-
+ - name: service
+ type: string
+ description: For a given service in a product
+ short_option: n
+ long_option: service
+ is_optional: true
results:
direction: landscape
attributes:
- - name: sr.no
- description: Serial Number
- scope: short
- type: string
- name: command
description: Command name
scope: short
type: string
- name: schema
description: Schema name
+ scope: long
+ type: string
+ - name: service
+ description: Service name
scope: short
type: string
- name: ocs-version
@@ -51,5 +56,13 @@ results:
type: string
- name: type
description: Command type
+ scope: long
+ type: string
+ - name: enabled
+ description: Command is enabled or not
+ scope: short
+ type: string
+ - name: rpc
+ description: Command is executed remotely
scope: short
type: string \ No newline at end of file
diff --git a/framework/src/main/resources/open-cli-schema/schema-refresh.yaml b/framework/src/main/resources/open-cli-schema/schema/schema-refresh.yaml
index 1e448c9f..f3604845 100644
--- a/framework/src/main/resources/open-cli-schema/schema-refresh.yaml
+++ b/framework/src/main/resources/open-cli-schema/schema/schema-refresh.yaml
@@ -25,10 +25,6 @@ info:
results:
direction: landscape
attributes:
- - name: sr.no
- description: Serial Number
- scope: short
- type: string
- name: command
description: Command name
scope: short
@@ -48,4 +44,8 @@ results:
- name: type
description: Command type
scope: short
+ type: string
+ - name: enabled
+ description: Command is enabled or not
+ scope: short
type: string \ No newline at end of file
diff --git a/framework/src/main/resources/open-cli-schema/schema/schema-show.yaml b/framework/src/main/resources/open-cli-schema/schema/schema-show.yaml
new file mode 100644
index 00000000..451d36d8
--- /dev/null
+++ b/framework/src/main/resources/open-cli-schema/schema/schema-show.yaml
@@ -0,0 +1,51 @@
+# Copyright 2018 Huawei Technologies Co., Ltd.
+#
+# 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: schema-show
+description: OCLIP command to show available schema in JSON format
+
+info:
+ product: open-cli
+ service: schema
+ type: cmd
+ author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
+
+parameters:
+ - name: product
+ type: string
+ description: For a given product version
+ short_option: l
+ long_option: product
+ is_optional: false
+ - name: service
+ type: string
+ description: For a given service
+ short_option: x
+ long_option: service
+ is_optional: true
+ - name: command
+ type: string
+ description: Schema details to fetch
+ short_option: n
+ long_option: command
+ is_optional: false
+
+results:
+ direction: portrait
+ attributes:
+ - name: schema
+ description: Scheam json
+ scope: short
+ type: json \ No newline at end of file
diff --git a/framework/src/main/resources/open-cli-schema/schema/schema-switch.yaml b/framework/src/main/resources/open-cli-schema/schema/schema-switch.yaml
new file mode 100644
index 00000000..b676e851
--- /dev/null
+++ b/framework/src/main/resources/open-cli-schema/schema/schema-switch.yaml
@@ -0,0 +1,37 @@
+# Copyright 2018 Huawei Technologies Co., Ltd.
+#
+# 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: schema-switch
+description: OCLIP command to switch the given command enable/disable
+
+info:
+ product: open-cli
+ service: schema
+ type: cmd
+ author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
+
+parameters:
+ - name: name
+ type: string
+ description: Command name
+ short_option: l
+ long_option: name
+ is_optional: false
+ - name: product
+ type: string
+ description: Product name
+ short_option: i
+ long_option: product
+ is_optional: false
diff --git a/framework/src/main/resources/open-cli-schema/schema-validate.yaml b/framework/src/main/resources/open-cli-schema/schema/schema-validate.yaml
index 97999dde..e1496c51 100644
--- a/framework/src/main/resources/open-cli-schema/schema-validate.yaml
+++ b/framework/src/main/resources/open-cli-schema/schema/schema-validate.yaml
@@ -46,10 +46,6 @@ parameters:
results:
direction: landscape
attributes:
- - name: sl-no
- description: Serial Number of error
- scope: short
- type: string
- name: error
description: Schema validation error
scope: short