Skip to content

Commit

Permalink
correct docs for startup config
Browse files Browse the repository at this point in the history
- add x-internal flag which will prevent unsupported fields from showing
  up on external website
- add missing fields
  • Loading branch information
torcolvin committed Jul 2, 2024
1 parent 80c9ca6 commit a899884
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 6 deletions.
30 changes: 26 additions & 4 deletions docs/api/components/schemas.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2057,13 +2057,13 @@ Startup-config:
type: boolean
server_read_timeout:
description: |-
Maximum duration.Second before timing out read of the HTTP(S) request.
Maximum duration before timing out read of the HTTP(S) request.
This is a duration and therefore can be provided with units "h", "m", "s", "ms", "us", and "ns". For example, 5 hours, 20 minutes, and 30 seconds would be `5h20m30s`.
type: string
server_write_timeout:
description: |-
Maximum duration.Second before timing out write of the HTTP(S) response.
Maximum duration before timing out write of the HTTP(S) response.
This is a duration and therefore can be provided with units "h", "m", "s", "ms", "us", and "ns". For example, 5 hours, 20 minutes, and 30 seconds would be `5h20m30s`.
type: string
Expand All @@ -2082,8 +2082,9 @@ Startup-config:
type: string
default: 90s
pretty:
description: Pretty-print JSON responses
description: Pretty-print JSON responses. This property is deprecated.
type: boolean
deprecated: true
max_connections:
description: Max of incoming HTTP connections to accept
type: number
Expand Down Expand Up @@ -2189,16 +2190,30 @@ Startup-config:
max_concurrent_replications:
description: Maximum number of concurrent replication connections allowed. If set to 0 this limit will be ignored.
type: integer
max_concurrent_changes_batches:
description: Maximum number of changes batches to process concurrently per replication (1-5)"
type: integer
default: 2
minimum: 1
maximum: 5
max_concurrent_revs:
description: Maximum number of revs to process concurrently per replication (5-200)
type: integer
default: 5
minimum: 5
maximum: 200
readOnly: true
unsupported:
description: Settings that are not officially supported. It is highly recommended these are **not** used.
type: object
x-internal: true
properties:
serverless:
$ref: '#/Serverless'
use_xattr_config:
description: Store database configurations in system xattrs
type: boolean
default: false
stats_log_frequency:
description: |-
How often should stats be written to stats logs.
Expand All @@ -2209,12 +2224,18 @@ Startup-config:
use_stdlib_json:
description: Bypass the jsoniter package and use Go's stdlib instead
type: boolean
default: false
http2:
type: object
properties:
enabled:
description: Whether HTTP2 support is enabled
type: boolean
default: false
allow_dbconfig_env_vars:
description: Can be set to false to skip environment variable expansion in database configs
type: boolean
default: true
diagnostic_interface:
description: |-
Network interface to bind diagnotic API to.
Expand Down Expand Up @@ -2245,8 +2266,9 @@ Startup-config:
minimum: 0
readOnly: true
couchbase_keepalive_interval:
description: TCP keep-alive interval between SG and Couchbase server
description: TCP keep-alive interval between SG and Couchbase server. This is unused.
type: integer
deprecated: true
readOnly: true
title: Startup-config
Runtime-config:
Expand Down
4 changes: 2 additions & 2 deletions rest/config_startup.go
Original file line number Diff line number Diff line change
Expand Up @@ -123,8 +123,8 @@ type APIConfig struct {

EnableAdminAuthenticationPermissionsCheck *bool `json:"enable_advanced_auth_dp,omitempty" help:"Whether to enable the DP permissions check feature of admin auth"`

ServerReadTimeout *base.ConfigDuration `json:"server_read_timeout,omitempty" help:"Maximum duration.Second before timing out read of the HTTP(S) request"`
ServerWriteTimeout *base.ConfigDuration `json:"server_write_timeout,omitempty" help:"Maximum duration.Second before timing out write of the HTTP(S) response"`
ServerReadTimeout *base.ConfigDuration `json:"server_read_timeout,omitempty" help:"Maximum duration before timing out read of the HTTP(S) request"`
ServerWriteTimeout *base.ConfigDuration `json:"server_write_timeout,omitempty" help:"Maximum duration before timing out write of the HTTP(S) response"`
ReadHeaderTimeout *base.ConfigDuration `json:"read_header_timeout,omitempty" help:"The amount of time allowed to read request headers"`
IdleTimeout *base.ConfigDuration `json:"idle_timeout,omitempty" help:"The maximum amount of time to wait for the next request when keep-alives are enabled"`

Expand Down

0 comments on commit a899884

Please sign in to comment.