devview-networkmock-core/com.worldline.devview.networkmock.core.model/EnvironmentConfig

EnvironmentConfig

@Serializable

data class EnvironmentConfig(val id: String, val name: String, val url: String, val endpointOverrides: List<EndpointOverride> = emptyList(), val additionalEndpoints: List<EndpointConfig> = emptyList())

Configuration for a single deployment environment within an ApiGroupConfig.

An environment represents one stage in the delivery pipeline (e.g. staging, production, development). It provides the resolved base URL for its parent ApiGroupConfig at that stage, and optionally customises the shared endpoint pool via endpointOverrides and additionalEndpoints.

Endpoint Resolution

When the active environment is matched during request interception, the effective endpoint list for this environment is built as follows:

Start with ApiGroupConfig.endpoints (the shared pool)
Apply endpointOverrides — each override merges into the matching shared endpoint by EndpointOverride.id; unspecified fields keep their shared value
Append additionalEndpoints — endpoints that only exist in this environment

Example

{
  "id": "production",
  "name": "Production",
  "url": "https://api.example.com",
  "endpointOverrides": [
    { "id": "getUser", "path": "/v1/users/{userId}/profile" }
  ],
  "additionalEndpoints": [
    { "id": "getLegacyUser", "name": "Get Legacy User", "path": "/users/{userId}", "method": "GET" }
  ]
}

Constructors

EnvironmentConfig

constructor(id: String, name: String, url: String, endpointOverrides: List<EndpointOverride> = emptyList(), additionalEndpoints: List<EndpointConfig> = emptyList())

Properties

additionalEndpoints

val additionalEndpoints: List<EndpointConfig>

Optional list of endpoints that only exist in this environment (e.g. staging-only debug endpoints). Defaults to an empty list.

endpointOverrides

val endpointOverrides: List<EndpointOverride>

Optional list of partial endpoint replacements. Each entry references a shared endpoint by EndpointOverride.id and overrides only the fields it specifies. Defaults to an empty list.

val id: String

Unique identifier for this environment (e.g. "staging", "production"). Used as the second path segment of environment-specific mock response files: responses/{groupId}/{id}/{endpointId}/ and as part of the DataStore endpoint state key: "{id}-{endpointId}"

name

val name: String

Human-readable name displayed in the UI (e.g. "Staging", "Production")

url

val url: String

The base URL for the parent API group in this environment (scheme + hostname, e.g. "https://staging.api.example.com"). The hostname is extracted at runtime and compared against incoming request hosts.

EnvironmentConfig

Endpoint Resolution

Example

See also

Constructors

Properties