Documentation
¶
Index ¶
- type AdvancedController
- func (ac *AdvancedController) AddAdvanced(c echo.Context) error
- func (ac *AdvancedController) DeleteAdvancedAgainstGUID(c echo.Context) error
- func (ac *AdvancedController) GetAdvancedAgainstGUID(c echo.Context) error
- func (ac *AdvancedController) GetAll(c echo.Context) error
- func (ac *AdvancedController) UpdateAdvancedAgainstGUID(c echo.Context) error
- type AgentsubController
- func (ass *AgentsubController) AddAgentsubWithKey(c echo.Context) error
- func (ass *AgentsubController) DeleteAgentsubAgainstGUID(c echo.Context) error
- func (ass *AgentsubController) GetAgentSearchByTypeAndGUID(c echo.Context) error
- func (ass *AgentsubController) GetAgentsub(c echo.Context) error
- func (ass *AgentsubController) GetAgentsubAgainstGUID(c echo.Context) error
- func (ass *AgentsubController) GetAgentsubByType(c echo.Context) error
- func (ass *AgentsubController) UpdateAgentsubAgainstGUID(c echo.Context) error
- type AliasController
- type AuthtokenController
- func (ass *AuthtokenController) AddAuthtoken(c echo.Context) error
- func (ass *AuthtokenController) DeleteAuthtokenAgainstGUID(c echo.Context) error
- func (ass *AuthtokenController) GetAuthtoken(c echo.Context) error
- func (ass *AuthtokenController) GetAuthtokenAgainstGUID(c echo.Context) error
- func (ass *AuthtokenController) UpdateAuthtokenAgainstGUID(c echo.Context) error
- type Controller
- type DashBoardController
- func (dbc *DashBoardController) DeleteDashboard(c echo.Context) error
- func (dbc *DashBoardController) GetDashBoard(c echo.Context) error
- func (dbc *DashBoardController) GetDashBoardLists(c echo.Context) error
- func (dbc *DashBoardController) InsertDashboard(c echo.Context) error
- func (dbc *DashBoardController) ResetUserDashboard(c echo.Context) error
- func (dbc *DashBoardController) UpdateDashboard(c echo.Context) error
- type GrafanaController
- func (pc *GrafanaController) GrafanaFolders(c echo.Context) error
- func (pc *GrafanaController) GrafanaGetDashboardAgainstUUID(c echo.Context) error
- func (pc *GrafanaController) GrafanaGetDashboardRequest(c echo.Context) error
- func (pc *GrafanaController) GrafanaGetFoldersAgainstUUID(c echo.Context) error
- func (pc *GrafanaController) GrafanaORG(c echo.Context) error
- func (pc *GrafanaController) GrafanaStatus(c echo.Context) error
- func (pc *GrafanaController) GrafanaURL(c echo.Context) error
- type HepsubController
- func (hsc *HepsubController) AddHepSub(c echo.Context) error
- func (hsc *HepsubController) DeleteHepSubAgainstGUID(c echo.Context) error
- func (hsc *HepsubController) GetHepSub(c echo.Context) error
- func (hsc *HepsubController) GetHepSubAgainstGUID(c echo.Context) error
- func (hsc *HepsubController) GetHepSubFields(c echo.Context) error
- func (hsc *HepsubController) UpdateHepSubAgainstGUID(c echo.Context) error
- type HepsubsearchController
- type MappingController
- func (mpc *MappingController) AddMapping(c echo.Context) error
- func (mpc *MappingController) DeleteMappingAgainstGUID(c echo.Context) error
- func (mpc *MappingController) GetMapping(c echo.Context) error
- func (mpc *MappingController) GetMappingAgainstGUID(c echo.Context) error
- func (mpc *MappingController) GetMappingFields(c echo.Context) error
- func (mpc *MappingController) GetSmartHepProfile(c echo.Context) error
- func (mpc *MappingController) ResetMapping(c echo.Context) error
- func (mpc *MappingController) ResetMappingAgainstUUID(c echo.Context) error
- func (mpc *MappingController) UpdateMappingAgainstGUID(c echo.Context) error
- type ProfileController
- type PrometheusController
- type RemoteController
- type SearchController
- func (sc *SearchController) GetDataAsPCap(c echo.Context) error
- func (sc *SearchController) GetDataAsPCapNow(c echo.Context) error
- func (sc *SearchController) GetDecodeMessageById(c echo.Context) error
- func (sc *SearchController) GetMessageById(c echo.Context) error
- func (sc *SearchController) GetMessagesAsPCap(c echo.Context) error
- func (sc *SearchController) GetMessagesAsText(c echo.Context) error
- func (sc *SearchController) GetTransaction(c echo.Context) error
- func (sc *SearchController) GetTransactionHepSub(c echo.Context) error
- func (sc *SearchController) GetTransactionLog(c echo.Context) error
- func (sc *SearchController) GetTransactionQos(c echo.Context) error
- func (sc *SearchController) SearchData(c echo.Context) error
- type StatisticController
- func (sc *StatisticController) GetStatisticDBList(c echo.Context) error
- func (sc *StatisticController) GetStatisticMeasurementsList(c echo.Context) error
- func (sc *StatisticController) GetStatisticMetricsList(c echo.Context) error
- func (sc *StatisticController) GetStatisticRetentionsList(c echo.Context) error
- func (sc *StatisticController) GetStatisticTagsList(c echo.Context) error
- func (sc *StatisticController) StatisticData(c echo.Context) error
- type UserController
- func (uc *UserController) AuthSericeRequest(c echo.Context) error
- func (uc *UserController) CreateUser(c echo.Context) error
- func (uc *UserController) DeleteUser(c echo.Context) error
- func (uc *UserController) GetAuthTypeList(c echo.Context) error
- func (uc *UserController) GetCurrentUserProfile(c echo.Context) error
- func (uc *UserController) GetGroups(c echo.Context) error
- func (uc *UserController) GetUser(c echo.Context) error
- func (uc *UserController) GetUserByGUID(c echo.Context) error
- func (uc *UserController) LoginUser(c echo.Context) error
- func (uc *UserController) Oauth2TokenExchange(c echo.Context) error
- func (uc *UserController) RedirecToSericeAuth(c echo.Context) error
- func (uc *UserController) UpdateUser(c echo.Context) error
- type UserSettingsController
- func (usc *UserSettingsController) AddUserSettings(c echo.Context) error
- func (usc *UserSettingsController) DeleteUserSettings(c echo.Context) error
- func (usc *UserSettingsController) GetAll(c echo.Context) error
- func (usc *UserSettingsController) GetCategory(c echo.Context) error
- func (usc *UserSettingsController) UpdateUserSettings(c echo.Context) error
- type WebSocketController
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AdvancedController ¶
type AdvancedController struct { Controller AdvancedService *service.AdvancedService }
func (*AdvancedController) AddAdvanced ¶
func (ac *AdvancedController) AddAdvanced(c echo.Context) error
swagger:route POST /advanced Advanced advancedAddAdvanced
Add advanced item --- consumes: - application/json produces: - application/json Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
201: body:GlobalSettingsCreateSuccessfulResponse 400: body:FailureResponse
func (*AdvancedController) DeleteAdvancedAgainstGUID ¶
func (ac *AdvancedController) DeleteAdvancedAgainstGUID(c echo.Context) error
swagger:route DELETE /advanced/{guid} Advanced advancedDeleteAdvancedAgainstGUID
Delete advanced item by guid --- consumes: - application/json produces: - application/json parameters:
- name: guid in: path example: 11111111-1111-1111-1111-111111111111 description: guid of item required: true type: string
Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
201: body:GlobalSettingsDeleteSuccessfulResponse 400: body:FailureResponse
func (*AdvancedController) GetAdvancedAgainstGUID ¶
func (ac *AdvancedController) GetAdvancedAgainstGUID(c echo.Context) error
swagger:route GET /advanced/{guid} Advanced advancedGetAdvancedAgainstGUID
Get advanced item by guid --- consumes: - application/json produces: - application/json parameters:
- name: guid in: path example: 11111111-1111-1111-1111-111111111111 description: guid of item required: true type: string
Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
201: body:GlobalSettingsStruct 400: body:FailureResponse
func (*AdvancedController) GetAll ¶
func (ac *AdvancedController) GetAll(c echo.Context) error
swagger:route GET /advanced Advanced ListAdvancedSettings
Returns advanced setting of user --- produces: - application/json
Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
201: body:GlobalSettingsStructList 400: body:FailureResponse
func (*AdvancedController) UpdateAdvancedAgainstGUID ¶
func (ac *AdvancedController) UpdateAdvancedAgainstGUID(c echo.Context) error
swagger:route PUT /advanced/{guid} Advanced advancedUpdateAdvancedAgainstGUID
Update advanced item by guid --- consumes: - application/json produces: - application/json parameters:
- name: guid in: path example: 11111111-1111-1111-1111-111111111111 description: guid of item required: true type: string
Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
201: body:GlobalSettingsUpdateSuccessfulResponse 400: body:FailureResponse
type AgentsubController ¶
type AgentsubController struct { Controller AgentsubService *service.AgentsubService }
func (*AgentsubController) AddAgentsubWithKey ¶
func (ass *AgentsubController) AddAgentsubWithKey(c echo.Context) error
swagger:route POST /agent/subscribe agent agentsSubAddAgentsubWithKey
Add agent --- consumes: - application/json produces: - application/json parameters:
- name: AgentsLocation Struct in: body description: agent parameters schema: type: AgentsLocation required: true
Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
201: body:AgentLocationCreateSuccessResponse 400: body:FailureResponse
func (*AgentsubController) DeleteAgentsubAgainstGUID ¶
func (ass *AgentsubController) DeleteAgentsubAgainstGUID(c echo.Context) error
swagger:route DELETE /agent/subscribe/{guid} agent agentsSubDeleteAgentsubAgainstGUID
Delete agent by guid --- consumes: - application/json produces: - application/json parameters:
- name: guid in: path example: eacdae5b-4203-40a2-b388-969312ffcffe description: guid of agent required: true type: string
Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
201: body:AgentLocationDeleteSuccessResponse 400: body:FailureResponse
func (*AgentsubController) GetAgentSearchByTypeAndGUID ¶
func (ass *AgentsubController) GetAgentSearchByTypeAndGUID(c echo.Context) error
swagger:route GET /agent/search/{guid}/{type} agent agentsSubGetAgentSearchByTypeAndGUID
Get agent by guid and type --- consumes: - application/json produces: - application/json parameters:
- name: guid in: path example: eacdae5b-4203-40a2-b388-969312ffcffe description: guid of agent required: true type: string
- name: type in: path example: home description: type of agent required: true type: string
Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
201: body:AgentsLocationList 400: body:FailureResponse
func (*AgentsubController) GetAgentsub ¶
func (ass *AgentsubController) GetAgentsub(c echo.Context) error
swagger:route GET /agent/subscribe agent agentsSubGetAgentsub
Get all agents --- consumes: - application/json produces: - application/json Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
201: body:AgentsLocationList 400: body:FailureResponse
func (*AgentsubController) GetAgentsubAgainstGUID ¶
func (ass *AgentsubController) GetAgentsubAgainstGUID(c echo.Context) error
swagger:route GET /agent/subscribe/{guid} agent agentsSubGetAgentsubAgainstGUID
Get agent by guid --- consumes: - application/json produces: - application/json parameters:
- name: guid in: path example: eacdae5b-4203-40a2-b388-969312ffcffe description: guid of agent required: true type: string
Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
201: body:AgentsLocationList 400: body:FailureResponse
func (*AgentsubController) GetAgentsubByType ¶
func (ass *AgentsubController) GetAgentsubByType(c echo.Context) error
swagger:route GET /agent/type/{type} agent agentsSubGetAgentsubByType
Get agent by type --- consumes: - application/json produces: - application/json parameters:
- name: type in: path example: home description: type of agent required: true type: string
Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
200: body:AgentsLocationList 400: body:FailureResponse
func (*AgentsubController) UpdateAgentsubAgainstGUID ¶
func (ass *AgentsubController) UpdateAgentsubAgainstGUID(c echo.Context) error
swagger:route PUT /agent/subscribe/{guid} agent agentsSubUpdateAgentsubAgainstGUID
Update agent by guid --- consumes: - application/json produces: - application/json parameters:
- name: guid in: path example: eacdae5b-4203-40a2-b388-969312ffcffe description: guid of agent required: true type: string
- name: AgentsLocation Struct in: body description: agent parameters schema: type: AgentsLocation required: true
Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
201: body:AgentLocationUpdateSuccessResponse 400: body:FailureResponse
type AliasController ¶
type AliasController struct { Controller AliasService *service.AliasService }
func (*AliasController) AddAlias ¶
func (alc *AliasController) AddAlias(c echo.Context) error
swagger:route POST /alias alias aliasAddAlias
Adds alias to system --- consumes: - application/json produces: - application/json parameters:
- name: AliasStruct in: body description: AliasStruct parameters schema: type: AliasStruct required: true
Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
Responses:
201: body:AliasCreationSuccessResponse 401: body:FailureResponse
func (*AliasController) DeleteAlias ¶
func (als *AliasController) DeleteAlias(c echo.Context) error
swagger:route DELETE /alias/{guid} alias aliasDeleteAlias
delete an alias based upon guid --- consumes: - application/json produces: - application/json parameters:
- name: guid in: path example: 11111111-1111-1111-1111-111111111111 description: guid of the alias to delete required: true type: string
Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
Responses:
201: body:AliasDeleteSuccessResponse 401: body:FailureResponse
func (*AliasController) GetAllAlias ¶
func (alc *AliasController) GetAllAlias(c echo.Context) error
swagger:route GET /alias alias aliasGetAllAlias
Get all aliases --- produces: - application/json Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
200: body:AliasStructList
func (*AliasController) UpdateAlias ¶
func (als *AliasController) UpdateAlias(c echo.Context) error
swagger:route PUT /alias/{guid} alias aliasUpdateAlias
Update an existing alias based upon the lookup --- consumes: - application/json produces: - application/json parameters:
- name: guid in: path example: 11111111-1111-1111-1111-111111111111 description: uuid of the Alias to update required: true type: string
- name: AliasStruct in: body description: AliasStruct parameters schema: type: AliasStruct required: true
Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
Responses:
201: body:AliasUpdateSuccessResponse 401: body:FailureResponse
type AuthtokenController ¶
type AuthtokenController struct { Controller AuthtokenService *service.AuthtokenService }
func (*AuthtokenController) AddAuthtoken ¶
func (ass *AuthtokenController) AddAuthtoken(c echo.Context) error
swagger:route POST /token/auth token authTokenAddAuthToken
Add authentication token --- consumes: - application/json produces: - application/json parameters:
- name: authTokenStruct in: body description: authToken parameters schema: type: AuthToken required: true
Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
201: body:AuthTokenCreateSuccessfulResponse 400: body:FailureResponse
func (*AuthtokenController) DeleteAuthtokenAgainstGUID ¶
func (ass *AuthtokenController) DeleteAuthtokenAgainstGUID(c echo.Context) error
swagger:route DELETE /token/auth/{guid} token authTokenDeleteAuthtokenAgainstGUID
Delete authentication token by guid --- consumes: - application/json produces: - application/json parameters:
- name: guid in: path example: f4e2953e-ab42-40df-a7de-9ceb7faca396 description: guid of token required: true type: string
Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
201: body:AuthTokenDeleteSuccessfulResponse 400: body:FailureResponse
func (*AuthtokenController) GetAuthtoken ¶
func (ass *AuthtokenController) GetAuthtoken(c echo.Context) error
swagger:route GET /token/auth token authTokenGetAuthtoken
Get all authentication token data --- consumes: - application/json produces: - application/json Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
200: body:AuthTokenList 400: body:FailureResponse
func (*AuthtokenController) GetAuthtokenAgainstGUID ¶
func (ass *AuthtokenController) GetAuthtokenAgainstGUID(c echo.Context) error
swagger:route GET /token/auth/{guid} token authTokenGetAuthtokenAgainstGUID
Get authentication token data by guid --- consumes: - application/json produces: - application/json parameters:
- name: guid in: path example: eacdae5b-4203-40a2-b388-969312ffcffe description: guid of token required: true type: string
Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
200: body:AuthToken 400: body:FailureResponse
func (*AuthtokenController) UpdateAuthtokenAgainstGUID ¶
func (ass *AuthtokenController) UpdateAuthtokenAgainstGUID(c echo.Context) error
swagger:route PUT /token/auth/{guid} token authTokenUpdateAuthtokenAgainstGUID
Update authentication token data by guid --- consumes: - application/json produces: - application/json parameters:
- name: guid in: path example: f4e2953e-ab42-40df-a7de-9ceb7faca396 description: guid of token required: true type: string
- name: authTokenStruct in: body description: authToken parameters schema: type: AuthToken required: true
Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
201: body:AuthTokenUpdateSuccessfulResponse 400: body:FailureResponse
type Controller ¶
type Controller struct { }
type DashBoardController ¶
type DashBoardController struct { Controller DashBoardService *service.DashBoardService }
func (*DashBoardController) DeleteDashboard ¶
func (dbc *DashBoardController) DeleteDashboard(c echo.Context) error
swagger:route DELETE /dashboard/store/{dashboardId} Dashboard dashboardDeleteDashboard
Delete dashboard --- consumes: - application/json produces: - application/json parameters:
- name: dashboardId in: path example: home description: the ID of dashboard required: true type: string
Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
200: body:SuccessResponse 400: body:FailureResponse
func (*DashBoardController) GetDashBoard ¶
func (dbc *DashBoardController) GetDashBoard(c echo.Context) error
swagger:route GET /dashboard/store/{dashboardId} Dashboard dashboardGetDashBoard
Get dashboard by dashboard ID --- consumes: - application/json produces: - application/json parameters:
- name: dashboardId in: path example: home description: ID of dashboard required: true type: string
Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
200: body:DashboardElement 400: body:FailureResponse
func (*DashBoardController) GetDashBoardLists ¶
func (dbc *DashBoardController) GetDashBoardLists(c echo.Context) error
swagger:route GET /dashboard/info Dashboard dashboardGetDashBoardLists
Get all dashboards --- consumes: - application/json produces: - application/json Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
200: body:DashboardElementList 400: body:FailureResponse
func (*DashBoardController) InsertDashboard ¶
func (dbc *DashBoardController) InsertDashboard(c echo.Context) error
swagger:route POST /dashboard/store/{dashboardId} Dashboard dashboardInsertDashboard
Add new dashboard --- consumes: - application/json produces: - application/json parameters:
- name: dashboardId in: path example: home description: the ID of dashboard required: true type: string
- name: dashboard data in: body schema: type: DashboardElement required: true description: json of dashboard
Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
200: body:SuccessResponse 400: body:FailureResponse
func (*DashBoardController) ResetUserDashboard ¶
func (dbc *DashBoardController) ResetUserDashboard(c echo.Context) error
swagger:route GET /dashboard/reset Dashboard ListDashboard
Reset user Dashboards to default --- consumes: - application/json produces:
- application/json Security:
- JWT
- ApiKeyAuth
SecurityDefinitions: JWT:
type: apiKey name: Authorization in: header
ApiKeyAuth:
type: apiKey in: header name: Auth-Token
Responses:
201: body:DashboardElementList 400: body:FailureResponse
func (*DashBoardController) UpdateDashboard ¶
func (dbc *DashBoardController) UpdateDashboard(c echo.Context) error
swagger:route PUT /dashboard/store/{dashboardId} Dashboard UpdateDashboard
Update dashboard --- consumes: - application/json produces: - application/json parameters:
- name: dashboardId in: path example: home description: the ID of dashboard required: true type: string
- name: dashboard data in: body schema: type: DashboardElement required: true description: json of dashboard
Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
200: body:SuccessResponse 400: body:FailureResponse
type GrafanaController ¶
type GrafanaController struct { Controller GrafanaService *service.GrafanaService }
func (*GrafanaController) GrafanaFolders ¶
func (pc *GrafanaController) GrafanaFolders(c echo.Context) error
swagger:route GET /proxy/grafana/folders proxy grafanaGrafanaFolders
Returns list of folders from Grafana --- produces: - application/json Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
200: body:GrafanaFolders 400: body:FailureResponse
func (*GrafanaController) GrafanaGetDashboardAgainstUUID ¶
func (pc *GrafanaController) GrafanaGetDashboardAgainstUUID(c echo.Context) error
swagger:route GET /proxy/grafana/dashboards/uid/{uid} proxy grafanaGrafanaGetDashboardAgainstUUID
Returns dashboard from Grafana with specific UID --- produces: - application/json parameters:
- name: uid in: path example: 9Aklz9aGz description: uid required: true type: string
Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
200: body:GrafanaResponseValue 400: body:FailureResponse
func (*GrafanaController) GrafanaGetDashboardRequest ¶
func (pc *GrafanaController) GrafanaGetDashboardRequest(c echo.Context) error
swagger:route GET /proxy/grafana/request/d/{uid}/{param} Proxy grafanaRequest
Returns data based upon filtered json --- produces: - application/json Security: - JWT
SecurityDefinitions: JWT:
type: apiKey name: Authorization in: header
ApiKeyAuth:
type: apiKey in: header name: Auth-Token
Responses:
201: body:ListUsers 400: body:FailureResponse
func (*GrafanaController) GrafanaGetFoldersAgainstUUID ¶
func (pc *GrafanaController) GrafanaGetFoldersAgainstUUID(c echo.Context) error
swagger:route GET /proxy/grafana/search/{uid} proxy GrafanaGetFoldersAgainstUUID
Returns Grafana folder based on UID --- produces: - application/json Security: - bearer SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
parameters:
- name: uid in: path example: 9Aklz9aGz description: uid required: true type: string
responses:
200: body:ListUsers 400: body:FailureResponse
func (*GrafanaController) GrafanaORG ¶
func (pc *GrafanaController) GrafanaORG(c echo.Context) error
swagger:route GET /proxy/grafana/org proxy grafanaGrafanaORG
Returns data about Grafana organization --- produces: - application/json Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
200: body:GrafanaOrg 400: body:UserLoginFailureResponse
func (*GrafanaController) GrafanaStatus ¶
func (pc *GrafanaController) GrafanaStatus(c echo.Context) error
swagger:route GET /proxy/grafana/status Proxy grafana
Returns data based upon filtered json --- produces: - application/json Security: - JWT
SecurityDefinitions: JWT:
type: apiKey name: Authorization in: header
ApiKeyAuth:
type: apiKey in: header name: Auth-Token
Responses:
201: body:ListUsers 400: body:FailureResponse
func (*GrafanaController) GrafanaURL ¶
func (pc *GrafanaController) GrafanaURL(c echo.Context) error
swagger:route GET /proxy/grafana/url proxy grafanaGrafanaURL
Returns Grafana Proxy Url --- produces: - application/json Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
200: body:GrafanaUrl 400: body:FailureResponse
type HepsubController ¶
type HepsubController struct { Controller HepsubService *service.HepsubService }
func (*HepsubController) AddHepSub ¶
func (hsc *HepsubController) AddHepSub(c echo.Context) error
swagger:route POST /hepsub/protocol hep hepSubAddHepSub
Add new Hepsub information --- consumes: - application/json produces: - application/json parameters:
- name: HepsubSchema in: body description: hepSub parameters schema: type: HepsubSchema
Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
201: body:HepsubCreateSuccessResponse 400: body:FailureResponse
func (*HepsubController) DeleteHepSubAgainstGUID ¶
func (hsc *HepsubController) DeleteHepSubAgainstGUID(c echo.Context) error
swagger:route DELETE /hepsub/protocol/{guid} hep hepSubDeleteHepSubAgainstGUID
Delete hepsub by guid --- consumes: - application/json produces: - application/json parameters:
- name: guid in: path example: eacdae5b-4203-40a2-b388-969312ffcffe description: guid of hepsub item required: true type: string
Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
201: body:HepsubDeleteSuccessResponse 400: body:FailureResponse
func (*HepsubController) GetHepSub ¶
func (hsc *HepsubController) GetHepSub(c echo.Context) error
swagger:route GET /hepsub/protocol hep hepSubGetHepSub
Get all hepsub --- consumes: - application/json produces: - application/json Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
201: body:HepsubSchemaList 400: body:FailureResponse
func (*HepsubController) GetHepSubAgainstGUID ¶
func (hsc *HepsubController) GetHepSubAgainstGUID(c echo.Context) error
swagger:route GET /hepsub/protocol/{guid} hep hepSubGetHepSubAgainstGUID
Get hepsub by guid --- consumes: - application/json produces: - application/json parameters:
- name: guid in: path example: 11111111-1111-1111-1111-111111111111 description: guid of item required: true type: string
Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
201: body:HepsubSchema 400: body:FailureResponse
func (*HepsubController) GetHepSubFields ¶
func (hsc *HepsubController) GetHepSubFields(c echo.Context) error
swagger:route GET /hepsub/protocol/{id}/{transaction} hep hepSubGetHepSubFields
Get hepsub by id and transaction --- consumes: - application/json produces: - application/json parameters:
- name: id in: path example: 1 description: hepid required: true type: string
- name: transaction in: path example: call description: profile required: true type: string
Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
201: body:HepsubSchema 400: body:FailureResponse
func (*HepsubController) UpdateHepSubAgainstGUID ¶
func (hsc *HepsubController) UpdateHepSubAgainstGUID(c echo.Context) error
swagger:route PUT /hepsub/protocol/{guid} hep hepSubUpdateHepSubAgainstGUID
Update hepsub by guid --- consumes: - application/json produces: - application/json parameters:
- name: guid in: path example: eacdae5b-4203-40a2-b388-969312ffcffe description: guid of hepsub item required: true type: string
- name: HepsubSchema in: body description: hepSub parameters schema: type: HepsubSchema
Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
201: body:HepsubUpdateSuccessResponse 400: body:FailureResponse
type HepsubsearchController ¶
type HepsubsearchController struct { Controller HepsubsearchService *service.HepsubsearchService }
func (*HepsubsearchController) DoHepsubsearch ¶
func (hss *HepsubsearchController) DoHepsubsearch(c echo.Context) error
swagger:route POST /hepsub/search hep hepSubSearchDoHepsubsearch
Add hepsubsearch item --- consumes: - application/json produces: - application/json parameters:
- name: SearchObject in: body type: object description: SearchObject parameters schema: type: SearchObject required: true
Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
201: body:HepsubCreateSuccessResponse 400: body:FailureResponse
type MappingController ¶
type MappingController struct { Controller MappingService *service.MappingService }
func (*MappingController) AddMapping ¶
func (mpc *MappingController) AddMapping(c echo.Context) error
swagger:route POST /mapping/protocol mapping mappingAddMapping
Add mapping --- consumes: - application/json produces: - application/json Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
parameters:
- name: MappingSchema in: body description: Mapping parameters schema: type: MappingSchema
responses:
201: body:MappingCreateSuccessResponse 400: body:FailureResponse
func (*MappingController) DeleteMappingAgainstGUID ¶
func (mpc *MappingController) DeleteMappingAgainstGUID(c echo.Context) error
swagger:route DELETE /mapping/protocol/{guid} mapping mappingDeleteMappingAgainstGUID
Delete mapping using guid --- consumes: - application/json produces: - application/json parameters:
- name: guid in: path example: 11111111-1111-1111-1111-111111111111 description: guid of mapping required: true type: string
Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
201: body:MappingDeleteSuccessResponse 400: body:FailureResponse
func (*MappingController) GetMapping ¶
func (mpc *MappingController) GetMapping(c echo.Context) error
swagger:route GET /mapping/protocol mapping mappingGetMapping
Get all mappings --- consumes: - application/json produces: - application/json Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
201: body:MappingSchemaList 400: body:FailureResponse
func (*MappingController) GetMappingAgainstGUID ¶
func (mpc *MappingController) GetMappingAgainstGUID(c echo.Context) error
swagger:route GET /mapping/protocol/{guid} mapping mappingGetMappingAgainstGUID
Get mapping using guid --- consumes: - application/json produces: - application/json parameters:
- name: guid in: path example: 11111111-1111-1111-1111-111111111111 description: guid of mapping required: true type: string
Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
201: body:MappingSchemaList 400: body:FailureResponse
func (*MappingController) GetMappingFields ¶
func (mpc *MappingController) GetMappingFields(c echo.Context) error
swagger:route GET /mapping/protocol/{id}/{transaction} mapping mappingGetMappingFields
Get mapping using id and transaction --- consumes: - application/json produces: - application/json parameters:
- name: id in: path example: 1 description: hepid required: true type: number
parameters:
- name: transaction in: path example: call description: profile required: true type: string
Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
201: body:MappingSchemaList 400: body:FailureResponse
func (*MappingController) GetSmartHepProfile ¶
func (mpc *MappingController) GetSmartHepProfile(c echo.Context) error
swagger:route GET /smart/search/tag/{hepid}/{profile} mapping mappingGetSmartHepProfile
Get smart hep profile using hepid and profile --- consumes: - application/json produces: - application/json parameters:
- name: hepid in: path example: 1 description: hepid required: true type: string
- name: profile in: path example: description: profile required: true type: string
Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
201: body:SmartSearchFieldList 400: body:FailureResponse
func (*MappingController) ResetMapping ¶
func (mpc *MappingController) ResetMapping(c echo.Context) error
swagger:route GET /mapping/protocol/reset Mapping resetProtocols
Get mapping against id and profile --- consumes: - application/json produces: - application/json
Security: - JWT - ApiKeyAuth
SecurityDefinitions: JWT:
type: apiKey name: Authorization in: header
ApiKeyAuth:
type: apiKey in: header name: Auth-Token
Responses:
201: body:SuccessResponse 400: body:FailureResponse
func (*MappingController) ResetMappingAgainstUUID ¶
func (mpc *MappingController) ResetMappingAgainstUUID(c echo.Context) error
swagger:route GET /mapping/protocol/reset/{uuid} Mapping ResetMapping
Get mapping against id and profile --- consumes: - application/json produces: - application/json parameters:
- name: id in: path example: 11111111-1111-1111-1111-111111111111 description: uuid of mapping required: true type: string Security:
- JWT
- ApiKeyAuth
SecurityDefinitions: JWT:
type: apiKey name: Authorization in: header
ApiKeyAuth:
type: apiKey in: header name: Auth-Token
Responses:
201: body:SuccessResponse 400: body:FailureResponse
func (*MappingController) UpdateMappingAgainstGUID ¶
func (mpc *MappingController) UpdateMappingAgainstGUID(c echo.Context) error
swagger:route PUT /mapping/protocol/{guid} mapping mappingUpdateMappingAgainstGUID
Update mapping using guid --- consumes: - application/json produces: - application/json parameters:
- name: guid in: path example: 11111111-1111-1111-1111-111111111111 description: guid of mapping required: true type: string
- name: MappingSchema in: body description: Mapping parameters schema: type: MappingSchema
Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
201: body:MappingUpdateSuccessResponse 400: body:FailureResponse
type ProfileController ¶
type ProfileController struct { Controller ProfileService *service.ProfileService }
func (*ProfileController) GetDBNodeList ¶
func (pc *ProfileController) GetDBNodeList(c echo.Context) error
swagger:route GET /database/node/list profile profileGetDBNodeList
Get list of DB nodes --- consumes: - application/json produces: - application/json Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
201: body:NodeList 400: body:FailureResponse
func (*ProfileController) GetDashboardList ¶
func (pc *ProfileController) GetDashboardList(c echo.Context) error
swagger:route GET /admin/profiles Admin ListProfiles
Returns data from server --- consumes: - application/json produces: - application/json securityDefinitions:
bearer: type: apiKey in: header name: Authorization
security:
- bearer: []
responses:
201: body:HepsubSchema 400: body:FailureResponse
func (*ProfileController) GetHepsub ¶
func (pc *ProfileController) GetHepsub(c echo.Context) error
type PrometheusController ¶
type PrometheusController struct { Controller PrometheusService *service.PrometheusService }
func (*PrometheusController) PrometheusData ¶
func (pc *PrometheusController) PrometheusData(c echo.Context) error
swagger :route POST /prometheus/data proxy prometheusPrometheusData
Returns data based upon filtered json --- produces: - application/json Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
parameters:
- name: PrometheusObject in: body description: PrometheusObject parameters schema: type: PrometheusObject required: true
responses:
'200': body:ListUsers '400': body:UserLoginFailureResponse
func (*PrometheusController) PrometheusLabelData ¶
func (pc *PrometheusController) PrometheusLabelData(c echo.Context) error
swagger:route GET /prometheus/label/{labelName} proxy prometheusPrometheusLabelData
Returns data based upon filtered json --- produces: - application/json Security: - bearer: [] SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
parameters:
- name: labelName in: path example: 1 description: Label name required: true type: string
responses:
200: body:Label 400: body:FailureResponse
func (*PrometheusController) PrometheusLabels ¶
func (pc *PrometheusController) PrometheusLabels(c echo.Context) error
swagger:route GET /prometheus/labels proxy prometheusPrometheusLabels
Returns data based upon filtered json --- produces: - application/json Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
200: body:ListLabels example: ["go_goroutines","go_info","go_threads"] 400: body:FailureResponse
func (*PrometheusController) PrometheusValue ¶
func (pc *PrometheusController) PrometheusValue(c echo.Context) error
swagger:route POST /prometheus/value proxy prometheusPrometheusValue
Returns data based upon filtered json --- produces: - application/json
parameters:
- name: PrometheusObject in: body description: PrometheusObject parameters schema: type: PrometheusObject
Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
200: body:ListUsers 400: body:FailureResponse
type RemoteController ¶
type RemoteController struct { Controller RemoteService *service.RemoteService }
func (*RemoteController) RemoteData ¶
func (pc *RemoteController) RemoteData(c echo.Context) error
swagger:route POST /search/remote/data remote remoteRemoteData
Returns data based upon filtered json --- produces: - application/json parameters:
- name: RemoteObject in: body description: RemoteObject parameters schema: type: RemoteObject required: true
Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
200: body:RemoteResponseData 400: body:FailureResponse
func (*RemoteController) RemoteLabel ¶
func (pc *RemoteController) RemoteLabel(c echo.Context) error
swagger:route GET /search/remote/label remote remoteRemoteLabel
Returns data based upon filtered json --- produces: - application/json Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
parameters:
- name: server in: query description: url required: true type: string
responses:
200: body:RemoteLabels 400: body:FailureResponse
func (*RemoteController) RemoteValues ¶
func (pc *RemoteController) RemoteValues(c echo.Context) error
swagger:route GET /search/remote/values remote remoteRemoteValues
Returns data based upon filtered json --- produces: - application/json Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
parameters:
- name: server in: query description: url required: true type: string
- name: label in: query description: label required: true type: string
responses:
200: body:RemoteValues 400: body:FailureResponse
type SearchController ¶
type SearchController struct { Controller SearchService *service.SearchService SettingService *service.UserSettingsService AliasService *service.AliasService }
func (*SearchController) GetDataAsPCap ¶
func (sc *SearchController) GetDataAsPCap(c echo.Context) error
swagger:route POST /import/data/pcap Import GetMessagesAsPCap
Returns pcap data based upon filtered json --- consumes: - application/json produces: - application/json parameters:
- name: SearchObject in: body type: object description: SearchObject parameters schema: type: SearchObject required: true
Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
201: body:ListUsers 400: body:FailureResponse
func (*SearchController) GetDataAsPCapNow ¶
func (sc *SearchController) GetDataAsPCapNow(c echo.Context) error
swagger:route POST /import/data/pcap/now Import GetMessagesAsPCapNow
Returns pcap data based upon filtered json --- consumes: - application/json produces: - application/json parameters:
- name: SearchObject in: body type: object description: SearchObject parameters schema: type: SearchObject required: true
Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
201: body:ListUsers 400: body:FailureResponse
func (*SearchController) GetDecodeMessageById ¶
func (sc *SearchController) GetDecodeMessageById(c echo.Context) error
swagger:route POST /search/call/decode/message search searchGetDecodeMessageById
Returns data based upon filtered json --- consumes: - application/json produces: - application/json Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
parameters:
- name: SearchObject in: body type: object description: SearchObject parameters schema: type: SearchObject required: true
responses:
200: body:MessageDecoded 400: body:FailureResponse
func (*SearchController) GetMessageById ¶
func (sc *SearchController) GetMessageById(c echo.Context) error
swagger:route POST /search/call/message search searchGetMessageById
Returns message data based upon filtered json --- consumes: - application/json produces: - application/json parameters: Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
parameters:
- name: SearchObject in: body type: object description: SearchObject parameters schema: type: SearchObject required: true
responses:
200: body:SearchCallData 400: body:UserLoginFailureResponse
func (*SearchController) GetMessagesAsPCap ¶
func (sc *SearchController) GetMessagesAsPCap(c echo.Context) error
swagger:route POST /export/call/messages/pcap search searchGetMessagesAsPCap
Returns pcap data based upon filtered json --- consumes: - application/json produces: - application/octet-stream Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
parameters:
- name: SearchObject in: body type: object description: SearchObject parameters schema: type: SearchObject required: true
responses:
200: body:PCAPResponse 400: body:FailureResponse
func (*SearchController) GetMessagesAsText ¶
func (sc *SearchController) GetMessagesAsText(c echo.Context) error
swagger:route POST /export/call/messages/text search searchGetMessagesAsText
Returns text data based upon filtered json --- consumes: - application/json produces: - application/octet-stream Security: - bearer:
SecurityDefinitions:
bearer: type: apiKey name: Authorization in: header
parameters:
- name: SearchObject in: body type: object description: SearchObject parameters schema: type: SearchObject required: true
responses:
200: body:TextResponse 400: body:FailureResponse
func (*SearchController) GetTransaction ¶
func (sc *SearchController) GetTransaction(c echo.Context) error
swagger:route POST /call/transaction search searchGetTransaction
Returns transaction data based upon filtered json --- consumes: - application/json produces: - application/json Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
parameters:
- name: SearchObject in: body type: object description: SearchObject parameters schema: type: SearchObject required: true
responses:
200: body:SearchTransaction 400: body:FailureResponse
func (*SearchController) GetTransactionHepSub ¶
func (sc *SearchController) GetTransactionHepSub(c echo.Context) error
func (*SearchController) GetTransactionLog ¶
func (sc *SearchController) GetTransactionLog(c echo.Context) error
swagger:route POST /call/report/log search searchGetTransactionLog
Returns log data based upon filtered json --- consumes: - application/json produces: - application/json Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
parameters:
- name: SearchObject in: body type: object description: SearchObject parameters schema: type: SearchObject required: true
responses:
200: body:SearchTransactionLogList 400: body:FailureResponse
func (*SearchController) GetTransactionQos ¶
func (sc *SearchController) GetTransactionQos(c echo.Context) error
swagger:route POST /call/report/qos search searchGetTransactionQos
Returns qos data based upon filtered json --- consumes: - application/json produces: - application/json Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
parameters:
- name: SearchObject in: body type: object description: SearchObject parameters schema: type: SearchObject required: true
responses:
200: body:SearchTransactionQos 400: body:FailureResponse
func (*SearchController) SearchData ¶
func (sc *SearchController) SearchData(c echo.Context) error
swagger:route POST /search/call/data search searchSearchData
Returns data based upon filtered json --- consumes: - application/json produces: - application/json Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
parameters:
- name: SearchTransactionRequest in: body type: object description: SearchTransactionRequest parameters schema: type: SearchTransactionRequest required: true
responses:
200: body:SearchCallData 400: body:FailureResponse
type StatisticController ¶
type StatisticController struct { Controller StatisticService *service.StatisticService }
func (*StatisticController) GetStatisticDBList ¶
func (sc *StatisticController) GetStatisticDBList(c echo.Context) error
swagger:route GET /statistic/_db statistic statisticGetStatisticDBList
Returns data based upon filtered json --- produces: - application/json Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
200: body:StatisticDb 400: body:FailureResponse
func (*StatisticController) GetStatisticMeasurementsList ¶
func (sc *StatisticController) GetStatisticMeasurementsList(c echo.Context) error
swagger:route GET /statistic/_measurements/{dbid} statistic statisticGetStatisticMeasurementsList
Returns data based upon filtered json --- consumes: - application/json produces: - application/json parameters:
- name: dbid in: path type: string description: database id required: true
- name: StatisticSearchObject in: body type: StatisticSearchObject description: StatisticSearchObject required: true
Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
200: body:StatisticObject '400': body:UserLoginFailureResponse
func (*StatisticController) GetStatisticMetricsList ¶
func (sc *StatisticController) GetStatisticMetricsList(c echo.Context) error
swagger:route POST /statistic/_metrics statistic statisticGetStatisticMetricsList
Returns data based upon filtered json --- produces: - application/json Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
parameters:
- name: StatisticSearchObject in: body type: StatisticSearchObject description: StatisticSearchObject required: true
responses:
200: body:StatisticDb 400: body:FailureResponse
func (*StatisticController) GetStatisticRetentionsList ¶
func (sc *StatisticController) GetStatisticRetentionsList(c echo.Context) error
swagger:route POST /statistic/_retentions statistic statisticGetStatisticRetentionsList
Returns data based upon filtered json --- produces: - application/json Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
parameters:
- name: StatisticSearchObject in: body type: StatisticSearchObject description: StatisticSearchObject required: true
responses:
200: body:StatisticRetentions 400: body:UserLoginFailureResponse
func (*StatisticController) GetStatisticTagsList ¶
func (sc *StatisticController) GetStatisticTagsList(c echo.Context) error
swagger:route POST /statistic/_tags statistic statisticGetStatisticTagsList
Returns data based upon filtered json --- produces: - application/json Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
parameters:
- name: StatisticSearchObject in: body type: StatisticSearchObject description: StatisticSearchObject required: true
responses:
200: body:StatisticDb 400: body:FailureResponse
func (*StatisticController) StatisticData ¶
func (sc *StatisticController) StatisticData(c echo.Context) error
swagger:route POST /statistic/data statistic statisticStatisticData
Returns data based upon filtered json --- produces: - application/json Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
parameters:
- name: StatisticSearchObject in: body type: StatisticSearchObject description: StatisticSearchObject required: true
responses:
200: body:StatisticDb 400: body:FailureResponse
type UserController ¶
type UserController struct { Controller UserService *service.UserService }
func (*UserController) AuthSericeRequest ¶
func (uc *UserController) AuthSericeRequest(c echo.Context) error
swagger:route GET /oauth/auth Users SuccessResponse
Make redirect to the External Server URI --- consumes: - application/json produces:
- application/json Security:
- JWT
- ApiKeyAuth
SecurityDefinitions: JWT:
type: apiKey name: Authorization in: header
ApiKeyAuth:
type: apiKey in: header name: Auth-Token
responses:
200: body:SuccessResponse 400: body:FailureResponse
func (*UserController) CreateUser ¶
func (uc *UserController) CreateUser(c echo.Context) error
swagger:route POST /users user userCreateUser
Create a New user --- consumes: - application/json produces: - application/json parameters:
- name: CreateUserStruct in: body description: user structure schema: type: CreateUserStruct required: true
Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
201: body:UserCreateSuccessResponse 400: body:FailureResponse
func (*UserController) DeleteUser ¶
func (uc *UserController) DeleteUser(c echo.Context) error
swagger:route DELETE /users/{userGuid} user userDeleteUser
Delete an existing User --- consumes: - application/json produces: - application/json parameters:
- name: userGuid in: path example: 11111111-1111-1111-1111-111111111111 description: uuid of the user to update required: true type: string
Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
201: body:UserDeleteSuccessResponse 400: body:FailureResponse
func (*UserController) GetAuthTypeList ¶
func (uc *UserController) GetAuthTypeList(c echo.Context) error
swagger:route GET /auth/type/list user GetAuthTypeList
Returns data from server --- consumes: - application/json produces: - application/json Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
200: body:AuthTypeList 400: body:FailureResponse
func (*UserController) GetCurrentUserProfile ¶
func (uc *UserController) GetCurrentUserProfile(c echo.Context) error
swagger:route GET /user/profile settings settingsGetAll
Returns the list of settings --- produces: - application/json Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
200: body:UserSettingList 400: body:FailureResponse
func (*UserController) GetGroups ¶
func (uc *UserController) GetGroups(c echo.Context) error
swagger:route GET /users/groups Users groups
Returns the list of groups ---
Consumes: - application/json Produces: - application/json Security: - JWT
SecurityDefinitions: JWT:
type: apiKey name: Authorization in: header
ApiKeyAuth:
type: apiKey in: header name: Auth-Token
Responses:
201: body:ListUsers 400: body:FailureResponse
func (*UserController) GetUser ¶
func (uc *UserController) GetUser(c echo.Context) error
swagger:route GET /users user userGetUser
Returns the list of Users --- produces: - application/json Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
200: body:ListUsers 400: body:FailureResponse
func (*UserController) GetUserByGUID ¶
func (uc *UserController) GetUserByGUID(c echo.Context) error
swagger:route GET /users/{userGuid} user userGetUser
Returns the list of Users --- produces: - application/json Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
200: body:ListUsers 400: body:FailureResponse
func (*UserController) LoginUser ¶
func (uc *UserController) LoginUser(c echo.Context) error
swagger:route POST /auth user userLoginUser
Returns a JWT Token and UUID attached to user --- consumes: - application/json produces: - application/json parameters:
- name: userLoginStruct in: body description: user login structure schema: type: UserLogin required: true
responses:
201: body:UserLoginSuccessResponse 400: body:FailureResponse
func (*UserController) Oauth2TokenExchange ¶
func (uc *UserController) Oauth2TokenExchange(c echo.Context) error
swagger:route POST /oauth2/token user auth userLoginUser
Returns a JWT Token and UUID attached to user --- consumes: - application/json produces: - application/json parameters:
- name: userLoginStruct in: body description: user login structure schema: type: UserLogin required: true
responses:
201: body:UserLoginSuccessResponse 400: body:FailureResponse
func (*UserController) RedirecToSericeAuth ¶
func (uc *UserController) RedirecToSericeAuth(c echo.Context) error
swagger:route GET /oauth/redirect Users SuccessResponse
Make redirect to the External Server URI --- consumes: - application/json produces:
- application/json Security:
- JWT
- ApiKeyAuth
SecurityDefinitions: JWT:
type: apiKey name: Authorization in: header
ApiKeyAuth:
type: apiKey in: header name: Auth-Token
responses:
200: body:SuccessResponse 400: body:FailureResponse
func (*UserController) UpdateUser ¶
func (uc *UserController) UpdateUser(c echo.Context) error
swagger:route PUT /users/{userGuid} user userUpdateUser
Update an existing user --- consumes: - application/json produces: - application/json parameters:
- name: userGuid in: path example: 11111111-1111-1111-1111-111111111111 description: uuid of the user to update required: true type: string
- name: createUserStruct in: body description: user parameters schema: "$ref": "#/definitions/CreateUserStruct" required: true
Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
201: body:UserUpdateSuccessResponse 400: body:FailureResponse
type UserSettingsController ¶
type UserSettingsController struct { Controller UserSettingsService *service.UserSettingsService }
func (*UserSettingsController) AddUserSettings ¶
func (usc *UserSettingsController) AddUserSettings(c echo.Context) error
swagger:route POST /user/settings settings settingsAddUserSettings
Add new user setting --- consumes: - application/json produces: - application/json parameters:
- name: UserSetting in: body description: UserSetting struct schema: type: UserSetting required: true
Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
201: body:UserSettingCreateSuccessfulResponse 400: body:FailureResponse
func (*UserSettingsController) DeleteUserSettings ¶
func (usc *UserSettingsController) DeleteUserSettings(c echo.Context) error
swagger:route DELETE /user/settings/{guid} settings settingsDeleteUserSettings
Delete user setting --- consumes: - application/json produces: - application/json parameters:
- name: guid in: path example: 11111111-1111-1111-1111-111111111111 description: guid of user settings required: true type: string
Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
201: body:UserSettingDeleteSuccessfulResponse 400: body:FailureResponse
func (*UserSettingsController) GetAll ¶
func (usc *UserSettingsController) GetAll(c echo.Context) error
swagger:route GET /user/settings settings settingsGetAll
Returns the list of user settings --- produces: - application/json Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
200: body:UserSettingList 400: body:FailureResponse
func (*UserSettingsController) GetCategory ¶
func (usc *UserSettingsController) GetCategory(c echo.Context) error
swagger:route GET /user/settings/{category} settings settingsGetCategory
Returns the list of user settings --- consumes: - application/json produces: - application/json parameters:
- name: category in: path description: user settings category example: dashboard required: true type: string
Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
200: body:UserSettingList 400: body:FailureResponse
func (*UserSettingsController) UpdateUserSettings ¶
func (usc *UserSettingsController) UpdateUserSettings(c echo.Context) error
swagger:route PUT /user/settings/{guid} settings settingsUpdateUserSettings
Update user setting --- consumes: - application/json produces: - application/json parameters:
- name: guid in: path example: 11111111-1111-1111-1111-111111111111 description: guid of user settings required: true type: string
- name: UserSetting in: body description: UserSetting schema: type: UserSetting required: true
Security: - bearer: []
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
201: body:UserSettingUpdateSuccessfulResponse 400: body:FailureResponse
type WebSocketController ¶
type WebSocketController struct { Controller Addr *string }
func (*WebSocketController) RelayHepData ¶
func (wb *WebSocketController) RelayHepData(c echo.Context) error
GET /ws WebSocket
Returns data based upon filtered json --- consumes: - application/json produces: - application/json parameters:
- name: SearchObject in: body type: object description: SearchObject parameters schema: "$ref": "#/definitions/SearchCallData" required: true
SecurityDefinitions: bearer:
type: apiKey name: Authorization in: header
responses:
'200': body:ListUsers '400': body:UserLoginFailureResponse