teamapi

Documentation

Index

• type AddTeamMemberParams
• type CreateTeamParams
• type CreateTeamResponse
• type DeleteTeamByIDParams
• type GetTeamByIDParams
• type GetTeamByIDResponse
• type GetTeamMembersParams
• type GetTeamMembersResponse
• type GetTeamPreferencesParams
• type RemoveTeamMemberParams
• type SearchTeamsParams
• type SearchTeamsResponse
• type SetTeamMembershipsParams
• type TeamAPI
  • func ProvideTeamAPI(routeRegister routing.RouteRegister, teamService team.Service, ...) *TeamAPI
• type UpdateTeamMemberParams
• type UpdateTeamParams
• type UpdateTeamPreferencesParams

Types

type AddTeamMemberParams

type AddTeamMemberParams struct {
	// in:body
	// required:true
	Body team.AddTeamMemberCommand `json:"body"`
	// in:path
	// required:true
	TeamID string `json:"team_id"`
}

swagger:parameters addTeamMember

type CreateTeamParams

type CreateTeamParams struct {
	// in:body
	// required:true
	Body team.CreateTeamCommand `json:"body"`
}

swagger:parameters createTeam

type CreateTeamResponse

type CreateTeamResponse struct {
	// The response message
	// in: body
	Body struct {
		TeamId  int64  `json:"teamId"`
		Message string `json:"message"`
	} `json:"body"`
}

swagger:response createTeamResponse

type DeleteTeamByIDParams

type DeleteTeamByIDParams struct {
	// in:path
	// required:true
	TeamID string `json:"team_id"`
}

swagger:parameters deleteTeamByID

type GetTeamByIDParams

type GetTeamByIDParams struct {
	// in:path
	// required:true
	TeamID string `json:"team_id"`
}

swagger:parameters getTeamByID

type GetTeamByIDResponse

type GetTeamByIDResponse struct {
	// The response message
	// in: body
	Body *team.TeamDTO `json:"body"`
}

swagger:response getTeamByIDResponse

type GetTeamMembersParams

type GetTeamMembersParams struct {
	// in:path
	// required:true
	TeamID string `json:"team_id"`
}

swagger:parameters getTeamMembers

type GetTeamMembersResponse

type GetTeamMembersResponse struct {
	// The response message
	// in: body
	Body []*team.TeamMemberDTO `json:"body"`
}

swagger:response getTeamMembersResponse

type GetTeamPreferencesParams

type GetTeamPreferencesParams struct {
	// in:path
	// required:true
	TeamID string `json:"team_id"`
}

swagger:parameters getTeamPreferences

type RemoveTeamMemberParams

type RemoveTeamMemberParams struct {
	// in:path
	// required:true
	TeamID string `json:"team_id"`
	// in:path
	// required:true
	UserID int64 `json:"user_id"`
}

swagger:parameters removeTeamMember

type SearchTeamsParams

type SearchTeamsParams struct {
	// in:query
	// required:false
	// default: 1
	Page int `json:"page"`
	// Number of items per page
	// The totalCount field in the response can be used for pagination list E.g. if totalCount is equal to 100 teams and the perpage parameter is set to 10 then there are 10 pages of teams.
	// in:query
	// required:false
	// default: 1000
	PerPage int    `json:"perpage"`
	Name    string `json:"name"`
	// If set it will return results where the query value is contained in the name field. Query values with spaces need to be URL encoded.
	// required:false
	Query string `json:"query"`
}

swagger:parameters searchTeams

type SearchTeamsResponse

type SearchTeamsResponse struct {
	// The response message
	// in: body
	Body team.SearchTeamQueryResult `json:"body"`
}

swagger:response searchTeamsResponse

type SetTeamMembershipsParams

type SetTeamMembershipsParams struct {
	// in:body
	// required:true
	Body team.SetTeamMembershipsCommand `json:"body"`
	// in:path
	// required:true
	TeamID string `json:"team_id"`
}

swagger:parameters setTeamMemberships

type TeamAPI

type TeamAPI struct {
	// contains filtered or unexported fields
}

func ProvideTeamAPI

func ProvideTeamAPI(
	routeRegister routing.RouteRegister,
	teamService team.Service,
	ac accesscontrol.Service,
	acEvaluator accesscontrol.AccessControl,
	teamPermissionsService accesscontrol.TeamPermissionsService,
	userService user.Service,
	license licensing.Licensing,
	cfg *setting.Cfg,
	preferenceService pref.Service,
	ds dashboards.DashboardService,
) *TeamAPI

type UpdateTeamMemberParams

type UpdateTeamMemberParams struct {
	// in:body
	// required:true
	Body team.UpdateTeamMemberCommand `json:"body"`
	// in:path
	// required:true
	TeamID string `json:"team_id"`
	// in:path
	// required:true
	UserID int64 `json:"user_id"`
}

swagger:parameters updateTeamMember

type UpdateTeamParams

type UpdateTeamParams struct {
	// in:body
	// required:true
	Body team.UpdateTeamCommand `json:"body"`
	// in:path
	// required:true
	TeamID string `json:"team_id"`
}

swagger:parameters updateTeam

type UpdateTeamPreferencesParams

type UpdateTeamPreferencesParams struct {
	// in:path
	// required:true
	TeamID string `json:"team_id"`
	// in:body
	// required:true
	Body dtos.UpdatePrefsCmd `json:"body"`
}

swagger:parameters updateTeamPreferences