openapi/petstore/modules/user/api.yaml at master · Casperhr/openapi · GitHub

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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
"/user":
  post:
    tags:
    - user
    summary: Create user
    description: This can only be done by the logged in user.
    operationId: createUser
    responses:
      default:
        description: successful operation
    requestBody:

"/user/createWithArray":
  post:
    tags:
    - user
    summary: Creates list of users with given input array
    description: ''
    operationId: createUsersWithArrayInput
    responses:
      default:
        description: successful operation
    requestBody:
      $ref: "#/components/requestBodies/UserArray"
"/user/createWithList":
  post:
    tags:
    - user
    summary: Creates list of users with given input array
    description: ''
    operationId: createUsersWithListInput
    responses:
      default:
        description: successful operation
    requestBody:
      $ref: "#/components/requestBodies/UserArray"
"/user/login":
  get:
    tags:
    - user
    summary: Logs user into the system
    description: ''
    operationId: loginUser
    parameters:
    - name: username
      in: query
      description: The user name for login
      required: true
      schema:
        type: string
    - name: password
      in: query
      description: The password for login in clear text
      required: true
      schema:
        type: string
    responses:
      '200':
        description: successful operation
        headers:
          X-Rate-Limit:
            description: calls per hour allowed by the user
            schema:
              type: integer
              format: int32
          X-Expires-After:
            description: date in UTC when token expires
            schema:
              type: string
              format: date-time
        content:
          application/xml:
            schema:
              type: string
          application/json:
            schema:
              type: string
      '400':
        description: Invalid username/password supplied
"/user/logout":
  get:
    tags:
    - user
    summary: Logs out current logged in user session
    description: ''
    operationId: logoutUser
    responses:
      default:
        description: successful operation
"/user/{username}":
  get:
    tags:
    - user
    summary: Get user by user name
    description: ''
    operationId: getUserByName
    parameters:
    - name: username
      in: path
      description: 'The name that needs to be fetched. Use user1 for testing. '
      required: true
      schema:
        type: string
    responses:
      '200':
        description: successful operation
        content:
          application/xml:
            schema:
              $ref: "#/components/schemas/User"
          application/json:
            schema:
              $ref: "#/components/schemas/User"
      '400':
        description: Invalid username supplied
      '404':
        description: User not found
  put:
    tags:
    - user
    summary: Updated user
    description: This can only be done by the logged in user.
    operationId: updateUser
    parameters:
    - name: username
      in: path
      description: name that need to be updated
      required: true
      schema:
        type: string
    responses:
      '400':
        description: Invalid user supplied
      '404':
        description: User not found
    requestBody:
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/User"
      description: Updated user object
      required: true
  delete:
    tags:
    - user
    summary: Delete user
    description: This can only be done by the logged in user.
    operationId: deleteUser
    parameters:
    - name: username
      in: path
      description: The name that needs to be deleted
      required: true
      schema:
        type: string
    responses:
      '400':
        description: Invalid username supplied
      '404':
        description: User not found
components:
  schemas:
    User:
      $ref: "/models/user.yaml"
      xml:
        name: User
  requestBodies:
    User:
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/User"
      description: Created user object
      required: true
    UserArray:
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: "#/components/schemas/User"
      description: List of user object
      required: true