Class ServerConfiguration<T>

Represents the configuration of a server including its url template and variable configuration based on the url.

Type Parameters

T extends {}

Hierarchy

ServerConfiguration

Implements

BaseServerConfiguration

Index

Constructors

constructor

Methods

Constructors

constructor

new ServerConfiguration<T>(url: string, variableConfiguration: T): ServerConfiguration<T>

- Defined in src/generated/servers.ts:14
Type Parameters
- T extends {}
Parameters
- url: string
- variableConfiguration: T
Returns ServerConfiguration<T>

Methods

getConfiguration

getConfiguration(): T

- Defined in src/generated/servers.ts:27
Returns T

Private getUrl

getUrl(): string

- Defined in src/generated/servers.ts:31
Returns string

makeRequestContext

makeRequestContext(endpoint: string, httpMethod: HttpMethod): RequestContext

Implementation of BaseServerConfiguration.makeRequestContext
- Defined in src/generated/servers.ts:48
Creates a new request context for this server using the url with variables replaced with their respective values and the endpoint of the request appended.

Parameters
- endpoint: string
  
  the endpoint to be queried on the server
- httpMethod: HttpMethod
  
  httpMethod to be used
Returns RequestContext

setVariables

setVariables(variableConfiguration: Partial<T>): void

- Defined in src/generated/servers.ts:23
Sets the value of the variables of this server. Variables are included in the url of this ServerConfiguration in the form {variableName}

Parameters
- variableConfiguration: Partial<T>
  
  a partial variable configuration for the variables contained in the url
Returns void

Generated using TypeDoc