Option to enable or disable swagger endpoints #3502
Conversation
0rzech
changed the title
routers/routes/routes.go
Outdated
| apiv1.RegisterRoutes(m) | ||
| }, ignSignIn) | ||
|
|
||
| m.Group("/api/internal", func() { |
There was a problem hiding this comment.
/api/internal can not be disabled as this is called from ssh internally
tboerger
added
lgtm/need 2
lafriks
added
the
type/proposal
Codecov Report
@@ Coverage Diff @@
## master #3502 +/- ##
=========================================
+ Coverage 35.67% 35.7% +0.02%
=========================================
Files 281 281
Lines 40697 40705 +8
=========================================
+ Hits 14520 14533 +13
+ Misses 24030 24026 -4
+ Partials 2147 2146 -1
Continue to review full report at Codecov.
|
0rzech
changed the title
|
It turns out that |
modules/setting/setting.go
Outdated
| @@ -1078,8 +1081,6 @@ func NewContext() { | |||
| log.Fatal(4, "Failed to map Cron settings: %v", err) | |||
| } else if err = Cfg.Section("git").MapTo(&Git); err != nil { | |||
| log.Fatal(4, "Failed to map Git settings: %v", err) | |||
| } else if err = Cfg.Section("api").MapTo(&API); err != nil { | |||
There was a problem hiding this comment.
It has been replaced with this just a dozen lines earlier:
sec = Cfg.Section("api")
API.EnableSwaggerEndpoint = sec.Key("ENABLE_SWAGGER_ENDPOINT").MustBool(true)
API.MaxResponseItems = sec.Key("MAX_RESPONSE_ITEMS").MustInt(50)
which IMHO is generally more readable and maintainable.
There was a problem hiding this comment.
But that is not exactly the same as this will not keep defaults if added later for API struct
There was a problem hiding this comment.
I have changed it the way you want, but could you explain me a bit more what exactly do you mean by writing
this will not keep defaults if added later for API struct
?
There was a problem hiding this comment.
Sorry, that sentence was totally messed up :) I meant that if new option is added it will not be autoloaded without adding code to load it explicitly like it is for other sections if defaults are not needed
There was a problem hiding this comment.
No problem. ;) I get it now. On the other hand, ini handling will be more prone to unexpected refactoring side effects (eg. changing struct field name will restore default value for existing deployments), but as usual, it's a matter of compromise and priorities. ;)
tboerger
added
lgtm/need 1
tboerger
added
lgtm/done
lafriks
added
type/enhancement
* SECURITY * Limit uploaded avatar image-size to 4096x3072 by default (go-gitea#4353) * Do not allow to reuse TOTP passcode (go-gitea#3878) * FEATURE * Add cli commands to regen hooks & keys (go-gitea#3979) * Add support for FIDO U2F (go-gitea#3971) * Added user language setting (go-gitea#3875) * LDAP Public SSH Keys synchronization (go-gitea#1844) * Add topic support (go-gitea#3711) * Multiple assignees (go-gitea#3705) * Add protected branch whitelists for merging (go-gitea#3689) * Global code search support (go-gitea#3664) * Add label descriptions (go-gitea#3662) * Add issue search via API (go-gitea#3612) * Add repository setting to enable/disable health checks (go-gitea#3607) * Emoji Autocomplete (go-gitea#3433) * Implements generator cli for secrets (go-gitea#3531) * ENHANCEMENT * Add more webhooks support and refactor webhook templates directory (go-gitea#3929) * Add new option to allow only OAuth2/OpenID user registration (go-gitea#3910) * Add option to use paged LDAP search when synchronizing users (go-gitea#3895) * Symlink icons (go-gitea#1416) * Improve release page UI (go-gitea#3693) * Add admin dashboard option to run health checks (go-gitea#3606) * Add branch link in branch list (go-gitea#3576) * Reduce sql query times in retrieveFeeds (go-gitea#3547) * Option to enable or disable swagger endpoints (go-gitea#3502) * Add missing licenses (go-gitea#3497) * Reduce repo indexer disk usage (go-gitea#3452) * Enable caching on assets and avatars (go-gitea#3376) * Add repository search ordered by stars/forks. Forks column in admin repo list (go-gitea#3969) * Add Environment Variables to Docker template (go-gitea#4012) * LFS: make HTTP auth period configurable (go-gitea#4035) * Add config path as an optionial flag when changing pass via CLI (go-gitea#4184) * Refactor User Settings sections (go-gitea#3900) * Allow square brackets in external issue patterns (go-gitea#3408) * Add Attachment API (go-gitea#3478) * Add EnableTimetracking option to app settings (go-gitea#3719) * Add config option to enable or disable log executed SQL (go-gitea#3726) * Shows total tracked time in issue and milestone list (go-gitea#3341) * TRANSLATION * Improve English grammar and consistency (go-gitea#3614) * DEPLOYMENT * Allow Gitea to run as different USER in Docker (go-gitea#3961) * Provide compressed release binaries (go-gitea#3991) * Sign release binaries (go-gitea#4188)
Adds option to enable or disable swagger endpoints. Current defaults are preserved. Partially solves #3498.