aboutsummaryrefslogtreecommitdiffstats
path: root/products/sample/src/main
diff options
context:
space:
mode:
Diffstat (limited to 'products/sample/src/main')
-rw-r--r--products/sample/src/main/resources/open-cli-schema/reqres-create-user.yaml77
-rw-r--r--products/sample/src/main/resources/open-cli-schema/reqres-delete-user.yaml43
-rw-r--r--products/sample/src/main/resources/open-cli-schema/reqres-list-users.yaml58
-rw-r--r--products/sample/src/main/resources/open-cli-schema/reqres-single-user.yaml58
-rw-r--r--products/sample/src/main/resources/open-cli-schema/reqres-update-user.yaml77
5 files changed, 313 insertions, 0 deletions
diff --git a/products/sample/src/main/resources/open-cli-schema/reqres-create-user.yaml b/products/sample/src/main/resources/open-cli-schema/reqres-create-user.yaml
new file mode 100644
index 00000000..1dc6985b
--- /dev/null
+++ b/products/sample/src/main/resources/open-cli-schema/reqres-create-user.yaml
@@ -0,0 +1,77 @@
+# Copyright 2020 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: create-user
+description: |
+ Place this OCS YAML under $OPEN_CLI_HOME/open-cli-schema folder. Then run the commands
+ oclip schema-refresh
+
+ It is used to create a new user record at https://reqres.in.
+
+ Sample usage:
+ oclip --product test create-user --host-url https://reqres.in --user-name Priyanka --job-role Developer
+
+info:
+ product: test
+ service: ut
+ author: Priyanka Akhade priyanka.akhade@huawei.com
+
+parameters:
+ - name: name
+ description: User name
+ type: string
+ short_option: n
+ long_option: user-name
+ is_optional: false
+ - name: job
+ description: job role
+ type: string
+ short_option: r
+ long_option: job-role
+ is_optional: true
+ default_value: Software Engineer
+
+results:
+ direction: landscape
+ attributes:
+ - name: ID
+ description: user id
+ scope: short
+ type: string
+ - name: NAME
+ description: user name
+ scope: short
+ type: string
+ - name : DESIGNATION
+ description: job role
+ scope: short
+ type: string
+http:
+ service:
+ auth: none
+ mode: direct
+ request:
+ uri: /api/users
+ method: POST
+ body: '{
+ "name":"${name}",
+ "job":"${job}"
+ }'
+ success_codes:
+ - 201
+ result_map:
+ ID: $b{$.id}
+ NAME: $b{$.name}
+ DESIGNATION: $b{$.job}
diff --git a/products/sample/src/main/resources/open-cli-schema/reqres-delete-user.yaml b/products/sample/src/main/resources/open-cli-schema/reqres-delete-user.yaml
new file mode 100644
index 00000000..706ba0ed
--- /dev/null
+++ b/products/sample/src/main/resources/open-cli-schema/reqres-delete-user.yaml
@@ -0,0 +1,43 @@
+# Copyright 2020 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: delete-user
+description: |
+ Place this OCS YAML under $OPEN_CLI_HOME/open-cli-schema folder. Then run the commands
+ oclip schema-refresh
+
+ It is used to delete a user record at https://reqres.in.
+
+ Sample usage:
+ oclip --product test delete-user --host-url https://reqres.in
+
+info:
+ product: test
+ service: ut
+ author: Priyanka Akhade priyanka.akhade@huawei.com
+
+
+results:
+ direction: landscape
+
+http:
+ service:
+ auth: none
+ mode: direct
+ request:
+ uri: /api/users/2
+ method: DELETE
+ success_codes:
+ - 204
diff --git a/products/sample/src/main/resources/open-cli-schema/reqres-list-users.yaml b/products/sample/src/main/resources/open-cli-schema/reqres-list-users.yaml
new file mode 100644
index 00000000..eae51fd9
--- /dev/null
+++ b/products/sample/src/main/resources/open-cli-schema/reqres-list-users.yaml
@@ -0,0 +1,58 @@
+# Copyright 2020 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: list-users
+description: |
+ Place this OCS YAML under $OPEN_CLI_HOME/open-cli-schema folder. Then run the commands
+ oclip schema-refresh
+
+ It is used to display the users' details from https://reqres.in.
+
+ Sample usage:
+ oclip --product test list-users --host-url https://reqres.in
+
+info:
+ product: test
+ service: ut
+ author: Priyanka Akhade priyanka.akhade@huawei.com
+
+results:
+ direction: landscape
+ attributes:
+ - name: FIRST_NAME
+ description: FirstName
+ scope: short
+ type: string
+ - name: LAST_NAME
+ description: LastName
+ scope: short
+ type: string
+ - name: EMAIL
+ description: Email
+ scope: short
+ type: string
+http:
+ service:
+ auth: none
+ mode: direct
+ request:
+ uri: /api/users?page=2
+ method: GET
+ success_codes:
+ - 200
+ result_map:
+ FIRST_NAME: $b{$.data.[*].first_name}
+ LAST_NAME: $b{$.data.[*].last_name}
+ EMAIL: $b{$.data.[*].email}
diff --git a/products/sample/src/main/resources/open-cli-schema/reqres-single-user.yaml b/products/sample/src/main/resources/open-cli-schema/reqres-single-user.yaml
new file mode 100644
index 00000000..98db2ac6
--- /dev/null
+++ b/products/sample/src/main/resources/open-cli-schema/reqres-single-user.yaml
@@ -0,0 +1,58 @@
+# Copyright 2020 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: single-user
+description: |
+ Place this OCS YAML under $OPEN_CLI_HOME/open-cli-schema folder. Then run the commands
+ oclip schema-refresh
+
+ It is used to display the specific user's details from https://reqres.in.
+
+ Sample usage:
+ oclip --product test single-user --host-url https://reqres.in
+
+info:
+ product: test
+ service: ut
+ author: Priyanka Akhade priyanka.akhade@huawei.com
+
+results:
+ direction: landscape
+ attributes:
+ - name: FIRST_NAME
+ description: demo response
+ scope: short
+ type: string
+ - name: LAST_NAME
+ description: LastName
+ scope: short
+ type: string
+ - name: EMAIL
+ description: Email
+ scope: short
+ type: string
+http:
+ service:
+ auth: none
+ mode: direct
+ request:
+ uri: /api/users/2
+ method: GET
+ success_codes:
+ - 200
+ result_map:
+ FIRST_NAME: $b{$.data.first_name}
+ LAST_NAME: $b{$.data.last_name}
+ EMAIL: $b{$.data.email}
diff --git a/products/sample/src/main/resources/open-cli-schema/reqres-update-user.yaml b/products/sample/src/main/resources/open-cli-schema/reqres-update-user.yaml
new file mode 100644
index 00000000..ee5e07bb
--- /dev/null
+++ b/products/sample/src/main/resources/open-cli-schema/reqres-update-user.yaml
@@ -0,0 +1,77 @@
+# Copyright 2020 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: update-user
+description: |
+ Place this OCS YAML under $OPEN_CLI_HOME/open-cli-schema folder. Then run the commands
+ oclip schema-refresh
+
+ It is used to update the specific user's details at https://reqres.in.
+
+ Sample usage:
+ oclip --product test update-user --host-url https://reqres.in --user-name Priyanka --job-role Tester
+
+info:
+ product: test
+ service: ut
+ author: Priyanka Akhade priyanka.akhade@huawei.com
+
+parameters:
+ - name: name
+ description: User name
+ type: string
+ short_option: n
+ long_option: user-name
+ is_optional: false
+ - name: job
+ description: job role
+ type: string
+ short_option: r
+ long_option: job-role
+ is_optional: true
+ default_value: Software Engineer
+
+results:
+ direction: landscape
+ attributes:
+ - name: NAME
+ description: user name
+ scope: short
+ type: string
+ - name : DESIGNATION
+ description: job role
+ scope: short
+ type: string
+ - name : UPDATED_AT
+ description: updated DateTime
+ scope: short
+ type: string
+http:
+ service:
+ auth: none
+ mode: direct
+ request:
+ uri: /api/users/2
+ method: PUT
+ body: '{
+ "name":"${name}",
+ "job":"${job}"
+ }'
+ success_codes:
+ - 200
+ result_map:
+ NAME: $b{$.name}
+ DESIGNATION: $b{$.job}
+ UPDATED_AT: $b{$.updatedAt}