taurus-auth-ms/api.yml at master · c0ff33un/taurus-auth-ms · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
#Test with: http://editor.swagger.io/

swagger: '2.0'
info:
  version: 1.0.0
  title: Microservice for Authentication
  description: Ruby + Postgresql
  license:
    name: Software Architecture, 2019-II
host: localhost:3000
basePath: /
schemes:
  - http
consumes:
  - application/json
produces:
  - application/json
paths:
  /signup:
    post:
      summary: Creates a new user
      operationId: signup
      parameters:
        - name: user
          in: body
          required: true
          description: Creates user on db, but it will require a later confirmation
          schema:
            $ref: '#/definitions/UserCreate'
      responses:
        '201':
          description: Created
        '422':
          description: Error Already Taken, Too short password, etc.
  /login:
    post:
      summary: Log in and returns bearer token(JWT)
      operationId: login
      parameters:
        - name: user
          in: body
          required: true
          description: Returns user object
          schema:
            $ref: '#/definitions/UserLogin'
      responses:
        '201':
          description: User Session Created
        '401':
          description: Unauthorized, Invalid email or password
  /logout:
    delete:
      summary: Blacklists user token - Requires JWT
      operationId: logout
      responses:
        '201':
          description: Ok
        '401':
          description: Not Found
  /user:
    get:
      summary: Get current user with token
      operationId: getUser
      responses:
        '201':
          description: Ok
        '401':
          description: Not Found
    put:
      summary: Updates current user with token
      operationId: putUser
      parameters:
      - name: user
        in: body
        required: true
        description: Returns user object
        schema:
          $ref: '#/definitions/UserUpdate'
      responses:
        '201':
          description: Ok
        '401':
          description: Not Found


components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer


definitions:

  UserUpdate:
    type: "object"
    properties:
      user:
        $ref: "#/definitions/UserUpdateParams"

  UserLogin:
    type: "object"
    properties:
      user:
        $ref: "#/definitions/UserLoginParams"


  UserCreate:
    type: "object"
    properties:
      user:
        $ref: "#/definitions/UserInput"

  UserInput:
    type: object
    properties:
      name:
        type: string
      handle:
        type: string
      email:
        type: string
      password:
        type: string

  UserUpdateParams:
    type: object
    properties:
      name:
        type: string
      handle:
        type: string
      email:
        type: string

  UserLoginParams:
    type: object
    properties:
      email:
        type: string
      password:
        type: string