Skip to content

Update specsAdapterConfig documentation with detailed field descriptions #3656

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Update specsAdapterConfig documentation with detailed field descriptions #3656

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a394e83
Update snippets/server-core/node/statsigOptions.mdx
mintlify[bot] Oct 22, 2025
9422523
Update snippets/server-core/rust/options.mdx
mintlify[bot] Oct 22, 2025
7530818
Update snippets/server-core/node/statsigOptions.mdx
mintlify[bot] Oct 28, 2025
9d730e7
Update snippets/server-core/rust/options.mdx
mintlify[bot] Oct 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions snippets/server-core/node/statsigOptions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,46 @@
Advanced settings to fetch from different sources (e.g., [statsig forward proxy](/infrastructure/forward-proxy), your own proxy server, data store) or to use different network protocols (HTTP vs gRPC streaming).
</ResponseField>

<Accordion title="SpecAdapterConfig">
<ResponseField name="adapterType" type="'data_store' | 'network_grpc_websocket' | 'network_http'" required>
Type of adapter to use for fetching specifications. Options:
- `network_http`: Standard HTTP polling (default)
- `network_grpc_websocket`: gRPC streaming for real-time updates
- `data_store`: Fetch from a custom data store
</ResponseField>

<ResponseField name="initTimeoutMs" type="number" required>
Maximum time (in milliseconds) to wait for initialization to complete.
</ResponseField>

<ResponseField name="specsUrl" type="string">
Custom URL for fetching feature specifications. Use this to point to your own proxy server or custom endpoint. **Note:** When using gRPC (`network_grpc_websocket`), ensure the URL includes the `dns://` prefix (e.g., `dns://your-server.com:port`).
</ResponseField>

<ResponseField name="authenticationMode" type="'none' | 'tls' | 'mtls'">
Authentication mode for secure connections (primarily for gRPC):
- `none`: No authentication
- `tls`: Transport Layer Security
- `mtls`: Mutual TLS (client and server authentication)
</ResponseField>

<ResponseField name="caCertPath" type="string">
Path to the Certificate Authority (CA) certificate file for TLS/mTLS authentication.
</ResponseField>

<ResponseField name="clientCertPath" type="string">
Path to the client certificate file for mTLS authentication.
</ResponseField>

<ResponseField name="clientKeyPath" type="string">
Path to the client private key file for mTLS authentication.
</ResponseField>

<ResponseField name="domainName" type="string">
Domain name for the server (used for certificate validation in TLS/mTLS).
</ResponseField>
</Accordion>

<ResponseField name="observabilityClient" type="ObservabilityClient">
Interface to integrate observability metrics exposed by the SDK (e.g., config propagation delay, initialization time). See [details](#observability-client).
</ResponseField>
Expand Down
42 changes: 41 additions & 1 deletion snippets/server-core/rust/options.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,9 +89,49 @@
</ResponseField>

<ResponseField name="spec_adapters_config" type="Option<Vec<SpecAdapterConfig>>">
Configuration for specification adapters.
Configuration for specification adapters. Advanced settings to fetch from different sources (e.g., [statsig forward proxy](/infrastructure/forward-proxy), your own proxy server, data store) or to use different network protocols (HTTP vs gRPC streaming).
</ResponseField>

<Accordion title="SpecAdapterConfig">
<ResponseField name="adapter_type" type="SpecsAdapterType" required>
Type of adapter to use for fetching specifications. Options:
- `NetworkHttp`: Standard HTTP polling (default)
- `NetworkGrpcWebsocket`: gRPC streaming for real-time updates
- `DataStore`: Fetch from a custom data store
</ResponseField>

<ResponseField name="init_timeout_ms" type="u64" required>
Maximum time (in milliseconds) to wait for initialization to complete.
</ResponseField>

<ResponseField name="specs_url" type="Option<String>">
Custom URL for fetching feature specifications. Use this to point to your own proxy server or custom endpoint. **Note:** When using gRPC (`NetworkGrpcWebsocket`), ensure the URL includes the `dns://` prefix (e.g., `dns://your-server.com:port`).
</ResponseField>

<ResponseField name="authentication_mode" type="Option<String>">
Authentication mode for secure connections (primarily for gRPC). Options: `"none"`, `"tls"`, `"mtls"`:
- `none`: No authentication
- `tls`: Transport Layer Security
- `mtls`: Mutual TLS (client and server authentication)
</ResponseField>

<ResponseField name="ca_cert_path" type="Option<String>">
Path to the Certificate Authority (CA) certificate file for TLS/mTLS authentication.
</ResponseField>

<ResponseField name="client_cert_path" type="Option<String>">
Path to the client certificate file for mTLS authentication.
</ResponseField>

<ResponseField name="client_key_path" type="Option<String>">
Path to the client private key file for mTLS authentication.
</ResponseField>

<ResponseField name="domain_name" type="Option<String>">
Domain name for the server (used for certificate validation in TLS/mTLS).
</ResponseField>
</Accordion>

<ResponseField name="specs_adapter" type="Option<Arc<dyn SpecsAdapter>>">
Custom adapter for specifications.
</ResponseField>
Expand Down