diff --git a/api.json b/api.json new file mode 100644 index 0000000..ac13ae9 --- /dev/null +++ b/api.json @@ -0,0 +1 @@ +{"openapi":"3.1.0","paths":{"/defects":{"get":{"parameters":[{"name":"integrationId","in":"query","schema":{"type":"integer","format":"int64"}},{"name":"queryValue","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DefectResource"}}}}}},"summary":"List Defects","tags":["Defect Controller"]},"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefectCreationResource"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefectResource"}}}},"400":{"description":"Bad Request"}},"summary":"Create Defect","tags":["Defect Controller"]}},"/defects/link":{"delete":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefectLinkResource"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefectResource"}}}}},"summary":"Unlink Defect","tags":["Defect Controller"]},"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefectLinkResource"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefectResource"}}}},"400":{"description":"Bad Request"}},"summary":"Link Defect","tags":["Defect Controller"]}},"/releases":{"get":{"parameters":[{"name":"almBoardId","in":"query","schema":{"type":"integer","format":"int64"}},{"name":"almIntegrationId","in":"query","schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","schema":{"$ref":"#/components/schemas/Date"}},{"name":"getAll","in":"query","schema":{"type":"boolean"}},{"name":"startTime","in":"query","schema":{"$ref":"#/components/schemas/Date"}},{"name":"X-PROJECT-ID","in":"header","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ReleaseResource"}}}}}},"summary":"List Releases","tags":["Release Resource Controller"]}},"/releases/{id}":{"get":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"almBoardId","in":"query","schema":{"type":"integer","format":"int64"}},{"name":"X-PROJECT-ID","in":"header","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReleaseResource"}}}}},"summary":"Get Release Detail","tags":["Release Resource Controller"]}},"/repo-connections":{"get":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RepoConnectionResource"}}}}}},"summary":"List reposiroty connections","tags":["Repo Connection Resource Controller"]},"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateConnectionPayload"}}},"required":true},"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request"}},"summary":"Create Reposiroty Connection","tags":["Repo Connection Resource Controller"]}},"/repo-connections/{id}":{"put":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"reconnect","in":"query","schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateConnectionPayload"}}},"required":true},"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request"}},"summary":"Update Repository Connection","tags":["Repo Connection Resource Controller"]},"get":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RepoConnectionResource"}}}}},"summary":"Get Connection","tags":["Repo Connection Resource Controller"]}},"/repo-connections/{id}/disconnect":{"post":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}},"summary":"Disconnect Repsository Connection","tags":["Repo Connection Resource Controller"]}},"/repo-connections/{id}/reconnect":{"post":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}},"summary":"Reconnect Repository Connection","tags":["Repo Connection Resource Controller"]}},"/repositories":{"get":{"parameters":[{"name":"projectId","in":"query","schema":{"type":"integer","format":"int64"}},{"name":"types","in":"query","schema":{"type":"array","items":{"$ref":"#/components/schemas/TestProjectType"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TestProjectResource"}}}}}},"summary":"List Repositories","tags":["Test Project Controller"]}},"/repositories/search":{"get":{"parameters":[{"name":"types","in":"query","schema":{"type":"array","items":{"$ref":"#/components/schemas/TestProjectType"}}},{"name":"X-PROJECT-ID","in":"header","schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchRequestPagination"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageTestProjectResource"}}}}},"summary":"Search Repositories","tags":["Test Project Controller"]}},"/repositories/{id}":{"get":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"includeFields","in":"query","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestProjectResource"}}}}},"summary":"Get Repository Detail","tags":["Test Project Controller"]}},"/requirements":{"get":{"parameters":[{"name":"assignees","in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"keyOrSummary","in":"query","schema":{"type":"string"}},{"name":"releaseId","in":"query","schema":{"type":"integer","format":"int64"}},{"name":"sprintId","in":"query","schema":{"type":"integer","format":"int64"}},{"name":"testCaseId","in":"query","schema":{"type":"integer","format":"int64"}},{"name":"X-PROJECT-ID","in":"header","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RequirementResource"}}}}}},"summary":"List Requirements","tags":["Requirement Resource Controller"]}},"/requirements/{id}":{"patch":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"X-PROJECT-ID","in":"header","schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequirementResource"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequirementResource"}}}}},"summary":"Update Requirement","tags":["Requirement Resource Controller"]},"get":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"X-PROJECT-ID","in":"header","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequirementResource"}}}}},"summary":"Get Requirement Detail","tags":["Requirement Resource Controller"]}},"/requirements/{id}/link-test-cases":{"post":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkTestCaseResource"}}},"required":true},"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request"}},"summary":"Link Test Cases to a Requirement","tags":["Requirement Resource Controller"]}},"/requirements/{id}/unlink-test-cases":{"delete":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkTestCaseResource"}}},"required":true},"responses":{"200":{"description":"OK"}},"summary":"Unlink Test Cases from a Requirement","tags":["Requirement Resource Controller"]}},"/sprints":{"get":{"parameters":[{"name":"almBoardId","in":"query","schema":{"type":"integer","format":"int64"}},{"name":"almIntegrationId","in":"query","schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","schema":{"$ref":"#/components/schemas/Date"}},{"name":"getAll","in":"query","schema":{"type":"boolean"}},{"name":"startTime","in":"query","schema":{"$ref":"#/components/schemas/Date"}},{"name":"X-PROJECT-ID","in":"header","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SprintResource"}}}}}},"summary":"List Sprints","tags":["Sprint Resource Controller"]}},"/sprints/search":{"get":{"parameters":[{"name":"name","in":"query","schema":{"type":"string"}},{"name":"X-PROJECT-ID","in":"header","schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchRequestPagination"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageSprintResource"}}}}},"summary":"Search Sprints","tags":["Sprint Resource Controller"]}},"/sprints/{id}":{"get":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"almBoardId","in":"query","schema":{"type":"integer","format":"int64"}},{"name":"X-PROJECT-ID","in":"header","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SprintResource"}}}}},"summary":"Get","tags":["Sprint Resource Controller"]}},"/test-cases/{id}":{"get":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"action","in":"query","schema":{"type":"string"}},{"name":"contentTypes","in":"query","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestCaseResource"}}}}},"summary":"Get Test Case","tags":["Test Case Resource Controller"]}},"/test-cases/{id}/link-requirements":{"post":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"requirementIds","in":"query","schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"X-PROJECT-ID","in":"header","schema":{"type":"integer","format":"int64"}}],"responses":{"201":{"description":"Created"}},"summary":"Link Requirements","tags":["Test Case Resource Controller"]}},"/test-cases/{id}/linked-ado-test-cases":{"get":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ADOTestCase"}}}}}},"summary":"Get Linked ADO Test Cases","tags":["Test Case Resource Controller"]}},"/test-cases/{id}/linked-test-cases":{"get":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TestCaseResource"}}}}}},"summary":"Get Linked Test Cases","tags":["Test Case Resource Controller"]}},"/test-cases/{id}/unlink-requirements":{"post":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"requirementIds","in":"query","schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"X-PROJECT-ID","in":"header","schema":{"type":"integer","format":"int64"}}],"responses":{"201":{"description":"Created"}},"summary":"Unlink Requirements from Test Case","tags":["Test Case Resource Controller"]}},"/test-suites/{id}":{"get":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestSuiteResource"}}}}},"summary":"Get Test Suite Detail","tags":["Test Suite Resource Controller"]}}},"components":{"schemas":{"ADOConfigurationResource":{"type":"object","required":["planId","almIntegrationId"],"properties":{"planId":{"type":"integer","format":"int64"},"almIntegrationId":{"type":"integer","format":"int64"},"pushMechanism":{"$ref":"#/components/schemas/PushMechanism"},"attachments":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/AttachmentSupportType"}}}},"ADOTestCase":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"testCaseId":{"type":"integer","format":"int64"},"summary":{"type":"string"},"externalIssueId":{"type":"integer","format":"int64"}}},"Action":{"type":"string","enum":["CREATE","RENAME","MOVE","DUPLICATE","DELETE","UPDATE_TEST_TYPE","UPDATE_STATUS","UPDATE_DESCRIPTION","UPDATE_PRECONDITION","UPDATE_PRIORITY","UPDATE_AUTOMATION_STATUS","UPDATE","ADD_TEST_CASES"]},"AttachmentSupportType":{"type":"string","enum":["PNG","AVI","MOV","MP4","DOC","DOCX","XLS","XLSX","CSV","TXT","PDF","LOG","HTML","HTM","XML"]},"AutomationStatus":{"type":"string","enum":["TO_BE_ASSESSED","AUTOMATION_CANDIDATE","AUTOMATION_IN_PROGRESS","AUTOMATION_COMPLETE","MANUAL_ONLY"]},"ConnectionStatus":{"type":"string","enum":["ACTIVE","ERROR","INACTIVE"]},"CreateConnectionPayload":{"type":"object","required":["name","organizationUrl"],"properties":{"name":{"type":"string","pattern":"\\S"},"description":{"type":"string"},"organizationUrl":{"type":"string","pattern":"\\S"},"username":{"type":"string"},"password":{"type":"string"},"vcsType":{"type":"string"},"linkTestExecution":{"type":"boolean"}}},"CreateProjectIntegrationPayload":{"type":"object","required":["repository","branch","name"],"properties":{"repository":{"type":"string","pattern":"\\S"},"branch":{"type":"string","pattern":"\\S"},"name":{"type":"string","pattern":"\\S"},"projectId":{"type":"integer","format":"int64"},"description":{"type":"string"},"type":{"type":"string"},"targetDirectory":{"type":"string"},"linkTestExecution":{"type":"boolean"},"proceed":{"type":"boolean"}}},"Date":{"type":"string","format":"date","examples":["2022-03-10"]},"DefectCreationResource":{"type":"object","properties":{"testResultId":{"type":"integer","format":"int64"},"integrationId":{"type":"integer","format":"int64"},"fields":{"type":"object","additionalProperties":{}}}},"DefectLinkResource":{"type":"object","properties":{"testResultId":{"type":"integer","format":"int64"},"externalIssueId":{"type":"integer","format":"int64"},"issueId":{"type":"string"},"integrationId":{"type":"integer","format":"int64"}}},"DefectResource":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"issueId":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string"},"status":{"type":"string"},"issueTypeName":{"type":"string"},"url":{"type":"string"},"priority":{"type":"string"},"integrationId":{"type":"integer","format":"int64"},"externalProjectId":{"type":"integer","format":"int64"},"severity":{"type":"string"}}},"ErrorResponse":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"data":{}}},"ExecutionTestSuiteResource":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"startTime":{"$ref":"#/components/schemas/Date"},"duration":{"type":"integer","format":"int64"}}},"ExternalPlanResource":{"type":"object","properties":{"sourceId":{"type":"string"},"name":{"type":"string"},"startDate":{"$ref":"#/components/schemas/Date"},"endDate":{"$ref":"#/components/schemas/Date"}}},"FieldMapping":{"type":"object","properties":{"field":{"type":"string"},"mappedField":{"type":"string"}}},"FileAction":{"type":"string","enum":["CREATE","MOVE","COPY","DELETE","REGENERATE_UUID","BULK_REGENERATE_UUID","BULK_REPLACE","REMOVE_CONTENT","REPLACE_CONTENT","ADD_CONTENT"]},"FileResource":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"uploadFileId":{"type":"integer","format":"int64"},"self":{"type":"string"},"name":{"type":"string"},"path":{"type":"string"},"url":{"type":"string"},"hash":{"type":"string"},"size":{"type":"integer","format":"int64"},"uploadUrl":{"type":"string"},"signedUrl":{"type":"string"},"thumbnailUrl":{"type":"string"}}},"FileResource1":{"type":"object","properties":{"name":{"type":"string"},"path":{"type":"string"},"fullPath":{"type":"string"},"newFullPath":{"type":"string"},"content":{"type":"string"},"newContent":{"type":"string"},"removedContent":{"type":"array","items":{"type":"string"}},"additionalContentObject":{},"isDeleted":{"type":"boolean"},"action":{"$ref":"#/components/schemas/FileAction"},"isFolder":{"type":"boolean"},"parentPath":{"type":"string"},"deleted":{"type":"boolean"},"folder":{"type":"boolean"}}},"FileResource2":{"type":"object","properties":{"downloadUrl":{"type":"string"},"uploadUrl":{"type":"string"}}},"FileSettings":{"type":"object","properties":{"encoding":{"type":"string"},"delimiter":{"type":"string","format":"char"}}},"Framework":{"type":"string","enum":["KATALON_STUDIO","CLOUD_STUDIO"]},"GitRepositoryResource":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"repository":{"type":"string"},"branch":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"}}},"GitTestProjectVCSType":{"type":"string","enum":["GITHUB","GITLAB","GITLAB_DC","BITBUCKET","OTHERS","AZURE","AWS"]},"ImportResource":{"type":"object","properties":{"filePath":{"type":"string"},"testCasePath":{"type":"string"},"testProjectId":{"type":"integer","format":"int64"},"mappingStrategy":{"$ref":"#/components/schemas/MappingStrategy"},"fileSettings":{"$ref":"#/components/schemas/FileSettings"},"dryRun":{"type":"boolean"},"ignoreInvalidStatus":{"type":"boolean"},"ignoreDuplicate":{"type":"boolean"},"ignoreSpecialCharacters":{"type":"boolean"},"ignoreInvalidPriority":{"type":"boolean"},"ignoreInvalidAutomationStatus":{"type":"boolean"},"ignoreInvalidPath":{"type":"boolean"},"ignoreSpecialCharactersInPath":{"type":"boolean"},"testCaseMapping":{"$ref":"#/components/schemas/MappingStrategy"}}},"IntegrationStatus":{"type":"string","enum":["INACTIVE","IN_PROGRESS","ACTIVE","ERROR","ARCHIVED"]},"KatalonCloudRepositoryResource":{"type":"object","properties":{"region":{"type":"string"},"bucketName":{"type":"string"},"path":{"type":"string"},"accessKeyId":{"type":"string"},"secretAccessKey":{"type":"string"},"sessionToken":{"type":"string"}}},"LinkTestCaseResource":{"type":"object","properties":{"testCaseIds":{"type":"array","items":{"type":"integer","format":"int64"}}}},"MappingStrategy":{"type":"object","properties":{"fieldMappings":{"type":"array","items":{"$ref":"#/components/schemas/FieldMapping"}},"valueMappings":{"type":"array","items":{"$ref":"#/components/schemas/ValueMapping"}}}},"Origin":{"type":"string","enum":["TRUETEST","JIRA"]},"PageSprintResource":{"type":"object","properties":{"pageable":{"$ref":"#/components/schemas/Pageable"},"totalElements":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int32"},"content":{"type":"array","items":{"$ref":"#/components/schemas/SprintResource"}}}},"PageTestProjectResource":{"type":"object","properties":{"pageable":{"$ref":"#/components/schemas/Pageable"},"totalElements":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int32"},"content":{"type":"array","items":{"$ref":"#/components/schemas/TestProjectResource"}}}},"Pageable":{"type":"object","properties":{"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"sorts":{"type":"string"}}},"Priority":{"type":"string","enum":["LOW","MEDIUM","HIGH","CRITICAL"]},"ProjectRepoIntegrationResource":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"connection":{"$ref":"#/components/schemas/RepoConnectionResource"},"testProjectId":{"type":"integer","format":"int64"},"repository":{"type":"string"},"accountUuid":{"$ref":"#/components/schemas/UUID"},"branch":{"type":"string"},"createdAt":{"$ref":"#/components/schemas/Date"},"updatedAt":{"$ref":"#/components/schemas/Date"},"name":{"type":"string"},"projectId":{"type":"integer","format":"int64"},"uploadFileId":{"type":"integer","format":"int64"},"description":{"type":"string"},"type":{"$ref":"#/components/schemas/TestProjectType"},"targetDirectory":{"type":"string"},"archived":{"type":"boolean"},"status":{"$ref":"#/components/schemas/IntegrationStatus"}}},"PublishStrategy":{"type":"string","enum":["NORMAL","FORCE_PUSH","SPLIT_BRANCH"]},"PublishTestEntityResource":{"type":"object","properties":{"action":{"$ref":"#/components/schemas/Action"},"resource":{"$ref":"#/components/schemas/TestEntityType"},"data":{"$ref":"#/components/schemas/TestEntityData"}}},"PublishTestProjectResource":{"type":"object","properties":{"testProjectId":{"type":"integer","format":"int64"},"testEntities":{"type":"array","items":{"$ref":"#/components/schemas/PublishTestEntityResource"}},"taskResource":{"$ref":"#/components/schemas/TaskResource"},"message":{"type":"string"}}},"PushMechanism":{"type":"string","enum":["ALL","FAILED"]},"ReleaseResource":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"status":{"$ref":"#/components/schemas/ReleaseStatus"},"releasedDate":{"$ref":"#/components/schemas/Date"},"sourceUrl":{"type":"string"}}},"ReleaseStatus":{"type":"string","enum":["RELEASED","UNRELEASED"]},"RepoConnectionResource":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"description":{"type":"string"},"organizationUrl":{"type":"string"},"accountUuid":{"$ref":"#/components/schemas/UUID"},"username":{"type":"string"},"createdAt":{"$ref":"#/components/schemas/Date"},"updatedAt":{"$ref":"#/components/schemas/Date"},"passwordEncrypt":{"type":"string"},"vcsType":{"$ref":"#/components/schemas/GitTestProjectVCSType"},"accessKeyId":{"type":"string"},"secretAccessKey":{"type":"string"},"metadata":{},"status":{"$ref":"#/components/schemas/ConnectionStatus"},"linkTestExecution":{"type":"boolean"},"archived":{"type":"boolean"}}},"RequirementResource":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"summary":{"type":"string"},"description":{"type":"string"},"status":{"$ref":"#/components/schemas/RequirementStatus"},"assignee":{"$ref":"#/components/schemas/UserResource"},"linkedTestCaseCount":{"type":"integer","format":"int64"},"sourceId":{"type":"string"},"sourceType":{"$ref":"#/components/schemas/SourceType"},"jiraIssueType":{"type":"string"},"sprints":{"type":"array","items":{"$ref":"#/components/schemas/SprintResource"}},"externalIssueId":{"type":"integer","format":"int64"},"externalIssueUrl":{"type":"string"},"releases":{"type":"array","items":{"$ref":"#/components/schemas/ReleaseResource"}}}},"RequirementStatus":{"type":"string","enum":["TODO","IN_PROGRESS","RESOLVED","CANCEL"]},"SearchRequestPagination":{"type":"object","properties":{"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"sorts":{"type":"string"}}},"Source":{"type":"string","enum":["USER","SYSTEM"]},"SourceSystem":{"type":"string","enum":["ATG"]},"SourceType":{"type":"string","enum":["JIRA","ADO"]},"SprintResource":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"state":{"$ref":"#/components/schemas/SprintState"},"startDate":{"$ref":"#/components/schemas/Date"},"endDate":{"$ref":"#/components/schemas/Date"},"sourceUrl":{"type":"string"}}},"SprintState":{"type":"string","enum":["ACTIVE","CLOSED","FUTURE"]},"TaskFailedOutput":{"type":"object","properties":{"reason":{"type":"array","items":{"type":"string"}},"failedItemData":{},"errors":{"type":"array","items":{"type":"string"}}}},"TaskOutput":{"type":"object","properties":{"totalItemsNumber":{"type":"integer","format":"int32"},"finishedItemsNumber":{"type":"integer","format":"int32"},"firstItem":{"$ref":"#/components/schemas/TestCase"},"failedItems":{"type":"array","items":{"$ref":"#/components/schemas/TaskFailedOutput"}}}},"TaskResource":{"type":"object","properties":{"uuid":{"$ref":"#/components/schemas/UUID"},"error":{"type":"string"},"status":{"$ref":"#/components/schemas/TaskStatus"},"output":{"$ref":"#/components/schemas/TaskOutput"},"input":{"type":"string"},"response":{"$ref":"#/components/schemas/ErrorResponse"}}},"TaskStatus":{"type":"string","enum":["TRACKED","IN_PROGRESS","SUCCEED","FAILED","CANCELED"]},"TestCase":{"type":"object","properties":{"name":{"type":"string"},"path":{"type":"string"},"description":{"type":"string"},"preCondition":{"type":"string"},"status":{"$ref":"#/components/schemas/TestCaseStatus"},"priority":{"$ref":"#/components/schemas/Priority"},"automationStatus":{"$ref":"#/components/schemas/AutomationStatus"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/TestStep"}}}},"TestCaseResource":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"path":{"type":"string"},"description":{"type":"string"},"preCondition":{"type":"string"},"hasScript":{"type":"boolean"},"hasFlow":{"type":"boolean"},"testType":{"$ref":"#/components/schemas/TestType"},"script":{"$ref":"#/components/schemas/FileResource2"},"flow":{"$ref":"#/components/schemas/FileResource2"},"status":{"$ref":"#/components/schemas/TestCaseStatus"},"testProject":{"$ref":"#/components/schemas/TestProjectResource"},"testFolder":{"$ref":"#/components/schemas/TestFolderResource"},"postUpdateUrl":{"type":"string"},"author":{"$ref":"#/components/schemas/UserResource"},"priority":{"$ref":"#/components/schemas/Priority"},"automationStatus":{"$ref":"#/components/schemas/AutomationStatus"}}},"TestCaseStatus":{"type":"string","enum":["DRAFT","READY_TO_REVIEW","IN_REVIEW","PUBLISHED","INACTIVE"]},"TestEntityData":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"path":{"type":"string"},"description":{"type":"string"},"preCondition":{"type":"string"},"content":{"type":"string"},"testType":{"$ref":"#/components/schemas/TestType"},"status":{"$ref":"#/components/schemas/TestCaseStatus"},"linkedTestCaseId":{"type":"integer","format":"int64"},"linkedRequirementIds":{"type":"array","items":{"type":"integer","format":"int64"}},"origin":{"$ref":"#/components/schemas/Origin"},"testFolderId":{"type":"integer","format":"int64"},"testSuiteTestType":{"$ref":"#/components/schemas/TestType1"},"testCaseIds":{"type":"array","items":{"type":"integer","format":"int64"}},"steps":{"type":"array","items":{"$ref":"#/components/schemas/TestStep"}},"source":{"$ref":"#/components/schemas/Source"},"priority":{"$ref":"#/components/schemas/Priority"},"automationStatus":{"$ref":"#/components/schemas/AutomationStatus"}}},"TestEntityType":{"type":"string","enum":["TEST_CASE","TEST_SUITE","TEST_FOLDER"]},"TestFolderResource":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"rawPath":{"type":"string"},"treePath":{"type":"string"},"parentId":{"type":"integer","format":"int64"}}},"TestProjectResource":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"gitRepository":{"$ref":"#/components/schemas/GitRepositoryResource"},"katalonCloudRepository":{"$ref":"#/components/schemas/KatalonCloudRepositoryResource"},"zipRepository":{"$ref":"#/components/schemas/ZipRepositoryResource"},"type":{"$ref":"#/components/schemas/TestProjectType"},"frameworks":{"type":"array","items":{"$ref":"#/components/schemas/Framework"}},"targetDirectory":{"type":"string"},"dirty":{"type":"boolean"},"patNavigationPath":{"type":"string"},"testFolders":{"type":"array","items":{"$ref":"#/components/schemas/TestFolderResource"}}}},"TestProjectType":{"type":"string","enum":["KS","GIT","CLOUD"]},"TestStep":{"type":"object","properties":{"description":{"type":"string"},"expectedResult":{"type":"string"},"testData":{"type":"string"}}},"TestSuiteResource":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"path":{"type":"string"},"testFolder":{"$ref":"#/components/schemas/TestFolderResource"},"testProject":{"$ref":"#/components/schemas/TestProjectResource"},"testType":{"$ref":"#/components/schemas/TestType1"},"lastExecutionTestSuite":{"$ref":"#/components/schemas/ExecutionTestSuiteResource"},"author":{"$ref":"#/components/schemas/UserResource"},"type":{"$ref":"#/components/schemas/TestSuiteType"},"source":{"$ref":"#/components/schemas/Source"}}},"TestSuiteType":{"type":"string","enum":["KATALON_STUDIO","TESTOPS","CLOUD_STUDIO"]},"TestType":{"type":"string","enum":["AUTOMATED","G5_TEST_CASE","MANUAL"]},"TestType1":{"type":"string","enum":["AUTOMATED","MANUAL"]},"UUID":{"type":"string","format":"uuid","pattern":"[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}"},"UpdateConnectionPayload":{"type":"object","required":["name"],"properties":{"name":{"type":"string","pattern":"\\S"},"description":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"},"linkTestExecution":{"type":"boolean"}}},"UpdateProjectIntegrationPayload":{"type":"object","required":["repository","branch","name"],"properties":{"repository":{"type":"string","pattern":"\\S"},"branch":{"type":"string","pattern":"\\S"},"name":{"type":"string","pattern":"\\S"},"targetDirectory":{"type":"string"},"description":{"type":"string"},"linkTestExecution":{"type":"boolean"},"proceed":{"type":"boolean"}}},"UploadFileResource":{"type":"object","properties":{"message":{"type":"string"},"files":{"type":"array","items":{"$ref":"#/components/schemas/FileResource1"}}}},"UserGitCredentialResource":{"type":"object","properties":{"username":{"type":"string"},"accessToken":{"type":"string"},"type":{"$ref":"#/components/schemas/GitTestProjectVCSType"}}},"UserResource":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"email":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"password":{"type":"string"},"avatar":{"type":"string"},"uuid":{"$ref":"#/components/schemas/UUID"},"fullName":{"type":"string"}}},"ValidateGitPathPayload":{"type":"object","required":["repository","branch"],"properties":{"repository":{"type":"string","pattern":"\\S"},"branch":{"type":"string","pattern":"\\S"},"targetDirectory":{"type":"string"}}},"ValueMapping":{"type":"object","properties":{"field":{"type":"string"},"values":{"type":"array","items":{"$ref":"#/components/schemas/Values"}},"defaultValue":{"type":"string"}}},"Values":{"type":"object","properties":{"value":{"type":"string"},"mappedValue":{"type":"array","items":{"type":"string"}}}},"ZipRepositoryResource":{"type":"object","properties":{"downloadUrl":{"type":"string"},"uplaodUrl":{"type":"string"}}}},"securitySchemes":{"SecurityScheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Authentication"}}},"info":{"title":"organizing-be API","version":"1.0.0-SNAPSHOT"}} diff --git a/open-api.json b/open-api.json new file mode 100644 index 0000000..a1346d2 --- /dev/null +++ b/open-api.json @@ -0,0 +1,2911 @@ +{ + "openapi": "3.1.0", + "paths": { + "/defects": { + "get": { + "parameters": [ + { + "name": "integrationId", + "in": "query", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "queryValue", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DefectResource" + } + } + } + } + } + }, + "summary": "Get Defects", + "tags": [ + "Defect Controller" + ] + }, + "post": { + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DefectCreationResource" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DefectResource" + } + } + } + }, + "400": { + "description": "Bad Request" + } + }, + "summary": "Create Defect", + "tags": [ + "Defect Controller" + ] + } + }, + "/defects/link": { + "delete": { + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DefectLinkResource" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DefectResource" + } + } + } + } + }, + "summary": "Unlink Defect", + "tags": [ + "Defect Controller" + ] + }, + "post": { + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DefectLinkResource" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DefectResource" + } + } + } + }, + "400": { + "description": "Bad Request" + } + }, + "summary": "Link Defect", + "tags": [ + "Defect Controller" + ] + } + }, + "/refresh": { + "post": { + "parameters": [ + { + "name": "almIntegrationId", + "in": "query", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "X-PROJECT-ID", + "in": "header", + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "summary": "Sync Data", + "tags": [ + "Alm Controller" + ] + } + }, + "/releases": { + "get": { + "parameters": [ + { + "name": "almBoardId", + "in": "query", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "almIntegrationId", + "in": "query", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "endTime", + "in": "query", + "schema": { + "$ref": "#/components/schemas/Date" + } + }, + { + "name": "getAll", + "in": "query", + "schema": { + "type": "boolean" + } + }, + { + "name": "startTime", + "in": "query", + "schema": { + "$ref": "#/components/schemas/Date" + } + }, + { + "name": "X-PROJECT-ID", + "in": "header", + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ReleaseResource" + } + } + } + } + } + }, + "summary": "List", + "tags": [ + "Release Resource Controller" + ] + } + }, + "/releases/{id}": { + "get": { + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "almBoardId", + "in": "query", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "X-PROJECT-ID", + "in": "header", + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ReleaseResource" + } + } + } + } + }, + "summary": "Get", + "tags": [ + "Release Resource Controller" + ] + } + }, + "/repo-connections": { + "get": { + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RepoConnectionResource" + } + } + } + } + } + }, + "summary": "List", + "tags": [ + "Repo Connection Resource Controller" + ] + }, + "post": { + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateConnectionPayload" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "OK" + }, + "400": { + "description": "Bad Request" + } + }, + "summary": "Create Repo Connection", + "tags": [ + "Repo Connection Resource Controller" + ] + } + }, + "/repo-connections/{id}": { + "put": { + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "reconnect", + "in": "query", + "schema": { + "type": "boolean", + "default": false + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateConnectionPayload" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "OK" + }, + "400": { + "description": "Bad Request" + } + }, + "summary": "Update Repo Connection", + "tags": [ + "Repo Connection Resource Controller" + ] + }, + "get": { + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RepoConnectionResource" + } + } + } + } + }, + "summary": "Get Connection", + "tags": [ + "Repo Connection Resource Controller" + ] + } + }, + "/repo-connections/{id}/disconnect": { + "post": { + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "summary": "Disconnect", + "tags": [ + "Repo Connection Resource Controller" + ] + } + }, + "/repo-connections/{id}/reconnect": { + "post": { + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "summary": "Reconnect", + "tags": [ + "Repo Connection Resource Controller" + ] + } + }, + "/repositories": { + "post": { + "parameters": [ + { + "name": "source", + "in": "query", + "schema": { + "$ref": "#/components/schemas/SourceSystem" + } + }, + { + "name": "X-PROJECT-ID", + "in": "header", + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "201": { + "description": "Created" + } + }, + "summary": "Refresh", + "tags": [ + "Test Project Controller" + ] + }, + "get": { + "parameters": [ + { + "name": "projectId", + "in": "query", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "types", + "in": "query", + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TestProjectType" + } + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TestProjectResource" + } + } + } + } + } + }, + "summary": "List", + "tags": [ + "Test Project Controller" + ] + } + }, + "/repositories/search": { + "get": { + "parameters": [ + { + "name": "types", + "in": "query", + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TestProjectType" + } + } + }, + { + "name": "X-PROJECT-ID", + "in": "header", + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchRequestPagination" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PageTestProjectResource" + } + } + } + } + }, + "summary": "Search", + "tags": [ + "Test Project Controller" + ] + } + }, + "/repositories/test-entities": { + "post": { + "parameters": [ + { + "name": "async", + "in": "query", + "schema": { + "type": "boolean" + } + }, + { + "name": "publishStrategy", + "in": "query", + "schema": { + "$ref": "#/components/schemas/PublishStrategy" + } + }, + { + "name": "X-PROJECT-ID", + "in": "header", + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PublishTestProjectResource" + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PublishTestProjectResource" + } + } + } + } + }, + "400": { + "description": "Bad Request" + } + }, + "summary": "Publish", + "tags": [ + "Repository Storage Controller" + ] + } + }, + "/repositories/{id}": { + "get": { + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "includeFields", + "in": "query", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TestProjectResource" + } + } + } + } + }, + "summary": "Get", + "tags": [ + "Test Project Controller" + ] + } + }, + "/requirements": { + "get": { + "parameters": [ + { + "name": "assignees", + "in": "query", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "fields", + "in": "query", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "keyOrSummary", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "releaseId", + "in": "query", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sprintId", + "in": "query", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "testCaseId", + "in": "query", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "X-PROJECT-ID", + "in": "header", + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RequirementResource" + } + } + } + } + } + }, + "summary": "List", + "tags": [ + "Requirement Resource Controller" + ] + } + }, + "/requirements/{id}": { + "patch": { + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "X-PROJECT-ID", + "in": "header", + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RequirementResource" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RequirementResource" + } + } + } + } + }, + "summary": "Update Patch", + "tags": [ + "Requirement Resource Controller" + ] + }, + "get": { + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "X-PROJECT-ID", + "in": "header", + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RequirementResource" + } + } + } + } + }, + "summary": "Get", + "tags": [ + "Requirement Resource Controller" + ] + } + }, + "/requirements/{id}/link-test-cases": { + "post": { + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LinkTestCaseResource" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "OK" + }, + "400": { + "description": "Bad Request" + } + }, + "summary": "Link Test Cases", + "tags": [ + "Requirement Resource Controller" + ] + } + }, + "/requirements/{id}/unlink-test-cases": { + "delete": { + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LinkTestCaseResource" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "OK" + } + }, + "summary": "Unlink Test Cases", + "tags": [ + "Requirement Resource Controller" + ] + } + }, + "/sprints": { + "get": { + "parameters": [ + { + "name": "almBoardId", + "in": "query", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "almIntegrationId", + "in": "query", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "endTime", + "in": "query", + "schema": { + "$ref": "#/components/schemas/Date" + } + }, + { + "name": "getAll", + "in": "query", + "schema": { + "type": "boolean" + } + }, + { + "name": "startTime", + "in": "query", + "schema": { + "$ref": "#/components/schemas/Date" + } + }, + { + "name": "X-PROJECT-ID", + "in": "header", + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SprintResource" + } + } + } + } + } + }, + "summary": "List", + "tags": [ + "Sprint Resource Controller" + ] + } + }, + "/sprints/search": { + "get": { + "parameters": [ + { + "name": "name", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "X-PROJECT-ID", + "in": "header", + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchRequestPagination" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PageSprintResource" + } + } + } + } + }, + "summary": "Search", + "tags": [ + "Sprint Resource Controller" + ] + } + }, + "/sprints/{id}": { + "get": { + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "almBoardId", + "in": "query", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "X-PROJECT-ID", + "in": "header", + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SprintResource" + } + } + } + } + }, + "summary": "Get", + "tags": [ + "Sprint Resource Controller" + ] + } + }, + "/test-cases/{id}": { + "get": { + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "action", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "contentTypes", + "in": "query", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TestCaseResource" + } + } + } + } + }, + "summary": "Get Test Case", + "tags": [ + "Test Case Resource Controller" + ] + } + }, + "/test-cases/{id}/link-requirements": { + "post": { + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "requirementIds", + "in": "query", + "schema": { + "type": "array", + "items": { + "type": "integer", + "format": "int64" + } + } + }, + { + "name": "X-PROJECT-ID", + "in": "header", + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "201": { + "description": "Created" + } + }, + "summary": "Link Requirements", + "tags": [ + "Test Case Resource Controller" + ] + } + }, + "/test-cases/{id}/linked-ado-test-cases": { + "get": { + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ADOTestCase" + } + } + } + } + } + }, + "summary": "Get Linked ADO Test Cases", + "tags": [ + "Test Case Resource Controller" + ] + } + }, + "/test-cases/{id}/linked-test-cases": { + "get": { + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TestCaseResource" + } + } + } + } + } + }, + "summary": "Get Linked Test Cases", + "tags": [ + "Test Case Resource Controller" + ] + } + }, + "/test-cases/{id}/unlink-requirements": { + "post": { + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "requirementIds", + "in": "query", + "schema": { + "type": "array", + "items": { + "type": "integer", + "format": "int64" + } + } + }, + { + "name": "X-PROJECT-ID", + "in": "header", + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "201": { + "description": "Created" + } + }, + "summary": "Unlink Requirements from Test Case", + "tags": [ + "Test Case Resource Controller" + ] + } + }, + "/test-suites/{id}": { + "get": { + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TestSuiteResource" + } + } + } + } + }, + "summary": "Get Test Suite Detail", + "tags": [ + "Test Suite Resource Controller" + ] + } + } + }, + "components": { + "schemas": { + "ADOConfigurationResource": { + "type": "object", + "required": [ + "planId", + "almIntegrationId" + ], + "properties": { + "planId": { + "type": "integer", + "format": "int64" + }, + "almIntegrationId": { + "type": "integer", + "format": "int64" + }, + "pushMechanism": { + "$ref": "#/components/schemas/PushMechanism" + }, + "attachments": { + "type": "array", + "uniqueItems": true, + "items": { + "$ref": "#/components/schemas/AttachmentSupportType" + } + } + } + }, + "ADOTestCase": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "testCaseId": { + "type": "integer", + "format": "int64" + }, + "summary": { + "type": "string" + }, + "externalIssueId": { + "type": "integer", + "format": "int64" + } + } + }, + "Action": { + "type": "string", + "enum": [ + "CREATE", + "RENAME", + "MOVE", + "DUPLICATE", + "DELETE", + "UPDATE_TEST_TYPE", + "UPDATE_STATUS", + "UPDATE_DESCRIPTION", + "UPDATE_PRECONDITION", + "UPDATE_PRIORITY", + "UPDATE_AUTOMATION_STATUS", + "UPDATE", + "ADD_TEST_CASES" + ] + }, + "AttachmentSupportType": { + "type": "string", + "enum": [ + "PNG", + "AVI", + "MOV", + "MP4", + "DOC", + "DOCX", + "XLS", + "XLSX", + "CSV", + "TXT", + "PDF", + "LOG", + "HTML", + "HTM", + "XML" + ] + }, + "AutomationStatus": { + "type": "string", + "enum": [ + "TO_BE_ASSESSED", + "AUTOMATION_CANDIDATE", + "AUTOMATION_IN_PROGRESS", + "AUTOMATION_COMPLETE", + "MANUAL_ONLY" + ] + }, + "ConnectionStatus": { + "type": "string", + "enum": [ + "ACTIVE", + "ERROR", + "INACTIVE" + ] + }, + "CreateConnectionPayload": { + "type": "object", + "required": [ + "name", + "organizationUrl" + ], + "properties": { + "name": { + "type": "string", + "pattern": "\\S" + }, + "description": { + "type": "string" + }, + "organizationUrl": { + "type": "string", + "pattern": "\\S" + }, + "username": { + "type": "string" + }, + "password": { + "type": "string" + }, + "vcsType": { + "type": "string" + }, + "linkTestExecution": { + "type": "boolean" + } + } + }, + "CreateProjectIntegrationPayload": { + "type": "object", + "required": [ + "repository", + "branch", + "name" + ], + "properties": { + "repository": { + "type": "string", + "pattern": "\\S" + }, + "branch": { + "type": "string", + "pattern": "\\S" + }, + "name": { + "type": "string", + "pattern": "\\S" + }, + "projectId": { + "type": "integer", + "format": "int64" + }, + "description": { + "type": "string" + }, + "type": { + "type": "string" + }, + "targetDirectory": { + "type": "string" + }, + "linkTestExecution": { + "type": "boolean" + }, + "proceed": { + "type": "boolean" + } + } + }, + "Date": { + "type": "string", + "format": "date", + "examples": [ + "2022-03-10" + ] + }, + "DefectCreationResource": { + "type": "object", + "properties": { + "testResultId": { + "type": "integer", + "format": "int64" + }, + "integrationId": { + "type": "integer", + "format": "int64" + }, + "fields": { + "type": "object", + "additionalProperties": {} + } + } + }, + "DefectLinkResource": { + "type": "object", + "properties": { + "testResultId": { + "type": "integer", + "format": "int64" + }, + "externalIssueId": { + "type": "integer", + "format": "int64" + }, + "issueId": { + "type": "string" + }, + "integrationId": { + "type": "integer", + "format": "int64" + } + } + }, + "DefectResource": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "issueId": { + "type": "string" + }, + "summary": { + "type": "string" + }, + "description": { + "type": "string" + }, + "status": { + "type": "string" + }, + "issueTypeName": { + "type": "string" + }, + "url": { + "type": "string" + }, + "priority": { + "type": "string" + }, + "integrationId": { + "type": "integer", + "format": "int64" + }, + "externalProjectId": { + "type": "integer", + "format": "int64" + }, + "severity": { + "type": "string" + } + } + }, + "ErrorResponse": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "data": {} + } + }, + "ExecutionTestSuiteResource": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "startTime": { + "$ref": "#/components/schemas/Date" + }, + "duration": { + "type": "integer", + "format": "int64" + } + } + }, + "ExternalPlanResource": { + "type": "object", + "properties": { + "sourceId": { + "type": "string" + }, + "name": { + "type": "string" + }, + "startDate": { + "$ref": "#/components/schemas/Date" + }, + "endDate": { + "$ref": "#/components/schemas/Date" + } + } + }, + "FieldMapping": { + "type": "object", + "properties": { + "field": { + "type": "string" + }, + "mappedField": { + "type": "string" + } + } + }, + "FileAction": { + "type": "string", + "enum": [ + "CREATE", + "MOVE", + "COPY", + "DELETE", + "REGENERATE_UUID", + "BULK_REGENERATE_UUID", + "BULK_REPLACE", + "REMOVE_CONTENT", + "REPLACE_CONTENT", + "ADD_CONTENT" + ] + }, + "FileResource": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "uploadFileId": { + "type": "integer", + "format": "int64" + }, + "self": { + "type": "string" + }, + "name": { + "type": "string" + }, + "path": { + "type": "string" + }, + "url": { + "type": "string" + }, + "hash": { + "type": "string" + }, + "size": { + "type": "integer", + "format": "int64" + }, + "uploadUrl": { + "type": "string" + }, + "signedUrl": { + "type": "string" + }, + "thumbnailUrl": { + "type": "string" + } + } + }, + "FileResource1": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "path": { + "type": "string" + }, + "fullPath": { + "type": "string" + }, + "newFullPath": { + "type": "string" + }, + "content": { + "type": "string" + }, + "newContent": { + "type": "string" + }, + "removedContent": { + "type": "array", + "items": { + "type": "string" + } + }, + "additionalContentObject": {}, + "isDeleted": { + "type": "boolean" + }, + "action": { + "$ref": "#/components/schemas/FileAction" + }, + "isFolder": { + "type": "boolean" + }, + "parentPath": { + "type": "string" + }, + "deleted": { + "type": "boolean" + }, + "folder": { + "type": "boolean" + } + } + }, + "FileResource2": { + "type": "object", + "properties": { + "downloadUrl": { + "type": "string" + }, + "uploadUrl": { + "type": "string" + } + } + }, + "FileSettings": { + "type": "object", + "properties": { + "encoding": { + "type": "string" + }, + "delimiter": { + "type": "string", + "format": "char" + } + } + }, + "Framework": { + "type": "string", + "enum": [ + "KATALON_STUDIO", + "CLOUD_STUDIO" + ] + }, + "GitRepositoryResource": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "repository": { + "type": "string" + }, + "branch": { + "type": "string" + }, + "username": { + "type": "string" + }, + "password": { + "type": "string" + } + } + }, + "GitTestProjectVCSType": { + "type": "string", + "enum": [ + "GITHUB", + "GITLAB", + "GITLAB_DC", + "BITBUCKET", + "OTHERS", + "AZURE", + "AWS" + ] + }, + "ImportResource": { + "type": "object", + "properties": { + "filePath": { + "type": "string" + }, + "testCasePath": { + "type": "string" + }, + "testProjectId": { + "type": "integer", + "format": "int64" + }, + "mappingStrategy": { + "$ref": "#/components/schemas/MappingStrategy" + }, + "fileSettings": { + "$ref": "#/components/schemas/FileSettings" + }, + "dryRun": { + "type": "boolean" + }, + "ignoreInvalidStatus": { + "type": "boolean" + }, + "ignoreDuplicate": { + "type": "boolean" + }, + "ignoreSpecialCharacters": { + "type": "boolean" + }, + "ignoreInvalidPriority": { + "type": "boolean" + }, + "ignoreInvalidAutomationStatus": { + "type": "boolean" + }, + "ignoreInvalidPath": { + "type": "boolean" + }, + "ignoreSpecialCharactersInPath": { + "type": "boolean" + }, + "testCaseMapping": { + "$ref": "#/components/schemas/MappingStrategy" + } + } + }, + "IntegrationStatus": { + "type": "string", + "enum": [ + "INACTIVE", + "IN_PROGRESS", + "ACTIVE", + "ERROR", + "ARCHIVED" + ] + }, + "KatalonCloudRepositoryResource": { + "type": "object", + "properties": { + "region": { + "type": "string" + }, + "bucketName": { + "type": "string" + }, + "path": { + "type": "string" + }, + "accessKeyId": { + "type": "string" + }, + "secretAccessKey": { + "type": "string" + }, + "sessionToken": { + "type": "string" + } + } + }, + "LinkTestCaseResource": { + "type": "object", + "properties": { + "testCaseIds": { + "type": "array", + "items": { + "type": "integer", + "format": "int64" + } + } + } + }, + "MappingStrategy": { + "type": "object", + "properties": { + "fieldMappings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FieldMapping" + } + }, + "valueMappings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ValueMapping" + } + } + } + }, + "Origin": { + "type": "string", + "enum": [ + "TRUETEST", + "JIRA" + ] + }, + "PageSprintResource": { + "type": "object", + "properties": { + "pageable": { + "$ref": "#/components/schemas/Pageable" + }, + "totalElements": { + "type": "integer", + "format": "int64" + }, + "totalPages": { + "type": "integer", + "format": "int32" + }, + "content": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SprintResource" + } + } + } + }, + "PageTestProjectResource": { + "type": "object", + "properties": { + "pageable": { + "$ref": "#/components/schemas/Pageable" + }, + "totalElements": { + "type": "integer", + "format": "int64" + }, + "totalPages": { + "type": "integer", + "format": "int32" + }, + "content": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TestProjectResource" + } + } + } + }, + "Pageable": { + "type": "object", + "properties": { + "pageNumber": { + "type": "integer", + "format": "int32" + }, + "pageSize": { + "type": "integer", + "format": "int32" + }, + "sorts": { + "type": "string" + } + } + }, + "Priority": { + "type": "string", + "enum": [ + "LOW", + "MEDIUM", + "HIGH", + "CRITICAL" + ] + }, + "ProjectRepoIntegrationResource": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "connection": { + "$ref": "#/components/schemas/RepoConnectionResource" + }, + "testProjectId": { + "type": "integer", + "format": "int64" + }, + "repository": { + "type": "string" + }, + "accountUuid": { + "$ref": "#/components/schemas/UUID" + }, + "branch": { + "type": "string" + }, + "createdAt": { + "$ref": "#/components/schemas/Date" + }, + "updatedAt": { + "$ref": "#/components/schemas/Date" + }, + "name": { + "type": "string" + }, + "projectId": { + "type": "integer", + "format": "int64" + }, + "uploadFileId": { + "type": "integer", + "format": "int64" + }, + "description": { + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/TestProjectType" + }, + "targetDirectory": { + "type": "string" + }, + "archived": { + "type": "boolean" + }, + "status": { + "$ref": "#/components/schemas/IntegrationStatus" + } + } + }, + "PublishStrategy": { + "type": "string", + "enum": [ + "NORMAL", + "FORCE_PUSH", + "SPLIT_BRANCH" + ] + }, + "PublishTestEntityResource": { + "type": "object", + "properties": { + "action": { + "$ref": "#/components/schemas/Action" + }, + "resource": { + "$ref": "#/components/schemas/TestEntityType" + }, + "data": { + "$ref": "#/components/schemas/TestEntityData" + } + } + }, + "PublishTestProjectResource": { + "type": "object", + "properties": { + "testProjectId": { + "type": "integer", + "format": "int64" + }, + "testEntities": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PublishTestEntityResource" + } + }, + "taskResource": { + "$ref": "#/components/schemas/TaskResource" + }, + "message": { + "type": "string" + } + } + }, + "PushMechanism": { + "type": "string", + "enum": [ + "ALL", + "FAILED" + ] + }, + "ReleaseResource": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/ReleaseStatus" + }, + "releasedDate": { + "$ref": "#/components/schemas/Date" + }, + "sourceUrl": { + "type": "string" + } + } + }, + "ReleaseStatus": { + "type": "string", + "enum": [ + "RELEASED", + "UNRELEASED" + ] + }, + "RepoConnectionResource": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "organizationUrl": { + "type": "string" + }, + "accountUuid": { + "$ref": "#/components/schemas/UUID" + }, + "username": { + "type": "string" + }, + "createdAt": { + "$ref": "#/components/schemas/Date" + }, + "updatedAt": { + "$ref": "#/components/schemas/Date" + }, + "passwordEncrypt": { + "type": "string" + }, + "vcsType": { + "$ref": "#/components/schemas/GitTestProjectVCSType" + }, + "accessKeyId": { + "type": "string" + }, + "secretAccessKey": { + "type": "string" + }, + "metadata": {}, + "status": { + "$ref": "#/components/schemas/ConnectionStatus" + }, + "linkTestExecution": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + } + } + }, + "RequirementResource": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "summary": { + "type": "string" + }, + "description": { + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/RequirementStatus" + }, + "assignee": { + "$ref": "#/components/schemas/UserResource" + }, + "linkedTestCaseCount": { + "type": "integer", + "format": "int64" + }, + "sourceId": { + "type": "string" + }, + "sourceType": { + "$ref": "#/components/schemas/SourceType" + }, + "jiraIssueType": { + "type": "string" + }, + "sprints": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SprintResource" + } + }, + "externalIssueId": { + "type": "integer", + "format": "int64" + }, + "externalIssueUrl": { + "type": "string" + }, + "releases": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ReleaseResource" + } + } + } + }, + "RequirementStatus": { + "type": "string", + "enum": [ + "TODO", + "IN_PROGRESS", + "RESOLVED", + "CANCEL" + ] + }, + "SearchRequestPagination": { + "type": "object", + "properties": { + "pageNumber": { + "type": "integer", + "format": "int32" + }, + "pageSize": { + "type": "integer", + "format": "int32" + }, + "sorts": { + "type": "string" + } + } + }, + "Source": { + "type": "string", + "enum": [ + "USER", + "SYSTEM" + ] + }, + "SourceSystem": { + "type": "string", + "enum": [ + "ATG" + ] + }, + "SourceType": { + "type": "string", + "enum": [ + "JIRA", + "ADO" + ] + }, + "SprintResource": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + }, + "state": { + "$ref": "#/components/schemas/SprintState" + }, + "startDate": { + "$ref": "#/components/schemas/Date" + }, + "endDate": { + "$ref": "#/components/schemas/Date" + }, + "sourceUrl": { + "type": "string" + } + } + }, + "SprintState": { + "type": "string", + "enum": [ + "ACTIVE", + "CLOSED", + "FUTURE" + ] + }, + "TaskFailedOutput": { + "type": "object", + "properties": { + "reason": { + "type": "array", + "items": { + "type": "string" + } + }, + "failedItemData": {}, + "errors": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "TaskOutput": { + "type": "object", + "properties": { + "totalItemsNumber": { + "type": "integer", + "format": "int32" + }, + "finishedItemsNumber": { + "type": "integer", + "format": "int32" + }, + "firstItem": { + "$ref": "#/components/schemas/TestCase" + }, + "failedItems": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaskFailedOutput" + } + } + } + }, + "TaskResource": { + "type": "object", + "properties": { + "uuid": { + "$ref": "#/components/schemas/UUID" + }, + "error": { + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/TaskStatus" + }, + "output": { + "$ref": "#/components/schemas/TaskOutput" + }, + "input": { + "type": "string" + }, + "response": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + }, + "TaskStatus": { + "type": "string", + "enum": [ + "TRACKED", + "IN_PROGRESS", + "SUCCEED", + "FAILED", + "CANCELED" + ] + }, + "TestCase": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "path": { + "type": "string" + }, + "description": { + "type": "string" + }, + "preCondition": { + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/TestCaseStatus" + }, + "priority": { + "$ref": "#/components/schemas/Priority" + }, + "automationStatus": { + "$ref": "#/components/schemas/AutomationStatus" + }, + "steps": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TestStep" + } + } + } + }, + "TestCaseResource": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + }, + "path": { + "type": "string" + }, + "description": { + "type": "string" + }, + "preCondition": { + "type": "string" + }, + "hasScript": { + "type": "boolean" + }, + "hasFlow": { + "type": "boolean" + }, + "testType": { + "$ref": "#/components/schemas/TestType" + }, + "script": { + "$ref": "#/components/schemas/FileResource2" + }, + "flow": { + "$ref": "#/components/schemas/FileResource2" + }, + "status": { + "$ref": "#/components/schemas/TestCaseStatus" + }, + "testProject": { + "$ref": "#/components/schemas/TestProjectResource" + }, + "testFolder": { + "$ref": "#/components/schemas/TestFolderResource" + }, + "postUpdateUrl": { + "type": "string" + }, + "author": { + "$ref": "#/components/schemas/UserResource" + }, + "priority": { + "$ref": "#/components/schemas/Priority" + }, + "automationStatus": { + "$ref": "#/components/schemas/AutomationStatus" + } + } + }, + "TestCaseStatus": { + "type": "string", + "enum": [ + "DRAFT", + "READY_TO_REVIEW", + "IN_REVIEW", + "PUBLISHED", + "INACTIVE" + ] + }, + "TestEntityData": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + }, + "path": { + "type": "string" + }, + "description": { + "type": "string" + }, + "preCondition": { + "type": "string" + }, + "content": { + "type": "string" + }, + "testType": { + "$ref": "#/components/schemas/TestType" + }, + "status": { + "$ref": "#/components/schemas/TestCaseStatus" + }, + "linkedTestCaseId": { + "type": "integer", + "format": "int64" + }, + "linkedRequirementIds": { + "type": "array", + "items": { + "type": "integer", + "format": "int64" + } + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "testFolderId": { + "type": "integer", + "format": "int64" + }, + "testSuiteTestType": { + "$ref": "#/components/schemas/TestType1" + }, + "testCaseIds": { + "type": "array", + "items": { + "type": "integer", + "format": "int64" + } + }, + "steps": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TestStep" + } + }, + "source": { + "$ref": "#/components/schemas/Source" + }, + "priority": { + "$ref": "#/components/schemas/Priority" + }, + "automationStatus": { + "$ref": "#/components/schemas/AutomationStatus" + } + } + }, + "TestEntityType": { + "type": "string", + "enum": [ + "TEST_CASE", + "TEST_SUITE", + "TEST_FOLDER" + ] + }, + "TestFolderResource": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + }, + "rawPath": { + "type": "string" + }, + "treePath": { + "type": "string" + }, + "parentId": { + "type": "integer", + "format": "int64" + } + } + }, + "TestProjectResource": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + }, + "gitRepository": { + "$ref": "#/components/schemas/GitRepositoryResource" + }, + "katalonCloudRepository": { + "$ref": "#/components/schemas/KatalonCloudRepositoryResource" + }, + "zipRepository": { + "$ref": "#/components/schemas/ZipRepositoryResource" + }, + "type": { + "$ref": "#/components/schemas/TestProjectType" + }, + "frameworks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Framework" + } + }, + "targetDirectory": { + "type": "string" + }, + "dirty": { + "type": "boolean" + }, + "patNavigationPath": { + "type": "string" + }, + "testFolders": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TestFolderResource" + } + } + } + }, + "TestProjectType": { + "type": "string", + "enum": [ + "KS", + "GIT", + "CLOUD" + ] + }, + "TestStep": { + "type": "object", + "properties": { + "description": { + "type": "string" + }, + "expectedResult": { + "type": "string" + }, + "testData": { + "type": "string" + } + } + }, + "TestSuiteResource": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + }, + "path": { + "type": "string" + }, + "testFolder": { + "$ref": "#/components/schemas/TestFolderResource" + }, + "testProject": { + "$ref": "#/components/schemas/TestProjectResource" + }, + "testType": { + "$ref": "#/components/schemas/TestType1" + }, + "lastExecutionTestSuite": { + "$ref": "#/components/schemas/ExecutionTestSuiteResource" + }, + "author": { + "$ref": "#/components/schemas/UserResource" + }, + "type": { + "$ref": "#/components/schemas/TestSuiteType" + }, + "source": { + "$ref": "#/components/schemas/Source" + } + } + }, + "TestSuiteType": { + "type": "string", + "enum": [ + "KATALON_STUDIO", + "TESTOPS", + "CLOUD_STUDIO" + ] + }, + "TestType": { + "type": "string", + "enum": [ + "AUTOMATED", + "G5_TEST_CASE", + "MANUAL" + ] + }, + "TestType1": { + "type": "string", + "enum": [ + "AUTOMATED", + "MANUAL" + ] + }, + "UUID": { + "type": "string", + "format": "uuid", + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + }, + "UpdateConnectionPayload": { + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "type": "string", + "pattern": "\\S" + }, + "description": { + "type": "string" + }, + "username": { + "type": "string" + }, + "password": { + "type": "string" + }, + "linkTestExecution": { + "type": "boolean" + } + } + }, + "UpdateProjectIntegrationPayload": { + "type": "object", + "required": [ + "repository", + "branch", + "name" + ], + "properties": { + "repository": { + "type": "string", + "pattern": "\\S" + }, + "branch": { + "type": "string", + "pattern": "\\S" + }, + "name": { + "type": "string", + "pattern": "\\S" + }, + "targetDirectory": { + "type": "string" + }, + "description": { + "type": "string" + }, + "linkTestExecution": { + "type": "boolean" + }, + "proceed": { + "type": "boolean" + } + } + }, + "UploadFileResource": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "files": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FileResource1" + } + } + } + }, + "UserGitCredentialResource": { + "type": "object", + "properties": { + "username": { + "type": "string" + }, + "accessToken": { + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/GitTestProjectVCSType" + } + } + }, + "UserResource": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "email": { + "type": "string" + }, + "firstName": { + "type": "string" + }, + "lastName": { + "type": "string" + }, + "password": { + "type": "string" + }, + "avatar": { + "type": "string" + }, + "uuid": { + "$ref": "#/components/schemas/UUID" + }, + "fullName": { + "type": "string" + } + } + }, + "ValidateGitPathPayload": { + "type": "object", + "required": [ + "repository", + "branch" + ], + "properties": { + "repository": { + "type": "string", + "pattern": "\\S" + }, + "branch": { + "type": "string", + "pattern": "\\S" + }, + "targetDirectory": { + "type": "string" + } + } + }, + "ValueMapping": { + "type": "object", + "properties": { + "field": { + "type": "string" + }, + "values": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Values" + } + }, + "defaultValue": { + "type": "string" + } + } + }, + "Values": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "mappedValue": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ZipRepositoryResource": { + "type": "object", + "properties": { + "downloadUrl": { + "type": "string" + }, + "uplaodUrl": { + "type": "string" + } + } + } + }, + "securitySchemes": { + "SecurityScheme": { + "type": "http", + "scheme": "bearer", + "bearerFormat": "JWT", + "description": "Authentication" + } + } + }, + "info": { + "title": "organizing-be API", + "version": "1.0.0-SNAPSHOT" + } +}