config: Rename scheme to schemes

The description in `gate-configuration.md` has also been adjusted. Signed-off-by: Tatiana Nesterenko <[email protected]>
nspcc-dev · Apr 19, 2024 · b2bcbf8 · b2bcbf8
1 parent 9998d44
commit b2bcbf8
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/cmd/neofs-rest-gw/config.go b/cmd/neofs-rest-gw/config.go
@@ -429,7 +429,7 @@ type ServerConfig struct {
 }
 
 const (
-	FlagScheme           = "scheme"
+	FlagScheme           = "schemes"
 	FlagCleanupTimeout   = "cleanup-timeout"
 	FlagGracefulTimeout  = "graceful-timeout"
 	FlagMaxHeaderSize    = "max-header-size"

diff --git a/config/config.yaml b/config/config.yaml
@@ -52,7 +52,7 @@ pool:
 
 server:
   # The listeners to enable, this can be repeated and defaults to the schemes in the swagger spec.
-  scheme: [ http ]
+  schemes: [ http ]
   # Grace period for which to wait before killing idle connections
   cleanup-timeout: 10s
   # Grace period for which to wait before shutting down the server

diff --git a/docs/gate-configuration.md b/docs/gate-configuration.md
@@ -22,7 +22,7 @@ There are some custom types used for brevity:
 # General section
 
 ```yaml
-scheme: [ http ]
+schemes: [ http ]
 cleanup-timeout: 10s
 graceful-timeout: 15s
 max-header-size: 1000000
@@ -47,7 +47,7 @@ external-address: localhost:8090
 
 | Parameter            | Type       | Default value    | Description                                                                                                                                                                         |
 |----------------------|------------|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `scheme`             | `[]string` | `[http]`         | The listeners to enable, this can be repeated and defaults to the schemes in the swagger spec.                                                                                      |
+| `schemes`            | `[]string` | `[http]`         | The listeners to enable (http and/or https) are also used for swagger to make list of hosts for the `Servers` section.                                                              |
 | `cleanup-timeout`    | `duration` | `10s`            | Grace period for which to wait before killing idle connections.                                                                                                                     |
 | `graceful-timeout`   | `duration` | `15s`            | Grace period for which to wait before shutting down the server.                                                                                                                     |
 | `max-header-size`    | `int`      | `1000000`        | Controls the maximum number of bytes the server will read parsing the request header's keys and values, including the request line. It does not limit the size of the request body. |