From 3cc82d8522b2e1107a312d9ff89683af99af76fd Mon Sep 17 00:00:00 2001 From: Elias Schneider Date: Sun, 8 Jun 2025 16:10:42 +0200 Subject: [PATCH] docs: remove difficult to maintain OpenAPI properties --- backend/internal/controller/app_config_controller.go | 3 --- backend/internal/controller/custom_claim_controller.go | 3 --- backend/internal/controller/oidc_controller.go | 3 +-- 3 files changed, 1 insertion(+), 8 deletions(-) diff --git a/backend/internal/controller/app_config_controller.go b/backend/internal/controller/app_config_controller.go index afbdeffb..4a05f580 100644 --- a/backend/internal/controller/app_config_controller.go +++ b/backend/internal/controller/app_config_controller.go @@ -57,7 +57,6 @@ type AppConfigController struct { // @Accept json // @Produce json // @Success 200 {array} dto.PublicAppConfigVariableDto -// @Failure 500 {object} object "{"error": "error message"}" // @Router /application-configuration [get] func (acc *AppConfigController) listAppConfigHandler(c *gin.Context) { configuration := acc.appConfigService.ListAppConfig(false) @@ -162,7 +161,6 @@ func (acc *AppConfigController) getLogoHandler(c *gin.Context) { // @Tags Application Configuration // @Produce image/x-icon // @Success 200 {file} binary "Favicon image" -// @Failure 404 {object} object "{"error": "File not found"}" // @Router /api/application-configuration/favicon [get] func (acc *AppConfigController) getFaviconHandler(c *gin.Context) { acc.getImage(c, "favicon", "ico") @@ -175,7 +173,6 @@ func (acc *AppConfigController) getFaviconHandler(c *gin.Context) { // @Produce image/png // @Produce image/jpeg // @Success 200 {file} binary "Background image" -// @Failure 404 {object} object "{"error": "File not found"}" // @Router /api/application-configuration/background-image [get] func (acc *AppConfigController) getBackgroundImageHandler(c *gin.Context) { imageType := acc.appConfigService.GetDbConfig().BackgroundImageType.Value diff --git a/backend/internal/controller/custom_claim_controller.go b/backend/internal/controller/custom_claim_controller.go index 839e0866..9e26e35f 100644 --- a/backend/internal/controller/custom_claim_controller.go +++ b/backend/internal/controller/custom_claim_controller.go @@ -35,9 +35,6 @@ type CustomClaimController struct { // @Tags Custom Claims // @Produce json // @Success 200 {array} string "List of suggested custom claim names" -// @Failure 401 {object} object "Unauthorized" -// @Failure 403 {object} object "Forbidden" -// @Failure 500 {object} object "Internal server error" // @Router /api/custom-claims/suggestions [get] func (ccc *CustomClaimController) getSuggestionsHandler(c *gin.Context) { claims, err := ccc.customClaimService.GetSuggestions(c.Request.Context()) diff --git a/backend/internal/controller/oidc_controller.go b/backend/internal/controller/oidc_controller.go index 49d3c088..443e301e 100644 --- a/backend/internal/controller/oidc_controller.go +++ b/backend/internal/controller/oidc_controller.go @@ -227,7 +227,6 @@ func (oc *OidcController) userInfoHandler(c *gin.Context) { // @Description End user session and handle OIDC logout // @Tags OIDC // @Accept application/x-www-form-urlencoded -// @Produce html // @Param id_token_hint query string false "ID token" // @Param post_logout_redirect_uri query string false "URL to redirect to after logout" // @Param state query string false "State parameter to include in the redirect" @@ -542,7 +541,7 @@ func (oc *OidcController) getClientLogoHandler(c *gin.Context) { // @Tags OIDC // @Accept multipart/form-data // @Param id path string true "Client ID" -// @Param file formData file true "Logo image file (PNG, JPG, or SVG, max 2MB)" +// @Param file formData file true "Logo image file (PNG, JPG, or SVG)" // @Success 204 "No Content" // @Router /api/oidc/clients/{id}/logo [post] func (oc *OidcController) updateClientLogoHandler(c *gin.Context) {