swagger docs

docs/swagger.yaml

@@ -0,0 +1,162 @@
+basePath: /api/v2
+definitions:
+  responses.ErrorResponse400:
+    properties:
+      error:
+        example: Bad Request
+        type: string
+    type: object
+  responses.ErrorResponse401:
+    properties:
+      error:
+        example: Unauthorized
+        type: string
+    type: object
+  responses.ErrorResponse500:
+    properties:
+      error:
+        example: Internal Server Error
+        type: string
+    type: object
+  user.Info:
+    properties:
+      created_at:
+        type: string
+      email:
+        type: string
+      username:
+        type: string
+    type: object
+  user.Register:
+    properties:
+      email:
+        type: string
+      password:
+        type: string
+      username:
+        type: string
+    type: object
+  user.Update:
+    properties:
+      email:
+        type: string
+      username:
+        type: string
+    type: object
+info:
+  contact: {}
+  title: Merch Parser
+  version: 2.0.0-alpha
+paths:
+  /user:
+    delete:
+      description: Помечает пользователя как удаленного по его uuid из токена
+      responses:
+        "200":
+          description: OK
+        "400":
+          description: Bad Request
+          schema:
+            $ref: '#/definitions/responses.ErrorResponse400'
+        "401":
+          description: Unauthorized
+          schema:
+            $ref: '#/definitions/responses.ErrorResponse401'
+        "500":
+          description: Internal Server Error
+          schema:
+            $ref: '#/definitions/responses.ErrorResponse500'
+      security:
+      - BearerAuth: []
+      summary: Удалить пользователя
+      tags:
+      - Users
+    get:
+      description: Получает информацию о пользователе по его uuid из токена
+      responses:
+        "200":
+          description: OK
+          schema:
+            $ref: '#/definitions/user.Info'
+        "400":
+          description: Bad Request
+          schema:
+            $ref: '#/definitions/responses.ErrorResponse400'
+        "401":
+          description: Unauthorized
+          schema:
+            $ref: '#/definitions/responses.ErrorResponse401'
+        "500":
+          description: Internal Server Error
+          schema:
+            $ref: '#/definitions/responses.ErrorResponse500'
+      security:
+      - BearerAuth: []
+      summary: Получить информацию о пользователе
+      tags:
+      - Users
+    post:
+      consumes:
+      - application/json
+      description: Регистрация нового пользователя
+      parameters:
+      - description: новый пользователь
+        in: body
+        name: body
+        required: true
+        schema:
+          $ref: '#/definitions/user.Register'
+      responses:
+        "200":
+          description: OK
+        "400":
+          description: Bad Request
+          schema:
+            $ref: '#/definitions/responses.ErrorResponse400'
+        "500":
+          description: Internal Server Error
+          schema:
+            $ref: '#/definitions/responses.ErrorResponse500'
+      security:
+      - BearerAuth: []
+      summary: Регистрация нового пользователя
+      tags:
+      - Users
+    put:
+      consumes:
+      - application/json
+      description: Обновить информацию о пользователе по его uuid из токена
+      parameters:
+      - description: изменения
+        in: body
+        name: body
+        required: true
+        schema:
+          $ref: '#/definitions/user.Update'
+      responses:
+        "200":
+          description: OK
+        "400":
+          description: Bad Request
+          schema:
+            $ref: '#/definitions/responses.ErrorResponse400'
+        "401":
+          description: Unauthorized
+          schema:
+            $ref: '#/definitions/responses.ErrorResponse401'
+        "500":
+          description: Internal Server Error
+          schema:
+            $ref: '#/definitions/responses.ErrorResponse500'
+      security:
+      - BearerAuth: []
+      summary: Обновить информацию о пользователе
+      tags:
+      - Users
+securityDefinitions:
+  BearerAuth:
+    description: Введите "Bearer {your_token}" для аутентификации
+    in: header
+    name: Authorization
+    type: apiKey
+swagger: "2.0"