Endpoint Class Reference

Public Attributes
bool	resultIsReference = false
bool	hasSuccessResponse = false
string	name
string	resultType
	The type of the.
string	parameterType = "void"
	The name of the structure containing the parameters for this endpoint.
string	path
	HTTP path for this endpoint.
string	description
	Description/documentation for this endpoint.
string	operation
	HTTP method for this endpoint.
RequestParameter[]	parameters = []
	List of all parameters for this request.
RequestParameter[]	requiredPathParameters
RequestParameter[]	requiredQueryParameters
RequestParameter[]	optionalQueryParameters
RequestParameter[]	bodyParameters

Detailed Description

Represents an API endpoint.

Member Data Documentation

bodyParameters

RequestParameter [] Endpoint::bodyParameters

description

string Endpoint::description

Description/documentation for this endpoint.

hasSuccessResponse

bool Endpoint::hasSuccessResponse = false

name

string Endpoint::name

operation

string Endpoint::operation

HTTP method for this endpoint.

optionalQueryParameters

RequestParameter [] Endpoint::optionalQueryParameters

parameters

RequestParameter [] Endpoint::parameters = []

List of all parameters for this request.

parameterType

string Endpoint::parameterType = "void"

The name of the structure containing the parameters for this endpoint.

path

string Endpoint::path

HTTP path for this endpoint.

requiredPathParameters

RequestParameter [] Endpoint::requiredPathParameters

requiredQueryParameters

RequestParameter [] Endpoint::requiredQueryParameters

resultIsReference

bool Endpoint::resultIsReference = false

resultType

string Endpoint::resultType

The type of the.

---

The documentation for this class was generated from the following file:

• core/openapigenerator.d