summaryrefslogtreecommitdiffstats
path: root/products/sample/src/main/resources/open-cli-schema/reqres-update-user.yaml
blob: ee5e07bb114652ffbd35ca8ef1326e47b0edbc81 (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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
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}