common

Documentation

Index

• Variables
• type ConstraintViolation
• type Error
• type ParameterLocation
• type SettingsObjectCreate
• type SettingsObjectErrorResponse
• type SettingsObjectList
• type SettingsObjectListItem
• type SettingsObjectResponse
• type SettingsObjectUpdate

Variables

var ParameterLocations = struct {
	Path        ParameterLocation
	PayloadBody ParameterLocation
	Query       ParameterLocation
}{
	Path:        ParameterLocation("PATH"),
	PayloadBody: ParameterLocation("PAYLOAD_BODY"),
	Query:       ParameterLocation("QUERY"),
}

Types

type ConstraintViolation

type ConstraintViolation struct {
	ParmeterLocation *ParameterLocation `json:"parameterLocation,omitempty"`
	Location         *string            `json:"location,omitempty"`
	Message          *string            `json:"message,omitempty"`
	Path             *string            `json:"path,omitempty"`
}

type Error

type Error struct {
	ConstraintViolations []*ConstraintViolation `json:"constraintViolations,omitempty"` // A list of constraint violations
	Message              string                 `json:"message,omitempty"`              // The error message
	Code                 int32                  `json:"code,omitempty"`                 // The HTTP status code
}

type ParameterLocation

type ParameterLocation string

type SettingsObjectCreate

type SettingsObjectCreate struct {
	SchemaVersion string `json:"schemaVersion"`
	SchemaID      string `json:"schemaId"`
	Scope         string `json:"scope"`
	Value         any    `json:"value"`
}

type SettingsObjectErrorResponse

type SettingsObjectErrorResponse struct {
	InvalidValue map[string]any `json:"invalidValue,omitempty"` // The value of the setting. \n\n It defines the actual values of settings' parameters. \n\nThe actual content depends on the object's schema.
	Error        *Error         `json:"error,omitempty"`        // Error details
	Code         *int32         `json:"code,omitempty"`         // The HTTP status code for the object
}

type SettingsObjectList

type SettingsObjectList struct {
	Items []*SettingsObjectListItem `json:"items"`
}

type SettingsObjectListItem

type SettingsObjectListItem struct {
	ObjectID string `json:"objectId"`
}

type SettingsObjectResponse

type SettingsObjectResponse struct {
	ObjectID string `json:"objectId"` // The ID of the settings object
	Code     int32  // The HTTP status code for the object
}

type SettingsObjectUpdate

type SettingsObjectUpdate struct {
	SchemaVersion string `json:"schemaVersion"`
	Value         any    `json:"value"`
}