Igris/docs/swagger.yaml

121 lines
2.8 KiB
YAML

basePath: /api
definitions:
dto.AuthenticateRequest:
properties:
pubKey:
type: string
signature:
type: string
required:
- pubKey
- signature
type: object
dto.AuthenticateResponse:
properties:
authorizationToken:
type: string
expiresAt:
type: integer
refreshToken:
type: string
type: object
dto.ChallengeRequest:
properties:
pubKey:
type: string
required:
- pubKey
type: object
dto.ChallengeResponse:
properties:
expiresAt:
type: string
message:
type: string
timeStamp:
type: string
type: object
host: localhost:8080
info:
contact:
email: support@swagger.io
name: API Support
url: http://www.swagger.io/support
description: This is the DeZone backend API server.
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
termsOfService: http://swagger.io/terms/
title: DeZone API
version: "1.0"
paths:
/auth/authenticate:
post:
consumes:
- application/json
description: Authenticate user with wallet signature
parameters:
- description: Authentication Request
in: body
name: request
required: true
schema:
$ref: '#/definitions/dto.AuthenticateRequest'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/dto.AuthenticateResponse'
"400":
description: Bad Request
schema:
additionalProperties:
type: string
type: object
"401":
description: Unauthorized
schema:
additionalProperties:
type: string
type: object
summary: Authenticate user
tags:
- auth
/auth/challenge:
post:
consumes:
- application/json
description: Generate a challenge message for wallet authentication
parameters:
- description: Challenge Request
in: body
name: request
required: true
schema:
$ref: '#/definitions/dto.ChallengeRequest'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/dto.ChallengeResponse'
"400":
description: Bad Request
schema:
additionalProperties:
type: string
type: object
"500":
description: Internal Server Error
schema:
additionalProperties:
type: string
type: object
summary: Generate authentication challenge
tags:
- auth
swagger: "2.0"