mirror of
https://github.com/valitydev/openapi-generator.git
synced 2024-11-08 19:33:55 +00:00
178 lines
4.7 KiB
YAML
178 lines
4.7 KiB
YAML
|
apiVersion: 1.0.0
|
||
|
|
swaggerVersion: "1.2"
|
||
|
|
basePath: "http://localhost:8002/api"
|
||
|
|
resourcePath: /user
|
||
|
|
produces:
|
||
|
|
- application/json
|
||
|
|
- application/xml
|
||
|
|
apis:
|
||
|
|
- path: /user
|
||
|
|
operations:
|
||
|
|
- method: POST
|
||
|
|
summary: Create user
|
||
|
|
notes: This can only be done by the logged in user.
|
||
|
|
type: void
|
||
|
|
nickname: createUser
|
||
|
|
parameters:
|
||
|
|
- name: body
|
||
|
|
description: Created user object
|
||
|
|
required: true
|
||
|
|
allowMultiple: false
|
||
|
|
type: User
|
||
|
|
paramType: body
|
||
|
|
- path: /user/createWithArray
|
||
|
|
operations:
|
||
|
|
- method: POST
|
||
|
|
summary: Creates list of users with given input array
|
||
|
|
notes: ""
|
||
|
|
type: void
|
||
|
|
nickname: createUsersWithArrayInput
|
||
|
|
parameters:
|
||
|
|
- name: body
|
||
|
|
description: List of user object
|
||
|
|
required: true
|
||
|
|
allowMultiple: false
|
||
|
|
type: array
|
||
|
|
items:
|
||
|
|
$ref: User
|
||
|
|
paramType: body
|
||
|
|
- path: /user/createWithList
|
||
|
|
operations:
|
||
|
|
- method: POST
|
||
|
|
summary: Creates list of users with given list input
|
||
|
|
notes: ""
|
||
|
|
type: void
|
||
|
|
nickname: createUsersWithListInput
|
||
|
|
parameters:
|
||
|
|
- name: body
|
||
|
|
description: List of user object
|
||
|
|
required: true
|
||
|
|
allowMultiple: false
|
||
|
|
type: array
|
||
|
|
items:
|
||
|
|
$ref: User
|
||
|
|
paramType: body
|
||
|
|
- path: "/user/{username}"
|
||
|
|
operations:
|
||
|
|
- method: PUT
|
||
|
|
summary: Updated user
|
||
|
|
notes: This can only be done by the logged in user.
|
||
|
|
type: void
|
||
|
|
nickname: updateUser
|
||
|
|
parameters:
|
||
|
|
- name: username
|
||
|
|
description: name that need to be deleted
|
||
|
|
required: true
|
||
|
|
allowMultiple: false
|
||
|
|
type: string
|
||
|
|
paramType: path
|
||
|
|
- name: body
|
||
|
|
description: Updated user object
|
||
|
|
required: true
|
||
|
|
allowMultiple: false
|
||
|
|
type: User
|
||
|
|
paramType: body
|
||
|
|
responseMessages:
|
||
|
|
- code: 400
|
||
|
|
message: Invalid username supplied
|
||
|
|
- code: 404
|
||
|
|
message: User not found
|
||
|
|
- method: DELETE
|
||
|
|
summary: Delete user
|
||
|
|
notes: This can only be done by the logged in user.
|
||
|
|
type: void
|
||
|
|
nickname: deleteUser
|
||
|
|
parameters:
|
||
|
|
- name: username
|
||
|
|
description: The name that needs to be deleted
|
||
|
|
required: true
|
||
|
|
allowMultiple: false
|
||
|
|
type: string
|
||
|
|
paramType: path
|
||
|
|
responseMessages:
|
||
|
|
- code: 400
|
||
|
|
message: Invalid username supplied
|
||
|
|
- code: 404
|
||
|
|
message: User not found
|
||
|
|
- method: GET
|
||
|
|
summary: Get user by user name
|
||
|
|
notes: ""
|
||
|
|
type: User
|
||
|
|
nickname: getUserByName
|
||
|
|
produces:
|
||
|
|
- application/json
|
||
|
|
- application/xml
|
||
|
|
parameters:
|
||
|
|
- name: username
|
||
|
|
description: The name that needs to be fetched. Use user1 for testing.
|
||
|
|
required: true
|
||
|
|
allowMultiple: false
|
||
|
|
type: string
|
||
|
|
paramType: path
|
||
|
|
responseMessages:
|
||
|
|
- code: 400
|
||
|
|
message: Invalid username supplied
|
||
|
|
- code: 404
|
||
|
|
message: User not found
|
||
|
|
- path: /user/login
|
||
|
|
operations:
|
||
|
|
- method: GET
|
||
|
|
summary: Logs user into the system
|
||
|
|
notes: ""
|
||
|
|
type: string
|
||
|
|
nickname: loginUser
|
||
|
|
produces:
|
||
|
|
- text/plain
|
||
|
|
parameters:
|
||
|
|
- name: username
|
||
|
|
description: The user name for login
|
||
|
|
required: true
|
||
|
|
allowMultiple: false
|
||
|
|
type: string
|
||
|
|
paramType: query
|
||
|
|
- name: password
|
||
|
|
description: The password for login in clear text
|
||
|
|
required: true
|
||
|
|
allowMultiple: false
|
||
|
|
type: string
|
||
|
|
paramType: query
|
||
|
|
responseMessages:
|
||
|
|
- code: 400
|
||
|
|
message: Invalid username and password combination
|
||
|
|
- path: /user/logout
|
||
|
|
operations:
|
||
|
|
- method: GET
|
||
|
|
summary: Logs out current logged in user session
|
||
|
|
notes: ""
|
||
|
|
type: void
|
||
|
|
nickname: logoutUser
|
||
|
|
produces:
|
||
|
|
- text/plain
|
||
|
|
parameters: []
|
||
|
|
models:
|
||
|
|
User:
|
||
|
|
id: User
|
||
|
|
properties:
|
||
|
|
id:
|
||
|
|
type: integer
|
||
|
|
format: int64
|
||
|
|
username:
|
||
|
|
type: string
|
||
|
|
password:
|
||
|
|
type: string
|
||
|
|
email:
|
||
|
|
type: string
|
||
|
|
firstName:
|
||
|
|
type: string
|
||
|
|
lastName:
|
||
|
|
type: string
|
||
|
|
phone:
|
||
|
|
type: string
|
||
|
|
userStatus:
|
||
|
|
type: integer
|
||
|
|
format: int32
|
||
|
|
description: User Status
|
||
|
|
enum:
|
||
|
|
- 1-registered
|
||
|
|
- 2-active
|
||
|
|
- 3-closed
|