components: schemas: dbsqlc.TestKind: type: string x-enum-varnames: - TestKindGeneral - TestKindAdhoc - TestKindTriage - TestKindIntegration - TestKindUserAcceptance - TestKindRegression - TestKindSecurity - TestKindUserInterface - TestKindScenario dbsqlc.TestRunState: description: passed, failed, or leave nil for pending type: string x-enum-varnames: - TestRunStatePending - TestRunStatePassed - TestRunStateFailed - TestRunStateBlocked problemdetail.ProblemDetail: properties: context: {} detail: type: string title: type: string type: type: string type: object schema.AddProjectTestCaseTemplateRequest: properties: project_id: type: integer test_case_template: type: string required: - project_id - test_case_template type: object schema.AssignTestsToPlanRequest: properties: all_test_cases: $ref: '#/components/schemas/schema.ProjectTestCaseSelection' planned_tests: description: Required unless all_test_cases is set items: $ref: '#/components/schemas/schema.TestCaseAssignment' maxItems: 100 type: array uniqueItems: false project_id: type: integer test_plan_id: type: integer required: - project_id - test_plan_id type: object schema.AssignedTestCase: properties: assigned_to_id: type: integer code: type: string created_at: type: string created_by_id: type: integer description: type: string environment_id: type: integer external_id: type: string feature_or_module: type: string id: type: string is_closed: type: boolean is_draft: type: boolean is_viewed: type: boolean kind: $ref: '#/components/schemas/dbsqlc.TestKind' preconditions: type: string priority: type: string project_id: type: integer tags: items: type: string type: array uniqueItems: false test_plan_id: type: integer title: type: string updated_at: type: string urgency: type: string type: object schema.AssignedTestCaseListResponse: properties: pagination: $ref: '#/components/schemas/schema.Pagination' test_cases: items: $ref: '#/components/schemas/schema.AssignedTestCase' type: array uniqueItems: false type: object schema.AttachmentResponse: properties: file_name: type: string file_size: type: integer file_type: type: string id: type: string storage_url: type: string type: object schema.BulkAssignTesters: properties: project_id: type: integer testers: items: properties: role: type: string user_id: type: integer type: object type: array uniqueItems: false type: object schema.BulkCreateTestCases: properties: project_id: type: integer test_cases: items: $ref: '#/components/schemas/schema.CreateTestCaseRequest' maxItems: 100 minItems: 1 type: array uniqueItems: false required: - project_id - test_cases type: object schema.BulkDeleteTestCasesRequest: properties: selection: $ref: '#/components/schemas/schema.TestCaseSelection' required: - selection type: object schema.BulkDeleteTestCasesResponse: properties: deleted: type: integer type: object schema.BulkTransferTestCasesRequest: properties: feature_or_module: type: string selection: $ref: '#/components/schemas/schema.TestCaseSelection' target_project_id: type: integer required: - feature_or_module - selection - target_project_id type: object schema.BulkTransferTestCasesResponse: properties: transferred: type: integer type: object schema.ChangeEnvironmentRequest: properties: environment_id: type: integer required: - environment_id type: object schema.ChangePasswordRequest: properties: confirm_password: type: string new_password: type: string old_password: type: string user_id: type: integer required: - confirm_password - new_password - old_password - user_id type: object schema.CommentListResponse: properties: comments: items: $ref: '#/components/schemas/schema.CommentResponseItem' type: array uniqueItems: false type: object schema.CommentResponseItem: properties: content: type: string created_at: type: string id: type: string parent_comment_id: type: string replies: items: $ref: '#/components/schemas/schema.CommentResponseItem' type: array uniqueItems: false test_plan_id: type: integer updated_at: type: string user_id: type: integer user_name: type: string type: object schema.CommitTestRunResponse: properties: actual_result: type: string attachment_count: type: integer code: type: string environment_id: type: integer executed_by: type: string expected_result: type: string id: type: string is_closed: type: boolean latest_result_id: type: string notes: type: string project_id: type: integer result_id: type: string result_state: type: string test_case_id: type: string test_case_title: type: string test_plan_id: type: integer tested_by_id: type: integer tested_on: type: string type: object schema.CommitTestRunResult: properties: actual_result: type: string environment_id: type: integer expected_result: type: string is_closed: type: boolean notes: type: string result_state: description: State is the result of the test run type: string x-enum-varnames: - TestRunStatePending - TestRunStatePassed - TestRunStateFailed - TestRunStateBlocked test_run_id: type: string tested_on: type: string required: - actual_result - result_state - test_run_id - tested_on type: object schema.CompactUserListResponse: properties: total: type: integer users: items: $ref: '#/components/schemas/schema.UserCompact' type: array uniqueItems: false type: object schema.CreateComment: properties: content: type: string parent_comment_id: type: string test_plan_id: type: integer user_id: type: integer required: - content - test_plan_id - user_id type: object schema.CreateOrgRequest: properties: address: type: string country: type: string github_url: type: string name: type: string website_url: type: string required: - name type: object schema.CreateProjectModuleRequest: properties: code: type: string description: type: string name: type: string parent_module_id: description: ParentModuleID is the module this module sits under, omit for a top-level module type: integer priority: type: integer project_id: type: integer type: type: string required: - code - description - name - priority - project_id - type type: object schema.CreateReportRequest: properties: name: type: string project_id: type: integer status: type: string test_plan_id: type: integer type: type: string required: - name - project_id - status - test_plan_id - type type: object schema.CreateSuggestedTestCaseRequest: properties: code: type: string description: type: string feature_or_module: type: string kind: type: string preconditions: description: Markdown type: string priority: description: defaults to medium enum: - low - medium - high - urgent type: string project_id: type: integer runner: type: string script_path: type: string tags: items: type: string type: array uniqueItems: false title: type: string required: - description - feature_or_module - kind - project_id - title type: object schema.CreateTestCaseRelationRequest: properties: related_test_case_id: type: string relation_kind: enum: - depends_on - related_to - duplicates - branched_from - blocks type: string required: - related_test_case_id - relation_kind type: object schema.CreateTestCaseRequest: properties: code: description: optional; auto-generated if blank type: string description: type: string external_id: description: identifier in the source system, e.g. TestLink form: external_id type: string feature_or_module: type: string is_draft: type: boolean kind: type: string parent_test_case_id: type: string preconditions: description: Markdown type: string priority: description: defaults to medium enum: - low - medium - high - urgent type: string project_id: type: integer runner: type: string script_path: type: string tags: items: type: string type: array uniqueItems: false title: type: string required: - description - feature_or_module - kind - title type: object schema.CreateTestPlan: properties: all_test_cases: $ref: '#/components/schemas/schema.ProjectTestCaseSelection' assigned_to_id: type: integer closed_at: type: string created_by_id: type: integer description: type: string environment_id: type: integer kind: type: string planned_tests: items: $ref: '#/components/schemas/schema.TestCaseAssignment' type: array uniqueItems: false project_id: type: integer scheduled_end_at: type: string start_at: type: string updated_by_id: type: integer required: - description - kind - project_id - scheduled_end_at - start_at type: object schema.DashboardProjectRecord: properties: id: type: integer name: type: string updated_at: type: string type: object schema.DashboardSummaryResponse: properties: closed_to_open_ratio: type: number project_count: type: integer recent_projects: items: $ref: '#/components/schemas/schema.DashboardProjectRecord' type: array uniqueItems: false test_case_count: type: integer test_plan_count: type: integer tester_count: type: integer type: object schema.EnvironmentListResponse: properties: environments: items: $ref: '#/components/schemas/schema.EnvironmentResponse' type: array uniqueItems: false type: object schema.EnvironmentRequest: properties: base_url: type: string description: type: string name: type: string required: - name type: object schema.EnvironmentResponse: properties: base_url: type: string created_at: type: string description: type: string id: type: integer name: type: string project_id: type: integer updated_at: type: string type: object schema.ExecuteTestCaseRequest: properties: runner: description: optional, falls back to test case runner type type: string test_plan_id: type: integer type: object schema.ExecuteTestRunRequest: properties: environment_id: type: integer expected_result: type: string id: type: string notes: type: string result: type: string status: type: string required: - id - result - status type: object schema.ExportTestCasesRequest: properties: fileformat: type: string filename: type: string selection: $ref: '#/components/schemas/schema.TestCaseSelection' testcases: items: $ref: '#/components/schemas/schema.ExportedTestCase' type: array uniqueItems: false type: object schema.ExportedTestCase: properties: code: type: string description: type: string featureOrModule: type: string isDraft: type: boolean kind: type: string priority: type: string tags: items: type: string type: array uniqueItems: false title: type: string type: object schema.HealthStatus: properties: message: type: string status: type: string uptime: type: integer type: object schema.ImportFromGithubRequest: properties: github_token: type: string owner: type: string project_id: type: integer repository: type: string type: object schema.ImportProjectRequest: type: object schema.InboxNavigationResponse: properties: next_id: type: string position: type: integer previous_id: type: string total: type: integer type: object schema.InboxUnseenCountResponse: properties: unseen_count: type: integer type: object schema.LoginRequest: properties: email: type: string password: type: string required: - email - password type: object schema.LoginResponse: properties: displayName: type: string email: type: string expires_at: type: integer token: type: string user_id: type: integer type: object schema.MessageResponse: properties: developer_message: type: string message: type: string type: object schema.Metrics: properties: errorsTotal: type: integer requestsTotal: type: integer uptimeSeconds: type: integer type: object schema.NewProjectRequest: properties: automated_testing_enabled: type: boolean code: maxLength: 10 minLength: 3 type: string description: type: string environments: items: $ref: '#/components/schemas/schema.EnvironmentRequest' type: array uniqueItems: false github_url: type: string name: type: string parent_project_id: type: integer project_owner_id: type: integer supported_runners: items: type: string type: array uniqueItems: false version: type: string website_url: type: string required: - code - description - name - version type: object schema.NewUserRequest: properties: display_name: type: string email: type: string first_name: type: string last_name: type: string organization_id: type: integer password: type: string required: - display_name - email - first_name - last_name - password type: object schema.Org: properties: address: type: string country: type: string created_at: type: string created_by: type: integer github_url: type: string id: type: integer name: type: string updated_at: type: string website_url: type: string type: object schema.OrgListResponse: properties: orgs: items: $ref: '#/components/schemas/schema.Org' type: array uniqueItems: false total: type: integer type: object schema.PageRequest: type: object schema.Pagination: properties: page: type: integer pageSize: type: integer total: type: integer type: object schema.ProjectListResponse: properties: projects: items: $ref: '#/components/schemas/schema.ProjectResponse' type: array uniqueItems: false type: object schema.ProjectResponse: properties: automated_testing_enabled: type: boolean code: type: string created_at: type: string description: type: string github_url: type: string id: type: integer is_active: type: boolean is_public: type: boolean jira_url: type: string monday_url: type: string owner_user_id: type: integer parent_project_id: type: integer supported_runners: items: type: string type: array uniqueItems: false title: type: string trello_url: type: string updated_at: type: string version: type: string website_url: type: string type: object schema.ProjectTestCaseSelection: properties: excluded_test_case_ids: description: Test cases the user deselected items: type: string type: array uniqueItems: false search: description: Same filter as the project test case list (matches title or code) type: string user_ids: description: Testers assigned to each of the selected test cases items: type: integer maxItems: 100 minItems: 1 type: array uniqueItems: false required: - user_ids type: object schema.ProjectTestCaseSummaryResponse: properties: blocked: type: integer completed: type: integer failed: type: integer incomplete: type: integer passed: type: integer pending: type: integer total: type: integer type: object schema.ProjectTestCaseTemplateResponse: properties: test_case_template: type: string type: object schema.RefreshTokenRequest: type: object schema.RefreshTokenResponse: type: object schema.RelatedTestCaseSummary: properties: code: type: string id: type: string project_id: type: integer title: type: string type: object schema.ReportListResponse: properties: pagination: $ref: '#/components/schemas/schema.Pagination' reports: items: $ref: '#/components/schemas/schema.ReportResponse' type: array uniqueItems: false type: object schema.ReportResponse: properties: created_at: type: string file_path: type: string id: type: string name: type: string project_id: type: integer status: type: string type: type: string type: object schema.ResetPasswordRequest: properties: confirm_password: type: string new_password: type: string user_id: type: integer required: - confirm_password - new_password - user_id type: object schema.SignUpRequest: properties: display_name: type: string email: type: string firstname: type: string lastname: type: string password: type: string required: - display_name - email - firstname - lastname - password type: object schema.SystemInfo: properties: buildDate: type: string developedBy: type: string projectUrl: type: string sha: type: string title: type: string version: type: string type: object schema.TestCaseAssignment: properties: test_case_id: type: string urgency: description: |- Urgency of the test case within the plan (low, medium, high, urgent). When blank an existing urgency is kept, otherwise it defaults to medium enum: - low - medium - high - urgent type: string user_ids: items: type: integer type: array uniqueItems: false type: object schema.TestCaseExecutionSummary: properties: failure_count: type: integer success_count: type: integer test_case_id: type: string usage_count: type: integer type: object schema.TestCaseListResponse: properties: pagination: $ref: '#/components/schemas/schema.Pagination' test_cases: items: $ref: '#/components/schemas/schema.TestCaseResponse' type: array uniqueItems: false type: object schema.TestCaseRelationListResponse: properties: relations: items: $ref: '#/components/schemas/schema.TestCaseRelationResponse' type: array uniqueItems: false type: object schema.TestCaseRelationResponse: properties: created_at: type: string created_by_id: type: integer direction: description: Direction relative to the test case in the request path enum: - outgoing - incoming type: string id: type: string other_test_case: $ref: '#/components/schemas/schema.RelatedTestCaseSummary' related_test_case_id: type: string relation_kind: enum: - depends_on - related_to - duplicates - branched_from - blocks type: string test_case_id: description: 'Stored as: test_case_id related_test_case_id' type: string updated_at: type: string type: object schema.TestCaseResponse: properties: code: type: string created_at: type: string created_by: type: integer description: type: string executed_by: type: integer external_id: type: string feature_or_module: type: string id: type: string is_draft: type: boolean kind: type: string notes: type: string parent_code: type: string parent_test_case_id: type: string parent_title: type: string preconditions: type: string priority: type: string project_id: type: integer result: type: string runner: type: string script_path: type: string status: type: string suggested: type: boolean tags: items: type: string type: array uniqueItems: false title: type: string updated_at: type: string type: object schema.TestCaseResponseItem: properties: assigned_tester_ids: items: type: integer type: array uniqueItems: false code: type: string id: type: string is_assigned_to_test_plan: type: boolean priority: type: string test_plan: $ref: '#/components/schemas/schema.TestPlanSummary' title: type: string urgency: type: string type: object schema.TestCaseSelection: properties: excluded_test_case_ids: description: Test cases deselected after select_all items: type: string type: array uniqueItems: false project_id: type: integer search: description: Same filter as the project test case list (matches title or code), used with select_all type: string select_all: description: Select every test case in the project matching search type: boolean test_case_ids: description: Test cases ticked individually, used when select_all is false items: type: string type: array uniqueItems: false required: - project_id type: object schema.TestPlanListResponse: properties: test_plans: items: $ref: '#/components/schemas/schema.TestPlanResponseItem' type: array uniqueItems: false type: object schema.TestPlanResponseItem: properties: assigned_testers: type: integer assigned_to_id: type: integer closed_at: type: string created_at: type: string created_by_id: type: integer description: type: string environment_id: type: integer failed_count: type: integer has_report: type: boolean id: type: integer is_complete: type: boolean is_locked: type: boolean kind: type: string num_failures: type: integer num_test_cases: type: integer passed_count: type: integer pending_count: type: integer project_id: type: integer scheduled_end_at: type: string start_at: type: string test_cases: items: $ref: '#/components/schemas/schema.TestCaseResponseItem' type: array uniqueItems: false updated_at: type: string updated_by_id: type: integer type: object schema.TestPlanSummary: properties: id: type: integer name: type: string type: object schema.TestRunListResponse: properties: test_runs: items: $ref: '#/components/schemas/schema.TestRunResponse' type: array uniqueItems: false type: object schema.TestRunRequest: properties: actual_result: description: Feedback fields (optional) - for recording results at creation time type: string assigned_to_id: type: integer code: type: string created_at: type: string environment_id: type: integer expected_result: type: string notes: type: string owner_id: type: integer project_id: type: integer result_state: $ref: '#/components/schemas/dbsqlc.TestRunState' runner: description: '"basi", "playwright", "cypress", "browseruse"' type: string script_path: description: optional; used for "playwright" and "cypress" runner types type: string test_case_id: type: string test_plan_id: type: integer tested_by_id: type: integer tested_on: type: string updated_at: type: string required: - owner_id - project_id - test_case_id - test_plan_id - tested_by_id type: object schema.TestRunResponse: properties: actual_result: type: string attachment_count: type: integer code: type: string environment_id: type: integer executed_by: type: string expected_result: type: string id: type: string is_closed: type: boolean latest_result_id: type: string notes: type: string project_id: type: integer result_state: type: string test_case_id: type: string test_case_title: type: string test_plan_id: type: integer tested_by_id: type: integer tested_on: type: string type: object schema.Tester: properties: created_at: type: string email: type: string last_login_at: type: string name: type: string project: type: string project_id: type: integer role: type: string updated_at: type: string user_id: type: integer type: object schema.TesterListResponse: properties: testers: items: $ref: '#/components/schemas/schema.Tester' type: array uniqueItems: false type: object schema.TransferTestCaseRequest: properties: feature_or_module: type: string target_project_id: type: integer required: - feature_or_module - target_project_id type: object schema.UpdateAutomatedTestingRequest: properties: automated_testing_enabled: type: boolean project_id: type: integer supported_runners: items: type: string type: array uniqueItems: false required: - project_id type: object schema.UpdateEnvironmentRequest: properties: base_url: type: string description: type: string name: type: string required: - name type: object schema.UpdateOrgRequest: properties: address: type: string country: type: string github_url: type: string id: type: integer name: type: string website_url: type: string required: - id - name type: object schema.UpdatePageRequest: type: object schema.UpdateProjectModuleRequest: properties: code: type: string description: type: string name: type: string parent_module_id: description: ParentModuleID is the module this module sits under, omit or null to make it a top-level module type: integer priority: type: integer type: type: string required: - code - name - priority - type type: object schema.UpdateProjectRequest: properties: automated_testing_enabled: type: boolean code: maxLength: 10 minLength: 3 type: string description: type: string environments: items: $ref: '#/components/schemas/schema.EnvironmentRequest' type: array uniqueItems: false github_url: type: string id: type: integer name: type: string parent_project_id: type: integer project_owner_id: type: integer supported_runners: items: type: string type: array uniqueItems: false version: type: string website_url: type: string required: - code - description - id - name - project_owner_id - version type: object schema.UpdateTestCaseRequest: properties: code: type: string description: type: string external_id: description: identifier in the source system, e.g. TestLink form: external_id type: string feature_or_module: type: string id: type: string is_draft: type: boolean kind: type: string preconditions: description: Markdown type: string priority: description: defaults to medium enum: - low - medium - high - urgent type: string project_id: type: integer runner: type: string script_path: type: string tags: items: type: string type: array uniqueItems: false title: type: string required: - feature_or_module - id - kind - project_id - title type: object schema.UpdateTestPlanCaseUrgencyRequest: properties: urgency: enum: - low - medium - high - urgent type: string required: - urgency type: object schema.UpdateTesterRoleRequest: properties: role: type: string type: object schema.UpdateUserRequest: properties: address: type: string city: type: string country_iso: type: string display_name: type: string first_name: type: string id: type: integer last_name: type: string org_id: type: integer phone: type: string required: - city - display_name - first_name - last_name - org_id type: object schema.User: properties: address: type: string city: type: string country_iso: type: string created_at: type: string display_name: type: string email: type: string first_name: type: string id: type: integer is_activated: type: boolean is_reviewed: type: boolean is_super_admin: type: boolean is_verified: type: boolean last_name: type: string org_id: type: integer phone: type: string updated_at: type: string type: object schema.UserCompact: properties: createdAt: type: string displayName: type: string email: type: string id: type: integer type: object externalDocs: description: "" url: "" info: title: "" version: "" openapi: 3.1.0 paths: /healthz: get: description: Returns the health status of the system responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.HealthStatus' description: OK summary: Health check endpoint tags: - system /metrics: get: description: Returns system metrics for monitoring responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.Metrics' description: OK summary: System metrics endpoint tags: - system /system/info: get: description: Returns general information about the system including version and build details responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.SystemInfo' description: OK summary: System information tags: - system /v1/auth/change-password: post: description: Allows autheticated user to change their password operationId: Change password requestBody: content: application/json: schema: $ref: '#/components/schemas/schema.ChangePasswordRequest' description: Password change request required: true responses: "200": content: application/json: schema: additionalProperties: type: string type: object description: Password changed successfully "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Allows autheticated user to change their password tags: - auth /v1/auth/login: post: description: Authenticates a user and returns access tokens requestBody: content: application/json: schema: $ref: '#/components/schemas/schema.LoginRequest' description: Login credentials required: true responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.LoginResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Invalid credentials or request body "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Server error summary: User login tags: - auth /v1/auth/refresh-token: post: description: Refreshes an expired access token using a valid refresh token requestBody: content: application/json: schema: $ref: '#/components/schemas/schema.RefreshTokenRequest' description: Refresh token required: true responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.RefreshTokenResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Invalid token "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Server error summary: Refresh access token tags: - auth /v1/auth/reset-password: post: description: Resets a user's password without requiring the old one. Restricted to super admins. operationId: ResetPassword requestBody: content: application/json: schema: $ref: '#/components/schemas/schema.ResetPasswordRequest' description: Password reset request required: true responses: "200": content: application/json: schema: additionalProperties: type: string type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "403": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Forbidden "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Resets a user's password tags: - auth /v1/auth/signup: post: description: Registers a new user account requestBody: content: application/json: schema: $ref: '#/components/schemas/schema.SignUpRequest' description: User registration details required: true responses: "200": content: application/json: schema: additionalProperties: {} type: object description: Returns success message and token "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: User already exists or invalid request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Server error summary: User signup tags: - auth /v1/dashboard/summary: get: description: Returns key metrics for dashboard operationId: DashboardSummary requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.DashboardSummaryResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Get dashboard summary tags: - dashboard /v1/environments/{envID}: get: description: Get details of a single environment by ID operationId: GetEnvironment parameters: - description: Environment ID in: path name: envID required: true schema: type: string requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.EnvironmentResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Get details of a single environment by ID tags: - environments /v1/me/test-cases/inbox: get: description: List Test Cases assigned to the current user operationId: ListAssignedTestCases parameters: - description: Page number (1-based) in: query name: page schema: type: integer - description: Page size in: query name: pageSize schema: type: integer - description: Include closed test cases in: query name: includeClosed schema: type: boolean requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.AssignedTestCaseListResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: List Test Cases assigned to the current user tags: - test-cases /v1/me/test-cases/inbox/{testCaseID}: get: description: Get a single Test Case assigned to the current user, regardless of which inbox page it is on operationId: GetAssignedTestCase parameters: - description: Test Case ID in: path name: testCaseID required: true schema: type: string requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.AssignedTestCase' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "404": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Not Found "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Get a single Test Case from the current user's inbox tags: - test-cases /v1/me/test-cases/inbox/{testCaseID}/navigation: get: description: Get the neighbouring open Test Cases around a Test Case, following the inbox order, with its position. Empty IDs mean there is none in that direction. operationId: GetInboxNavigation parameters: - description: Test Case ID in: path name: testCaseID required: true schema: type: string requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.InboxNavigationResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "404": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Not Found "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Get the previous and next Test Cases in the current user's inbox tags: - test-cases /v1/me/test-cases/inbox/{testCaseID}/view: post: description: Mark a Test Case in the current user's inbox as viewed operationId: MarkInboxTestCaseViewed parameters: - description: Test Case ID in: path name: testCaseID required: true schema: type: string requestBody: content: application/json: schema: type: object responses: "204": description: No Content "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Mark a Test Case in the current user's inbox as viewed tags: - test-cases /v1/me/test-cases/inbox/unseen-count: get: description: Count open Test Cases assigned to the current user that they have not viewed yet operationId: GetInboxUnseenCount requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.InboxUnseenCountResponse' description: OK "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Count unseen Test Cases in the current user's inbox tags: - test-cases /v1/me/test-cases/summary: get: description: Get execution summary for assigned test cases operationId: GetExecutionSummary requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: items: $ref: '#/components/schemas/schema.TestCaseExecutionSummary' type: array description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Get execution summary for assigned test cases tags: - test-cases /v1/modules: get: description: Get all Modules operationId: GetAllModules requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Get all Modules tags: - modules post: description: Create a Module, optionally under a parent module. The hierarchy depth is limited by the platform max_module_depth setting (default 4, at most 8) operationId: CreateModule requestBody: content: application/json: schema: $ref: '#/components/schemas/schema.CreateProjectModuleRequest' description: Module data required: true responses: "200": content: application/json: schema: type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Create a Module tags: - modules /v1/modules/{moduleID}: delete: description: Delete a Module operationId: DeleteModule parameters: - description: moduleID in: path name: moduleID required: true schema: type: string requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "404": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Not Found "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Delete a Module tags: - modules get: description: Get one Module operationId: GetOneModule parameters: - description: moduleID in: path name: moduleID required: true schema: type: string requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Get one Module tags: - modules post: description: Update a Module, including moving it under another parent module or to the top level operationId: UpdateModule parameters: - description: moduleID in: path name: moduleID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/schema.UpdateProjectModuleRequest' description: id required: true responses: "200": content: application/json: schema: type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "404": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Not Found "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Update a Module tags: - modules /v1/modules/{moduleID}/freeze: post: description: Freeze a Module. Test cases in a frozen module, or in any module below it, cannot be added to test plans or used in new test runs. Existing test plans are not changed operationId: FreezeModule parameters: - description: moduleID in: path name: moduleID required: true schema: type: string requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "404": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Not Found "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Freeze a Module tags: - modules /v1/modules/{moduleID}/unfreeze: post: description: Unfreeze a Module so that its test cases can be used in tests again operationId: UnfreezeModule parameters: - description: moduleID in: path name: moduleID required: true schema: type: string requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "404": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Not Found "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Unfreeze a Module tags: - modules /v1/orgs: get: description: List All organizations operationId: ListOrgs requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.OrgListResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: List All organizations tags: - organizations post: description: Create a new organization operationId: CreateOrg requestBody: content: application/json: schema: $ref: '#/components/schemas/schema.CreateOrgRequest' description: Organization data required: true responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.Org' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Create a new organization tags: - organizations /v1/orgs/{orgID}: delete: description: Delete organization operationId: DeleteOrg parameters: - description: Organization ID in: path name: orgID required: true schema: type: string requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: additionalProperties: type: string type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Delete organization tags: - organizations get: description: Get organization by ID operationId: GetOrg parameters: - description: Organization ID in: path name: orgID required: true schema: type: string requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.Org' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Get organization by ID tags: - organizations put: description: Update organization operationId: UpdateOrg parameters: - description: Organization ID in: path name: orgID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/schema.UpdateOrgRequest' description: Organization data required: true responses: "200": content: application/json: schema: additionalProperties: type: string type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Update organization tags: - organizations /v1/pages: get: description: Get all pages operationId: GetAllPages requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Get all pages tags: - pages post: description: Create a page operationId: CreatePage requestBody: content: application/json: schema: $ref: '#/components/schemas/schema.PageRequest' description: Page data required: true responses: "200": content: application/json: schema: type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Create a page tags: - pages /v1/pages/{pageID}: delete: description: Delete a page operationId: DeletePage parameters: - description: pageID in: path name: pageID required: true schema: type: string requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Delete a page tags: - pages get: description: Get one page operationId: GetOnePage parameters: - description: pageID in: path name: pageID required: true schema: type: string requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Get one page tags: - pages post: description: Update a page operationId: UpdatePage parameters: - description: pageID in: path name: pageID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/schema.UpdatePageRequest' description: id required: true responses: "200": content: application/json: schema: type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Update a page tags: - pages /v1/projects: get: description: List Projects available on the platform operationId: ListProject requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.ProjectListResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: List Projects available on the platform tags: - projects post: description: Create a Project operationId: CreateProject requestBody: content: application/json: schema: $ref: '#/components/schemas/schema.NewProjectRequest' description: Project Creation data required: true responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.ProjectResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Create a Project tags: - projects /v1/projects/{projectID}: delete: description: Delete a Project operationId: DeleteProject parameters: - description: Project ID in: path name: projectID required: true schema: type: string requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: additionalProperties: type: string type: object description: Success message "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Delete a Project tags: - projects get: description: Get a single Project operationId: GetOneProject parameters: - description: Project ID in: path name: projectID required: true schema: type: string requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.ProjectResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Get a single Project tags: - projects post: description: Update a Project operationId: UpdateProject parameters: - description: Project ID in: path name: projectID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/schema.UpdateProjectRequest' description: Project Update data required: true responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.ProjectResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Update a Project tags: - projects /v1/projects/{projectID}/archive: post: description: Mark a project as archived (inactive) without deleting it operationId: ArchiveProject parameters: - description: Project ID in: path name: projectID required: true schema: type: integer requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.ProjectResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Archive a Project tags: - projects /v1/projects/{projectID}/automated-testing: post: description: Enable or disable automated testing capability for a project and configure supported runners operationId: UpdateAutomatedTesting parameters: - description: Project ID in: path name: projectID required: true schema: type: integer requestBody: content: application/json: schema: $ref: '#/components/schemas/schema.UpdateAutomatedTestingRequest' description: Automated testing state required: true responses: "200": content: application/json: schema: additionalProperties: type: string type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Update project automated testing setting tags: - projects /v1/projects/{projectID}/documents: get: parameters: - description: Project ID in: path name: projectID required: true schema: type: integer requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: additionalProperties: {} type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Get all documents for a project tags: - projects post: parameters: - description: Project ID in: path name: projectID required: true schema: type: integer requestBody: content: multipart/form-data: schema: type: file description: Document File required: true responses: "200": content: application/json: schema: additionalProperties: {} type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Upload/Create a document for a project tags: - projects /v1/projects/{projectID}/documents/{documentID}: delete: parameters: - description: Document ID (UUID) in: path name: documentID required: true schema: type: string requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: additionalProperties: type: string type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "404": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Not Found "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Delete a project document tags: - projects /v1/projects/{projectID}/environments: get: description: List environments for a project operationId: ListEnvironments parameters: - description: Project ID in: path name: projectID required: true schema: type: string requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.EnvironmentListResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: List environments for a project tags: - environments post: description: Create a new environment operationId: CreateEnvironmnet parameters: - description: Project ID in: path name: projectID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/schema.EnvironmentRequest' description: Environment details required: true responses: "200": content: application/json: schema: type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Create a new environment tags: - environments /v1/projects/{projectID}/environments/{environmentID}: delete: description: Delete an environment from a project. Test plans and runs using it are detached from it. operationId: DeleteEnvironment parameters: - description: Project ID in: path name: projectID required: true schema: type: string - description: Environment ID in: path name: environmentID required: true schema: type: string requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.MessageResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "404": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Not Found "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Delete an environment tags: - environments post: description: Update the name, description and base URL of an environment in a project operationId: UpdateEnvironment parameters: - description: Project ID in: path name: projectID required: true schema: type: string - description: Environment ID in: path name: environmentID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/schema.UpdateEnvironmentRequest' description: Environment details required: true responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.EnvironmentResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "404": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Not Found "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Update an environment tags: - environments /v1/projects/{projectID}/modules: get: description: Get a Modules by project operationId: GetProjectModule parameters: - description: projectID in: path name: projectID required: true schema: type: string requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Get a Modules by project tags: - modules /v1/projects/{projectID}/reports: get: description: List Reports for a Project operationId: ListReports parameters: - description: Project ID in: path name: projectID required: true schema: type: string requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.ReportListResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: List Reports for a Project tags: - reports post: description: Generate a new report operationId: CreateReport parameters: - description: Project ID in: path name: projectID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/schema.CreateReportRequest' description: Report data required: true responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.ReportResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Generate a new report tags: - reports /v1/projects/{projectID}/reports/{reportID}: delete: operationId: DeleteReport parameters: - description: Project ID in: path name: projectID required: true schema: type: string - description: Report ID in: path name: reportID required: true schema: type: string responses: "200": content: application/json: schema: additionalProperties: type: string type: object description: OK summary: Delete a Report tags: - reports /v1/projects/{projectID}/reports/{reportID}/download: get: operationId: DownloadReport parameters: - description: Project ID in: path name: projectID required: true schema: type: string - description: Report ID in: path name: reportID required: true schema: type: string responses: "200": content: application/json: schema: type: file application/pdf: schema: format: binary type: string description: PDF file summary: Download a Report file (forces browser download) tags: - reports /v1/projects/{projectID}/reports/{reportID}/view: get: operationId: ViewReport parameters: - description: Project ID in: path name: projectID required: true schema: type: string - description: Report ID in: path name: reportID required: true schema: type: string responses: "200": content: application/json: schema: type: file application/pdf: schema: format: binary type: string description: PDF file summary: View a Report file inline in the browser tags: - reports /v1/projects/{projectID}/summary: get: description: Get summary of test cases for a project operationId: GetProjectTestCaseSummary parameters: - description: Project ID in: path name: projectID required: true schema: type: string requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.ProjectTestCaseSummaryResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Get summary of test cases for a project tags: - test-cases /v1/projects/{projectID}/test-case-template: get: description: Get the test case template for a project. This template can be used as a default structure for test cases within the project. operationId: GetProjectTestCaseTemplate parameters: - description: Project ID in: path name: projectID required: true schema: type: integer requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.ProjectTestCaseTemplateResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Get the test case template for a project tags: - projects post: description: Add or update the test case template for a project. This template can be used as a default structure for test cases within the project. operationId: AddProjectTestCaseTemplate parameters: - description: Project ID in: path name: projectID required: true schema: type: integer requestBody: content: application/json: schema: $ref: '#/components/schemas/schema.AddProjectTestCaseTemplateRequest' description: Test case template data required: true responses: "200": content: application/json: schema: additionalProperties: type: string type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Add or update the test case template for a project tags: - projects /v1/projects/{projectID}/test-cases: get: description: Get a single Project's test cases operationId: GetProjectTestCases parameters: - description: Project ID in: path name: projectID required: true schema: type: string - description: Page number (1-based) in: query name: page schema: type: integer - description: Page size in: query name: pageSize schema: type: integer - description: Sort field (created_at, updated_at, code, title, kind, is_draft) in: query name: sortBy schema: type: string - description: Sort order (asc, desc) in: query name: sortOrder schema: type: string - description: Search query (matches code, title, description, feature_or_module) in: query name: search schema: type: string - description: Filter by kind in: query name: kind schema: type: string - description: Filter by draft state in: query name: isDraft schema: type: boolean requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.TestCaseListResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Get a single Project's test cases tags: - projects /v1/projects/{projectID}/test-cases/blocked: get: description: List all test cases that are currently blocked operationId: ListBlockedTestCases parameters: - description: Project ID in: path name: projectID required: true schema: type: string requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.TestCaseListResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: List all test cases that are currently blocked tags: - test-cases /v1/projects/{projectID}/test-cases/closed: get: description: List Completed/Closed Test Cases operationId: ListClosedTestCases parameters: - description: Project ID in: path name: projectID required: true schema: type: string requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.TestCaseListResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: List Completed/Closed Test Cases tags: - test-cases /v1/projects/{projectID}/test-cases/failing: get: description: List Failing Test Cases operationId: ListFailingTestCases parameters: - description: Project ID in: path name: projectID required: true schema: type: string requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.TestCaseListResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: List Failing Test Cases tags: - test-cases /v1/projects/{projectID}/test-cases/scheduled: get: description: List all test cases scheduled for execution operationId: ListScheduledTestCases parameters: - description: Project ID in: path name: projectID required: true schema: type: string requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.TestCaseListResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: List Scheduled Test Cases tags: - test-cases /v1/projects/{projectID}/test-cases/suggested: get: description: List suggested test cases for a project operationId: ListSuggestedTestCases parameters: - description: Project ID in: path name: projectID required: true schema: type: string requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.TestCaseListResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: List suggested test cases for a project tags: - test-cases /v1/projects/{projectID}/test-plans: get: description: Get a single Project's test plans operationId: GetProjectTestPlans parameters: - description: Project ID in: path name: projectID required: true schema: type: string requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.TestPlanListResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Get a single Project's test plans tags: - projects /v1/projects/{projectID}/test-runs: get: description: Get a single Project's test runs operationId: GetProjectTestRuns parameters: - description: Project ID in: path name: projectID required: true schema: type: string requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.TestRunListResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Get a single Project's test runs tags: - projects /v1/projects/{projectID}/testers: get: description: Get all Testers for a specific Project operationId: GetProjectTesters parameters: - description: The project ID in: path name: projectID required: true schema: type: integer requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.TesterListResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Get all Testers for a specific Project tags: - projects /v1/projects/{projectID}/testers/assign: post: description: Assign multiple testers to a project operationId: AssignTesters parameters: - description: Project ID in: path name: projectID required: true schema: type: integer requestBody: content: application/json: schema: $ref: '#/components/schemas/schema.BulkAssignTesters' description: Bulk assign testers request required: true responses: "200": content: application/json: schema: additionalProperties: type: string type: object description: Success message "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Invalid request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Server error summary: Assign testers to a project tags: - projects /v1/projects/{projectID}/unarchive: post: description: Restore a previously archived project back to active state operationId: UnarchiveProject parameters: - description: Project ID in: path name: projectID required: true schema: type: integer requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.ProjectResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Unarchive a Project tags: - projects /v1/projects/import: post: description: Import Projects from some source operationId: ImportProject requestBody: content: application/json: schema: $ref: '#/components/schemas/schema.ImportProjectRequest' description: Import Specification required: true responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.ProjectListResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Import Projects from some source tags: - projects /v1/projects/query: get: description: Search for a Project operationId: SearchProjects requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.ProjectListResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Search for a Project tags: - projects /v1/settings: get: description: Retrieves all system settings responses: "200": content: application/json: schema: additionalProperties: {} type: object description: OK "401": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Unauthorized "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Server error security: - ApiKeyAuth: [] summary: Get system settings tags: - settings put: description: Updates a specific system setting requestBody: content: application/json: schema: additionalProperties: {} type: object description: Setting key and value required: true responses: "200": content: application/json: schema: additionalProperties: {} type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Invalid request "401": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Unauthorized "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Server error security: - ApiKeyAuth: [] summary: Update system setting tags: - settings /v1/test-cases: get: description: List Test Cases operationId: ListTestCases parameters: - description: Page number (1-based) in: query name: page schema: type: integer - description: Page size in: query name: pageSize schema: type: integer - description: Sort field (created_at, updated_at, code, title, kind, is_draft, priority) in: query name: sortBy schema: type: string - description: Sort order (asc, desc) in: query name: sortOrder schema: type: string - description: Search query (matches code, title, description, feature_or_module) in: query name: search schema: type: string - description: Filter by kind in: query name: kind schema: type: string - description: Filter by draft state in: query name: isDraft schema: type: boolean - description: Filter by priority (low, medium, high, urgent) in: query name: priority schema: type: string requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.TestCaseListResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: List Test Cases tags: - test-cases post: description: Create a new Test Case operationId: CreateTestCase requestBody: content: application/json: schema: type: file multipart/form-data: schema: type: file description: Script file responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.TestCaseResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Create a new Test Case tags: - test-cases /v1/test-cases/{test_case_id}/execute: post: description: Execute a test case by running its script against the configured runner operationId: ExecuteTestCase parameters: - description: Test Case ID in: path name: test_case_id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/schema.ExecuteTestCaseRequest' description: Execution request data required: true responses: "202": content: application/json: schema: $ref: '#/components/schemas/schema.TestRunResponse' description: Accepted "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "404": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Not Found "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Execute a Test Case and create a Test Run tags: - test-cases /v1/test-cases/{testCaseID}: delete: description: Delete a test case operationId: DeleteTestCase parameters: - description: Test Case ID in: path name: testCaseID required: true schema: type: string requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: additionalProperties: type: string type: object description: Success message "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Delete a test case tags: - test-cases get: description: Get a single Test Case operationId: GetOneTestCase parameters: - description: Test Case ID in: path name: testCaseID required: true schema: type: string requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.TestCaseResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Get a single Test Case tags: - test-cases post: description: Update a Test Case operationId: UpdateTestCase parameters: - description: Test Case ID in: path name: testCaseID required: true schema: type: string requestBody: content: application/json: schema: type: file multipart/form-data: schema: type: file description: Script file responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.TestCaseResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Update a Test Case tags: - test-cases /v1/test-cases/{testCaseID}/accept: post: description: Accept a suggested test case operationId: AcceptSuggestedTestCase parameters: - description: Test Case ID in: path name: testCaseID required: true schema: type: string requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: additionalProperties: type: string type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Accept a suggested test case tags: - test-cases /v1/test-cases/{testCaseID}/branch: post: description: Create a new test case by branching from an existing one. operationId: BranchTestCase parameters: - description: Parent Test Case ID in: path name: testCaseID required: true schema: type: string requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.TestCaseResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "404": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Not Found "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Branch a Test Case tags: - test-cases /v1/test-cases/{testCaseID}/mark-draft: post: description: Mark a test case as draft operationId: MarkTestCaseAsDraft parameters: - description: Test Case ID in: path name: testCaseID required: true schema: type: string requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Mark a test case as draft tags: - test-cases /v1/test-cases/{testCaseID}/reject: delete: description: Reject a suggested Test Case operationId: RejectSuggestedTestCase parameters: - description: Test Case ID in: path name: testCaseID required: true schema: type: string requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: additionalProperties: type: string type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Reject a suggested Test Case tags: - test-cases /v1/test-cases/{testCaseID}/relations: get: description: List relations where the Test Case is on either side. direction is "outgoing" when the Test Case is the subject (e.g. it depends_on other_test_case) and "incoming" otherwise operationId: ListTestCaseRelations parameters: - description: Test Case ID in: path name: testCaseID required: true schema: type: string requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.TestCaseRelationListResponse' description: OK "404": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Not Found "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: List relations of a Test Case tags: - test-cases post: description: Create a relation read as " ". Only one relation of each kind is allowed per pair of Test Cases, in either direction operationId: CreateTestCaseRelation parameters: - description: Test Case ID in: path name: testCaseID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/schema.CreateTestCaseRelationRequest' description: Relation data required: true responses: "201": content: application/json: schema: $ref: '#/components/schemas/schema.TestCaseRelationResponse' description: Created "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "404": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Not Found "409": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Conflict "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Relate a Test Case to another Test Case tags: - test-cases /v1/test-cases/{testCaseID}/relations/{relationID}: delete: description: Remove a relation the Test Case is on either side of operationId: DeleteTestCaseRelation parameters: - description: Test Case ID in: path name: testCaseID required: true schema: type: string - description: Relation ID in: path name: relationID required: true schema: type: string requestBody: content: application/json: schema: type: object responses: "204": description: No Content "404": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Not Found "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Remove a relation from a Test Case tags: - test-cases /v1/test-cases/{testCaseID}/transfer: post: description: Transfer an existing test case to a different project ID and feature/module operationId: TransferTestCase parameters: - description: Test Case ID in: path name: testCaseID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/schema.TransferTestCaseRequest' description: Transfer request data required: true responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.TestCaseResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Transfer a Test Case to another project tags: - test-cases /v1/test-cases/{testCaseID}/unmark-draft: post: description: Mark a test case as draft operationId: UnMarkTestCaseAsDraft parameters: - description: Test Case ID in: path name: testCaseID required: true schema: type: string requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Mark a test case as draft tags: - test-cases /v1/test-cases/bulk: post: description: Create multiple Test Cases at once operationId: BulkCreateTestCases requestBody: content: application/json: schema: $ref: '#/components/schemas/schema.BulkCreateTestCases' description: Bulk Create Test Case data required: true responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.TestCaseListResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Create multiple Test Cases at once tags: - test-cases /v1/test-cases/bulk-delete: post: description: Delete the test cases ticked in a project's test case list, or with select_all every test case matching the search except the excluded ones operationId: BulkDeleteTestCases requestBody: content: application/json: schema: $ref: '#/components/schemas/schema.BulkDeleteTestCasesRequest' description: Test cases to delete required: true responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.BulkDeleteTestCasesResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "409": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Conflict "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Delete the selected test cases of a project tags: - test-cases /v1/test-cases/bulk-transfer: post: description: Move the test cases ticked in a project's test case list, or with select_all every test case matching the search except the excluded ones, to another project and feature/module operationId: BulkTransferTestCases requestBody: content: application/json: schema: $ref: '#/components/schemas/schema.BulkTransferTestCasesRequest' description: Test cases to transfer and where to required: true responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.BulkTransferTestCasesResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Transfer the selected test cases of a project to another project tags: - test-cases /v1/test-cases/export-file: post: description: Export test cases to a CSV, XLSX or JSON file. Send either the testcases to export, or a selection of a project's test cases (which may select all of them) for the server to load. operationId: ExportFileFromTestCases requestBody: content: application/json: schema: $ref: '#/components/schemas/schema.ExportTestCasesRequest' description: Export request data required: true responses: "200": content: application/json: schema: type: file application/octet-stream: schema: format: binary type: string description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Export test cases to a CSV, XLSX or JSON file tags: - test-cases /v1/test-cases/import-file: post: description: Import test cases from Excel or CSV file operationId: ImportTestCasesFromFile requestBody: content: multipart/form-data: schema: type: file description: Excel or CSV file required: true responses: "200": content: application/json: schema: additionalProperties: type: string type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Import test cases from Excel or CSV file tags: - test-cases /v1/test-cases/import/github: post: description: Imports open issues from a GitHub repository as test cases for a project operationId: ImportIssuesFromGitHubAsTestCases requestBody: content: application/json: schema: $ref: '#/components/schemas/schema.ImportFromGithubRequest' description: GitHub import request required: true responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.TestCaseListResponse' description: List of imported test cases "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Invalid request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Server error summary: Import GitHub issues as test cases tags: - test-cases /v1/test-cases/query: get: description: Search for Test Cases operationId: SearchTestCases requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.TestCaseListResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Search for Test Cases tags: - test-cases /v1/test-cases/suggest: post: description: Suggest a new Test Case operationId: SuggestTestCase requestBody: content: application/json: schema: $ref: '#/components/schemas/schema.CreateSuggestedTestCaseRequest' description: Suggest Test Case data required: true responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.TestCaseResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Suggest a new Test Case tags: - test-cases /v1/test-cases/validate-script: post: description: Validate a test script by sending it to the configured runner before creation operationId: ValidateTestCaseScript requestBody: content: multipart/form-data: schema: type: string description: Runner required: true responses: "200": content: application/json: schema: additionalProperties: {} type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Validate a runner script without creating a test case tags: - test-cases /v1/test-plans: get: description: List all Test Plans operationId: ListTestPlans requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: List all Test Plans tags: - test-plans post: description: Create a new Test Plan operationId: CreateTestPlan requestBody: content: application/json: schema: $ref: '#/components/schemas/schema.CreateTestPlan' description: Create Test plan data required: true responses: "200": content: application/json: schema: type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Create a new Test Plan tags: - test-plans /v1/test-plans/{testPlanID}: delete: description: Delete a Test Plan operationId: DeleteTestPlan parameters: - description: Test Plan ID in: path name: testPlanID required: true schema: type: string requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Delete a Test Plan tags: - test-plans get: description: Get one Test Plan operationId: GetOneTestPlan parameters: - description: Test Plan ID in: path name: testPlanID required: true schema: type: string requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Get one Test Plan tags: - test-plans post: description: Update a Test Plan operationId: UpdateTestPlan parameters: - description: Test Plan ID in: path name: testPlanID required: true schema: type: string requestBody: content: application/json: schema: type: object description: Test Plan data required: true responses: "200": content: application/json: schema: type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Update a Test Plan tags: - test-plans /v1/test-plans/{testPlanID}/close: post: description: Close a Test Plan operationId: CloseTestPlan parameters: - description: Test Plan ID in: path name: testPlanID required: true schema: type: integer requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Close a Test Plan tags: - test-plans /v1/test-plans/{testPlanID}/comments: get: operationId: ListTestPlanComments parameters: - description: Test Plan ID in: path name: testPlanID required: true schema: type: integer responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.CommentListResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: List all comments for a test plan tags: - test-plans - comments post: operationId: CreateTestPlanComment parameters: - description: Test Plan ID in: path name: testPlanID required: true schema: type: integer requestBody: content: application/json: schema: $ref: '#/components/schemas/schema.CreateComment' description: Comment payload required: true responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.CommentResponseItem' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Add a new comment to a test plan tags: - test-plans - comments /v1/test-plans/{testPlanID}/comments/{commentID}: delete: operationId: DeleteTestPlanComment parameters: - description: Test Plan ID in: path name: testPlanID required: true schema: type: integer - description: Comment ID in: path name: commentID required: true schema: type: string responses: "200": content: application/json: schema: type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Delete a comment from a test plan tags: - test-plans - comments /v1/test-plans/{testPlanID}/comments/{commentID}/convert: post: operationId: ConvertCommentToTestCase parameters: - description: Test Plan ID in: path name: testPlanID required: true schema: type: integer - description: Comment ID in: path name: commentID required: true schema: type: string responses: "200": content: application/json: schema: type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Convert a comment into a test case tags: - test-plans - comments - test-cases /v1/test-plans/{testPlanID}/environment: post: description: Change environment of a Test Plan operationId: ChangeEnvironment parameters: - description: Test Plan ID in: path name: testPlanID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/schema.ChangeEnvironmentRequest' description: Environment change payload required: true responses: "200": content: application/json: schema: type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Change environment of a Test Plan tags: - test-plans /v1/test-plans/{testPlanID}/script-test-cases: get: description: Returns only test cases that have a runner and script_path set operationId: GetScriptTestPlanTestCases parameters: - description: Test Plan ID in: path name: testPlanID required: true schema: type: integer requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.TestCaseListResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: List all script-based test cases of a test plan tags: - test-cases - test-plans /v1/test-plans/{testPlanID}/test-cases: get: description: List all tests of a test plan operationId: GetTestPlanTestCases parameters: - description: Test Plan ID in: path name: testPlanID required: true schema: type: integer requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: List all tests of a test plan tags: - test-cases - test-runs post: description: Assign a test to a plan operationId: AssignTestsToPlan parameters: - description: testPlanID in: path name: testPlanID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/schema.AssignTestsToPlanRequest' description: testPlanID required: true responses: "200": content: application/json: schema: type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Assign a test to a plan tags: - test-plans /v1/test-plans/{testPlanID}/test-cases/{testCaseID}/urgency: post: description: Set the urgency (low, medium, high, urgent) of a Test Case within a Test Plan operationId: UpdateTestPlanCaseUrgency parameters: - description: Test Plan ID in: path name: testPlanID required: true schema: type: string - description: Test Case ID in: path name: testCaseID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/schema.UpdateTestPlanCaseUrgencyRequest' description: Urgency payload required: true responses: "200": content: application/json: schema: type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "404": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Not Found "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Set the urgency of a Test Case within a Test Plan tags: - test-plans /v1/test-plans/{testPlanID}/test-runs: get: description: List all test runs of a test plan operationId: GetTestPlanTestRuns parameters: - description: Test Plan ID in: path name: testPlanID required: true schema: type: string requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.TestRunListResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: List all test runs of a test plan tags: - test-plans - test-runs /v1/test-plans/query: get: description: Search test plans operationId: SearchTestPlans parameters: - description: query in: path name: query required: true schema: type: string requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Search test plans tags: - test-plans /v1/test-runs: get: description: List Test Runs operationId: ListTestRuns requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: List Test Runs tags: - test-runs post: description: 'Create a new Test Run. Optional: provide feedback (actual_result, result_state) to record results immediately (GitHub Actions-like workflow)' operationId: CreateTestRun requestBody: content: application/json: schema: $ref: '#/components/schemas/schema.TestRunRequest' description: Test Run data (feedback fields optional) required: true responses: "200": content: application/json: schema: type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Create a new Test Run tags: - test-runs /v1/test-runs/{resultID}/attachments: get: description: List all file attachments linked to a Test Run Result operationId: ListAttachments parameters: - description: Test Run Result ID in: path name: resultID required: true schema: type: string requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: items: $ref: '#/components/schemas/schema.AttachmentResponse' type: array description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: List attachments for a Test Run Result tags: - test-runs post: description: Upload a file attachment linked to a Test Run Result operationId: UploadAttachment parameters: - description: Test Run Result ID in: path name: resultID required: true schema: type: string requestBody: content: multipart/form-data: schema: type: file description: Attachment files(multiple allowed) required: true responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.AttachmentResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Upload an attachment for a Test Run Result tags: - test-runs /v1/test-runs/{testRunID}: delete: description: Delete a Test Run operationId: DeleteTestRun parameters: - description: Test Run ID in: path name: testRunID required: true schema: type: string requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Delete a Test Run tags: - test-runs get: description: Get one Test Run operationId: GetOneTestRun parameters: - description: Test Run ID in: path name: testRunID required: true schema: type: string requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Get one Test Run tags: - test-runs post: description: Update a Test Run operationId: UpdateTestRun parameters: - description: Test Run ID in: path name: testRunID required: true schema: type: string requestBody: content: application/json: schema: type: object description: Test Run update data required: true responses: "200": content: application/json: schema: type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Update a Test Run tags: - test-runs /v1/test-runs/{testRunID}/close: post: description: Close a Test Run operationId: CloseTestRun parameters: - description: Test Run ID in: path name: testRunID required: true schema: type: string requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.TestRunResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Close a Test Run tags: - test-runs /v1/test-runs/{testRunID}/commit: post: description: Mark a Test Run as committed operationId: CommitTestRun parameters: - description: Test Run ID in: path name: testRunID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/schema.CommitTestRunResult' description: Test Run update data required: true responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.CommitTestRunResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Mark a Test Run as committed tags: - test-runs /v1/test-runs/{testRunID}/execute: post: description: Execute a Test Run operationId: ExecuteTestRun parameters: - description: Test Run ID in: path name: testRunID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/schema.ExecuteTestRunRequest' description: Execution data required: true responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.TestRunResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Execute a Test Run tags: - test-runs /v1/test-runs/{testRunID}/feedback: post: description: Record test execution feedback with outcome (passed/failed). This transitions the test run from pending to completed status based on the provided feedback. operationId: RecordTestRunFeedback parameters: - description: Test Run ID in: path name: testRunID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/schema.CommitTestRunResult' description: Feedback data (actual_result, result_state, notes, etc.) required: true responses: "200": content: application/json: schema: type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Record feedback/results for a Test Run (GitHub Actions-like workflow) tags: - test-runs /v1/test-runs/query: get: description: Search for Test Runs operationId: SearchTestRuns requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Search for Test Runs tags: - test-runs /v1/testers: get: description: List all Testers operationId: ListTesters requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.TesterListResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: List all Testers tags: - testers /v1/testers.query: get: description: Search all Testers operationId: SearchTesters requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Search all Testers tags: - testers /v1/testers/{testerID}: delete: description: Delete a Tester by ID operationId: DeleteTester parameters: - description: Tester ID in: path name: testerID required: true schema: type: string requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Delete a Tester by ID tags: - testers get: description: Get a Tester by ID operationId: GetOneTester parameters: - description: Tester ID in: path name: testerID required: true schema: type: string requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Get a Tester by ID tags: - testers /v1/testers/{testerID}/update-role: post: description: Updte a tester's role in a project operationId: UpdateTesterRole parameters: - description: Tester User ID in: path name: testerID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/schema.UpdateTesterRoleRequest' description: New role required: true responses: "200": content: application/json: schema: type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Updte a tester's role in a project tags: - testers /v1/testers/invite/{email}: post: description: Invite a tester by Email operationId: InviteTester parameters: - description: Email of tester in: path name: email required: true schema: type: string requestBody: content: application/json: schema: type: object description: Invite data required: true responses: "200": content: application/json: schema: type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Invite a tester by Email tags: - testers /v1/users: get: description: List all Users operationId: ListUsers requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.CompactUserListResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: List all Users tags: - users post: description: Create a new User operationId: CreateUser requestBody: content: application/json: schema: $ref: '#/components/schemas/schema.NewUserRequest' description: User data required: true responses: "200": content: application/json: schema: type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Create a new User tags: - users /v1/users/{userID}: delete: description: Deactivate (soft delete) a user. The user can no longer log in and is hidden from user lists. operationId: DeleteUser parameters: - description: User ID in: path name: userID required: true schema: type: string requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "403": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Forbidden "404": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Not Found "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Deactivate a user tags: - users get: description: Get one User operationId: GetOneUser parameters: - description: User ID in: path name: userID required: true schema: type: string requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: $ref: '#/components/schemas/schema.User' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Get one User tags: - users post: description: Update a User operationId: UpdateUser parameters: - description: User ID in: path name: userID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/schema.UpdateUserRequest' description: User ID required: true responses: "200": content: application/json: schema: type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Update a User tags: - users /v1/users/invite/{email}: post: description: Invite a User by email operationId: InviteUser parameters: - description: User's email in: path name: email required: true schema: type: string requestBody: content: application/json: schema: type: object description: User invite data required: true responses: "200": content: application/json: schema: type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Invite a User by email tags: - users /v1/users/query: get: description: Search all Users operationId: SearchUsers requestBody: content: application/json: schema: type: object responses: "200": content: application/json: schema: type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Bad Request "500": content: application/json: schema: $ref: '#/components/schemas/problemdetail.ProblemDetail' description: Internal Server Error summary: Search all Users tags: - users