Files
easywish/backend/docs/swagger.yaml

87 lines
1.8 KiB
YAML

definitions:
controllers.HealthStatus:
properties:
healthy:
type: boolean
type: object
info:
contact: {}
paths:
/auth/login:
post:
consumes:
- application/json
produces:
- application/json
responses: {}
summary: Acquire tokens via login credentials or by providing 2FA code
tags:
- Auth
/auth/passwordResetBegin:
post:
consumes:
- application/json
produces:
- application/json
responses: {}
summary: Request password reset email
tags:
- Auth
/auth/passwordResetComplete:
post:
consumes:
- application/json
produces:
- application/json
responses: {}
summary: Complete password reset with email code and provide 2FA code or backup
code if needed
tags:
- Auth
/auth/refresh:
post:
consumes:
- application/json
produces:
- application/json
responses: {}
summary: Receive new tokens via refresh token
tags:
- Auth
/auth/registrationBegin:
post:
consumes:
- application/json
produces:
- application/json
responses: {}
summary: Register an account
tags:
- Auth
/auth/registrationComplete:
post:
consumes:
- application/json
produces:
- application/json
responses: {}
summary: Confirm with code, finish creating the account
tags:
- Auth
/service/health:
get:
consumes:
- application/json
description: Used internally for checking service health
produces:
- application/json
responses:
"200":
description: desc
schema:
$ref: '#/definitions/controllers.HealthStatus'
summary: Get health status
tags:
- Service
swagger: "2.0"