timeline_api/openapi.yaml at master · aslanator/timeline_api · 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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
openapi: 3.0.0
# Added by API Auto Mocking Plugin
servers:
  # Added by API Auto Mocking Plugin
  - description: SwaggerHub API Auto Mocking
    url: https://virtserver.swaggerhub.com/aslanator/Timeline/1.0.0
  - description: SwaggerHub API Auto Mocking
    url: https://virtserver.swaggerhub.com/aslanator/Timeline/0.0.0
info:
  description: This is a simple API
  version: "1.0.0"
  title: Timeline api
  contact:
    email: aslanator@mail.ru
tags:
  - name: admins
    description: Secured Admin-only calls
  - name: users
    description: Operations available to regular users
  - name: any
    description: Operations avalible to everybody
paths:
  /auth:
    post:
      tags:
        - any
      summary: login
      operationId: auth
      description: login
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthRequest'
      responses:
        '200':
          description: 'auth success'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserWithTokenResponse'
        '400':
          description: 'auth fail'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'

  /register:
    post:
      tags:
        - any
      summary: add new user
      operationId: register
      description: simple register
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegisterRequest'
      responses:
        '200':
          description: 'register success'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserResponse'
        '400':
          description: 'auth fail'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'

components:
  schemas:
    AuthRequest:
      type: object
      required:
        - login
        - password

      properties:
        login:
          type: string
          format: email
          example: 'M0r64n@pe4kin.com'
        password:
          type: string
          format: password
          minLength: 6
          maxLength: 250
          example: '123457'
    RegisterRequest:
      type: object
      required:
        - login
        - password
        - name
      properties:
        login:
          type: string
          format: email
          example: 'M0r64n@pe4kin.com'
        password:
          type: string
          format: password
          minLength: 6
          maxLength: 250
          example: '123457'
        name:
          type: string
          example: 'Valera'

    UserWithTokenResponse:
      type: object
      required:
        - message
      properties:
        message:
          $ref: '#/components/schemas/UserWithToken'

    UserResponse:
      type: object
      required:
        - message
      properties:
        message:
          $ref: '#/components/schemas/User'

    UserWithToken:
      type: object
      required:
        - user
        - access_token
      properties:
        user:
          $ref: '#/components/schemas/User'
        access_token:
          type: string
          example: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ'

    User:
      type: object
      required:
        - id
        - name
        - login

      properties:
        id:
          type: number
          example: 20
        login:
          type: string
          format: email
          example: 'M0r64n@pe4kin.com'
        name:
          type: string
          example: 'Valera'

    Error:
      type: object
      properties:
        message:
          type: string
          example: ""
        errors:
          type: string
          example: "error in email field"
      required:
        - code
        - message