aboutsummaryrefslogtreecommitdiffstats
path: root/products/sample/src/main/resources/open-cli-schema/reqres-list-users.yaml
blob: eae51fd9b197eb7f43a545d4b612ade58f1ca80e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
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}