Skip to main content

Endpoint Properties

To properly define our SDKs...

SettingTypePurposeLanguage Support
Optionalbool
Nullablebool
HasOptionalQueryParamsbool
HasOptionalFieldParamsbool
CollectParametersboolCollect all parameters into a structure and take one parameter of that structure type as input.
ParameterCollectionNamestringA structure name to be used when CollectParameters is true.
WrapBodyInObjectboolWhen enabled, this flag allows more than one body parameter in an endpoint.
ExternalDocumentationExternalDocumentation-
RequiresAuthenticationboolChecks whether this endpoint requires authentication or not.
RequiredScopesList<string>List of OAuth 2.0 scopes required by this endpoint.?
ErrorsList<ErrorModel>List of error responses for this endpoint.
TestCasesList<TestCase>List of test cases for this endpoint.
DeprecatedboolIdentifies whether this endpoint is deprecated or not.
DeprecationDetailsDeprecationDetailsDetails of the deprecated item e.g. version when it was deprecated, help message etc.
MethodNamestringUsed instead of Name for generating method names in SDKs.
MethodGroupNamestringUsed instead of Group for generating group names in SDKs.
XmlRequestbool
XmlResponsebool
ResponsesOrderedDictionary<string, Response>Dictionary of possible endpoint responses.