| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
SwaggerPetstore.API.User
Contents
Description
- createUser :: (Consumes CreateUser contentType, MimeRender contentType User) => ContentType contentType -> User -> SwaggerPetstoreRequest CreateUser contentType NoContent MimeNoContent
- data CreateUser
- createUsersWithArrayInput :: (Consumes CreateUsersWithArrayInput contentType, MimeRender contentType User2) => ContentType contentType -> User2 -> SwaggerPetstoreRequest CreateUsersWithArrayInput contentType NoContent MimeNoContent
- data CreateUsersWithArrayInput
- createUsersWithListInput :: (Consumes CreateUsersWithListInput contentType, MimeRender contentType User2) => ContentType contentType -> User2 -> SwaggerPetstoreRequest CreateUsersWithListInput contentType NoContent MimeNoContent
- data CreateUsersWithListInput
- deleteUser :: Username -> SwaggerPetstoreRequest DeleteUser MimeNoContent NoContent MimeNoContent
- data DeleteUser
- getUserByName :: Accept accept -> Username -> SwaggerPetstoreRequest GetUserByName MimeNoContent User accept
- data GetUserByName
- loginUser :: Accept accept -> Username -> Password -> SwaggerPetstoreRequest LoginUser MimeNoContent Text accept
- data LoginUser
- logoutUser :: SwaggerPetstoreRequest LogoutUser MimeNoContent NoContent MimeNoContent
- data LogoutUser
- updateUser :: (Consumes UpdateUser contentType, MimeRender contentType User) => ContentType contentType -> User -> Username -> SwaggerPetstoreRequest UpdateUser contentType NoContent MimeNoContent
- data UpdateUser
Operations
User
createUser
Arguments
| :: (Consumes CreateUser contentType, MimeRender contentType User) | |
| => ContentType contentType | request content-type ( |
| -> User | "user" - Created user object |
| -> SwaggerPetstoreRequest CreateUser contentType NoContent MimeNoContent |
POST /user
Create user
This can only be done by the logged in user.
data CreateUser Source #
Instances
| Produces CreateUser MimeNoContent Source # | |
| HasBodyParam CreateUser User Source # | Body Param User - Created user object |
createUsersWithArrayInput
createUsersWithArrayInput Source #
Arguments
| :: (Consumes CreateUsersWithArrayInput contentType, MimeRender contentType User2) | |
| => ContentType contentType | request content-type ( |
| -> User2 | "user" - List of user object |
| -> SwaggerPetstoreRequest CreateUsersWithArrayInput contentType NoContent MimeNoContent |
POST /user/createWithArray
Creates list of users with given input array
data CreateUsersWithArrayInput Source #
Instances
| Produces CreateUsersWithArrayInput MimeNoContent Source # | |
| HasBodyParam CreateUsersWithArrayInput User2 Source # | Body Param User - List of user object |
createUsersWithListInput
createUsersWithListInput Source #
Arguments
| :: (Consumes CreateUsersWithListInput contentType, MimeRender contentType User2) | |
| => ContentType contentType | request content-type ( |
| -> User2 | "user" - List of user object |
| -> SwaggerPetstoreRequest CreateUsersWithListInput contentType NoContent MimeNoContent |
POST /user/createWithList
Creates list of users with given input array
data CreateUsersWithListInput Source #
Instances
| Produces CreateUsersWithListInput MimeNoContent Source # | |
| HasBodyParam CreateUsersWithListInput User2 Source # | Body Param User - List of user object |
deleteUser
Arguments
| :: Username | "username" - The name that needs to be deleted |
| -> SwaggerPetstoreRequest DeleteUser MimeNoContent NoContent MimeNoContent |
DELETE /user/{username}Delete user
This can only be done by the logged in user.
data DeleteUser Source #
Instances
getUserByName
Arguments
| :: Accept accept | request accept ( |
| -> Username | "username" - The name that needs to be fetched. Use user1 for testing. |
| -> SwaggerPetstoreRequest GetUserByName MimeNoContent User accept |
GET /user/{username}Get user by user name
data GetUserByName Source #
Instances
| Produces GetUserByName MimeXML Source # | application/xml |
| Produces GetUserByName MimeJSON Source # | application/json |
loginUser
Arguments
| :: Accept accept | request accept ( |
| -> Username | "username" - The user name for login |
| -> Password | "password" - The password for login in clear text |
| -> SwaggerPetstoreRequest LoginUser MimeNoContent Text accept |
GET /user/login
Logs user into the system
logoutUser
logoutUser :: SwaggerPetstoreRequest LogoutUser MimeNoContent NoContent MimeNoContent Source #
GET /user/logout
Logs out current logged in user session
data LogoutUser Source #
Instances
updateUser
Arguments
| :: (Consumes UpdateUser contentType, MimeRender contentType User) | |
| => ContentType contentType | request content-type ( |
| -> User | "user" - Updated user object |
| -> Username | "username" - name that need to be deleted |
| -> SwaggerPetstoreRequest UpdateUser contentType NoContent MimeNoContent |
PUT /user/{username}Updated user
This can only be done by the logged in user.
data UpdateUser Source #
Instances
| Produces UpdateUser MimeNoContent Source # | |
| HasBodyParam UpdateUser User Source # | Body Param User - Updated user object |