HellreigN/Control-plane
5
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

feat: add API versioning , translate swagger, remove rate limiter
ci / build (push) Successful in 2m42s
Details
ci / build (pull_request) Successful in 2m45s
Details

Browse Source
This commit is contained in:
Mephimeow
2026-06-14 17:14:37 +00:00
parent 2da484d781
commit ff355ad1d9
7 changed files with 417 additions and 409 deletions
Download Patch File Download Diff File Expand all files Collapse all files
internal/org/handler.go
+39 -34
View File
@@ -17,17 +17,18 @@ func NewHandler(service *Service) *Handler {
return &Handler{service: service}
}
// @Summary Create organization
// @Description Create a new organization
// @Summary Создание организации
// @Description Создание новой организации. slug используется в URL и должен быть уникальным.
// @Description **Требуется:** заголовок `Authorization: Bearer <token>`.
// @Tags organizations
// @Accept json
// @Produce json
// @Security Bearer
// @Param request body CreateOrgRequest true "Organization details"
// @Success 201 {object} OrgResponse
// @Failure 400 {object} ErrorResponse
// @Failure 409 {object} ErrorResponse
// @Router /api/organizations [post]
// @Param request body CreateOrgRequest true "Название и slug организации"
// @Success 201 {object} OrgResponse "Организация создана"
// @Failure 400 {object} ErrorResponse "Ошибка валидации полей"
// @Failure 409 {object} ErrorResponse "Slug уже занят"
// @Router /api/v1/organizations [post]
func (h *Handler) Create(c *gin.Context) {
var req CreateOrgRequest
if err := c.ShouldBindJSON(&req); err != nil {
@@ -49,16 +50,17 @@ func (h *Handler) Create(c *gin.Context) {
c.JSON(http.StatusCreated, OrgResponse{Organization: *org})
}
// @Summary Get organization by ID
// @Description Get organization details
// @Summary Получить организацию
// @Description Получение информации об организации по её ID.
// @Description **Требуется:** заголовок `Authorization: Bearer <token>`.
// @Tags organizations
// @Accept json
// @Produce json
// @Security Bearer
// @Param id path string true "Organization ID"
// @Success 200 {object} OrgResponse
// @Failure 404 {object} ErrorResponse
// @Router /api/organizations/{id} [get]
// @Param id path string true "UUID организации"
// @Success 200 {object} OrgResponse "Данные организации"
// @Failure 404 {object} ErrorResponse "Организация не найдена"
// @Router /api/v1/organizations/{id} [get]
func (h *Handler) GetByID(c *gin.Context) {
id := c.Param("id")
@@ -76,17 +78,18 @@ func (h *Handler) GetByID(c *gin.Context) {
c.JSON(http.StatusOK, OrgResponse{Organization: *org})
}
// @Summary List organizations
// @Description Get all organizations with pagination
// @Summary Список организаций
// @Description Получение списка всех организаций с пагинацией.
// @Description **Требуется:** заголовок `Authorization: Bearer <token>`.
// @Tags organizations
// @Accept json
// @Produce json
// @Security Bearer
// @Param limit query int false "Page size (default 20)"
// @Param offset query int false "Offset (default 0)"
// @Success 200 {object} OrgListResponse
// @Failure 500 {object} ErrorResponse
// @Router /api/organizations [get]
// @Param limit query int false "Количество записей на странице (по умолчанию 20)"
// @Param offset query int false "Смещение от начала списка (по умолчанию 0)"
// @Success 200 {object} OrgListResponse "Список организаций"
// @Failure 500 {object} ErrorResponse "Внутренняя ошибка сервера"
// @Router /api/v1/organizations [get]
func (h *Handler) List(c *gin.Context) {
limit, _ := strconv.Atoi(c.DefaultQuery("limit", "20"))
offset, _ := strconv.Atoi(c.DefaultQuery("offset", "0"))
@@ -101,18 +104,19 @@ func (h *Handler) List(c *gin.Context) {
c.JSON(http.StatusOK, resp)
}
// @Summary Update organization
// @Description Update organization name
// @Summary Обновление организации
// @Description Обновление названия организации. slug изменить нельзя.
// @Description **Требуется:** заголовок `Authorization: Bearer <token>`.
// @Tags organizations
// @Accept json
// @Produce json
// @Security Bearer
// @Param id path string true "Organization ID"
// @Param request body UpdateOrgRequest true "New organization details"
// @Success 200 {object} OrgResponse
// @Failure 400 {object} ErrorResponse
// @Failure 404 {object} ErrorResponse
// @Router /api/organizations/{id} [put]
// @Param id path string true "UUID организации"
// @Param request body UpdateOrgRequest true "Новое название организации"
// @Success 200 {object} OrgResponse "Обновлённая организация"
// @Failure 400 {object} ErrorResponse "Ошибка валидации полей"
// @Failure 404 {object} ErrorResponse "Организация не найдена"
// @Router /api/v1/organizations/{id} [put]
func (h *Handler) Update(c *gin.Context) {
id := c.Param("id")
@@ -136,16 +140,17 @@ func (h *Handler) Update(c *gin.Context) {
c.JSON(http.StatusOK, OrgResponse{Organization: *org})
}
// @Summary Delete organization
// @Description Delete an organization
// @Summary Удаление организации
// @Description Безвозвратное удаление организации по её ID.
// @Description **Требуется:** заголовок `Authorization: Bearer <token>`.
// @Tags organizations
// @Accept json
// @Produce json
// @Security Bearer
// @Param id path string true "Organization ID"
// @Success 200 {object} map[string]string
// @Failure 404 {object} ErrorResponse
// @Router /api/organizations/{id} [delete]
// @Param id path string true "UUID организации"
// @Success 200 {object} map[string]string "{"message": "organization deleted"}"
// @Failure 404 {object} ErrorResponse "Организация не найдена"
// @Router /api/v1/organizations/{id} [delete]
func (h *Handler) Delete(c *gin.Context) {
id := c.Param("id")