package definitions import ( "github.com/grafana/grafana/pkg/api/dtos" "github.com/grafana/grafana/pkg/models" ) // swagger:route GET /teams/search teams searchTeams // // Team Search With Paging. // // Responses: // 200: searchTeamsResponse // 401: unauthorisedError // 403: forbiddenError // 500: internalServerError // swagger:route POST /teams teams createTeam // // Add Team. // // Responses: // 200: createTeamResponse // 401: unauthorisedError // 403: forbiddenError // 409: conflictError // 500: internalServerError // swagger:route GET /teams/{team_id} teams getTeam // // Get Team By ID. // // Responses: // 200: getTeamResponse // 401: unauthorisedError // 403: forbiddenError // 404: notFoundError // 500: internalServerError // swagger:route PUT /teams/{team_id} teams updateTeam // // Update Team. // // Responses: // 200: okResponse // 401: unauthorisedError // 403: forbiddenError // 404: notFoundError // 409: conflictError // 500: internalServerError // swagger:route DELETE /teams/{team_id} teams deleteTeamByID // // Delete Team By ID. // // Responses: // 200: okResponse // 401: unauthorisedError // 403: forbiddenError // 404: notFoundError // 500: internalServerError // swagger:route GET /teams/{team_id}/members teams getTeamMembers // // Get Team Members. // // Responses: // 200: okResponse // 401: unauthorisedError // 403: forbiddenError // 404: notFoundError // 500: internalServerError // swagger:route POST /teams/{team_id}/members teams addTeamMember // // Add Team Member. // // Responses: // 200: okResponse // 401: unauthorisedError // 403: forbiddenError // 404: notFoundError // 500: internalServerError // swagger:route PUT /teams/{team_id}/members/{user_id} teams updateTeamMember // // Update Team Member. // // Responses: // 200: okResponse // 401: unauthorisedError // 403: forbiddenError // 404: notFoundError // 500: internalServerError // swagger:route DELETE /teams/{team_id}/members/{user_id} teams removeTeamMember // // Remove Member From Team. // // Responses: // 200: okResponse // 401: unauthorisedError // 403: forbiddenError // 404: notFoundError // 500: internalServerError // swagger:route GET /teams/{team_id}/preferences teams getTeamPreferences // // Get Team Preferences. // // Responses: // 200: getPreferencesResponse // 401: unauthorisedError // 500: internalServerError // swagger:route PUT /teams/{team_id}/preferences teams updateTeamPreferences // // Update Team Preferences. // // Responses: // 200: okResponse // 400: badRequestError // 401: unauthorisedError // 500: internalServerError // swagger:parameters updateTeamPreferences type UpdateTeamPreferencesParams struct { // in:path // required:true TeamID string `json:"team_id"` // in:body // required:true Body dtos.UpdatePrefsCmd `json:"body"` } // swagger:parameters getTeam type GetTeamParams struct { // in:path // required:true TeamID string `json:"team_id"` } // swagger:parameters deleteTeamByID type DeleteTeamByIDParams struct { // in:path // required:true TeamID string `json:"team_id"` } // swagger:parameters getTeamMembers type GetTeamMembersParams struct { // in:path // required:true TeamID string `json:"team_id"` } // swagger:parameters getTeamPreferences type GetTeamPreferencesParams struct { // in:path // required:true TeamID string `json:"team_id"` } // swagger:parameters removeTeamMember type RemoveTeamMemberParams struct { // in:path // required:true TeamID string `json:"team_id"` // in:path // required:true UserID int64 `json:"user_id"` } // swagger:parameters searchTeams 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 createTeam type CreateTeamParams struct { // in:body // required:true Body models.CreateTeamCommand `json:"body"` } // swagger:parameters updateTeam type UpdateTeamParams struct { // in:body // required:true Body models.UpdateTeamCommand `json:"body"` // in:path // required:true TeamID string `json:"team_id"` } // swagger:parameters addTeamMember type AddTeamMemberParams struct { // in:body // required:true Body models.AddTeamMemberCommand `json:"body"` // in:path // required:true TeamID string `json:"team_id"` } // swagger:parameters updateTeamMember type UpdateTeamMember struct { // in:body // required:true Body models.UpdateTeamMemberCommand `json:"body"` // in:path // required:true TeamID string `json:"team_id"` // in:path // required:true UserID int64 `json:"user_id"` } // swagger:response searchTeamsResponse type SearchTeamsResponse struct { // The response message // in: body Body models.SearchTeamQueryResult `json:"body"` } // swagger:response getTeamResponse type GetTeamResponse struct { // The response message // in: body Body *models.TeamDTO `json:"body"` } // swagger:response createTeamResponse type CreateTeamResponse struct { // The response message // in: body Body struct { TeamId int64 `json:"teamId"` Message string `json:"message"` } `json:"body"` } // swagger:response getTeamMembersResponse type GetTeamMembersResponse struct { // The response message // in: body Body []*models.TeamMemberDTO `json:"body"` }