Current swagger file
parent
54a86bce4e
commit
fdfb5520a6
20
swagger.yaml
20
swagger.yaml
|
@ -12,6 +12,17 @@ info:
|
|||
title: App-Idea Rest-API Documentation
|
||||
version: 0.0.1
|
||||
paths:
|
||||
/user/activate/:id:
|
||||
post:
|
||||
operationId: activation
|
||||
responses:
|
||||
"200":
|
||||
description: User was activated
|
||||
"401":
|
||||
description: Activation Id not correct or expired
|
||||
summary: Activate user
|
||||
tags:
|
||||
- User
|
||||
/user/login:
|
||||
post:
|
||||
operationId: userLogin
|
||||
|
@ -21,7 +32,7 @@ paths:
|
|||
name: username or email
|
||||
required: true
|
||||
type: string
|
||||
- description: password of the user
|
||||
- description: password (base64) of the user
|
||||
in: query
|
||||
name: password
|
||||
required: true
|
||||
|
@ -34,6 +45,8 @@ paths:
|
|||
"401":
|
||||
description: login credentials not correct
|
||||
summary: Login a user
|
||||
tags:
|
||||
- User
|
||||
/users:
|
||||
post:
|
||||
operationId: usersNewUser
|
||||
|
@ -53,7 +66,7 @@ paths:
|
|||
name: password
|
||||
required: true
|
||||
type: string
|
||||
- description: hashtag of the client (length 2-6, UPPERCASE)
|
||||
- description: hashtag of the client (length 2-6, UPPERCASE (Letters, Numbers))
|
||||
in: query
|
||||
name: hashtag
|
||||
type: string
|
||||
|
@ -69,12 +82,15 @@ paths:
|
|||
- application/json
|
||||
responses:
|
||||
"201":
|
||||
$ref: '#/definitions/User'
|
||||
description: user created
|
||||
"400":
|
||||
description: format is not correct
|
||||
"422":
|
||||
description: username, email or/and hashtag already assigned
|
||||
summary: Create new user
|
||||
tags:
|
||||
- User
|
||||
produces:
|
||||
- application/json
|
||||
securityDefinitions:
|
||||
|
|
Loading…
Reference in New Issue