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