v1

package
v0.0.0-...-b3accde Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 18, 2024 License: MIT Imports: 15 Imported by: 0

Documentation

Overview

Handlers for Projects endpoints

Handlers for TestCases endpoints

Handlers for Testers endpoints

Handlers for TestPlans endpoints

Handlers for TestRuns endpoints

Handlers for users endpoints

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func AssignTestsToPlan 

func AssignTestsToPlan(testPlanService services.TestPlanService, logger logging.Logger) fiber.Handler

func AuthLogin 

func AuthLogin(authService services.AuthService) fiber.Handler

func AuthRefreshToken 

func AuthRefreshToken(authService services.AuthService) fiber.Handler

func BulkCreateTestCases 

func BulkCreateTestCases(testCaseService services.TestCaseService, logger logging.Logger) fiber.Handler

BulkCreateTestCases godoc 

@ID				BulkCreateTestCases
@Summary		Create multiple Test Cases at once
@Description	Create multiple Test Cases at once
@Tags			test-cases
@Accept			json
@Produce		json
@Param			request	body		interface{}	true	"Bulk Create Test Case data"
@Success		200		{object}	interface{}
@Failure		400		{object}	problemdetail.ProblemDetail
@Failure		500		{object}	problemdetail.ProblemDetail
@Router			/api/v1/test-cases/bulk [post]

func CommitBulkTestRun 

func CommitBulkTestRun(testRunService services.TestRunService, logger logging.Logger) fiber.Handler

func CommitTestRun 

func CommitTestRun(testRunService services.TestRunService, logger logging.Logger) fiber.Handler

CommitTestRun godoc 

@ID				CommitTestRun
@Summary		Mark a Test Run as committed
@Description	Mark a Test Run as committed
@Tags			test-runs
@Accept			json
@Produce		json
@Param			testRunID	path		string		true	"Test Run ID"
@Param			request		body		interface{}	true	"Test Run update data"
@Success		200			{object}	interface{}
@Failure		400			{object}	problemdetail.ProblemDetail
@Failure		500			{object}	problemdetail.ProblemDetail
@Router			/api/v1/test-runs/{testRunID}/commit [post]

func CreateProject 

func CreateProject(projectService services.ProjectService, testPlanService services.TestPlanService, platform *config.PlatformConfiguration, logger logging.Logger) fiber.Handler

CreateProject godoc 

@ID				CreateProject
@Summary		Create a Project
@Description	Create a Project
@Tags			projects
@Accept			json
@Produce		json
@Param			request	body		interface{}	true	"Project Creation data"
@Success		200		{object}	interface{}
@Failure		400		{object}	problemdetail.ProblemDetail
@Failure		500		{object}	problemdetail.ProblemDetail
@Router			/api/v1/projects [post]

func CreateTestCase 

func CreateTestCase(testCaseService services.TestCaseService, logger logging.Logger) fiber.Handler

CreateTestCase godoc 

@ID				CreateTestCase
@Summary		Create a new Test Case
@Description	Create a new Test Case
@Tags			test-cases
@Accept			json
@Produce		json
@Param			request	body		interface{}	true	"Create Test Case data"
@Success		200		{object}	interface{}
@Failure		400		{object}	problemdetail.ProblemDetail
@Failure		500		{object}	problemdetail.ProblemDetail
@Router			/api/v1/test-cases [post]

func CreateTestPlan 

func CreateTestPlan(testPlanService services.TestPlanService, logger logging.Logger) fiber.Handler

CreateTestPlan godoc 

@ID				CreateTestPlan
@Summary		Create a new Test Plan
@Description	Create a new Test Plan
@Tags			test-plans
@Accept			json
@Produce		json
@Param			request	body		interface{}	true	"Create Test plan data"
@Success		200		{object}	interface{}
@Failure		400		{object}	problemdetail.ProblemDetail
@Failure		500		{object}	problemdetail.ProblemDetail
@Router			/api/v1/test-plans [post]

func CreateTestRun 

func CreateTestRun(services.TestRunService) fiber.Handler

CreateTestRun godoc 

@ID				CreateTestRun
@Summary		Create a new Test Run
@Description	Create a new Test Run
@Tags			test-runs
@Accept			json
@Produce		json
@Param			request	body		interface{}	true	"Test Run data"
@Success		200		{object}	interface{}
@Failure		400		{object}	problemdetail.ProblemDetail
@Failure		500		{object}	problemdetail.ProblemDetail
@Router			/api/v1/test-runs [post]

func CreateUser 

func CreateUser(userService services.UserService, logger logging.Logger) fiber.Handler

CreateUser godoc 

@ID				CreateUser
@Summary		Create a new User
@Description	Create a new User
@Tags			users
@Accept			json
@Produce		json
@Param			request	body		interface{}	true	"User data"
@Success		200		{object}	interface{}
@Failure		400		{object}	problemdetail.ProblemDetail
@Failure		500		{object}	problemdetail.ProblemDetail
@Router			/api/v1/users [post]

func DeleteProject 

func DeleteProject(projectService services.ProjectService) fiber.Handler

DeleteProject godoc 

@ID				DeleteProject
@Summary		Delete a Project
@Description	Delete a Project
@Tags			projects
@Accept			json
@Produce		json
@Param			projectID	path		string	true	"Project ID"
@Success		200			{object}	interface{}
@Failure		400			{object}	problemdetail.ProblemDetail
@Failure		500			{object}	problemdetail.ProblemDetail
@Router			/api/v1/projects/{projectID} [delete]

func DeleteTestCase 

func DeleteTestCase(services.TestCaseService) fiber.Handler

DeleteTestCase godoc 

@ID				DeleteTestCase
@Summary		Delete a test case
@Description	Delete a test case
@Tags			test-cases
@Accept			json
@Produce		json
@Param			testCaseID	path		string	true	"Test Case ID"
@Success		200			{object}	interface{}
@Failure		400			{object}	problemdetail.ProblemDetail
@Failure		500			{object}	problemdetail.ProblemDetail
@Router			/api/v1/test-cases/{testCaseID} [delete]

func DeleteTestPlan 

func DeleteTestPlan(testPlanService services.TestPlanService) fiber.Handler

DeleteTestPlan godoc 

@ID				DeleteTestPlan
@Summary		Delete a Test Plan
@Description	Delete a Test Plan
@Tags			test-plans
@Accept			json
@Produce		json
@Param			testPlanID	path		string	true	"Test Plan ID"
@Success		200			{object}	interface{}
@Failure		400			{object}	problemdetail.ProblemDetail
@Failure		500			{object}	problemdetail.ProblemDetail
@Router			/api/v1/test-plans/{testPlanID} [delete]

func DeleteTestRun 

func DeleteTestRun(testRunService services.TestRunService) fiber.Handler

DeleteTestRun godoc 

@ID				DeleteTestRun
@Summary		Delete a Test Run
@Description	Delete a Test Run
@Tags			test-runs
@Accept			json
@Produce		json
@Param			testRunID	path		string	true	"Test Run ID"
@Success		200			{object}	interface{}
@Failure		400			{object}	problemdetail.ProblemDetail
@Failure		500			{object}	problemdetail.ProblemDetail
@Router			/api/v1/test-runs/{testRunID} [delete]

func DeleteUser 

func DeleteUser(services.UserService) fiber.Handler

DeleteUser godoc 

@ID				DeleteUser
@Summary		Delete a user
@Description	Delete a user
@Tags			users
@Accept			json
@Produce		json
@Param			userID	path		string	true	"User ID"
@Success		200		{object}	interface{}
@Failure		400		{object}	problemdetail.ProblemDetail
@Failure		500		{object}	problemdetail.ProblemDetail
@Router			/api/v1/users/{userID} [delete]

func GetOneProject 

func GetOneProject(projectService services.ProjectService) fiber.Handler

GetOneProject godoc 

@ID				GetOneProject
@Summary		Get a single Project
@Description	Get a single Project
@Tags			projects
@Accept			json
@Produce		json
@Param			projectID	path		string	true	"Project ID"
@Success		200			{object}	interface{}
@Failure		400			{object}	problemdetail.ProblemDetail
@Failure		500			{object}	problemdetail.ProblemDetail
@Router			/api/v1/projects/{projectID} [get]

func GetOneTestCase 

func GetOneTestCase(services.TestCaseService) fiber.Handler

GetOneTestCase godoc 

@ID				GetOneTestCase
@Summary		Get a single Test Case
@Description	Get a single Test Case
@Tags			test-cases
@Accept			json
@Produce		json
@Param			testCaseID	path		string	true	"Test Case ID"
@Success		200			{object}	interface{}
@Failure		400			{object}	problemdetail.ProblemDetail
@Failure		500			{object}	problemdetail.ProblemDetail
@Router			/api/v1/test-cases/{testCaseID} [get]

func GetOneTestPlan 

func GetOneTestPlan(services.TestPlanService) fiber.Handler

GetOneTestPlan godoc 

@ID				GetOneTestPlan
@Summary		Get one Test Plan
@Description	Get one Test Plan
@Tags			test-plans
@Accept			json
@Produce		json
@Param			testPlanID	path		string	true	"Test Plan ID"
@Success		200			{object}	interface{}
@Failure		400			{object}	problemdetail.ProblemDetail
@Failure		500			{object}	problemdetail.ProblemDetail
@Router			/api/v1/test-plans/{testPlanID} [get]

func GetOneTestRun 

func GetOneTestRun(services.TestRunService) fiber.Handler

GetOneTestRun godoc 

@ID				GetOneTestRun
@Summary		Get one Test Run
@Description	Get one Test Run
@Tags			test-runs
@Accept			json
@Produce		json
@Param			testRunID	path		string	true	"Test Run ID"
@Success		200			{object}	interface{}
@Failure		400			{object}	problemdetail.ProblemDetail
@Failure		500			{object}	problemdetail.ProblemDetail
@Router			/api/v1/test-runs/{testRunID} [get]

func GetOneTester 

func GetOneTester(services.TesterService) fiber.Handler

GetOneTester godoc 

@ID				GetOneTester
@Summary		Get a Tester by ID
@Description	Get a Tester by ID
@Tags			testers
@Accept			json
@Produce		json
@Param			testerID	path		string	true	"Tester ID"
@Success		200			{object}	interface{}
@Failure		400			{object}	problemdetail.ProblemDetail
@Failure		500			{object}	problemdetail.ProblemDetail
@Router			/api/v1/testers/{testerID} [get]

func GetOneUser 

func GetOneUser(services.UserService) fiber.Handler

GetOneUser godoc 

@ID				GetOneUser
@Summary		Get one User
@Description	Get one User
@Tags			users
@Accept			json
@Produce		json
@Param			userID	path		string	true	"User ID"
@Success		200		{object}	interface{}
@Failure		400		{object}	problemdetail.ProblemDetail
@Failure		500		{object}	problemdetail.ProblemDetail
@Router			/api/v1/users/{userID} [get]

func GetProjectTestCases 

func GetProjectTestCases(testCaseService services.TestCaseService, logger logging.Logger) fiber.Handler

GetProjectTestCases godoc 

@ID				GetProjectTestCases
@Summary		Get a single Project's test cases
@Description	Get a single Project's test cases
@Tags			projects
@Accept			json
@Produce		json
@Param			projectID	path		string	true	"Project ID"
@Success		200			{object}	interface{}
@Failure		400			{object}	problemdetail.ProblemDetail
@Failure		500			{object}	problemdetail.ProblemDetail
@Router			/api/v1/projects/{projectID}/test-cases [get]

func GetProjectTestPlans 

func GetProjectTestPlans(testPlanService services.TestPlanService, logger logging.Logger) fiber.Handler

GetProjectTestPlans godoc 

@ID				GetProjectTestPlans
@Summary		Get a single Project's test plans
@Description	Get a single Project's test plans
@Tags			projects
@Accept			json
@Produce		json
@Param			projectID	path		string	true	"Project ID"
@Success		200			{object}	interface{}
@Failure		400			{object}	problemdetail.ProblemDetail
@Failure		500			{object}	problemdetail.ProblemDetail
@Router			/api/v1/projects/{projectID}/test-cases [get]

func GetProjectTestRuns 

func GetProjectTestRuns(testRunService services.TestRunService, logger logging.Logger) fiber.Handler

GetProjectTestRuns godoc 

@ID				GetProjectTestRuns
@Summary		Get a single Project's test runs
@Description	Get a single Project's test runs
@Tags			projects
@Accept			json
@Produce		json
@Param			projectID	path		string	true	"Project ID"
@Success		200			{object}	interface{}
@Failure		400			{object}	problemdetail.ProblemDetail
@Failure		500			{object}	problemdetail.ProblemDetail
@Router			/api/v1/projects/{projectID}/test-runs [get]

func GetSettings 

func GetSettings(config *config.Config) fiber.Handler

func ImportIssuesFromGitHubAsTestCases 

func ImportIssuesFromGitHubAsTestCases(projectService services.ProjectService, testCaseService services.TestCaseService, logger logging.Logger) fiber.Handler

func ImportProject 

func ImportProject(projectService services.ProjectService) fiber.Handler

ImportProject godoc 

@ID				ImportProject
@Summary		Import Projects from some source
@Description	Import Projects from some source
@Tags			projects
@Accept			json
@Produce		json
@Param			request	body		interface{}	true	"Import Specification"
@Success		200		{object}	interface{}
@Failure		400		{object}	problemdetail.ProblemDetail
@Failure		500		{object}	problemdetail.ProblemDetail
@Router			/api/v1/projects/import [post]

func InviteTester 

func InviteTester(services.TesterService) fiber.Handler

InviteTester godoc 

@ID				InviteTester
@Summary		Invite a tester by Email
@Description	Invite a tester by Email
@Tags			testers
@Accept			json
@Produce		json
@Param			email	path		string		true	"Email of tester"
@Param			request	body		interface{}	true	"Invite data"
@Success		200		{object}	interface{}
@Failure		400		{object}	problemdetail.ProblemDetail
@Failure		500		{object}	problemdetail.ProblemDetail
@Router			/api/v1/testers/invite/{email} [post]

func InviteUser 

func InviteUser(services.UserService) fiber.Handler

InviteUser godoc 

@ID				InviteUser
@Summary		Invite a User by email
@Description	Invite a User by email
@Tags			users
@Accept			json
@Produce		json
@Param			email	path		string		true	"User's email"
@Param			request	body		interface{}	true	"User invite data"
@Success		200		{object}	interface{}
@Failure		400		{object}	problemdetail.ProblemDetail
@Failure		500		{object}	problemdetail.ProblemDetail
@Router			/api/v1/users/invite/{email} [post]

func ListProjects 

func ListProjects(projectService services.ProjectService) fiber.Handler

ListProject godoc 

@ID				ListProject
@Summary		List Projects available on the platform
@Description	List Projects available on the platform
@Tags			projects
@Accept			json
@Produce		json
@Success		200	{object}	interface{}
@Failure		400	{object}	problemdetail.ProblemDetail
@Failure		500	{object}	problemdetail.ProblemDetail
@Router			/api/v1/projects [get]

func ListTestCases 

func ListTestCases(testCasesService services.TestCaseService) fiber.Handler

ListTestCases godoc 

@ID				ListTestCases
@Summary		List Test Cases
@Description	List Test Cases
@Tags			test-cases
@Accept			json
@Produce		json
@Success		200	{object}	interface{}
@Failure		400	{object}	problemdetail.ProblemDetail
@Failure		500	{object}	problemdetail.ProblemDetail
@Router			/api/v1/test-cases [get]

func ListTestPlans 

func ListTestPlans(testPlanService services.TestPlanService) fiber.Handler

ListTestPlans godoc 

@ID				ListTestPlans
@Summary		List all Test Plans
@Description	List all Test Plans
@Tags			test-plans
@Accept			json
@Produce		json
@Success		200	{object}	interface{}
@Failure		400	{object}	problemdetail.ProblemDetail
@Failure		500	{object}	problemdetail.ProblemDetail
@Router			/api/v1/test-plans [get]

func ListTestRuns 

func ListTestRuns(services.TestRunService) fiber.Handler

ListTestRuns godoc 

@ID				ListTestRuns
@Summary		List Test Runs
@Description	List Test Runs
@Tags			test-runs
@Accept			json
@Produce		json
@Success		200	{object}	interface{}
@Failure		400	{object}	problemdetail.ProblemDetail
@Failure		500	{object}	problemdetail.ProblemDetail
@Router			/api/v1/test-runs [get]

func ListTesters 

func ListTesters(testerService services.TesterService) fiber.Handler

ListTesters godoc 

@ID				ListTesters
@Summary		List all Testers
@Description	List all Testers
@Tags			testers
@Accept			json
@Produce		json
@Success		200	{object}	interface{}
@Failure		400	{object}	problemdetail.ProblemDetail
@Failure		500	{object}	problemdetail.ProblemDetail
@Router			/api/v1/testers [get]

func ListUsers 

func ListUsers(services.UserService) fiber.Handler

ListUsers godoc 

@ID				ListUsers
@Summary		List all Users
@Description	List all Users
@Tags			users
@Accept			json
@Produce		json
@Success		200	{object}	interface{}
@Failure		400	{object}	problemdetail.ProblemDetail
@Failure		500	{object}	problemdetail.ProblemDetail
@Router			/api/v1/users [get]

func SearchProjects 

func SearchProjects(projectService services.ProjectService) fiber.Handler

SearchProjects godoc 

@ID				SearchProjects
@Summary		Search for a Project
@Description	Search for a Project
@Tags			projects
@Accept			json
@Produce		json
@Success		200	{object}	interface{}
@Failure		400	{object}	problemdetail.ProblemDetail
@Failure		500	{object}	problemdetail.ProblemDetail
@Router			/api/v1/projects/query [get]

func SearchTestCases 

func SearchTestCases(services.TestCaseService) fiber.Handler

SearchTestCases godoc 

@ID				SearchTestCases
@Summary		Search for Test Cases
@Description	Search for Test Cases
@Tags			test-cases
@Accept			json
@Produce		json
@Success		200	{object}	interface{}
@Failure		400	{object}	problemdetail.ProblemDetail
@Failure		500	{object}	problemdetail.ProblemDetail
@Router			/api/v1/test-cases/query [get]

func SearchTestPlans 

func SearchTestPlans(services.TestPlanService) fiber.Handler

SearchTestPlans godoc 

@ID				SearchTestPlans
@Summary		Search all Test Plans
@Description	Search all Test Plans
@Tags			test-plans
@Accept			json
@Produce		json
@Success		200	{object}	interface{}
@Failure		400	{object}	problemdetail.ProblemDetail
@Failure		500	{object}	problemdetail.ProblemDetail
@Router			/api/v1/test-plans [get]

func SearchTestRuns 

func SearchTestRuns(services.TestRunService) fiber.Handler

SearchTestRuns godoc 

@ID				SearchTestRuns
@Summary		Search for Test Runs
@Description	Search for Test Runs
@Tags			test-runs
@Accept			json
@Produce		json
@Success		200	{object}	interface{}
@Failure		400	{object}	problemdetail.ProblemDetail
@Failure		500	{object}	problemdetail.ProblemDetail
@Router			/api/v1/test-runs/query [get]

func SearchTesters 

func SearchTesters(services.TesterService) fiber.Handler

SearchTesters godoc 

@ID				SearchTesters
@Summary		Search all Testers
@Description	Search all Testers
@Tags			testers
@Accept			json
@Produce		json
@Success		200	{object}	interface{}
@Failure		400	{object}	problemdetail.ProblemDetail
@Failure		500	{object}	problemdetail.ProblemDetail
@Router			/api/v1/testers.query [get]

func SearchUsers 

func SearchUsers(services.UserService) fiber.Handler

SearchUsers godoc 

@ID				SearchUsers
@Summary		Search all Users
@Description	Search all Users
@Tags			users
@Accept			json
@Produce		json
@Success		200	{object}	interface{}
@Failure		400	{object}	problemdetail.ProblemDetail
@Failure		500	{object}	problemdetail.ProblemDetail
@Router			/api/v1/users/query [get]

func Signup 

func Signup(authService services.AuthService) fiber.Handler

func UpdateProject 

func UpdateProject(projectService services.ProjectService) fiber.Handler

UpdateProject godoc 

@ID				UpdateProject
@Summary		Update a Project
@Description	Update a Project
@Tags			projects
@Accept			json
@Produce		json
@Param			projectID	path		string		true	"Project ID"
@Param			request		body		interface{}	true	"Project Update data"
@Success		200			{object}	interface{}
@Failure		400			{object}	problemdetail.ProblemDetail
@Failure		500			{object}	problemdetail.ProblemDetail
@Router			/api/v1/projects/{projectID} [post]

func UpdateSetting 

func UpdateSetting(config *config.Config) fiber.Handler

func UpdateTestCase 

func UpdateTestCase(testCaseService services.TestCaseService, logger logging.Logger) fiber.Handler

UpdateTestCase godoc 

@ID				UpdateTestCase
@Summary		Update a Test Case
@Description	Update a Test Case
@Tags			test-cases
@Accept			json
@Produce		json
@Param			testCaseID	path		string		true	"Test Case ID"
@Param			request		body		interface{}	true	"Test Case update data"
@Success		200			{object}	interface{}
@Failure		400			{object}	problemdetail.ProblemDetail
@Failure		500			{object}	problemdetail.ProblemDetail
@Router			/api/v1/test-cases/{testCaseID} [post]

func UpdateTestPlan 

func UpdateTestPlan(services.TestPlanService) fiber.Handler

UpdateTestPlan godoc 

@ID				UpdateTestPlan
@Summary		Update a Test Plan
@Description	Update a Test Plan
@Tags			test-plans
@Accept			json
@Produce		json
@Param			testPlanID	path		string		true	"Test Plan ID"
@Param			request		body		interface{}	true	"Test Plan data"
@Success		200			{object}	interface{}
@Failure		400			{object}	problemdetail.ProblemDetail
@Failure		500			{object}	problemdetail.ProblemDetail
@Router			/api/v1/test-plans/{testPlanID} [post]

func UpdateTestRun 

func UpdateTestRun(services.TestRunService) fiber.Handler

UpdateTestRun godoc 

@ID				UpdateTestRun
@Summary		Update a Test Run
@Description	Update a Test Run
@Tags			test-runs
@Accept			json
@Produce		json
@Param			testRunID	path		string		true	"Test Run ID"
@Param			request		body		interface{}	true	"Test Run update data"
@Success		200			{object}	interface{}
@Failure		400			{object}	problemdetail.ProblemDetail
@Failure		500			{object}	problemdetail.ProblemDetail
@Router			/api/v1/test-runs/{testRunID} [post]

func UpdateUser 

func UpdateUser(services.UserService) fiber.Handler

UpdateUser godoc 

@ID				UpdateUser
@Summary		Update a User
@Description	Update a User
@Tags			users
@Accept			json
@Produce		json
@Param			userID	path		string		true	"User ID"
@Param			request	body		interface{}	true	"User ID"
@Success		200		{object}	interface{}
@Failure		400		{object}	problemdetail.ProblemDetail
@Failure		500		{object}	problemdetail.ProblemDetail
@Router			/api/v1/users/{userID} [post]

Types

This section is empty.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.