diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/devops/2021-06-25/api-docs.php | |
| download | acs-metadata-full-main.tar.gz acs-metadata-full-main.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/devops/2021-06-25/api-docs.php')
| -rw-r--r-- | data/en_us/devops/2021-06-25/api-docs.php | 50748 |
1 files changed, 50748 insertions, 0 deletions
diff --git a/data/en_us/devops/2021-06-25/api-docs.php b/data/en_us/devops/2021-06-25/api-docs.php new file mode 100644 index 0000000..4716c31 --- /dev/null +++ b/data/en_us/devops/2021-06-25/api-docs.php @@ -0,0 +1,50748 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'ROA', + 'product' => 'devops', + 'version' => '2021-06-25', + ], + 'directories' => [ + [ + 'id' => 164546, + 'title' => 'Code Management', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 172780, + 'title' => 'File', + 'type' => 'directory', + 'children' => [ + 'CreateFile', + 'DeleteFile', + 'UpdateFile', + 'GetFileBlobs', + 'ListRepositoryTree', + ], + ], + [ + 'id' => 164547, + 'title' => 'Submission', + 'type' => 'directory', + 'children' => [ + 'GetFileLastCommit', + 'GetRepositoryCommit', + 'ListRepositoryCommits', + 'ListRepositoryCommitDiff', + 'CreateCommitWithMultipleFiles', + ], + ], + [ + 'id' => 164551, + 'title' => 'Members', + 'type' => 'directory', + 'children' => [ + 'AddRepositoryMember', + 'AddGroupMember', + 'DeleteRepositoryMember', + 'DeleteGroupMember', + 'UpdateRepositoryMember', + 'UpdateGroupMember', + 'ListRepositoryMemberWithInherited', + 'GetProjectMember', + 'ListGroupMember', + ], + ], + [ + 'id' => 164554, + 'title' => 'Warehouse', + 'type' => 'directory', + 'children' => [ + 'CreateRepository', + 'DeleteRepository', + 'UpdateRepository', + 'TriggerRepositoryMirrorSync', + 'TransferRepository', + 'ListRepositories', + 'GetRepository', + ], + ], + [ + 'id' => 171910, + 'title' => 'Branch', + 'type' => 'directory', + 'children' => [ + 'CreateBranch', + 'CreateProtectdBranch', + 'DeleteBranch', + 'DeleteProtectedBranch', + 'UpdateProtectedBranches', + 'GetBranchInfo', + 'ListRepositoryBranches', + 'ListProtectedBranches', + ], + ], + [ + 'id' => 185321, + 'title' => 'Merge Request', + 'type' => 'directory', + 'children' => [ + 'GetMergeRequest', + 'ListMergeRequests', + 'CreateMergeRequest', + 'UpdateMergeRequest', + 'UpdateMergeRequestPersonnel', + 'MergeMergeRequest', + 'ReviewMergeRequest', + 'CloseMergeRequest', + 'ReopenMergeRequest', + 'ListMergeRequestPatchSets', + 'GetMergeRequestChangeTree', + 'ListMergeRequestFilesReads', + 'ListMergeRequestComments', + 'CreateComment', + ], + ], + [ + 'id' => 178462, + 'title' => 'Compare', + 'type' => 'directory', + 'children' => [ + 'GetCompareDetail', + ], + ], + [ + 'id' => 187893, + 'title' => 'Submit Status', + 'type' => 'directory', + 'children' => [ + 'CreateCommitStatus', + 'ListCommitStatuses', + ], + ], + [ + 'id' => 189204, + 'title' => 'Check Run', + 'type' => 'directory', + 'children' => [ + 'CreateCheckRun', + 'UpdateCheckRun', + 'GetCheckRun', + 'ListCheckRuns', + ], + ], + [ + 'id' => 177752, + 'title' => 'Label', + 'type' => 'directory', + 'children' => [ + 'CreateTag', + 'DeleteTag', + 'GetRepositoryTag', + 'ListRepositoryTags', + ], + ], + [ + 'id' => 188973, + 'title' => 'Class Label', + 'type' => 'directory', + 'children' => [ + 'CreateProjectLabel', + 'UpdateProjectLabel', + 'DeleteProjectLabel', + 'ListProjectLabels', + 'ListMergeRequestLabels', + 'LinkMergeRequestLabel', + ], + ], + [ + 'id' => 164559, + 'title' => 'Webhook', + 'type' => 'directory', + 'children' => [ + 'AddWebhook', + 'DeleteRepositoryWebhook', + 'ListRepositoryWebhook', + ], + ], + [ + 'id' => 176819, + 'title' => 'Code Group', + 'type' => 'directory', + 'children' => [ + 'CreateRepositoryGroup', + 'DeleteRepositoryGroup', + 'UpdateGroup', + 'GetGroupDetail', + 'GetGroupByPath', + 'ListRepositoryGroups', + 'ListGroupRepositories', + ], + ], + [ + 'id' => 178460, + 'title' => 'Push Review', + 'type' => 'directory', + 'children' => [ + 'UpdatePushReviewOnOff', + ], + ], + [ + 'id' => 186377, + 'title' => 'Push Rules', + 'type' => 'directory', + 'children' => [ + 'CreatePushRule', + 'UpdatePushRule', + 'DeletePushRule', + 'ListPushRules', + ], + ], + [ + 'id' => 177915, + 'title' => 'Deployment Key', + 'type' => 'directory', + 'children' => [ + 'CreateDeployKey', + 'EnableDeployKey', + ], + ], + [ + 'id' => 183443, + 'title' => 'SSH Key', + 'type' => 'directory', + 'children' => [ + 'CreateUserKey', + 'DeleteUserKey', + 'ListUserKeys', + ], + ], + [ + 'id' => 178455, + 'title' => 'Code Search', + 'type' => 'directory', + 'children' => [ + 'ListSearchSourceCode', + 'ListSearchRepository', + 'ListSearchCommit', + 'GetSearchCodePreview', + ], + ], + [ + 'id' => 164549, + 'title' => 'Enterprise Information', + 'type' => 'directory', + 'children' => [ + 'GetCodeupOrganization', + 'ListOrganizations', + ], + ], + [ + 'id' => 177750, + 'title' => 'User', + 'type' => 'directory', + 'children' => [ + 'GetUserInfo', + ], + ], + [ + 'id' => 184606, + 'title' => 'Audit', + 'type' => 'directory', + 'children' => [ + 'ListUserResources', + ], + ], + [ + 'id' => 167604, + 'title' => 'Authentication', + 'type' => 'directory', + 'children' => [ + 'CreateOAuthToken', + ], + ], + ], + ], + [ + 'id' => 129795, + 'title' => 'assembly line', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 184754, + 'title' => 'Service Connection', + 'type' => 'directory', + 'children' => [ + 'CreateServiceConnection', + 'CreateServiceAuth', + 'CreateServiceCredential', + 'ListServiceCredentials', + 'ListServiceAuths', + 'ListServiceConnections', + ], + ], + [ + 'id' => 169998, + 'title' => 'Host Deployment', + 'type' => 'directory', + 'children' => [ + 'StopVMDeployOrder', + 'SkipVMDeployMachine', + 'RetryVMDeployMachine', + 'ResumeVMDeployOrder', + 'GetVMDeployOrder', + 'LogVMDeployMachine', + ], + ], + [ + 'id' => 169999, + 'title' => 'pipeline grouping', + 'type' => 'directory', + 'children' => [ + 'CreatePipelineGroup', + 'DeletePipelineGroup', + 'JoinPipelineGroup', + 'UpdatePipelineGroup', + 'GetPipelineGroup', + 'ListPipelineGroupPipelines', + 'ListPipelineGroups', + ], + ], + [ + 'id' => 129796, + 'title' => 'Label', + 'type' => 'directory', + 'children' => [ + 'CreateFlowTag', + 'CreateFlowTagGroup', + 'DeleteFlowTagGroup', + 'DeleteFlowTag', + 'UpdateFlowTag', + 'UpdateFlowTagGroup', + 'GetFlowTagGroup', + 'ListFlowTagGroups', + ], + ], + [ + 'id' => 129805, + 'title' => 'Other', + 'type' => 'directory', + 'children' => [ + 'CreateSshKey', + 'ResetSshKey', + ], + ], + [ + 'id' => 129809, + 'title' => 'Members', + 'type' => 'directory', + 'children' => [ + 'CreateResourceMember', + 'DeleteResourceMember', + 'UpdateResourceMember', + 'ListResourceMembers', + ], + ], + [ + 'id' => 129814, + 'title' => 'Host Group', + 'type' => 'directory', + 'children' => [ + 'CreateHostGroup', + 'DeleteHostGroup', + 'UpdateHostGroup', + 'GetHostGroup', + 'ListHostGroups', + ], + ], + [ + 'id' => 129820, + 'title' => 'Variable Group', + 'type' => 'directory', + 'children' => [ + 'CreateVariableGroup', + 'DeleteVariableGroup', + 'UpdateVariableGroup', + 'GetVariableGroup', + 'ListVariableGroups', + ], + ], + [ + 'id' => 129826, + 'title' => 'assembly line', + 'type' => 'directory', + 'children' => [ + 'CreatePipeline', + 'DeletePipeline', + 'DeletePipelineRelations', + 'UpdatePipeline', + 'StartPipelineRun', + 'StopPipelineJobRun', + 'StopPipelineRun', + 'UpdatePipelineBaseInfo', + 'RetryPipelineJobRun', + 'SkipPipelineJobRun', + 'PassPipelineValidate', + 'RefusePipelineValidate', + 'AddPipelineRelations', + 'GetPipeline', + 'GetPipelineRun', + 'ListPipelineRuns', + 'ListPipelines', + 'GetPipelineArtifactUrl', + 'GetPipelineEmasArtifactUrl', + 'GetPipelineScanReportUrl', + 'ListPipelineJobHistorys', + 'ListPipelineJobs', + 'LogPipelineJobRun', + 'ListPipelineRelations', + ], + ], + ], + ], + [ + 'id' => 129766, + 'title' => 'Project Management (Projex)', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 129767, + 'title' => '工作项', + 'type' => 'directory', + 'children' => [ + 'WorkitemAttachmentCreate', + 'ListWorkitemAttachments', + 'CreateWorkitemV2', + 'CreateWorkitemRecord', + 'CreateWorkitem', + 'CreateWorkitemComment', + 'DeleteWorkitemComment', + 'DeleteWorkitemAllComment', + 'UpdateWorkitemComment', + 'UpdateWorkItem', + 'GetWorkitemAttachmentCreatemeta', + 'GetWorkitemTimeTypeList', + 'GetWorkitemRelations', + 'GetWorkitemCommentList', + 'CreateWorkitemEstimate', + 'GetCustomFieldOption', + 'GetWorkItemActivity', + 'GetWorkItemInfo', + 'GetWorkItemWorkFlowInfo', + 'ListProjectWorkitemTypes', + 'ListWorkItemAllFields', + 'ListWorkItemWorkFlowStatus', + 'ListWorkitems', + 'ListWorkitemTime', + 'ListWorkitemEstimate', + 'UpdateWorkitemField', + 'DeleteWorkitem', + 'GetWorkitemFile', + ], + ], + [ + 'id' => 129777, + 'title' => '项目', + 'type' => 'directory', + 'children' => [ + 'CreateProject', + 'CreateSprint', + 'DeleteProject', + 'UpdateProjectMember', + 'UpdateProjectField', + 'GetProjectInfo', + 'ListProjectMembers', + 'GetSprintInfo', + 'ListProjects', + 'ListProjectTemplates', + 'ListSprints', + ], + ], + ], + ], + [ + 'id' => 183317, + 'title' => 'Test Management', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 183318, + 'title' => 'Test Case Library', + 'type' => 'directory', + 'children' => [ + 'CreateTestCase', + 'UpdateTestCase', + 'ListTestCaseFields', + 'GetTestcaseList', + ], + ], + [ + 'id' => 183322, + 'title' => 'Test Plan', + 'type' => 'directory', + 'children' => [ + 'UpdateTestResult', + 'GetTestResultList', + ], + ], + ], + ], + [ + 'id' => 192620, + 'title' => 'Performance Insights', + 'type' => 'directory', + 'children' => [ + 'ExportWorkitemActivity', + 'ExportInsightWorkitemVersion', + 'ExportInsightWorkitemStatusJoinWorkitemDefectExtra', + 'ExportInsightWorkitemStatus', + 'ExportInsightWorkTime', + 'ExportInsightTagRef', + 'ExportInsightSprint', + 'ExportInsightSpaceRef', + 'ExportInsightSpace', + 'ExportInsightField', + 'ExportInsightExpectedWorkTime', + 'ExportInsightCustomValue', + ], + ], + [ + 'id' => 129762, + 'title' => 'Enterprises and members', + 'type' => 'directory', + 'children' => [ + 'UpdateOrganizationMember', + 'ListOrganizationMembers', + 'GetOrganizationMember', + 'ListJoinedOrganizations', + ], + ], + [ + 'id' => 188636, + 'title' => 'Application Delivery', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 188637, + 'title' => 'Application', + 'type' => 'directory', + 'children' => [ + 'GetApplication', + 'UpdateApplication', + 'ListApplications', + ], + ], + [ + 'id' => 193448, + 'title' => 'Application Member', + 'type' => 'directory', + 'children' => [ + 'ListApplicationMembers', + 'CreateAppMembers', + 'UpdateAppMember', + 'DeleteAppMember', + ], + ], + [ + 'id' => 193449, + 'title' => 'Application R & D Process', + 'type' => 'directory', + 'children' => [ + 'GetReleaseStagePipelineRun', + 'ExecuteChangeRequestReleaseStage', + 'CancelExecutionReleaseStage', + 'ListAllReleaseWorkflows', + 'ListAppReleaseStageExecutions', + 'ListAppReleaseStageExecutionIntegratedMetadata', + 'RefuseReleaseStagePipelineValidate', + 'PassReleaseStagePipelineValidate', + ], + ], + [ + 'id' => 193927, + 'title' => 'Change', + 'type' => 'directory', + 'children' => [ + 'CreateChangeRequest', + 'ListChangeRequests', + 'ListChangeRequestWorkflowExecutions', + ], + ], + ], + ], + [ + 'id' => 196435, + 'title' => 'Other', + 'type' => 'directory', + 'children' => [ + 'ListUserDrawRecordByPk', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'CreateFile' => [ + 'summary' => '创建文件', + 'path' => '/repository/{repositoryId}/files', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2080972', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'filePath' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '/src/main/test.java', + ], + 'branchName' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'master', + ], + 'encoding' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'text', + ], + 'content' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + 'commitMessage' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'F8053E32-9623-511F-8B46-F0E5FD206524', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'filePath' => [ + 'description' => '', + 'type' => 'string', + 'example' => '/src/main/test.java', + ], + 'branchName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'master', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F8053E32-9623-511F-8B46-F0E5FD206524\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"filePath\\": \\"/src/main/test.java\\",\\n \\"branchName\\": \\"master\\"\\n }\\n}","type":"json"}]', + ], + 'DeleteFile' => [ + 'summary' => '删除文件', + 'path' => '/repository/{repositoryId}/files/delete', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2709413', + ], + ], + [ + 'name' => 'branchName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'master', + ], + ], + [ + 'name' => 'filePath', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'src/main/test.java', + ], + ], + [ + 'name' => 'commitMessage', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '7EFAD5FB-2296-5D52-BC60-FCC992A40767', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => ' '."\n" + .'SYSTEM_UNKNOWN_ERROR', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'filePath' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'src/main/delete.java', + ], + 'branchName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'master', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"7EFAD5FB-2296-5D52-BC60-FCC992A40767\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"filePath\\": \\"src/main/delete.java\\",\\n \\"branchName\\": \\"master\\"\\n }\\n}","type":"json"}]', + ], + 'UpdateFile' => [ + 'summary' => '更新代码库文件', + 'path' => '/repository/{repositoryId}/files/update', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '0cf2c8458ac44d9481aab2dd6ec10596v3'."\n", + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2813489', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'oldPath' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'src/main/update.txt', + ], + 'newPath' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'src/main/update.txt', + ], + 'branchName' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'master', + ], + 'encoding' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'text', + ], + 'content' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + 'commitMessage' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'C2F153F6-BB43-50C4-9F4F-40593203E19A', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'branchName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'master', + ], + 'filePath' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'src/main/update.txt', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C2F153F6-BB43-50C4-9F4F-40593203E19A\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"branchName\\": \\"master\\",\\n \\"filePath\\": \\"src/main/update.txt\\"\\n }\\n}","type":"json"}]', + ], + 'GetFileBlobs' => [ + 'summary' => '查询文件', + 'path' => '/repository/{repositoryId}/files/blobs', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2744800', + ], + ], + [ + 'name' => 'filePath', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'src/Test.java', + ], + ], + [ + 'name' => 'ref', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'master / tag1.0 / ecykhdd', + ], + ], + [ + 'name' => 'from', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'to', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'F590C9D8-E908-5B6C-95AC-56B7E8011FFA', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'content' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'totalLines' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '65535', + ], + 'size' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F590C9D8-E908-5B6C-95AC-56B7E8011FFA\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"content\\": \\"xxxx\\",\\n \\"totalLines\\": 65535,\\n \\"size\\": 10\\n }\\n}","type":"json"}]', + ], + 'ListRepositoryTree' => [ + 'summary' => '查询代码库文件树', + 'path' => '/repository/{repositoryId}/files/tree', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '624666bd54d036291ae13a36', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2851516', + ], + ], + [ + 'name' => 'path', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'module', + ], + ], + [ + 'name' => 'refName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'master / tag1.0 / sjjfssa', + ], + ], + [ + 'name' => 'type', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'RECURSIVE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '6557983C-FB08-51A9-AC5A-A7A0D0950A07', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'path' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'isLFS' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'id' => [ + 'description' => '', + 'type' => 'string', + 'example' => '76c3f251f414ac31f2e01faf6f2008a9d756a437', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'type' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'blob', + ], + 'mode' => [ + 'description' => '', + 'type' => 'string', + 'example' => '100644', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"6557983C-FB08-51A9-AC5A-A7A0D0950A07\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": true,\\n \\"result\\": [\\n {\\n \\"path\\": \\"test-codeup\\",\\n \\"isLFS\\": false,\\n \\"id\\": \\"76c3f251f414ac31f2e01faf6f2008a9d756a437\\",\\n \\"name\\": \\"test-codeup\\",\\n \\"type\\": \\"blob\\",\\n \\"mode\\": \\"100644\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetFileLastCommit' => [ + 'summary' => '获取文件上一次提交信息', + 'path' => '/repository/{repositoryId}/files/lastCommit', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'accessToken', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '个人访问令牌', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'title' => '代码库ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '2825387', + ], + ], + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => '云效企业ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'sha', + 'in' => 'query', + 'schema' => [ + 'title' => '分支名称、标签名称或Commit ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'master', + ], + ], + [ + 'name' => 'filePath', + 'in' => 'query', + 'schema' => [ + 'title' => '文件路径', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'src/main/test.java', + ], + ], + [ + 'name' => 'showSignature', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'requestId' => [ + 'title' => '请求ID', + 'description' => '', + 'type' => 'string', + 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9', + ], + 'success' => [ + 'title' => '请求结果', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'result' => [ + 'title' => '响应结果', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'shortId' => [ + 'title' => 'Commit短ID', + 'description' => '', + 'type' => 'string', + 'example' => 'ff4fb5ac', + ], + 'authorName' => [ + 'title' => '作者姓名', + 'description' => '', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'authorDate' => [ + 'title' => '作者提交时间', + 'description' => '', + 'type' => 'string', + 'example' => '2022-08-08 18:09:09', + ], + 'createdAt' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54', + ], + 'message' => [ + 'title' => '提交内容', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'title' => [ + 'title' => '标题，提交的第一行内容', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'committerName' => [ + 'title' => '提交者姓名', + 'description' => '', + 'type' => 'string', + 'example' => 'committer-codeup', + ], + 'authorEmail' => [ + 'title' => '提交者邮箱', + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'id' => [ + 'title' => 'Commit ID', + 'description' => '', + 'type' => 'string', + 'example' => 'ff4fb5ac6d1f44f452654336d2dba468ae6c8d04 ', + ], + 'committerEmail' => [ + 'title' => '提交者邮箱', + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'committedDate' => [ + 'title' => '提交者提交时间', + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 15:00:02', + ], + 'parentIds' => [ + 'title' => '父提交ID', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '父提交Id', + 'description' => '', + 'type' => 'string', + 'example' => 'de02b625ba8488f92eb204bcb3773a40c1b4ddac', + ], + ], + 'signature' => [ + 'title' => '签名', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'verificationStatus' => [ + 'title' => '验证状态', + 'description' => '', + 'type' => 'string', + 'example' => 'verified', + ], + 'gpgKeyId' => [ + 'title' => 'GPG密钥ID', + 'description' => 'GPG密钥ID', + 'type' => 'string', + 'example' => '34d2c47c7ce46a5c4639c5ffe208', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'SystemError.UnKnownError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"requestId\\": \\"F7B85D1B-D1C2-140F-A039-341859F130B9\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"result\\": {\\n \\"shortId\\": \\"ff4fb5ac\\",\\n \\"authorName\\": \\"test-codeup\\",\\n \\"authorDate\\": \\"2022-08-08 18:09:09\\",\\n \\"createdAt\\": \\"2022-03-18 14:24:54\\",\\n \\"message\\": \\"提交的具体内容\\",\\n \\"title\\": \\"提交标题\\",\\n \\"committerName\\": \\"committer-codeup\\",\\n \\"authorEmail\\": \\"[email protected]\\",\\n \\"id\\": \\"ff4fb5ac6d1f44f452654336d2dba468ae6c8d04 \\",\\n \\"committerEmail\\": \\"[email protected]\\",\\n \\"committedDate\\": \\"2022-03-18 15:00:02\\",\\n \\"parentIds\\": [\\n \\"de02b625ba8488f92eb204bcb3773a40c1b4ddac\\"\\n ],\\n \\"signature\\": {\\n \\"verificationStatus\\": \\"verified\\",\\n \\"gpgKeyId\\": \\"34d2c47c7ce46a5c4639c5ffe208\\"\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetFileLastCommitResponse>\\n <ErrorMessage>An error occurred while processing your request.\\t\\n</ErrorMessage>\\n <RequestId>AB270BBA-EFB1-5773-B3DC-07CD036F7352</RequestId>\\n <Success>true</Success>\\n <ErrorCode>SYSTEM_UNKNOWN_ERROR</ErrorCode>\\n <Result>\\n <ShortId>231d5bc453d</ShortId>\\n <AuthorName>阿里云云效</AuthorName>\\n <AuthorDate>2022-03-18 10:00:00</AuthorDate>\\n <CreatedAt>2022-03-18 10:00:00</CreatedAt>\\n <Message>测试云效Codeup</Message>\\n <Title>Test 云效 Codeup Commit</Title>\\n <CommitterName>阿里云云效Codeup</CommitterName>\\n <AuthorEmail>[email protected]</AuthorEmail>\\n <Id>201</Id>\\n <CommitterEmail>[email protected]</CommitterEmail>\\n <CommittedDate>2022-03-18 10:00:00\\n</CommittedDate>\\n <ParentIds>34d2c47c7ce46a5c4639c5ffe208a66dda975a05</ParentIds>\\n <Signature>\\n <VerificationStatus>VERIFIED</VerificationStatus>\\n <GpgKeyId>34d2c47c7ce46a5c4639c5ffe208</GpgKeyId>\\n </Signature>\\n </Result>\\n</GetFileLastCommitResponse>","errorExample":""}]', + ], + 'GetRepositoryCommit' => [ + 'summary' => '查询代码库提交信息', + 'path' => '/repository/{repositoryId}/commits/{sha}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'title' => 'The ID of a project', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2464454', + ], + ], + [ + 'name' => 'sha', + 'in' => 'path', + 'schema' => [ + 'title' => 'The commit hash or name of a repository branch or tag', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'master', + ], + ], + [ + 'name' => 'showSignature', + 'in' => 'query', + 'schema' => [ + 'title' => '展示签名', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A7586FEB-E48D-5579-983F-74981FBFF627', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ff4fb5ac6d1f44f452654336d2dba468ae6c8d04 ', + ], + 'shortId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ff4fb5ac', + ], + 'title' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'authorName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'authorEmail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'createdAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54', + ], + 'message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'authoredDate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 15:00:00', + ], + 'committedDate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 15:00:02', + ], + 'committerEmail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]'."\n", + ], + 'committerName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'committer-codeup', + ], + 'parentIds' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'de02b625ba8488f92eb204bcb3773a40c1b4ddac', + ], + ], + 'author' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19927', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'username' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-nickname', + ], + 'state' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c4ef67f1bea827c4/w/100/h/100', + ], + 'websiteUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'email' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + ], + ], + 'committer' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '24661', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'committer-codeup', + ], + 'username' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'nickname', + ], + 'state' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c4ef67f1bea827c4/w/100/h/100', + ], + 'websiteUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'email' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + ], + ], + 'signature' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'gpgKeyId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '34d2c47c7ce46a5c4639c5ffe208', + ], + 'verificationStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'verified', + ], + ], + ], + 'commentsCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A7586FEB-E48D-5579-983F-74981FBFF627\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"id\\": \\"ff4fb5ac6d1f44f452654336d2dba468ae6c8d04 \\",\\n \\"shortId\\": \\"ff4fb5ac\\",\\n \\"title\\": \\"云效Codeup提交Title\\",\\n \\"authorName\\": \\"test-codeup\\",\\n \\"authorEmail\\": \\"[email protected]\\",\\n \\"createdAt\\": \\"2022-03-18 14:24:54\\",\\n \\"message\\": \\"具体的提交内容\\",\\n \\"authoredDate\\": \\"2022-03-18 15:00:00\\",\\n \\"committedDate\\": \\"2022-03-18 15:00:02\\",\\n \\"committerEmail\\": \\"[email protected]\\\\n\\",\\n \\"committerName\\": \\"committer-codeup\\",\\n \\"parentIds\\": [\\n \\"de02b625ba8488f92eb204bcb3773a40c1b4ddac\\"\\n ],\\n \\"author\\": {\\n \\"id\\": 19927,\\n \\"name\\": \\"test-codeup\\",\\n \\"username\\": \\"test-nickname\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c4ef67f1bea827c4/w/100/h/100\\",\\n \\"websiteUrl\\": \\"\\\\\\"\\\\\\"\\",\\n \\"email\\": \\"[email protected]\\"\\n },\\n \\"committer\\": {\\n \\"id\\": 24661,\\n \\"name\\": \\"committer-codeup\\",\\n \\"username\\": \\"nickname\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c4ef67f1bea827c4/w/100/h/100\\",\\n \\"websiteUrl\\": \\"\\\\\\"\\\\\\"\\",\\n \\"email\\": \\"[email protected]\\"\\n },\\n \\"signature\\": {\\n \\"gpgKeyId\\": \\"34d2c47c7ce46a5c4639c5ffe208\\",\\n \\"verificationStatus\\": \\"verified\\"\\n },\\n \\"commentsCount\\": 1\\n }\\n}","type":"json"}]', + ], + 'ListRepositoryCommits' => [ + 'summary' => '查询代码库提交历史', + 'path' => '/repository/{repositoryId}/commits', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2334743', + ], + ], + [ + 'name' => 'refName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'start', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2022-03-18 08:00:00', + ], + ], + [ + 'name' => 'end', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2022-08-18 08:00:00', + ], + ], + [ + 'name' => 'page', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'path', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'src/cpp/main.cpp', + ], + ], + [ + 'name' => 'search', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'search', + ], + ], + [ + 'name' => 'showSignature', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'showCommentsCount', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'F1138237-CF7F-56BF-95D4-9AA937CCE8E5', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OpenApi.error', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'total' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '145', + ], + 'result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'de02b625ba8488f92eb204bcb3773a40c1b4ddac', + ], + 'shortId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'de02b625', + ], + 'title' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'authorName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'authorEmail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'createdAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54', + ], + 'message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'authoredDate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 15:00:00', + ], + 'committedDate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 16:00:00', + ], + 'committerEmail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'committerName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'committer-codeup', + ], + 'parentIds' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ff4fb5ac6d1f44f452654336d2dba468ae6c8d04 ', + ], + ], + 'author' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '7914', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'username' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'nickname', + ], + 'state' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'websiteUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'email' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + ], + ], + 'committer' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '41031', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'committer-codeup', + ], + 'username' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'nickname', + ], + 'state' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'websiteUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'email' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + ], + ], + 'signature' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'gpgKeyId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'verificationStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'verified', + ], + ], + ], + 'commentsCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F1138237-CF7F-56BF-95D4-9AA937CCE8E5\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"OpenApi.error\\",\\n \\"success\\": true,\\n \\"total\\": 145,\\n \\"result\\": [\\n {\\n \\"id\\": \\"de02b625ba8488f92eb204bcb3773a40c1b4ddac\\",\\n \\"shortId\\": \\"de02b625\\",\\n \\"title\\": \\"提交标题\\",\\n \\"authorName\\": \\"test-codeup\\",\\n \\"authorEmail\\": \\"[email protected]\\",\\n \\"createdAt\\": \\"2022-03-18 14:24:54\\",\\n \\"message\\": \\"提交的具体内容\\",\\n \\"authoredDate\\": \\"2022-03-18 15:00:00\\",\\n \\"committedDate\\": \\"2022-03-18 16:00:00\\",\\n \\"committerEmail\\": \\"[email protected]\\",\\n \\"committerName\\": \\"committer-codeup\\",\\n \\"parentIds\\": [\\n \\"ff4fb5ac6d1f44f452654336d2dba468ae6c8d04 \\"\\n ],\\n \\"author\\": {\\n \\"id\\": 7914,\\n \\"name\\": \\"云效\\",\\n \\"username\\": \\"nickname\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"头像地址\\\\n\\\\nhttps://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"websiteUrl\\": \\"\\\\\\"\\\\\\"\\",\\n \\"email\\": \\"[email protected]\\"\\n },\\n \\"committer\\": {\\n \\"id\\": 41031,\\n \\"name\\": \\"committer-codeup\\",\\n \\"username\\": \\"nickname\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"websiteUrl\\": \\"\\\\\\"\\\\\\"\\",\\n \\"email\\": \\"[email protected]\\"\\n },\\n \\"signature\\": {\\n \\"gpgKeyId\\": \\"”“\\",\\n \\"verificationStatus\\": \\"verified\\"\\n },\\n \\"commentsCount\\": 1\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListRepositoryCommitDiff' => [ + 'summary' => '查询代码库单个提交（Commit）的提交内容', + 'path' => '/repository/{repositoryId}/commits/{sha}/diff', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => '60de7a6852743a5162b5f957', + 'required' => true, + 'type' => 'string', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'accessToken', + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'example' => '2464454', + 'format' => 'int64', + 'required' => true, + 'type' => 'integer', + ], + ], + [ + 'name' => 'sha', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'example' => 'master', + 'required' => true, + 'type' => 'string', + ], + ], + [ + 'name' => 'contextLine', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => '3', + 'format' => 'int32', + 'required' => false, + 'type' => 'integer', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => 'Schema of Response', + 'properties' => [ + 'errorMessage' => [ + 'description' => '', + 'example' => '""', + 'type' => 'string', + ], + 'requestId' => [ + 'description' => 'Id of the request', + 'example' => '0EE38A4E-8991-532A-8E8B-5C22B5D2E058', + 'title' => 'Id of the request', + 'type' => 'string', + ], + 'errorCode' => [ + 'description' => '', + 'example' => 'success', + 'type' => 'string', + ], + 'success' => [ + 'description' => '', + 'example' => 'true', + 'type' => 'boolean', + ], + 'result' => [ + 'description' => '', + 'items' => [ + 'description' => '', + 'properties' => [ + 'oldId' => [ + 'description' => '', + 'example' => '0000000000000000000000000000000000000000', + 'type' => 'string', + ], + 'newId' => [ + 'description' => '', + 'example' => '6c268061a546378276559c713d0ad377d4xxxxxx', + 'type' => 'string', + ], + 'isNewLfs' => [ + 'description' => '', + 'example' => '', + 'type' => 'boolean', + ], + 'isOldLfs' => [ + 'description' => '', + 'example' => '', + 'type' => 'boolean', + ], + 'diff' => [ + 'description' => '', + 'example' => '--- /dev/null\\n+++ b/src/test/java/com/aliyun/codeupdemo/CodeupDemoApplicationTests.java\\n@@ -0,0 +1,13 @@\\n+package com.aliyun.codeupdemo;\\n+\\n+import org.junit.jupiter.api.Test;\\n+import org.springframework.boot.test.context.SpringBootTest;\\n+\\n+@SpringBootTest\\n+class CodeupDemoApplicationTest {\\n+\\n+ @Test\\n+ void contextLoads() {\\n+ }\\n+\\n+}\\n', + 'type' => 'string', + ], + 'newPath' => [ + 'description' => '', + 'example' => 'src/test/java/com/aliyun/codeupdemo/CodeupDemoApplicationTests.java', + 'type' => 'string', + ], + 'oldPath' => [ + 'description' => '', + 'example' => 'src/test/java/com/aliyun/codeupdemo/CodeupDemoApplicationTests.java', + 'type' => 'string', + ], + 'aMode' => [ + 'description' => '', + 'example' => '100644', + 'type' => 'string', + ], + 'bMode' => [ + 'description' => '', + 'example' => '100755', + 'type' => 'string', + ], + 'newFile' => [ + 'description' => '', + 'example' => '', + 'type' => 'boolean', + ], + 'renamedFile' => [ + 'description' => '', + 'example' => '', + 'type' => 'boolean', + ], + 'deletedFile' => [ + 'description' => '', + 'example' => '', + 'type' => 'boolean', + ], + 'isBinary' => [ + 'description' => '', + 'example' => '', + 'type' => 'boolean', + ], + ], + 'type' => 'object', + ], + 'type' => 'array', + ], + ], + 'title' => 'Schema of Response', + 'type' => 'object', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"requestId\\": \\"AB270BBA-EFB1-5773-B3DC-07CD036F7352\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": true,\\n \\"result\\": [\\n {\\n \\"oldId\\": \\"0000000000000000000000000000000000000000\\",\\n \\"newId\\": \\"6c268061a546378276559c713d0ad377d4dsjfh\\",\\n \\"isNewLfs\\": true,\\n \\"isOldLfs\\": true,\\n \\"diff\\": \\"--- /dev/null\\\\\\\\n+++ b/src/test/java/com/aliyun/codeupdemo/CodeupDemoApplicationTests.java\\\\\\\\n@@ -0,0 +1,13 @@\\\\\\\\n+package com.aliyun.codeupdemo;\\\\\\\\n+\\\\\\\\n+import org.junit.jupiter.api.Test;\\\\\\\\n+import org.springframework.boot.test.context.SpringBootTest;\\\\\\\\n+\\\\\\\\n+@SpringBootTest\\\\\\\\n+class CodeupDemoApplicationTest {\\\\\\\\n+\\\\\\\\n+ @Test\\\\\\\\n+ void contextLoads() {\\\\\\\\n+ }\\\\\\\\n+\\\\\\\\n+}\\\\\\\\n\\",\\n \\"newPath\\": \\"src/test/java/com/aliyun/codeupdemo/CodeupDemoApplicationTests.java\\",\\n \\"oldPath\\": \\"src/test/java/com/aliyun/codeupExample/CodeupDemoApplicationTests.java\\",\\n \\"aMode\\": \\"100644\\",\\n \\"bMode\\": \\"100755\\",\\n \\"newFile\\": false,\\n \\"renamedFile\\": false,\\n \\"deletedFile\\": false,\\n \\"isBinary\\": false\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListRepositoryCommitDiffResponse>\\n <errorMessage>\\"\\"</errorMessage>\\n <requestId>0EE38A4E-8991-532A-8E8B-5C22B5D2E058</requestId>\\n <errorCode>success</errorCode>\\n <success>true</success>\\n <result>\\n <oldId>0000000000000000000000000000000000000000</oldId>\\n <newId>6c268061a546378276559c713d0ad377d4xxxxxx</newId>\\n <isNewLfs>false</isNewLfs>\\n <isOldLfs>false</isOldLfs>\\n <diff>--- /dev/null\\\\n+++ b/src/test/java/com/aliyun/codeupdemo/CodeupDemoApplicationTests.java\\\\n@@ -0,0 +1,13 @@\\\\n+package com.aliyun.codeupdemo;\\\\n+\\\\n+import org.junit.jupiter.api.Test;\\\\n+import org.springframework.boot.test.context.SpringBootTest;\\\\n+\\\\n+@SpringBootTest\\\\n+class CodeupDemoApplicationTest {\\\\n+\\\\n+ @Test\\\\n+ void contextLoads() {\\\\n+ }\\\\n+\\\\n+}\\\\n</diff>\\n <newPath>src/test/java/com/aliyun/codeupdemo/CodeupDemoApplicationTests.java</newPath>\\n <oldPath>src/test/java/com/aliyun/codeupdemo/CodeupDemoApplicationTests.java</oldPath>\\n <aMode>100644</aMode>\\n <bMode>100755</bMode>\\n <newFile>false</newFile>\\n <renamedFile>false</renamedFile>\\n <deletedFile>false</deletedFile>\\n <isBinary>false</isBinary>\\n </result>\\n</ListRepositoryCommitDiffResponse>","errorExample":""}]', + ], + 'CreateCommitWithMultipleFiles' => [ + 'summary' => '单提交变更多个文件', + 'path' => '/api/v4/projects/repository/commits/files', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryIdentity', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'branch' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'master', + ], + 'commitMessage' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'auto', + ], + 'actions' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'action' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'create', + ], + 'filePath' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'src/test.java', + ], + 'previousPath' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'src/main/test.java', + ], + 'content' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'A7586FEB-E48D-5579-983F-74981FBFF627', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorMsg' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'error', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'de02b625ba8488f92eb204bcb3773a40c1b4ddac', + ], + 'shortId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'de02b625', + ], + 'title' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'authorName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'authorEmail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'authoredDate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 15:00:00', + ], + 'committerName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'committer-codeup', + ], + 'committerEmail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'committedDate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 16:00:00', + ], + 'parentIds' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ff4fb5ac6d1f44f452654336d2dba468ae6c8d04 ', + ], + ], + 'createdAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54', + ], + 'author' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19927', + ], + 'aliyunPk' => [ + 'description' => '', + 'type' => 'string', + 'example' => '284692704493684695', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'username' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'email' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'state' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c4ef67f1bea827c4/w/100/h/100', + ], + 'websiteUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + ], + ], + 'committer' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '24661', + ], + 'aliyunPk' => [ + 'description' => '', + 'type' => 'string', + 'example' => '235671547828975455', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'committer-codeup', + ], + 'username' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'committer-codeup', + ], + 'email' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'state' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'websiteUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A7586FEB-E48D-5579-983F-74981FBFF627\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"result\\": {\\n \\"id\\": \\"de02b625ba8488f92eb204bcb3773a40c1b4ddac\\",\\n \\"shortId\\": \\"de02b625\\",\\n \\"title\\": \\"提交标题\\",\\n \\"message\\": \\"具体的提交内容\\",\\n \\"authorName\\": \\"test-codeup\\",\\n \\"authorEmail\\": \\"[email protected]\\",\\n \\"authoredDate\\": \\"2022-03-18 15:00:00\\",\\n \\"committerName\\": \\"committer-codeup\\",\\n \\"committerEmail\\": \\"[email protected]\\",\\n \\"committedDate\\": \\"2022-03-18 16:00:00\\",\\n \\"parentIds\\": [\\n \\"ff4fb5ac6d1f44f452654336d2dba468ae6c8d04 \\"\\n ],\\n \\"createdAt\\": \\"2022-03-18 14:24:54\\",\\n \\"author\\": {\\n \\"id\\": 19927,\\n \\"aliyunPk\\": \\"1234567890\\",\\n \\"name\\": \\"test-codeup\\",\\n \\"username\\": \\"test-codeup\\",\\n \\"email\\": \\"[email protected]\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c4ef67f1bea827c4/w/100/h/100\\",\\n \\"websiteUrl\\": \\"\\\\\\"\\\\\\"\\"\\n },\\n \\"committer\\": {\\n \\"id\\": 24661,\\n \\"aliyunPk\\": \\"1234567890\\",\\n \\"name\\": \\"committer-codeup\\",\\n \\"username\\": \\"committer-codeup\\",\\n \\"email\\": \\"[email protected]\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"websiteUrl\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n }\\n}","type":"json"}]', + ], + 'AddRepositoryMember' => [ + 'summary' => '添加代码库成员', + 'path' => '/repository/{repositoryId}/members', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => '企业ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '60de7a6852743a5162b5f957'."\n", + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'title' => '代码库ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '2464454', + 'isFileTransferUrl' => false, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => '请求入参', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'aliyunPks' => [ + 'title' => '需要添加为代码库成员的用户阿里云ID。支持多个，以","分割', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '18745637472884', + ], + 'accessLevel' => [ + 'title' => '成员权限', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '30', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'title' => 'Codeup访问令牌，使用AK/SK方式访问可以不用填AccessToken', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'requestId' => [ + 'title' => '请求ID', + 'description' => '', + 'type' => 'string', + 'example' => '4D6AF7CC-B43B-5454-86AB-023D25E44868', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => 'Invalid.IdNotFound', + ], + 'success' => [ + 'title' => '请求状态', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'title' => '返回结果', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'email' => [ + 'title' => '邮箱', + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'avatarUrl' => [ + 'title' => '头像地址', + 'description' => '', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'state' => [ + 'title' => '状态', + 'description' => '', + 'type' => 'string', + 'example' => 'active', + ], + 'accessLevel' => [ + 'title' => '权限类型', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + 'id' => [ + 'title' => 'Codeup用户Id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"requestId\\": \\"4D6AF7CC-B43B-5454-86AB-023D25E44868\\",\\n \\"errorCode\\": \\"Invalid.IdNotFound\\",\\n \\"success\\": true,\\n \\"result\\": [\\n {\\n \\"email\\": \\"[email protected]\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"state\\": \\"active\\",\\n \\"accessLevel\\": 40,\\n \\"id\\": 123456\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<AddRepositoryMemberResponse>\\n <ErrorMessage>SYSTEM_NOT_FOUND_ERROR</ErrorMessage>\\n <RequestId>6177543A-8D54-5736-A93B-E0195A1512CB</RequestId>\\n <ErrorCode>404</ErrorCode>\\n <Success>true</Success>\\n <Result>\\n <ExternUserId>ea18szad13r42</ExternUserId>\\n <Email>[email protected]</Email>\\n <AvatarUrl>\\"\\"</AvatarUrl>\\n <State>active</State>\\n <AccessLevel>30</AccessLevel>\\n <Id>13</Id>\\n </Result>\\n</AddRepositoryMemberResponse>","errorExample":""}]', + ], + 'AddGroupMember' => [ + 'summary' => '添加组成员', + 'path' => '/repository/groups/{groupId}/members/create', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '22901', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'aliyunPks' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '18745637472884', + ], + 'accessLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '30', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'codeup', + ], + 'username' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'state' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'email' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'accessLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'sourceId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '223241', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"result\\": [\\n {\\n \\"id\\": 123456,\\n \\"name\\": \\"codeup\\",\\n \\"username\\": \\"test-codeup\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"email\\": \\"[email protected]\\",\\n \\"accessLevel\\": 30,\\n \\"sourceId\\": 223241\\n }\\n ]\\n}","type":"json"}]', + ], + 'DeleteRepositoryMember' => [ + 'summary' => '删除代码库成员', + 'path' => '/repository/{repositoryId}/members/delete/{aliyunPk}', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '632bbfdf419338aaa2b1360a', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513'."\n", + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2080398', + ], + ], + [ + 'name' => 'aliyunPk', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1789095186553536', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'memberType' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'USERS', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '0E1BCF81-51E6-59D4-8D55-FF945111127A', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30815', + ], + 'createAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-12 12:00:00', + ], + 'updateAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-12 12:00:00', + ], + 'sourceId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2080398', + ], + 'sourceType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Project', + ], + 'userId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19280', + ], + 'accessLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0E1BCF81-51E6-59D4-8D55-FF945111127A\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"id\\": 30815,\\n \\"createAt\\": \\"2022-03-12 12:00:00\\",\\n \\"updateAt\\": \\"2022-03-12 12:00:00\\",\\n \\"sourceId\\": 2080398,\\n \\"sourceType\\": \\"Project\\",\\n \\"userId\\": 19280,\\n \\"accessLevel\\": 30\\n }\\n}","type":"json"}]', + ], + 'DeleteGroupMember' => [ + 'summary' => '删除组成员', + 'path' => '/repository/groups/{groupId}/members/remove/aliyun_pk', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '6082a9b0c7972588ac363793', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '34410', + ], + ], + [ + 'name' => 'aliyunPk', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1789095186553536', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'memberType' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'USERS', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '4D6AF7CC-B43B-5454-86AB-023D25E44868', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '524836', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'codeup', + ], + 'username' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'state' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'accessLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + 'memberType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'USERS', + ], + 'sourceId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2080398', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"4D6AF7CC-B43B-5454-86AB-023D25E44868\\",\\n \\"errorMessage\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"id\\": 524836,\\n \\"name\\": \\"codeup\\",\\n \\"username\\": \\"test-codeup\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"accessLevel\\": 40,\\n \\"memberType\\": \\"USERS\\",\\n \\"sourceId\\": 2080398\\n }\\n}","type":"json"}]', + ], + 'UpdateRepositoryMember' => [ + 'summary' => '修改代码库成员的权限（角色）', + 'path' => '/repository/{repositoryId}/members/{aliyunPk}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '889910', + ], + ], + [ + 'name' => 'aliyunPk', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1232456789123467', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'accessLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + 'expireAt' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2020-08-08 08:08:08', + ], + 'memberType' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'USERS', + ], + 'relatedId' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '10010', + ], + 'relatedInfos' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'relatedId' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '10011', + ], + 'sourceId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '24790', + ], + 'sourceType' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Project', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'F590C9D8-E908-5B6C-95AC-56B7E8011FFA', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30815', + ], + 'state' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'normal', + ], + 'avatarUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'webUrl' => [ + 'description' => 'web url', + 'type' => 'string', + 'example' => '""', + ], + 'email' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'memberName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test_memeber_name', + ], + 'accessLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + 'expireAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-08-08 08:08:08', + ], + 'memberType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'USERS', + ], + 'sourceId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '223241', + ], + 'sourceType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Project', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'codeup', + ], + 'username' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'codeup-test', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"F590C9D8-E908-5B6C-95AC-56B7E8011FFA\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"success\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"id\\": 30815,\\n \\"state\\": \\"normal\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"webUrl\\": \\"\\\\\\"\\\\\\"\\",\\n \\"email\\": \\"[email protected]\\",\\n \\"memberName\\": \\"test_memeber_name\\",\\n \\"accessLevel\\": 40,\\n \\"expireAt\\": \\"2020-08-08 08:08:08\\",\\n \\"memberType\\": \\"USERS\\",\\n \\"sourceId\\": 223241,\\n \\"sourceType\\": \\"Project\\",\\n \\"name\\": \\"codeup\\",\\n \\"username\\": \\"codeup-test\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<UpdateRepositoryMemberResponse>\\n <requestId>F590C9D8-E908-5B6C-95AC-56B7E8011FFA</requestId>\\n <errorMessage>”“</errorMessage>\\n <errorCode>success</errorCode>\\n <success>true</success>\\n <result>\\n <id>30815</id>\\n <state>normal</state>\\n <avatarUrl>https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100</avatarUrl>\\n <externUid>01133501525635538279</externUid>\\n <webUrl>\\"\\"</webUrl>\\n <email>[email protected]</email>\\n <memberName>test_memeber_name</memberName>\\n <accessLevel>40</accessLevel>\\n <expireAt>2020-08-08 08:08:08</expireAt>\\n <tbUserId>sweadsajojiwe</tbUserId>\\n <memberType>USERS</memberType>\\n <sourceId>223241</sourceId>\\n <sourceType>Project</sourceType>\\n <name>codeup</name>\\n <username>codeup-test</username>\\n </result>\\n</UpdateRepositoryMemberResponse>","errorExample":""}]', + ], + 'UpdateGroupMember' => [ + 'summary' => '修改组成员', + 'path' => '/repository/groups/{groupId}/members/update/aliyun_pk', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '632bbfdf419338aaa2b1360a', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '22901', + ], + ], + [ + 'name' => 'aliyunPk', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1789095186553536', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'accessLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '30', + ], + 'memberType' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'USERS', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '24661', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'codeup', + ], + 'username' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'state' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'email' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'accessLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'memberType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'USERS', + ], + 'sourceId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '223241', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"id\\": 24661,\\n \\"name\\": \\"codeup\\",\\n \\"username\\": \\"test-codeup\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"email\\": \\"[email protected]\\",\\n \\"accessLevel\\": 30,\\n \\"memberType\\": \\"USERS\\",\\n \\"sourceId\\": 223241\\n }\\n}","type":"json"}]', + ], + 'ListRepositoryMemberWithInherited' => [ + 'summary' => '查询代码库成员列表', + 'path' => '/repository/{repositoryId}/members/list', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'title' => 'accessToken', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'title' => '仓库Id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '', + 'isFileTransferUrl' => false, + ], + ], + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => '企业Id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'requestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => '', + ], + 'result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'email' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'avatarUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'state' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'active', + ], + 'accessLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'codeup', + ], + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '', + ], + 'username' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'yunxiao', + ], + 'inherited' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'nameWithNamespace' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'pathWithNamespace' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'visibilityLevel' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'path' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'codeup', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'codeup', + ], + 'id' => [ + 'description' => 'id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"requestId\\": \\"AB270BBA-EFB1-5773-B3DC-07CD036F7352\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": true,\\n \\"result\\": [\\n {\\n \\"email\\": \\"[email protected]\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"state\\": \\"active\\",\\n \\"accessLevel\\": 30,\\n \\"name\\": \\"codeup\\",\\n \\"id\\": 19285,\\n \\"username\\": \\"yunxiao\\",\\n \\"inherited\\": {\\n \\"type\\": \\"Group\\",\\n \\"nameWithNamespace\\": \\"test / test-group（斜杠两边有空格）\\",\\n \\"pathWithNamespace\\": \\"test/test-group \\\\n\\",\\n \\"visibilityLevel\\": \\"0\\",\\n \\"path\\": \\"test-group\\",\\n \\"name\\": \\"test-group\\",\\n \\"id\\": 2022\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListRepositoryMemberWithInheritedResponse>\\n <errorMessage>error</errorMessage>\\n <requestId>56C33A95-C04F-59F0-B3CD-E2A2EB9FADBB</requestId>\\n <errorCode>None</errorCode>\\n <success>true</success>\\n <result>\\n <externUserId>5f969843cd2214ba0e24327d</externUserId>\\n <email>[email protected]</email>\\n <avatarUrl>https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100</avatarUrl>\\n <state>active</state>\\n <accessLevel>40</accessLevel>\\n <name>codeup</name>\\n <id>19946</id>\\n <username>yunxiao</username>\\n <inherited>\\n <type>GROUP</type>\\n <nameWithNamespace>test/codeup</nameWithNamespace>\\n <pathWithNamespace>test / codeup\\n</pathWithNamespace>\\n <visibilityLevel>0</visibilityLevel>\\n <path>codeup</path>\\n <name>codeup</name>\\n <id>123</id>\\n </inherited>\\n </result>\\n</ListRepositoryMemberWithInheritedResponse>","errorExample":""}]', + ], + 'GetProjectMember' => [ + 'summary' => '查询代码库成员', + 'path' => '/repository/{repositoryId}/members/get/{aliyunPk}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => '企业ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '5eb53bb338076f00011bcfd5', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'title' => 'accessToken（选填），使用AK方式调用时无需填accessToken', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'title' => '代码仓库Id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1869702', + ], + ], + [ + 'name' => 'aliyunPk', + 'in' => 'path', + 'schema' => [ + 'title' => '用户阿里云PK', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1232456789123467', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'requestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '30C99C69-A340-5E2E-ACE4-8888FF50CF52', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR'."\n", + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'accessLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'codeup', + ], + 'avatarUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c4ef67f1bea827c4/w/100/h/100', + ], + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2959', + ], + 'email' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"requestId\\": \\"30C99C69-A340-5E2E-ACE4-8888FF50CF52\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\\\n\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"accessLevel\\": 30,\\n \\"name\\": \\"codeup\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c4ef67f1bea827c4/w/100/h/100\\",\\n \\"id\\": 2959,\\n \\"email\\": \\"[email protected]\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetProjectMemberResponse>\\n <errorMessage>”“</errorMessage>\\n <requestId>30C99C69-A340-5E2E-ACE4-8888FF50CF52</requestId>\\n <errorCode>NOT_FOUND</errorCode>\\n <success>true</success>\\n <result>\\n <accessLevel>40</accessLevel>\\n <externUserId>5f969843cd2214ba0e24327d</externUserId>\\n <name>codeup</name>\\n <avatarUrl>https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c4ef67f1bea827c4/w/100/h/100</avatarUrl>\\n <id>2959</id>\\n </result>\\n</GetProjectMemberResponse>","errorExample":""}]', + ], + 'ListGroupMember' => [ + 'summary' => '查询组成员列表', + 'path' => '/repository/groups/{groupId}/list', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '632bbfdf419338aaa2b1360a', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513'."\n", + ], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '22901', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'C8F8B434-B006-59FB-8B9C-0382CF3D5680', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'username' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-codeup-nickname', + ], + 'state' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'email' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'accessLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'memberType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'USERS', + ], + 'sourceId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '223241', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C8F8B434-B006-59FB-8B9C-0382CF3D5680\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": true,\\n \\"result\\": [\\n {\\n \\"id\\": 123456,\\n \\"name\\": \\"test-codeup\\",\\n \\"username\\": \\"test-codeup-nickname\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"email\\": \\"[email protected]\\",\\n \\"accessLevel\\": 30,\\n \\"memberType\\": \\"USERS\\",\\n \\"sourceId\\": 223241\\n }\\n ]\\n}","type":"json"}]', + ], + 'CreateRepository' => [ + 'summary' => '创建(导入)代码库', + 'path' => '/repository/create', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'sync', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'createParentPath', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '代码库名称', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + 'path' => [ + 'title' => '代码库路径', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'namespaceId' => [ + 'title' => '代码库父路径id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '', + ], + 'description' => [ + 'title' => '代码库描述', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'visibilityLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'enumValueTitles' => [], + 'example' => '0', + ], + 'importUrl' => [ + 'title' => '导入地址（http协议地址）', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'https://github.com/a/b.git', + ], + 'importAccount' => [ + 'title' => '导入时使用的账号', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'codeup-test', + ], + 'importToken' => [ + 'title' => '导入时账号的token', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'xxxxx', + ], + 'importTokenEncrypted' => [ + 'title' => 'import_token字段的传输格式，使用明文或rsa加密', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'text', + ], + 'importDemoProject' => [ + 'title' => '使用使用demo库内容进行初始化', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'avatarUrl' => [ + 'title' => '代码库头像地址', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'readmeType' => [ + 'title' => '自动创建readme类型 (EMPTY: 仅创建README.md, USER_GUIDE: 包含新手引导)', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'USER_GUIDE' => '', + 'EMPTY' => '', + ], + 'example' => 'USER_GUIDE', + ], + 'importRepoType' => [ + 'title' => '导入代码库类型 (GIT: Git库, SVN: SVN库)', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'GIT', + ], + 'initStandardService' => [ + 'title' => '初始化标准智能化服务', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'gitignoreType' => [ + 'title' => 'gitignore模板类型', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Java', + ], + 'isCryptoEnabled' => [ + 'title' => '是否启用加密', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'localImportUrl' => [ + 'title' => '本地导入代码库的远程地址', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '""', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNAUTHORIZED_ERROR', + ], + 'requestId' => [ + 'title' => '请求ID', + 'description' => '', + 'type' => 'string', + 'example' => 'F590C9D8-E908-5B6C-95AC-56B7E8011FFA', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '401', + ], + 'success' => [ + 'title' => '调用是否成功', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => 'id', + 'description' => 'id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2959', + ], + 'description' => [ + 'title' => '描述', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'defaultBranch' => [ + 'title' => '默认分支', + 'description' => '', + 'type' => 'string', + 'example' => 'master', + ], + 'visibilityLevel' => [ + 'title' => '可见性。0：私有，10：内部公开', + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'sshUrlToRepo' => [ + 'title' => 'ssh地址', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'httpUrlToRepo' => [ + 'title' => 'http地址', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'webUrl' => [ + 'title' => 'web url', + 'description' => 'web url', + 'type' => 'string', + 'example' => '""', + ], + 'name' => [ + 'title' => '名称', + 'description' => '', + 'type' => 'string', + 'example' => 'codeupTest', + ], + 'nameWithNamespace' => [ + 'title' => '名称（含父路径）', + 'description' => '', + 'type' => 'string', + 'example' => 'codeup-test-org / test-codeup', + ], + 'path' => [ + 'title' => '路径', + 'description' => '', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'pathWithNamespace' => [ + 'title' => '路径（含父路径）', + 'description' => '', + 'type' => 'string', + 'example' => 'codeup-test-org/test-codeup', + ], + 'createdAt' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'string', + 'example' => '2022-01-14T21:08:26+08:00', + ], + 'lastActivityAt' => [ + 'title' => '最后活跃时间', + 'description' => '', + 'type' => 'string', + 'example' => '2022-01-14T21:08:26+08:00', + ], + 'creatorId' => [ + 'title' => '创建者id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1233', + ], + 'namespace' => [ + 'title' => '父路径信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => 'id', + 'description' => 'id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3194', + ], + 'name' => [ + 'title' => '名称', + 'description' => '', + 'type' => 'string', + 'example' => 'codeup', + ], + 'path' => [ + 'title' => '路径', + 'description' => '', + 'type' => 'string', + 'example' => 'codeup', + ], + 'ownerId' => [ + 'title' => '归属者id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'createdAt' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'string', + 'example' => '2022-01-14T21:08:26+08:00', + ], + 'updatedAt' => [ + 'title' => '更新时间', + 'description' => '', + 'type' => 'string', + 'example' => '2022-01-14T21:08:26+08:00', + ], + 'description' => [ + 'title' => '描述', + 'description' => '', + 'type' => 'string', + 'example' => 'codeup repo description', + ], + 'avatar' => [ + 'title' => '头像地址', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'public' => [ + 'title' => '公开性', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'visibilityLevel' => [ + 'title' => '可见性。0：私有，10：内部公开', + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + 'archived' => [ + 'title' => '归档标识', + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'avatar_url' => [ + 'title' => '代码库头像地址', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'demoProject' => [ + 'title' => 'demo库标识', + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Import_from_svn' => [ + 'title' => '从SVN导入', + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"errorMessage\\": \\"SYSTEM_UNAUTHORIZED_ERROR\\",\\n \\"requestId\\": \\"F590C9D8-E908-5B6C-95AC-56B7E8011FFA\\",\\n \\"errorCode\\": \\"401\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"id\\": 2959,\\n \\"description\\": \\"线下测试\\",\\n \\"defaultBranch\\": \\"master\\",\\n \\"visibilityLevel\\": \\"0\\",\\n \\"sshUrlToRepo\\": \\"\\\\\\"\\\\\\"\\",\\n \\"httpUrlToRepo\\": \\"\\\\\\"\\\\\\"\\",\\n \\"webUrl\\": \\"\\\\\\"\\\\\\"\\",\\n \\"name\\": \\"codeupTest\\",\\n \\"nameWithNamespace\\": \\"codeup-test-org / test-codeup\\",\\n \\"path\\": \\"test-codeup\\",\\n \\"pathWithNamespace\\": \\"codeup-test-org/test-codeup\\",\\n \\"createdAt\\": \\"2022-01-14T21:08:26+08:00\\",\\n \\"lastActivityAt\\": \\"2022-01-14T21:08:26+08:00\\",\\n \\"creatorId\\": 1233,\\n \\"namespace\\": {\\n \\"id\\": 3194,\\n \\"name\\": \\"codeup\\",\\n \\"path\\": \\"codeup\\",\\n \\"ownerId\\": 123,\\n \\"createdAt\\": \\"2022-01-14T21:08:26+08:00\\",\\n \\"updatedAt\\": \\"2022-01-14T21:08:26+08:00\\",\\n \\"description\\": \\"codeup repo description\\",\\n \\"avatar\\": \\"\\\\\\"\\\\\\"\\",\\n \\"public\\": true,\\n \\"visibilityLevel\\": \\"0\\"\\n },\\n \\"archived\\": false,\\n \\"avatar_url\\": \\"\\\\\\"\\\\\\"\\",\\n \\"demoProject\\": false,\\n \\"Import_from_svn\\": false\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateRepositoryResponse>\\n <errorMessage>SYSTEM_UNAUTHORIZED_ERROR</errorMessage>\\n <requestId>F590C9D8-E908-5B6C-95AC-56B7E8011FFA</requestId>\\n <errorCode>401</errorCode>\\n <success>true</success>\\n <result>\\n <id>2959</id>\\n <description>线下测试</description>\\n <defaultBranch>master</defaultBranch>\\n <visibilityLevel>0</visibilityLevel>\\n <sshUrlToRepo>\\"\\"</sshUrlToRepo>\\n <httpUrlToRepo>\\"\\"</httpUrlToRepo>\\n <webUrl>\\"\\"</webUrl>\\n <name>codeupTest</name>\\n <nameWithNamespace>codeup-test-org / test-codeup</nameWithNamespace>\\n <path>test-codeup</path>\\n <pathWithNamespace>codeup-test-org/test-codeup</pathWithNamespace>\\n <createdAt>2022-01-14T21:08:26+08:00</createdAt>\\n <lastActivityAt>2022-01-14T21:08:26+08:00</lastActivityAt>\\n <creatorId>1233</creatorId>\\n <namespace>\\n <id>3194</id>\\n <name>codeup</name>\\n <path>codeup</path>\\n <ownerId>123</ownerId>\\n <createdAt>2022-01-14T21:08:26+08:00</createdAt>\\n <updatedAt>2022-01-14T21:08:26+08:00</updatedAt>\\n <description>codeup repo description</description>\\n <avatar>\\"\\"</avatar>\\n <public>true</public>\\n <visibilityLevel>0</visibilityLevel>\\n </namespace>\\n <archived>false</archived>\\n <avatar_url>\\"\\"</avatar_url>\\n <demoProject>false</demoProject>\\n <Import_from_svn>false</Import_from_svn>\\n </result>\\n</CreateRepositoryResponse>","errorExample":""}]', + ], + 'DeleteRepository' => [ + 'summary' => '删除代码库', + 'path' => '/repository/{repositoryId}/remove', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '6082a9b0c7972588ac363793', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2464454', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'reason' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'A7586FEB-E48D-5579-983F-74981FBFF627', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A7586FEB-E48D-5579-983F-74981FBFF627\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"result\\": true\\n }\\n}","type":"json"}]', + ], + 'UpdateRepository' => [ + 'summary' => '更新代码库名称、路径、描述、默认分支等设置', + 'path' => '/repository/{repositoryId}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'c3c09f1230187a879678da43c973d069', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2080398', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2080398', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'codeup', + ], + 'path' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'description' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'defaultBranch' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'master', + ], + 'issuesEnabled' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'mergeRequestsEnabled' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'buildsEnabled' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'wikiEnabled' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'snippetsEnabled' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'visibilityLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'checkEmail' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'avatar' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'https://xxxx', + ], + 'openCloneDownloadControl' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'projectCloneDownloadRoleList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'roleCode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '15', + ], + 'allowed' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'projectCloneDownloadMethodList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'permissionCode' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'project:download', + ], + 'allowed' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'adminSettingLanguage' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Java', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'EAE03103-5497-58D1-9169-E524DDE8604C', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '“”', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR'."\n", + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2825387', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'codeup', + ], + 'nameWithNamespace' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'path' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'codeup', + ], + 'pathWithNamespace' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'codeup-test-org / codeup', + ], + 'description' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'defaultBranch' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'master', + ], + 'visibilityLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'sshUrlToRepo' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]:xxx/test/test.git'."\n", + ], + 'httpUrlToRepo' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://codeup.aliyun.com/xxx/test/test.git'."\n", + ], + 'webUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://codeup.aliyun.com/xxx/test/test'."\n", + ], + 'issuesEnabled' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'mergeRequestsEnabled' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'buildsEnabled' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'wikiEnabled' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'snippetsEnabled' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'createdAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54', + ], + 'lastActivityAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-20 14:24:54', + ], + 'creatorId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19238', + ], + 'namespace' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '29322', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'codeup', + ], + 'path' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'ownerId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19238', + ], + 'createdAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-02-18 14:24:54', + ], + 'updatedAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54', + ], + 'description' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'avatar' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://xxx', + ], + 'visibilityLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + 'archived' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'avatarUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"EAE03103-5497-58D1-9169-E524DDE8604C\\",\\n \\"errorMessage\\": \\"“”\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\\\n\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"id\\": 2825387,\\n \\"name\\": \\"codeup\\",\\n \\"nameWithNamespace\\": \\"codeup-test-org / codeup（斜杠两侧有空格）\\",\\n \\"path\\": \\"codeup\\",\\n \\"pathWithNamespace\\": \\"codeup-test-org / codeup\\",\\n \\"description\\": \\"codeup代码库描述\\",\\n \\"defaultBranch\\": \\"master\\",\\n \\"visibilityLevel\\": 0,\\n \\"sshUrlToRepo\\": \\"[email protected]:xxx/test/test.git\\\\n\\",\\n \\"httpUrlToRepo\\": \\"https://codeup.aliyun.com/xxx/test/test.git\\\\n\\",\\n \\"webUrl\\": \\"https://codeup.aliyun.com/xxx/test/test\\\\n\\",\\n \\"issuesEnabled\\": true,\\n \\"mergeRequestsEnabled\\": true,\\n \\"buildsEnabled\\": false,\\n \\"wikiEnabled\\": true,\\n \\"snippetsEnabled\\": false,\\n \\"createdAt\\": \\"2022-03-18 14:24:54\\",\\n \\"lastActivityAt\\": \\"2022-03-20 14:24:54\\",\\n \\"creatorId\\": 19238,\\n \\"namespace\\": {\\n \\"id\\": 29322,\\n \\"name\\": \\"codeup\\",\\n \\"path\\": \\"地址：https://codeup.aliyun.com/60d54f3daccf2bbd6659f3ad/blank923/repo-test\\\\n组路径：blank923\\\\n企业路径：60d54f3daccf2bbd6659f3ad\\",\\n \\"ownerId\\": 19238,\\n \\"createdAt\\": \\"2022-02-18 14:24:54\\",\\n \\"updatedAt\\": \\"2022-03-18 14:24:54\\",\\n \\"description\\": \\"组或企业空间的描述信息\\",\\n \\"avatar\\": \\"https://xxx\\",\\n \\"visibilityLevel\\": 0\\n },\\n \\"archived\\": false,\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\"\\n }\\n}","type":"json"}]', + ], + 'TriggerRepositoryMirrorSync' => [ + 'summary' => '触发仓库同步', + 'path' => '/repository/{repositoryId}/mirror', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'title' => '个人访问令牌。 使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513'."\n", + ], + ], + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https://devops.aliyun.com/organization/', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'title' => '代码库ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '100', + ], + ], + [ + 'name' => 'account', + 'in' => 'query', + 'schema' => [ + 'title' => '远程同步库克隆账号', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test-account', + ], + ], + [ + 'name' => 'token', + 'in' => 'query', + 'schema' => [ + 'title' => '远程同步库克隆令牌', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'asd12e44827fe2444f952e931e51xxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '企业不存在', + ], + 'requestId' => [ + 'title' => '请求ID', + 'description' => '', + 'type' => 'string', + 'example' => '37294673-00CA-5B8B-914F-A8B35511E90A', + ], + 'success' => [ + 'title' => '请求结果', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_ILLEGAL_ARGUMENT_ERROR', + ], + 'result' => [ + 'title' => '响应结果', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'title' => '仓库同步触发结果', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + [ + [ + 'errorCode' => 'InvalidWorkspace.NotFound', + 'errorMessage' => 'The workspace is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"errorMessage\\": \\"企业不存在\\",\\n \\"requestId\\": \\"37294673-00CA-5B8B-914F-A8B35511E90A\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"SYSTEM_ILLEGAL_ARGUMENT_ERROR\\",\\n \\"result\\": {\\n \\"result\\": true\\n }\\n}","errorExample":""},{"type":"xml","example":"<TriggerRepositoryMirrorSyncResponse>\\n <errorMessage>xxx</errorMessage>\\n <requestId>xxxx-xxxx-xxx-xxxxx</requestId>\\n <success>true</success>\\n <errorCode>SYSTEM_ILLEGAL_ARGUMENT_ERROR</errorCode>\\n <result>\\n <result>true</result>\\n </result>\\n</TriggerRepositoryMirrorSyncResponse>","errorExample":""}]', + 'title' => 'TriggerRepositoryMirrorSync', + ], + 'TransferRepository' => [ + 'summary' => '转移代码库', + 'path' => '/api/v4/projects/repository/transfer', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'groupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19285', + ], + 'path' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-repo', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-repo', + ], + 'description' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'pathWithNamespace' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'codeup-test-org/test-create-codeup', + ], + 'nameWithNamespace' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'visibilityLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'lastActivityAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-01-14T21:08:26+08:00', + ], + 'starCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'webUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'starred' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'namespaceId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100003', + ], + 'accessLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'demoProject' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'createdAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-01-14T21:08:26+08:00', + ], + 'updatedAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-01-14T21:08:26+08:00', + ], + 'archived' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'creatorId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19238', + ], + 'encrypted' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"id\\": 19285,\\n \\"path\\": \\"test-repo\\",\\n \\"name\\": \\"test-repo\\",\\n \\"description\\": \\"描述信息的具体内容\\\\n\\",\\n \\"pathWithNamespace\\": \\"codeup-test-org/test-create-codeup\\",\\n \\"nameWithNamespace\\": \\"codeup-test-org / test-create-group （斜杠两侧有空格）\\",\\n \\"visibilityLevel\\": 0,\\n \\"lastActivityAt\\": \\"2022-01-14T21:08:26+08:00\\",\\n \\"starCount\\": 0,\\n \\"webUrl\\": \\"\\\\\\"\\\\\\"\\",\\n \\"starred\\": true,\\n \\"namespaceId\\": 100003,\\n \\"accessLevel\\": 30,\\n \\"demoProject\\": false,\\n \\"createdAt\\": \\"2022-01-14T21:08:26+08:00\\",\\n \\"updatedAt\\": \\"2022-01-14T21:08:26+08:00\\",\\n \\"archived\\": false,\\n \\"creatorId\\": 19238,\\n \\"encrypted\\": false\\n }\\n}","type":"json"}]', + ], + 'ListRepositories' => [ + 'summary' => '查询代码库列表', + 'path' => '/repository/list', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => '企业ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'title' => 'accessToken', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'page', + 'in' => 'query', + 'schema' => [ + 'title' => '页码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'perPage', + 'in' => 'query', + 'schema' => [ + 'title' => '每页大小', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'orderBy', + 'in' => 'query', + 'schema' => [ + 'title' => '排序字段', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'created_at', + ], + ], + [ + 'name' => 'sort', + 'in' => 'query', + 'schema' => [ + 'title' => '排序方式 (desc: 降序, asc: 升序)', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + [ + 'name' => 'search', + 'in' => 'query', + 'schema' => [ + 'title' => '搜索关键字', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Demo', + ], + ], + [ + 'name' => 'archived', + 'in' => 'query', + 'schema' => [ + 'title' => '是否列出归档项目', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'minAccessLevel', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求requestId', + 'description' => '', + 'type' => 'string', + 'example' => '4D6AF7CC-B43B-5454-86AB-023D25E44868', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'total' => [ + 'title' => '总数量', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '149', + ], + 'success' => [ + 'title' => '调用是否成功', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '', + ], + 'result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'lastActivityAt' => [ + 'title' => '最后活跃时间', + 'description' => '', + 'type' => 'string', + 'example' => '2022-01-14T21:08:26+08:00', + ], + 'namespaceId' => [ + 'title' => '上级路径的id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '745', + ], + 'avatarUrl' => [ + 'title' => '头像地址', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'starCount' => [ + 'title' => '被收藏的数量', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'archive' => [ + 'title' => '代码库是否归档', + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'createdAt' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'string', + 'example' => '2022-01-14T21:08:26+08:00', + ], + 'star' => [ + 'title' => '是否被收藏', + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'importStatus' => [ + 'title' => '代码库导入状态', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'webUrl' => [ + 'title' => '页面访问时的URL', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'description' => [ + 'title' => '代码库描述', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'nameWithNamespace' => [ + 'title' => '代码库完整名称（含完整组名称）', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'pathWithNamespace' => [ + 'title' => '代码库完整路径（含完整组路径）', + 'description' => '', + 'type' => 'string', + 'example' => 'codeup-test-org/test-codeup', + ], + 'path' => [ + 'title' => '代码库路径', + 'description' => '', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'visibilityLevel' => [ + 'title' => '可见性;0标识私有的/10标识企业内公开', + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'accessLevel' => [ + 'title' => '当前用户在该代码库上的权限类型', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + 'updatedAt' => [ + 'title' => '更新时间', + 'description' => '', + 'type' => 'string', + 'example' => '2022-01-14T21:08:26+08:00', + ], + 'name' => [ + 'title' => '代码库名称', + 'description' => '', + 'type' => 'string', + 'example' => 'codeupTest', + ], + 'Id' => [ + 'title' => '代码库Id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"4D6AF7CC-B43B-5454-86AB-023D25E44868\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"total\\": 149,\\n \\"success\\": true,\\n \\"errorCode\\": 0,\\n \\"result\\": [\\n {\\n \\"lastActivityAt\\": \\"2022-01-14T21:08:26+08:00\\",\\n \\"namespaceId\\": 745,\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"starCount\\": 0,\\n \\"archive\\": false,\\n \\"createdAt\\": \\"2022-01-14T21:08:26+08:00\\",\\n \\"star\\": false,\\n \\"importStatus\\": \\"started\\",\\n \\"webUrl\\": \\"\\\\\\"\\\\\\"\\",\\n \\"description\\": \\"测试Codeup托管\\",\\n \\"nameWithNamespace\\": \\"codeup-test-org / test-codeup（斜杠两侧有空格）\\",\\n \\"pathWithNamespace\\": \\"codeup-test-org/test-codeup\\",\\n \\"path\\": \\"test-codeup\\",\\n \\"visibilityLevel\\": \\"0\\",\\n \\"accessLevel\\": 40,\\n \\"updatedAt\\": \\"2022-01-14T21:08:26+08:00\\",\\n \\"name\\": \\"codeupTest\\",\\n \\"Id\\": 1\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListRepositoriesResponse>\\n <requestId>4D6AF7CC-B43B-5454-86AB-023D25E44868</requestId>\\n <errorMessage>\\"\\"</errorMessage>\\n <total>149</total>\\n <success>true</success>\\n <result>\\n <lastActivityAt>2022-01-14T21:08:26+08:00</lastActivityAt>\\n <namespaceId>745</namespaceId>\\n <avatarUrl>\\"\\"</avatarUrl>\\n <starCount>0</starCount>\\n <archive>false</archive>\\n <createdAt>2022-01-14T21:08:26+08:00</createdAt>\\n <star>false</star>\\n <importStatus>\\"\\"</importStatus>\\n <webUrl>\\"\\"</webUrl>\\n <description>测试Codeup托管</description>\\n <nameWithNamespace>codeup-test-org / test-codeup</nameWithNamespace>\\n <pathWithNamespace>codeup-test-org/test-codeup</pathWithNamespace>\\n <path>test-codeup</path>\\n <visibilityLevel>0</visibilityLevel>\\n <accessLevel>40</accessLevel>\\n <updatedAt>2022-01-14T21:08:26+08:00</updatedAt>\\n <name>codeupTest</name>\\n <Id>1</Id>\\n </result>\\n</ListRepositoriesResponse>","errorExample":""}]', + ], + 'GetRepository' => [ + 'summary' => '使用代码库ID或路径查询代码库信息', + 'path' => '/repository/get', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => '企业ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'title' => '个人访问令牌', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'identity', + 'in' => 'query', + 'schema' => [ + 'title' => '代码库ID或路径', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '100', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结果', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => '', + 'type' => 'string', + 'example' => '37294673-00CA-5B8B-914F-A8B35511E90A', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => '请求是否成功', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'repository' => [ + 'title' => '代码库信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'archive' => [ + 'title' => '归档标识', + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'avatarUrl' => [ + 'title' => '代码库头像地址', + 'description' => '', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'createdAt' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'string', + 'example' => '2020-06-19T04:02:00.744Z', + ], + 'creatorId' => [ + 'title' => '创建者ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19258', + ], + 'defaultBranch' => [ + 'title' => '默认分支', + 'description' => '', + 'type' => 'string', + 'example' => 'master', + ], + 'demoProjectStatus' => [ + 'title' => 'DEMO库标识', + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'description' => [ + 'title' => '描述', + 'description' => '', + 'type' => 'string', + 'example' => 'repo desc', + ], + 'httpUrlToRepository' => [ + 'title' => 'HTTP克隆地址', + 'description' => '', + 'type' => 'string', + 'example' => 'https://codeup.aliyun.com/xxx/test/test.git', + ], + 'id' => [ + 'title' => '代码库ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'lastActivityAt' => [ + 'title' => '最后活跃时间', + 'description' => '', + 'type' => 'string', + 'example' => '2020-06-19T04:02:00.744Z', + ], + 'name' => [ + 'title' => '名称', + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'nameWithNamespace' => [ + 'title' => '名称（含父名称）', + 'description' => '', + 'type' => 'string', + 'example' => 'test / test', + ], + 'namespace' => [ + 'title' => '父空间', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => 'id', + 'description' => 'id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'avatar' => [ + 'title' => '头像地址', + 'description' => '', + 'type' => 'string', + 'example' => 'https://xxx.jpg', + ], + 'createdAt' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'string', + 'example' => '2020-06-19T04:02:00.744Z', + ], + 'description' => [ + 'title' => '描述', + 'description' => '', + 'type' => 'string', + 'example' => 'repo desc', + ], + 'name' => [ + 'title' => '名称', + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + 'ownerId' => [ + 'title' => '归属者ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'path' => [ + 'title' => '路径', + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'updatedAt' => [ + 'title' => '更新时间', + 'description' => '', + 'type' => 'string', + 'example' => '2020-06-19T04:02:00.744Z', + ], + 'visibilityLevel' => [ + 'title' => '可见性。0：私有，10：内部公开', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + 'path' => [ + 'title' => '路径', + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'pathWithNamespace' => [ + 'title' => '路径（含父路径）', + 'description' => '', + 'type' => 'string', + 'example' => 'test/test', + ], + 'sshUrlToRepository' => [ + 'title' => 'SSH克隆地址', + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]:xxx/test/test.git', + ], + 'visibilityLevel' => [ + 'title' => '可见性。0：私有，10：内部公开', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'webUrl' => [ + 'title' => '页面访问地址', + 'description' => '', + 'type' => 'string', + 'example' => 'https://codeup.aliyun.com/xxx/test/test', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"37294673-00CA-5B8B-914F-A8B35511E90A\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"repository\\": {\\n \\"archive\\": false,\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"createdAt\\": \\"2020-06-19T04:02:00.744Z\\",\\n \\"creatorId\\": 19258,\\n \\"defaultBranch\\": \\"master\\",\\n \\"demoProjectStatus\\": false,\\n \\"description\\": \\"repo desc\\",\\n \\"httpUrlToRepository\\": \\"https://codeup.aliyun.com/xxx/test/test.git\\",\\n \\"id\\": 100,\\n \\"lastActivityAt\\": \\"2020-06-19T04:02:00.744Z\\",\\n \\"name\\": \\"test\\",\\n \\"nameWithNamespace\\": \\"test / test（斜杠两侧有空格）\\",\\n \\"namespace\\": {\\n \\"id\\": 100,\\n \\"avatar\\": \\"https://xxx.jpg\\",\\n \\"createdAt\\": \\"2020-06-19T04:02:00.744Z\\",\\n \\"description\\": \\"repo desc\\",\\n \\"name\\": \\"xxx\\",\\n \\"ownerId\\": 100,\\n \\"path\\": \\"test\\",\\n \\"updatedAt\\": \\"2020-06-19T04:02:00.744Z\\",\\n \\"visibilityLevel\\": 0\\n },\\n \\"path\\": \\"test\\",\\n \\"pathWithNamespace\\": \\"test/test\\",\\n \\"sshUrlToRepository\\": \\"[email protected]:xxx/test/test.git\\",\\n \\"visibilityLevel\\": 0,\\n \\"webUrl\\": \\"https://codeup.aliyun.com/xxx/test/test\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetRepositoryResponse>\\n <requestId>37294673-00CA-5B8B-914F-A8B35511E90A</requestId>\\n <errorCode>null</errorCode>\\n <errorMessage>null</errorMessage>\\n <success>false</success>\\n <repository>\\n <archive>false</archive>\\n <avatarUrl>https://xxx.jpg</avatarUrl>\\n <createdAt>2020-06-19T04:02:00.744Z</createdAt>\\n <creatorId>100</creatorId>\\n <defaultBranch>master</defaultBranch>\\n <demoProjectStatus>false</demoProjectStatus>\\n <description>repo desc</description>\\n <httpUrlToRepository>https://codeup.aliyun.com/xxx/test/test.git</httpUrlToRepository>\\n <id>100</id>\\n <lastActivityAt>2020-06-19T04:02:00.744Z</lastActivityAt>\\n <name>test</name>\\n <nameWithNamespace>test / test</nameWithNamespace>\\n <namespace>\\n <id>100</id>\\n <avatar>https://xxx.jpg</avatar>\\n <createdAt>2020-06-19T04:02:00.744Z</createdAt>\\n <description>repo desc</description>\\n <name>xxx</name>\\n <ownerId>100</ownerId>\\n <path>test</path>\\n <updatedAt>2020-06-19T04:02:00.744Z</updatedAt>\\n <visibilityLevel>0</visibilityLevel>\\n </namespace>\\n <path>test</path>\\n <pathWithNamespace>test/test</pathWithNamespace>\\n <sshUrlToRepository>[email protected]:xxx/test/test.git</sshUrlToRepository>\\n <visibilityLevel>0</visibilityLevel>\\n <webUrl>https://codeup.aliyun.com/xxx/test/test</webUrl>\\n </repository>\\n</GetRepositoryResponse>","errorExample":""}]', + ], + 'CreateBranch' => [ + 'summary' => '创建分支', + 'path' => '/repository/{repositoryId}/branches', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '0cf2c8458ac44d9481aab2dd6ec10596v3'."\n", + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2334815', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'branchName' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'createBranch', + ], + 'ref' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'master', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'createBranch', + ], + 'protected' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'commit' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ff4fb5ac6d1f44f452654336d2dba468ae6c8d04', + ], + 'shortId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ff4fb5ac', + ], + 'title' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'authorName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'authorEmail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'createdAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 10:00:00', + ], + 'message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'create branch', + ], + 'authoredDate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 09:00:00', + ], + 'committedDate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 10:00:00', + ], + 'committerEmail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'committerName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'parentIds' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '34d2c47c7ce46a5c4639c5ffe208a66dda975a05', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F7B85D1B-D1C2-140F-A039-341859F130B9\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"name\\": \\"createBranch\\",\\n \\"protected\\": false,\\n \\"commit\\": {\\n \\"id\\": \\"ff4fb5ac6d1f44f452654336d2dba468ae6c8d04\\",\\n \\"shortId\\": \\"ff4fb5ac\\",\\n \\"title\\": \\"创建代码库分支\\",\\n \\"authorName\\": \\"阿里云云效\\",\\n \\"authorEmail\\": \\"[email protected]\\",\\n \\"createdAt\\": \\"2022-03-18 10:00:00\\",\\n \\"message\\": \\"create branch\\",\\n \\"authoredDate\\": \\"2022-03-18 09:00:00\\",\\n \\"committedDate\\": \\"2022-03-18 10:00:00\\",\\n \\"committerEmail\\": \\"[email protected]\\",\\n \\"committerName\\": \\"阿里云云效committer\\",\\n \\"parentIds\\": [\\n \\"34d2c47c7ce46a5c4639c5ffe208a66dda975a05\\"\\n ]\\n }\\n }\\n}","type":"json"}]', + ], + 'CreateProtectdBranch' => [ + 'summary' => '创建保护分支', + 'path' => '/repository/{repositoryId}/protect_branches', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2813891', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '--', + ], + 'branch' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'protectBranch', + ], + 'allowPushRoles' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '[40, 30]', + ], + 'required' => false, + ], + 'allowPushUserIds' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'required' => false, + ], + 'allowMergeRoles' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '[40, 30]', + ], + 'required' => true, + ], + 'allowMergeUserIds' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'required' => false, + ], + 'mergeRequestSetting' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'isRequired' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'mrMode' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'general', + ], + 'isAllowSelfApproval' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'isRequireDiscussionProcessed' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'isResetApprovalWhenNewPush' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'minimumApproval' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'allowMergeRequestRoles' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '[40, 30]', + ], + 'required' => false, + ], + 'defaultAssignees' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1234567891234567', + ], + 'required' => false, + ], + 'whiteList' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '**.java', + ], + ], + 'required' => false, + ], + 'testSettingDTO' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'isRequired' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'codeGuidelinesDetection' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'enabled' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'message' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test_code_guide_lines', + ], + ], + 'required' => false, + ], + 'sensitiveInfoDetection' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'enabled' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'message' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test_code_sensitive_info', + ], + ], + 'required' => false, + ], + 'checkTaskQualityConfig' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'enabled' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'bizNo' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '123456', + ], + 'taskName' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'bz-task-quality', + ], + 'message' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test_task_quality', + ], + ], + 'required' => false, + ], + 'checkConfig' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'checkItems' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'isRequired' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'C2F153F6-BB43-50C4-9F4F-40593203E19A', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5240', + ], + 'branch' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'protectBranch', + ], + 'allowPushRoles' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + ], + 'allowPushUserIds' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19238', + ], + ], + 'allowMergeRoles' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + ], + 'allowMergeUserIds' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19238', + ], + ], + 'mergeRequestSetting' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'isRequired' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'mrMode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'general', + ], + 'isAllowSelfApproval' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'isRequireDiscussionProcessed' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'isResetApprovalWhenNewPush' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'minimumApproval' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'allowMergeRequestRoles' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + ], + 'defaultAssignees' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '5f969843cd2214ba0e24327d', + ], + ], + 'whiteList' => [ + 'description' => '', + 'type' => 'string', + 'example' => '**.java', + ], + ], + ], + 'testSettingDTO' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'isRequired' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'codeGuidelinesDetection' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'enabled' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test_code_guide_lines', + ], + ], + ], + 'sensitiveInfoDetection' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'enabled' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test_code_sensitive_info', + ], + ], + ], + 'checkTaskQualityConfig' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'enabled' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'bizNo' => [ + 'description' => '', + 'type' => 'string', + 'example' => '123456', + ], + 'taskName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'biz-task-quality', + ], + 'message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test_task_quality', + ], + ], + ], + 'checkConfig' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'checkItems' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'isRequired' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C2F153F6-BB43-50C4-9F4F-40593203E19A\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"id\\": 5240,\\n \\"branch\\": \\"protectBranch\\",\\n \\"allowPushRoles\\": [\\n 40\\n ],\\n \\"allowPushUserIds\\": [\\n 19238\\n ],\\n \\"allowMergeRoles\\": [\\n 40\\n ],\\n \\"allowMergeUserIds\\": [\\n 19238\\n ],\\n \\"mergeRequestSetting\\": {\\n \\"isRequired\\": true,\\n \\"mrMode\\": \\"general\\",\\n \\"isAllowSelfApproval\\": true,\\n \\"isRequireDiscussionProcessed\\": true,\\n \\"isResetApprovalWhenNewPush\\": false,\\n \\"minimumApproval\\": 1,\\n \\"allowMergeRequestRoles\\": [\\n 40\\n ],\\n \\"defaultAssignees\\": [\\n \\"5f969843cd2214ba0e24327d\\"\\n ],\\n \\"whiteList\\": \\"**.java\\"\\n },\\n \\"testSettingDTO\\": {\\n \\"isRequired\\": false,\\n \\"codeGuidelinesDetection\\": {\\n \\"enabled\\": false,\\n \\"message\\": \\"test_code_guide_lines\\"\\n },\\n \\"sensitiveInfoDetection\\": {\\n \\"enabled\\": false,\\n \\"message\\": \\"test_code_sensitive_info\\"\\n },\\n \\"checkTaskQualityConfig\\": {\\n \\"enabled\\": false,\\n \\"bizNo\\": \\"123456\\",\\n \\"taskName\\": \\"biz-task-quality\\",\\n \\"message\\": \\"test_task_quality\\"\\n },\\n \\"checkConfig\\": {\\n \\"checkItems\\": [\\n {\\n \\"name\\": \\"测试流水线\\",\\n \\"isRequired\\": false\\n }\\n ]\\n }\\n }\\n }\\n}","type":"json"}]', + ], + 'DeleteBranch' => [ + 'summary' => '删除分支', + 'path' => '/repository/{repositoryId}/branches/delete', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '619b80042f595dbd1b9b0de2', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2185366', + ], + ], + [ + 'name' => 'branchName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'deleteBranch', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '6177543A-8D54-5736-A93B-E0195A1512CB', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'success' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'branchName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'deleteBranch', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"6177543A-8D54-5736-A93B-E0195A1512CB\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": \\"true\\",\\n \\"result\\": {\\n \\"branchName\\": \\"deleteBranch\\"\\n }\\n}","type":"json"}]', + ], + 'DeleteProtectedBranch' => [ + 'summary' => '删除保护分支', + 'path' => '/repository/{repositoryId}/protect_branches/{protectedBranchId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '611b75680fc7bf0dbe1dce55', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2813489', + ], + ], + [ + 'name' => 'protectedBranchId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '5326', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '1F4F342D-493A-5B2C-B133-BA78B30FF834', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"1F4F342D-493A-5B2C-B133-BA78B30FF834\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"result\\": true\\n }\\n}","type":"json"}]', + ], + 'UpdateProtectedBranches' => [ + 'summary' => '更改保护分支设置', + 'path' => '/{repositoryId}/protect_branches/{id}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'title' => 'accessToken（选填），使用AK方式调用时无需填accessToken', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2835387', + ], + ], + [ + 'name' => 'id', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '19224', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '19224', + ], + 'branch' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'master', + ], + 'allowPushRoles' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '[40, 30]', + ], + 'required' => false, + ], + 'allowPushUserIds' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '[19258, 19262]', + ], + 'required' => false, + ], + 'allowMergeRoles' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '[40, 30]', + ], + 'required' => false, + ], + 'allowMergeUserIds' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '[19258, 19262]', + ], + 'required' => false, + ], + 'mergeRequestSetting' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'isRequired' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'mrMode' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'general', + ], + 'isAllowSelfApproval' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'isRequireDiscussionProcessed' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'isResetApprovalWhenNewPush' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'minimumApproval' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'allowMergeRequestRoles' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '[40, 30]', + ], + 'required' => false, + ], + 'defaultAssignees' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1234', + ], + 'required' => false, + ], + 'whiteList' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '**.java', + ], + ], + 'required' => false, + ], + 'testSettingDTO' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'isRequired' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'codeGuidelinesDetection' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'enabled' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'message' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test_code_guide_lines', + ], + ], + 'required' => false, + ], + 'sensitiveInfoDetection' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'enabled' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'message' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test_code_sensitive_info', + ], + ], + 'required' => false, + ], + 'checkTaskQualityConfig' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'enabled' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'bizNo' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '123456', + ], + 'taskName' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'bz-task-quality', + ], + 'message' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test_task_quality', + ], + ], + 'required' => false, + ], + 'checkConfig' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'checkItems' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'isRequired' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'A35869D5-BB29-5F84-A4DD-B09985EA2AFA', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => ' '."\n" + .'SYSTEM_UNKNOWN_ERROR'."\n", + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456', + ], + 'branch' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'master', + ], + 'allowPushRoles' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '[40, 30]', + ], + ], + 'allowPushUserIds' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '[19258, 19262]', + ], + ], + 'allowMergeRoles' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '[40, 30]', + ], + ], + 'allowMergeUserIds' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '[19258, 19262]', + ], + ], + 'mergeRequestSetting' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'isRequired' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'mrMode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'general', + ], + 'isAllowSelfApproval' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'isRequireDiscussionProcessed' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'isResetApprovalWhenNewPush' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'minimumApproval' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'allowMergeRequestRoles' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '[40, 30]', + ], + ], + 'defaultAssignees' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1234', + ], + ], + 'whiteList' => [ + 'description' => '', + 'type' => 'string', + 'example' => '**.java', + ], + ], + ], + 'testSettingDTO' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'isRequired' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'codeGuidelinesDetection' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'enabled' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test_code_guide_lines', + ], + ], + ], + 'sensitiveInfoDetection' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'enabled' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test_code_sensitive_info', + ], + ], + ], + 'checkTaskQualityConfig' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'enabled' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'bizNo' => [ + 'description' => '', + 'type' => 'string', + 'example' => '123456', + ], + 'taskName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'biz-task-quality', + ], + 'message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test_task_quality', + ], + ], + ], + 'checkConfig' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'checkItems' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'isRequired' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"A35869D5-BB29-5F84-A4DD-B09985EA2AFA\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\t\\\\nSYSTEM_UNKNOWN_ERROR\\\\n\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"id\\": 123456,\\n \\"branch\\": \\"master\\",\\n \\"allowPushRoles\\": [\\n 0\\n ],\\n \\"allowPushUserIds\\": [\\n 0\\n ],\\n \\"allowMergeRoles\\": [\\n 0\\n ],\\n \\"allowMergeUserIds\\": [\\n 0\\n ],\\n \\"mergeRequestSetting\\": {\\n \\"isRequired\\": true,\\n \\"mrMode\\": \\"general\\",\\n \\"isAllowSelfApproval\\": true,\\n \\"isRequireDiscussionProcessed\\": true,\\n \\"isResetApprovalWhenNewPush\\": false,\\n \\"minimumApproval\\": 1,\\n \\"allowMergeRequestRoles\\": [\\n 0\\n ],\\n \\"defaultAssignees\\": [\\n \\"1234\\"\\n ],\\n \\"whiteList\\": \\"**.java\\"\\n },\\n \\"testSettingDTO\\": {\\n \\"isRequired\\": false,\\n \\"codeGuidelinesDetection\\": {\\n \\"enabled\\": false,\\n \\"message\\": \\"test_code_guide_lines\\"\\n },\\n \\"sensitiveInfoDetection\\": {\\n \\"enabled\\": false,\\n \\"message\\": \\"test_code_sensitive_info\\"\\n },\\n \\"checkTaskQualityConfig\\": {\\n \\"enabled\\": false,\\n \\"bizNo\\": \\"123456\\",\\n \\"taskName\\": \\"biz-task-quality\\",\\n \\"message\\": \\"test_task_quality\\"\\n },\\n \\"checkConfig\\": {\\n \\"checkItems\\": [\\n {\\n \\"name\\": \\"测试流水线\\",\\n \\"isRequired\\": false\\n }\\n ]\\n }\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<UpdateProtectedBranchesResponse>\\n <requestId>A35869D5-BB29-5F84-A4DD-B09985EA2AFA</requestId>\\n <errorMessage>\\"\\"</errorMessage>\\n <errorCode>success</errorCode>\\n <success>false</success>\\n <result>\\n <id>123456</id>\\n <branch>master</branch>\\n <allowPushRoles>40</allowPushRoles>\\n <allowPushRoles>30</allowPushRoles>\\n <allowPushUserIds>123456</allowPushUserIds>\\n <allowMergeRoles>40</allowMergeRoles>\\n <allowMergeRoles>30</allowMergeRoles>\\n <allowMergeUserIds>123456</allowMergeUserIds>\\n <mergeRequestSetting>\\n <isRequired>true</isRequired>\\n <mrMode>general</mrMode>\\n <isAllowSelfApproval>true</isAllowSelfApproval>\\n <isRequireDiscussionProcessed>true</isRequireDiscussionProcessed>\\n <isResetApprovalWhenNewPush>false</isResetApprovalWhenNewPush>\\n <minimumApproval>1</minimumApproval>\\n <allowMergeRequestRoles>40</allowMergeRequestRoles>\\n <allowMergeRequestRoles>30</allowMergeRequestRoles>\\n <defaultAssignees>1234</defaultAssignees>\\n </mergeRequestSetting>\\n <testSettingDTO>\\n <isRequired>false</isRequired>\\n <codeGuidelinesDetection>\\n <enabled>false</enabled>\\n <message>test_code_guide_lines</message>\\n </codeGuidelinesDetection>\\n <sensitiveInfoDetection>\\n <enabled>false</enabled>\\n <message>test_code_sensitive_info</message>\\n </sensitiveInfoDetection>\\n <checkTaskQualityConfig>\\n <enabled>false</enabled>\\n <bizNo>123456</bizNo>\\n <taskName>biz-task-quality</taskName>\\n <message>test_task_quality</message>\\n </checkTaskQualityConfig>\\n <checkConfig>\\n <checkItems>\\n <name>api测试-create</name>\\n <isRequired>false</isRequired>\\n </checkItems>\\n </checkConfig>\\n </testSettingDTO>\\n </result>\\n</UpdateProtectedBranchesResponse>","errorExample":""}]', + ], + 'GetBranchInfo' => [ + 'summary' => '查询单个分支', + 'path' => '/repository/{repositoryId}/branches/detail', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5fbe3118672533690be72b12', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2334743', + ], + ], + [ + 'name' => 'branchName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'master', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '6177543A-8D54-5736-A93B-E0195A1512CB', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'master', + ], + 'protected' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'false', + ], + 'commit' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'e0297d8fb0393c833a8531e7cc8832739e3cba6d', + ], + 'shortId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'e0297d8f', + ], + 'title' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'authorName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'authorEmail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'createdAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 10:00:00', + ], + 'message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'authoredDate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 08:00:00', + ], + 'committedDate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 09:00:00', + ], + 'committerEmail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'committerName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'parentIds' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'de02b625ba8488f92eb204bcb3773a40c1b4ddac', + ], + ], + 'author' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '28056', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'codeup-test', + ], + 'username' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'testtest', + ], + 'state' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'email' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + ], + ], + 'committer' => [ + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5035', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'codeup-commit', + ], + 'username' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'commitcommit', + ], + 'state' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'email' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + ], + ], + 'signature' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'gpgKeyId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'verificationStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'verified', + ], + ], + ], + 'commentsCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"6177543A-8D54-5736-A93B-E0195A1512CB\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"name\\": \\"master\\",\\n \\"protected\\": \\"false\\",\\n \\"commit\\": {\\n \\"id\\": \\"e0297d8fb0393c833a8531e7cc8832739e3cba6d\\",\\n \\"shortId\\": \\"e0297d8f\\",\\n \\"title\\": \\"修改main.txt文件\\",\\n \\"authorName\\": \\"阿里云云效\\",\\n \\"authorEmail\\": \\"[email protected]\\",\\n \\"createdAt\\": \\"2022-03-18 10:00:00\\",\\n \\"message\\": \\"修改main.txt文件\\",\\n \\"authoredDate\\": \\"2022-03-18 08:00:00\\",\\n \\"committedDate\\": \\"2022-03-18 09:00:00\\",\\n \\"committerEmail\\": \\"[email protected]\\",\\n \\"committerName\\": \\"阿里云云效Committer\\",\\n \\"parentIds\\": [\\n \\"de02b625ba8488f92eb204bcb3773a40c1b4ddac\\"\\n ],\\n \\"author\\": {\\n \\"id\\": 28056,\\n \\"name\\": \\"codeup-test\\",\\n \\"username\\": \\"testtest\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"email\\": \\"[email protected]\\"\\n },\\n \\"committer\\": {\\n \\"id\\": 5035,\\n \\"name\\": \\"codeup-commit\\",\\n \\"username\\": \\"commitcommit\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"email\\": \\"[email protected]\\"\\n },\\n \\"signature\\": {\\n \\"gpgKeyId\\": \\"\\\\\\"\\\\\\"\\",\\n \\"verificationStatus\\": \\"verified\\"\\n },\\n \\"commentsCount\\": 0\\n }\\n }\\n}","type":"json"}]', + ], + 'ListRepositoryBranches' => [ + 'summary' => '查询分支列表', + 'path' => '/repository/{repositoryId}/branches', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2709413', + ], + ], + [ + 'name' => 'page', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'search', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Demo', + ], + ], + [ + 'name' => 'sort', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '1F4F342D-493A-5B2C-B133-BA78B30FF834', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'total' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'testBranch', + ], + 'protected' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'false', + ], + 'commit' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'de02b625ba8488f92eb204bcb3773a40c1b4ddac', + ], + 'shortId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'e0297d8f', + ], + 'title' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'authorName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'authorEmail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'createdAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 10:00:00', + ], + 'message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'authoredDate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 10:00:00', + ], + 'committedDate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 11:00:00', + ], + 'committerEmail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'committerName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'commit-codeup', + ], + 'parentIds' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'de02b625ba8488f92eb204bcb3773a40c1b4ddac', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"1F4F342D-493A-5B2C-B133-BA78B30FF834\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"total\\": 100,\\n \\"result\\": [\\n {\\n \\"name\\": \\"testBranch\\",\\n \\"protected\\": \\"false\\",\\n \\"commit\\": {\\n \\"id\\": \\"de02b625ba8488f92eb204bcb3773a40c1b4ddac\\",\\n \\"shortId\\": \\"e0297d8f\\",\\n \\"title\\": \\"提交标题\\",\\n \\"authorName\\": \\"test-codeup\\",\\n \\"authorEmail\\": \\"[email protected]\\",\\n \\"createdAt\\": \\"2022-03-18 10:00:00\\",\\n \\"message\\": \\"具体的提交内容\\",\\n \\"authoredDate\\": \\"2022-03-18 10:00:00\\",\\n \\"committedDate\\": \\"2022-03-18 11:00:00\\",\\n \\"committerEmail\\": \\"[email protected]\\",\\n \\"committerName\\": \\"commit-codeup\\",\\n \\"parentIds\\": [\\n \\"de02b625ba8488f92eb204bcb3773a40c1b4ddac\\"\\n ]\\n }\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListProtectedBranches' => [ + 'summary' => '查询保护分支列表', + 'path' => '/repository/{repositoryId}/protect_branches', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513'."\n", + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2813489', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '313A1BF6-63B7-52D4-A098-952221A65254', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19285', + ], + 'branch' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'protectedBranch', + ], + 'createdAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54', + ], + 'updatedAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54', + ], + 'allowPushRoles' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '[40, 30]', + ], + ], + 'allowPushUserIds' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19238', + ], + ], + 'allowPushUsers' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19238', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'username' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'codeup-test', + ], + 'email' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'avatar' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + ], + ], + ], + 'allowMergeRoles' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '[40, 30]', + ], + ], + 'allowMergeUserIds' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19238', + ], + ], + 'allowMergeUsers' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19238', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'username' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'codeup-test', + ], + 'email' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'avatar' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + ], + ], + ], + 'mergeRequestSetting' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'isRequired' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'mrMode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'general', + ], + 'isAllowSelfApproval' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'isRequireDiscussionProcessed' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'isResetApprovalWhenNewPush' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'minimumApproval' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'allowMergeRequestRoles' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '[40, 30]', + ], + ], + 'defaultAssignees' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19238', + ], + 'username' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'codeup-test', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'email' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'avatar' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + ], + ], + ], + 'whiteList' => [ + 'description' => '', + 'type' => 'string', + 'example' => '**.java', + ], + ], + ], + 'testSettingDTO' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'isRequired' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'codeGuidelinesDetection' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'enabled' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test_code_guide_lines', + ], + ], + ], + 'sensitiveInfoDetection' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'enabled' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test_code_sensitive_info', + ], + ], + ], + 'checkTaskQualityConfig' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'enabled' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'bizNo' => [ + 'description' => '', + 'type' => 'string', + 'example' => '123456', + ], + 'taskName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'biz-task-quality', + ], + 'message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test_task_quality', + ], + ], + ], + 'checkConfig' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'checkItems' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'isRequired' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + ], + ], + 'matches' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '["pb"]', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"313A1BF6-63B7-52D4-A098-952221A65254\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": true,\\n \\"result\\": [\\n {\\n \\"id\\": 19285,\\n \\"branch\\": \\"protectedBranch\\",\\n \\"createdAt\\": \\"2022-03-18 14:24:54\\",\\n \\"updatedAt\\": \\"2022-03-18 14:24:54\\",\\n \\"allowPushRoles\\": [\\n 0\\n ],\\n \\"allowPushUserIds\\": [\\n 19238\\n ],\\n \\"allowPushUsers\\": [\\n {\\n \\"id\\": 19238,\\n \\"name\\": \\"阿里云云效\\",\\n \\"username\\": \\"codeup-test\\",\\n \\"email\\": \\"[email protected]\\",\\n \\"avatar\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\"\\n }\\n ],\\n \\"allowMergeRoles\\": [\\n 0\\n ],\\n \\"allowMergeUserIds\\": [\\n 19238\\n ],\\n \\"allowMergeUsers\\": [\\n {\\n \\"id\\": 19238,\\n \\"name\\": \\"阿里云云效\\",\\n \\"username\\": \\"codeup-test\\",\\n \\"email\\": \\"[email protected]\\",\\n \\"avatar\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\"\\n }\\n ],\\n \\"mergeRequestSetting\\": {\\n \\"isRequired\\": true,\\n \\"mrMode\\": \\"general\\",\\n \\"isAllowSelfApproval\\": true,\\n \\"isRequireDiscussionProcessed\\": true,\\n \\"isResetApprovalWhenNewPush\\": false,\\n \\"minimumApproval\\": 1,\\n \\"allowMergeRequestRoles\\": [\\n 0\\n ],\\n \\"defaultAssignees\\": [\\n {\\n \\"id\\": 19238,\\n \\"username\\": \\"codeup-test\\",\\n \\"name\\": \\"阿里云云效\\",\\n \\"email\\": \\"[email protected]\\",\\n \\"avatar\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\"\\n }\\n ],\\n \\"whiteList\\": \\"**.java\\"\\n },\\n \\"testSettingDTO\\": {\\n \\"isRequired\\": false,\\n \\"codeGuidelinesDetection\\": {\\n \\"enabled\\": false,\\n \\"message\\": \\"test_code_guide_lines\\"\\n },\\n \\"sensitiveInfoDetection\\": {\\n \\"enabled\\": false,\\n \\"message\\": \\"test_code_sensitive_info\\"\\n },\\n \\"checkTaskQualityConfig\\": {\\n \\"enabled\\": false,\\n \\"bizNo\\": \\"123456\\",\\n \\"taskName\\": \\"biz-task-quality\\",\\n \\"message\\": \\"test_task_quality\\"\\n },\\n \\"checkConfig\\": {\\n \\"checkItems\\": [\\n {\\n \\"name\\": \\"测试流水线\\",\\n \\"isRequired\\": false\\n }\\n ]\\n }\\n },\\n \\"matches\\": [\\n \\"[\\\\\\"pb\\\\\\"]\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetMergeRequest' => [ + 'summary' => '查询合并请求详情', + 'path' => '/api/v4/projects/{repositoryId}/merge_requests/{localId}/detail', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2464454', + ], + ], + [ + 'name' => 'localId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'mrBizId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'bca90244c4b749e0b109df52ac0eb570', + ], + 'projectId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2369234', + ], + 'localId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'createTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2023-05-30T02:53:36Z', + ], + 'updateTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2023-05-30T02:53:36Z', + ], + 'mrType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CODE_REVIEW', + ], + 'sourceProjectId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2369234', + ], + 'sourceBranch' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-merge-request', + ], + 'targetProjectId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2369234', + ], + 'targetBranch' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'master', + ], + 'title' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'description' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'reviewers' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '90452', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'username' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'root-test-codeup', + ], + 'state' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'email' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'hasReviewed' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'reviewOpinionStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'NOT_PASS', + ], + 'reviewTime' => [ + 'type' => 'string', + ], + 'hasCommented' => [ + 'type' => 'boolean', + ], + ], + ], + ], + 'author' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19927', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'username' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'root-test-codeup', + ], + 'state' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'email' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + ], + ], + 'subscribers' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '90452', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-subscriber', + ], + 'username' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-subscriber', + ], + 'state' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'email' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + ], + ], + ], + 'status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'UNDER_REVIEW', + ], + 'createFrom' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'WEB', + ], + 'ahead' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'behind' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'todoList' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'requirementCheckItems' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'itemType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'COMMENTS_CHECK', + ], + 'pass' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + 'allRequirementsPass' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'supportMergeFastForwardOnly' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'detailUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + 'webUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + 'targetProjectNameWithNamespace' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'targetProjectPathWithNamespace' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'orgId/test-group/test-target-repo', + ], + 'mergedRevision' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F7B85D1B-D1C2-140F-A039-341859F130B9\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"mrBizId\\": \\"bca90244c4b749e0b109df52ac0eb570\\",\\n \\"projectId\\": 2369234,\\n \\"localId\\": 1,\\n \\"createTime\\": \\"2023-05-30T02:53:36Z\\",\\n \\"updateTime\\": \\"2023-05-30T02:53:36Z\\",\\n \\"mrType\\": \\"CODE_REVIEW\\",\\n \\"sourceProjectId\\": 2369234,\\n \\"sourceBranch\\": \\"test-merge-request\\",\\n \\"targetProjectId\\": 2369234,\\n \\"targetBranch\\": \\"master\\",\\n \\"title\\": \\"test-合并请求标题\\",\\n \\"description\\": \\"test-合并请求的具体描述内容\\",\\n \\"reviewers\\": [\\n {\\n \\"id\\": 90452,\\n \\"name\\": \\"test-codeup\\",\\n \\"username\\": \\"root-test-codeup\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"email\\": \\"[email protected]\\",\\n \\"hasReviewed\\": false,\\n \\"reviewOpinionStatus\\": \\"NOT_PASS\\",\\n \\"reviewTime\\": \\"2023-05-30T02:53:36Z\\",\\n \\"hasCommented\\": true\\n }\\n ],\\n \\"author\\": {\\n \\"id\\": 19927,\\n \\"name\\": \\"test-codeup\\",\\n \\"username\\": \\"root-test-codeup\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"email\\": \\"[email protected]\\"\\n },\\n \\"subscribers\\": [\\n {\\n \\"id\\": 90452,\\n \\"name\\": \\"test-subscriber\\",\\n \\"username\\": \\"test-subscriber\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"email\\": \\"[email protected]\\"\\n }\\n ],\\n \\"status\\": \\"UNDER_REVIEW\\",\\n \\"createFrom\\": \\"WEB\\",\\n \\"ahead\\": 1,\\n \\"behind\\": 1,\\n \\"todoList\\": {\\n \\"requirementCheckItems\\": [\\n {\\n \\"itemType\\": \\"COMMENTS_CHECK\\",\\n \\"pass\\": true\\n }\\n ]\\n },\\n \\"allRequirementsPass\\": true,\\n \\"supportMergeFastForwardOnly\\": true,\\n \\"detailUrl\\": \\"xxx\\",\\n \\"webUrl\\": \\"xxx\\",\\n \\"targetProjectNameWithNamespace\\": \\"orgId / test-group / test-target-repo（斜杠两侧有空格）\\",\\n \\"targetProjectPathWithNamespace\\": \\"orgId/test-group/test-target-repo\\",\\n \\"mergedRevision\\": \\"1a072f5367c21f9de3464b8c0ee8546e47764d2d\\"\\n }\\n}","type":"json"}]', + ], + 'ListMergeRequests' => [ + 'summary' => '查询代码评审列表', + 'path' => '/api/v4/projects/merge_requests/advanced_search', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513'."\n", + ], + ], + [ + 'name' => 'page', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'groupIds', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '889910, 889911', + ], + ], + [ + 'name' => 'projectIds', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2308912, 2308913', + ], + ], + [ + 'name' => 'authorIds', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1234567890', + ], + ], + [ + 'name' => 'reviewerIds', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1234567890123', + ], + ], + [ + 'name' => 'state', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'opened', + ], + ], + [ + 'name' => 'search', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test-search', + ], + ], + [ + 'name' => 'orderBy', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'updated_at', + ], + ], + [ + 'name' => 'sort', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + [ + 'name' => 'filter', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'new', + ], + ], + [ + 'name' => 'labelIds', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'createdBefore', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'createdAfter', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'total' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'newMergeRequestIdentifier' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'projectId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2369234', + ], + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'iid' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'mrBizId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'bca90244c4b749e0b109df52ac0eb570', + ], + 'localId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'title' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'description' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'state' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'opened', + ], + 'newVersionState' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'UNDER_REVIEW', + ], + 'createdAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54', + ], + 'updatedAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54', + ], + 'sourceBranch' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-merge-source-branch', + ], + 'targetBranch' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-merge-target-branch', + ], + 'author' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19927', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'username' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'root-test-codeup', + ], + 'state' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'email' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + ], + ], + 'reviewers' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '43127', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-review-user', + ], + 'username' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'root-test-review-user', + ], + 'state' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'email' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'approved', + ], + 'reviewTime' => [ + 'type' => 'string', + ], + 'hasReviewed' => [ + 'type' => 'boolean', + ], + 'hasCommented' => [ + 'type' => 'boolean', + ], + 'reviewOpinionStatus' => [ + 'type' => 'string', + ], + ], + ], + ], + 'subscribers' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1876119', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-subscriber', + ], + 'username' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'root-test-subscriber', + ], + 'state' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'email' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + ], + ], + ], + 'sourceProjectId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2876119', + ], + 'targetProjectId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2876119', + ], + 'workInProgress' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'detailUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + 'webUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'sshUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'git@xxx:xxx/test/test.git', + ], + 'creationMethod' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'WEB', + ], + 'sourceType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'BRANCH', + ], + 'targetType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'BRANCH', + ], + 'nameWithNamespace' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'supportMergeFFOnly' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'labels' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'type' => 'string', + ], + 'name' => [ + 'type' => 'string', + ], + 'color' => [ + 'type' => 'string', + ], + 'description' => [ + 'type' => 'string', + ], + ], + ], + ], + 'mergedRevision' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"total\\": 30,\\n \\"result\\": [\\n {\\n \\"newMergeRequestIdentifier\\": true,\\n \\"projectId\\": 2369234,\\n \\"id\\": 1,\\n \\"iid\\": 1,\\n \\"mrBizId\\": \\"bca90244c4b749e0b109df52ac0eb570\\",\\n \\"localId\\": 2,\\n \\"title\\": \\"test-合并请求标题\\",\\n \\"description\\": \\"描述信息的具体内容\\\\n\\",\\n \\"state\\": \\"opened\\",\\n \\"newVersionState\\": \\"UNDER_REVIEW\\",\\n \\"createdAt\\": \\"2022-03-18 14:24:54\\",\\n \\"updatedAt\\": \\"2022-03-18 14:24:54\\",\\n \\"sourceBranch\\": \\"test-merge-source-branch\\",\\n \\"targetBranch\\": \\"test-merge-target-branch\\",\\n \\"author\\": {\\n \\"id\\": 19927,\\n \\"name\\": \\"test-codeup\\",\\n \\"username\\": \\"root-test-codeup\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"email\\": \\"[email protected]\\"\\n },\\n \\"reviewers\\": [\\n {\\n \\"id\\": 43127,\\n \\"name\\": \\"test-review-user\\",\\n \\"username\\": \\"root-test-review-user\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"email\\": \\"[email protected]\\",\\n \\"status\\": \\"approved\\",\\n \\"reviewTime\\": \\"2022-03-18 14:24:54\\",\\n \\"hasReviewed\\": false,\\n \\"hasCommented\\": true,\\n \\"reviewOpinionStatus\\": \\"PASS\\"\\n }\\n ],\\n \\"subscribers\\": [\\n {\\n \\"id\\": 1876119,\\n \\"name\\": \\"test-subscriber\\",\\n \\"username\\": \\"root-test-subscriber\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"email\\": \\"[email protected]\\"\\n }\\n ],\\n \\"sourceProjectId\\": 2876119,\\n \\"targetProjectId\\": 2876119,\\n \\"workInProgress\\": false,\\n \\"detailUrl\\": \\"xxx\\",\\n \\"webUrl\\": \\"\\\\\\"\\\\\\"\\",\\n \\"sshUrl\\": \\"git@xxx:xxx/test/test.git\\",\\n \\"creationMethod\\": \\"WEB\\",\\n \\"sourceType\\": \\"BRANCH\\",\\n \\"targetType\\": \\"BRANCH\\",\\n \\"nameWithNamespace\\": \\"codeup-test-org / test-create-group （斜杠两侧有空格）\\",\\n \\"supportMergeFFOnly\\": true,\\n \\"labels\\": [\\n {\\n \\"id\\": \\"b5b5738b94954bc6aa5a293316ed1d24\\",\\n \\"name\\": \\"新特性\\",\\n \\"color\\": \\"#006AD4\\",\\n \\"description\\": \\"新的特性或需求\\"\\n }\\n ],\\n \\"mergedRevision\\": \\"1a072f5367c21f9de3464b8c0ee8546e47764d2d\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'CreateMergeRequest' => [ + 'summary' => '创建代码评审', + 'path' => '/api/v4/projects/{repositoryId}/merge_requests', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '6270e731cfea268afc21ccac', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2369234', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'sourceProjectId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2369234', + ], + 'sourceBranch' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'sourceBranch', + ], + 'targetProjectId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2369234', + ], + 'targetBranch' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'targetBranch', + ], + 'title' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + 'createFrom' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'WEB', + ], + 'description' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'reviewerIds' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1234567890', + ], + 'required' => false, + ], + 'workItemIds' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '722200214032b6b31e6f1434ab', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'mrBizId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'bca90244c4b749e0b109df52ac0eb570', + ], + 'projectId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2369234', + ], + 'localId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'createTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2023-06-02T03:41:22Z', + ], + 'updateTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2023-06-02T03:41:22Z', + ], + 'mrType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CODE_REVIEW', + ], + 'sourceProjectId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2369234', + ], + 'sourceBranch' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'sourceBranch', + ], + 'targetProjectId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2369234', + ], + 'targetBranch' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'targetBranch', + ], + 'title' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'description' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'reviewers' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '7905', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'codeup', + ], + 'username' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'root-codeup', + ], + 'state' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'email' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'hasReviewed' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'reviewOpinionStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'PASS', + ], + ], + ], + ], + 'author' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19230', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'username' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-codeup-nickname', + ], + 'state' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'email' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + ], + ], + 'subscribers' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10092', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'username' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'root-test-codeup', + ], + 'state' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'email' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + ], + ], + ], + 'status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'UNDER_REVIEW', + ], + 'createFrom' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'WEB', + ], + 'ahead' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'behind' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'detailUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + 'webUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://codeup.aliyun.com/xxx/test/test'."\n", + ], + 'allRequirementsPass' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'supportMergeFastForwardOnly' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F7B85D1B-D1C2-140F-A039-341859F130B9\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"mrBizId\\": \\"bca90244c4b749e0b109df52ac0eb570\\",\\n \\"projectId\\": 2369234,\\n \\"localId\\": 1,\\n \\"createTime\\": \\"2023-06-02T03:41:22Z\\",\\n \\"updateTime\\": \\"2023-06-02T03:41:22Z\\",\\n \\"mrType\\": \\"CODE_REVIEW\\",\\n \\"sourceProjectId\\": 2369234,\\n \\"sourceBranch\\": \\"sourceBranch\\",\\n \\"targetProjectId\\": 2369234,\\n \\"targetBranch\\": \\"targetBranch\\",\\n \\"title\\": \\"测试合并请求的标题\\",\\n \\"description\\": \\"测试合并请求\\",\\n \\"reviewers\\": [\\n {\\n \\"id\\": 7905,\\n \\"name\\": \\"codeup\\",\\n \\"username\\": \\"root-codeup\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"email\\": \\"[email protected]\\",\\n \\"hasReviewed\\": false,\\n \\"reviewOpinionStatus\\": \\"PASS\\"\\n }\\n ],\\n \\"author\\": {\\n \\"id\\": 19230,\\n \\"name\\": \\"test-codeup\\",\\n \\"username\\": \\"test-codeup-nickname\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"email\\": \\"[email protected]\\"\\n },\\n \\"subscribers\\": [\\n {\\n \\"id\\": 10092,\\n \\"name\\": \\"test-codeup\\",\\n \\"username\\": \\"root-test-codeup\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"email\\": \\"[email protected]\\"\\n }\\n ],\\n \\"status\\": \\"UNDER_REVIEW\\",\\n \\"createFrom\\": \\"WEB\\",\\n \\"ahead\\": 2,\\n \\"behind\\": 0,\\n \\"detailUrl\\": \\"xxx\\",\\n \\"webUrl\\": \\"https://codeup.aliyun.com/xxx/test/test\\\\n\\",\\n \\"allRequirementsPass\\": true,\\n \\"supportMergeFastForwardOnly\\": true\\n }\\n}","type":"json"}]', + ], + 'UpdateMergeRequest' => [ + 'summary' => '更新代码评审的标题和描述', + 'path' => '/api/v4/projects/{repositoryId}/merge_requests/{localId}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '889910', + ], + ], + [ + 'name' => 'localId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'title' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'description' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F7B85D1B-D1C2-140F-A039-341859F130B9\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"result\\": true\\n }\\n}","type":"json"}]', + ], + 'UpdateMergeRequestPersonnel' => [ + 'summary' => '更新代码评审的干系人', + 'path' => '/api/v4/projects/{repositoryId}/merge_requests/{localId}/person/{personType}', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1233456', + ], + ], + [ + 'name' => 'localId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'personType', + 'in' => 'path', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'newUserIdList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '249286812078239123', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '4D6AF7CC-B43B-5454-86AB-023D25E44868', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"4D6AF7CC-B43B-5454-86AB-023D25E44868\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"result\\": true\\n }\\n}","type":"json"}]', + ], + 'MergeMergeRequest' => [ + 'summary' => '合并代码评审', + 'path' => '/api/v4/projects/{repositoryId}/merge_requests/{localId}/merge', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '0cf2c8458ac44d9481aab2dd6ec10596v3'."\n", + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2709413', + ], + ], + [ + 'name' => 'localId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'mergeType' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'no-fast-forward', + ], + 'mergeMessage' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '""', + ], + 'removeSourceBranch' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '9ED5E382-3A58-51E4-8A81-CE25D1756025', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + 'required' => false, + ], + 'mergedRevision' => [ + 'type' => 'string', + ], + 'bizId' => [ + 'type' => 'string', + ], + 'projectId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'localId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"9ED5E382-3A58-51E4-8A81-CE25D1756025\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"result\\": true,\\n \\"mergedRevision\\": \\"1a072f5367c21f9de3464b8c0ee8546e47764d2d\\",\\n \\"bizId\\": \\"bca90244c4b749e0b109df52ac0eb570\\",\\n \\"projectId\\": 2369234,\\n \\"localId\\": 2\\n }\\n}","type":"json"}]', + ], + 'ReviewMergeRequest' => [ + 'summary' => '提交变更请求的评审意见', + 'path' => '/api/v4/projects/{repositoryId}/merge_requests/{localId}/submit_review_opinion', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2334743', + ], + ], + [ + 'name' => 'localId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'reviewOpinion' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'PASS', + ], + 'reviewComment' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'draftCommentIds' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"result\\": true\\n }\\n}","type":"json"}]', + ], + 'CloseMergeRequest' => [ + 'summary' => '关闭代码评审', + 'path' => '/api/v4/projects/{repositoryId}/merge_requests/{localId}/close', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '0cf2c8458ac44d9481aab2dd6ec10596v3'."\n", + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2369234', + ], + ], + [ + 'name' => 'localId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'HC93CE1A-8D7A-13A9-8306-7465DE2E5C0F', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'InvalidParam.NoPermission', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"HC93CE1A-8D7A-13A9-8306-7465DE2E5C0F\\",\\n \\"errorMessage\\": \\"InvalidParam.NoPermission\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"result\\": true\\n }\\n}","type":"json"}]', + ], + 'ReopenMergeRequest' => [ + 'summary' => '重新打开代码评审', + 'path' => '/api/v4/projects/{repositoryId}/merge_requests/{localId}/reopen', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2464454', + ], + ], + [ + 'name' => 'localId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '313A1BF6-63B7-52D4-A098-952221A65254', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"313A1BF6-63B7-52D4-A098-952221A65254\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"result\\": true\\n }\\n}","type":"json"}]', + ], + 'ListMergeRequestPatchSets' => [ + 'summary' => '查询合并请求的版本列表', + 'path' => '/api/v4/projects/merge_requests/diffs/list_patchsets', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryIdentity', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'localId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '4', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'patchSetNo' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'patchSetBizId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '513fcfd81a9142d2bb0db4f72c0aa15b', + ], + 'patchSetName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'commitId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1a072f5367c21f9de3464b8c0ee8546e47764d2d', + ], + 'shortCommitId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1a072f53', + ], + 'relatedMergeItemType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'MERGE_SOURCE', + ], + 'createdAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F7B85D1B-D1C2-140F-A039-341859F130B9\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"result\\": [\\n {\\n \\"patchSetNo\\": 1,\\n \\"patchSetBizId\\": \\"513fcfd81a9142d2bb0db4f72c0aa15b\\",\\n \\"patchSetName\\": \\"版本1\\",\\n \\"commitId\\": \\"1a072f5367c21f9de3464b8c0ee8546e47764d2d\\",\\n \\"shortCommitId\\": \\"1a072f53\\",\\n \\"relatedMergeItemType\\": \\"MERGE_SOURCE\\",\\n \\"createdAt\\": \\"2022-03-18 14:24:54\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetMergeRequestChangeTree' => [ + 'summary' => '查询合并请求的变更信息', + 'path' => '/api/v4/projects/merge_requests/diffs/change_tree', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryIdentity', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'localId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '7', + ], + ], + [ + 'name' => 'fromPatchSetBizId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5e733626d53f4b04a6aa0e23d4ff72b8', + ], + ], + [ + 'name' => 'toPatchSetBizId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '513fcfd81a9142d2bb0db4f72c0aa15b', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'HC93CE1A-8D7A-13A9-8306-7465DE2E5C0F', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'changedFilesCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'totalAddLines' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'totalDelLines' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50', + ], + 'changedFilesInfos' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'newPath' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test.txt', + ], + 'oldPath' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test.txt', + ], + 'newFile' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'renamedFile' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'deletedFile' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'binaryFile' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'addLines' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'delLines' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"HC93CE1A-8D7A-13A9-8306-7465DE2E5C0F\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"result\\": {\\n \\"changedFilesCount\\": 20,\\n \\"totalAddLines\\": 100,\\n \\"totalDelLines\\": 50,\\n \\"changedFilesInfos\\": [\\n {\\n \\"newPath\\": \\"test.txt\\",\\n \\"oldPath\\": \\"test.txt\\",\\n \\"newFile\\": true,\\n \\"renamedFile\\": false,\\n \\"deletedFile\\": false,\\n \\"binaryFile\\": false,\\n \\"addLines\\": 10,\\n \\"delLines\\": 0\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListMergeRequestFilesReads' => [ + 'summary' => '查询合并请求文件已读列表', + 'path' => '/api/v4/projects/merge_requests/diffs/files_read_infos', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'agp_4d57a6796b3626f52064ab1fba5384a5', + ], + ], + [ + 'name' => 'repositoryIdentity', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'localId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '5', + ], + ], + [ + 'name' => 'fromPatchSetBizId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5e733626d53f4b04a6aa0e23d4ff72b8', + ], + ], + [ + 'name' => 'toPatchSetBizId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '513fcfd81a9142d2bb0db4f72c0aa15b', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'oldFilePath' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'text.txt', + ], + 'newFilePath' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'text.txt', + ], + 'newFile' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'renamedFile' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'false', + ], + 'deletedFile' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'false', + ], + 'readUsers' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'aliyunPk' => [ + 'description' => '', + 'type' => 'string', + 'example' => '204485087002425236', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'codeup', + ], + 'username' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'state' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'email' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"result\\": [\\n {\\n \\"oldFilePath\\": \\"text.txt\\",\\n \\"newFilePath\\": \\"text.txt\\",\\n \\"newFile\\": true,\\n \\"renamedFile\\": \\"false\\",\\n \\"deletedFile\\": \\"false\\",\\n \\"readUsers\\": [\\n {\\n \\"aliyunPk\\": \\"204485087002425236\\",\\n \\"name\\": \\"codeup\\",\\n \\"username\\": \\"test-codeup\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"email\\": \\"[email protected]\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListMergeRequestComments' => [ + 'summary' => '查询合并请求评论列表', + 'path' => '/api/v4/projects/merge_requests/comments/list_comments', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryIdentity', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'localId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'patchSetBizIds' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '5e733626d53f4b04a6aa0e23d4ff72b8', + ], + 'required' => false, + ], + 'commentType' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'GLOBAL_COMMENT', + ], + 'filePath' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '/src/main/test.java', + ], + 'state' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'OPENED', + ], + 'resolved' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '56C33A95-C04F-59F0-B3CD-E2A2EB9FADBB', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'commentBizId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '5c399e3685e542a28db16d93e9f82abb', + ], + 'commentType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'GLOBAL_COMMENT', + ], + 'state' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OPENED', + ], + 'resolved' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'deleted' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'commentTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54'."\n", + ], + 'lastEditTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54'."\n", + ], + 'content' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'author' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'aliyunPk' => [ + 'description' => '', + 'type' => 'string', + 'example' => '284692704493684695', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'codeup', + ], + 'username' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'state' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'email' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'id' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + 'relatedPatchSet' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'patchSetNo' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'patchSetBizId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '513fcfd81a9142d2bb0db4f72c0aa15b', + ], + 'patchSetName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'commitId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1a072f5367c21f9de3464b8c0ee8546e47764d2d', + ], + 'shortId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1a072f53', + ], + 'relatedMergeItemType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'MERGE_SOURCE', + ], + 'createdAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54'."\n", + ], + ], + ], + 'lineNumber' => [ + 'description' => '', + 'type' => 'string', + 'example' => '3', + ], + 'filePath' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'src/main/test.java', + ], + 'parentCommentBizId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '4c5dcec6a8dc41e69c369737dadc1841', + ], + 'rootCommentBizId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'dcf2b23cebfc418f98dbd35e423d9fd3', + ], + 'childComments' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'commentBizId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '63f0e293357f48f9846ddc4dbbebd0e3', + ], + 'commentType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'GLOBAL_COMMENT', + ], + 'state' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OPENED', + ], + 'resolved' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'deleted' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'commentTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54', + ], + 'lastEditTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54', + ], + 'content' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'author' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'aliyunPk' => [ + 'description' => '', + 'type' => 'string', + 'example' => '204485087002425236', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'codeup', + ], + 'username' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'state' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'email' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]'."\n", + ], + 'id' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + 'relatedPatchSet' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'patchSetNo' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'patchSetBizId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '513fcfd81a9142d2bb0db4f72c0aa15b', + ], + 'patchSetName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'commitId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1a072f5367c21f9de3464b8c0ee8546e47764d2d', + ], + 'shortId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1a072f53', + ], + 'relatedMergeItemType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'MERGE_SOURCE', + ], + 'createdAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54'."\n", + ], + ], + ], + 'lineNumber' => [ + 'description' => '', + 'type' => 'string', + 'example' => '3', + ], + 'filePath' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'src/main/test.java'."\n", + ], + 'parentCommentBizId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '5c399e3685e542a28db16d93e9f82abb', + ], + 'rootCommentBizId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'dcf2b23cebfc418f98dbd35e423d9fd3', + ], + 'finalChildComments' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'commentBizId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '5c399e3685e542a28db16d93e9f82abb', + ], + 'commentType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'GLOBAL_COMMENT', + ], + 'state' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OPENED', + ], + 'resolved' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'deleted' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'commentTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54', + ], + 'lastEditTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54', + ], + 'content' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'author' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'aliyunPk' => [ + 'description' => '', + 'type' => 'string', + 'example' => '235671547828975455', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'codeup', + ], + 'username' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'state' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'email' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]'."\n", + ], + 'id' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + 'relatedPatchSet' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'patchSetNo' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'patchSetBizId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '513fcfd81a9142d2bb0db4f72c0aa15b', + ], + 'patchSetName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'commitId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1a072f5367c21f9de3464b8c0ee8546e47764d2d', + ], + 'shortId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1a072f53', + ], + 'relatedMergeItemType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'MERGE_SOURCE', + ], + 'createdAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54', + ], + ], + ], + 'lineNumber' => [ + 'description' => '', + 'type' => 'string', + 'example' => '3', + ], + 'filePath' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'src/main/test.java', + ], + 'parentCommentBizId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '4c5dcec6a8dc41e69c369737dadc1841', + ], + 'rootCommentBizId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'dcf2b23cebfc418f98dbd35e423d9fd3'."\n", + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"56C33A95-C04F-59F0-B3CD-E2A2EB9FADBB\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"result\\": [\\n {\\n \\"commentBizId\\": \\"5c399e3685e542a28db16d93e9f82abb\\",\\n \\"commentType\\": \\"GLOBAL_COMMENT\\",\\n \\"state\\": \\"OPENED\\",\\n \\"resolved\\": false,\\n \\"deleted\\": false,\\n \\"commentTime\\": \\"2022-03-18 14:24:54\\\\n\\",\\n \\"lastEditTime\\": \\"2022-03-18 14:24:54\\\\n\\",\\n \\"content\\": \\"{\\\\\\\\\\\\\\"htmlValue\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"<article class=\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"4ever-article\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"><p style=\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"text-align:left;text-indent:0;margin-left:0\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"><span>测试动态创建整体评论-2</span></p></article>\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"jsonMLValue\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"root\\\\\\\\\\\\\\",{},[\\\\\\\\\\\\\\"p\\\\\\\\\\\\\\",{},[\\\\\\\\\\\\\\"span\\\\\\\\\\\\\\",{\\\\\\\\\\\\\\"data-type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"text\\\\\\\\\\\\\\"},[\\\\\\\\\\\\\\"span\\\\\\\\\\\\\\",{\\\\\\\\\\\\\\"data-type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"leaf\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"测试动态创建整体评论-2\\\\\\\\\\\\\\"]]]]}\\",\\n \\"author\\": {\\n \\"aliyunPk\\": \\"284692704493684695\\",\\n \\"name\\": \\"codeup\\",\\n \\"username\\": \\"test-codeup\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"email\\": \\"[email protected]\\",\\n \\"id\\": 19230\\n },\\n \\"relatedPatchSet\\": {\\n \\"patchSetNo\\": \\"1\\",\\n \\"patchSetBizId\\": \\"513fcfd81a9142d2bb0db4f72c0aa15b\\",\\n \\"patchSetName\\": \\"版本1\\",\\n \\"commitId\\": \\"1a072f5367c21f9de3464b8c0ee8546e47764d2d\\",\\n \\"shortId\\": \\"1a072f53\\",\\n \\"relatedMergeItemType\\": \\"MERGE_SOURCE\\",\\n \\"createdAt\\": \\"2022-03-18 14:24:54\\\\n\\"\\n },\\n \\"lineNumber\\": \\"3\\",\\n \\"filePath\\": \\"src/main/test.java\\",\\n \\"parentCommentBizId\\": \\"4c5dcec6a8dc41e69c369737dadc1841\\",\\n \\"rootCommentBizId\\": \\"dcf2b23cebfc418f98dbd35e423d9fd3\\",\\n \\"childComments\\": [\\n {\\n \\"commentBizId\\": \\"63f0e293357f48f9846ddc4dbbebd0e3\\",\\n \\"commentType\\": \\"GLOBAL_COMMENT\\",\\n \\"state\\": \\"OPENED\\",\\n \\"resolved\\": false,\\n \\"deleted\\": false,\\n \\"commentTime\\": \\"2022-03-18 14:24:54\\",\\n \\"lastEditTime\\": \\"2022-03-18 14:24:54\\",\\n \\"content\\": \\"{\\\\\\\\\\\\\\"htmlValue\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\n测试动态创建整体评论-2\\\\n\\\\n\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"jsonMLValue\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"root\\\\\\\\\\\\\\",{},[\\\\\\\\\\\\\\"p\\\\\\\\\\\\\\",{},[\\\\\\\\\\\\\\"span\\\\\\\\\\\\\\",{\\\\\\\\\\\\\\"data-type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"text\\\\\\\\\\\\\\"},[\\\\\\\\\\\\\\"span\\\\\\\\\\\\\\",{\\\\\\\\\\\\\\"data-type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"leaf\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"测试动态创建整体评论-2\\\\\\\\\\\\\\"]]]]}\\",\\n \\"author\\": {\\n \\"aliyunPk\\": \\"204485087002425236\\",\\n \\"name\\": \\"codeup\\",\\n \\"username\\": \\"test-codeup\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"email\\": \\"[email protected]\\\\n\\",\\n \\"id\\": 132582\\n },\\n \\"relatedPatchSet\\": {\\n \\"patchSetNo\\": \\"1\\",\\n \\"patchSetBizId\\": \\"513fcfd81a9142d2bb0db4f72c0aa15b\\",\\n \\"patchSetName\\": \\"版本1\\\\n\\",\\n \\"commitId\\": \\"1a072f5367c21f9de3464b8c0ee8546e47764d2d\\",\\n \\"shortId\\": \\"1a072f53\\",\\n \\"relatedMergeItemType\\": \\"MERGE_SOURCE\\",\\n \\"createdAt\\": \\"2022-03-18 14:24:54\\\\n\\"\\n },\\n \\"lineNumber\\": \\"3\\",\\n \\"filePath\\": \\"src/main/test.java\\\\n\\",\\n \\"parentCommentBizId\\": \\"5c399e3685e542a28db16d93e9f82abb\\",\\n \\"rootCommentBizId\\": \\"dcf2b23cebfc418f98dbd35e423d9fd3\\",\\n \\"finalChildComments\\": [\\n {\\n \\"commentBizId\\": \\"5c399e3685e542a28db16d93e9f82abb\\",\\n \\"commentType\\": \\"GLOBAL_COMMENT\\",\\n \\"state\\": \\"OPENED\\",\\n \\"resolved\\": false,\\n \\"deleted\\": false,\\n \\"commentTime\\": \\"2022-03-18 14:24:54\\",\\n \\"lastEditTime\\": \\"2022-03-18 14:24:54\\",\\n \\"content\\": \\"{\\\\\\\\\\\\\\"htmlValue\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\n测试动态创建整体评论-2\\\\n\\\\n\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"jsonMLValue\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"root\\\\\\\\\\\\\\",{},[\\\\\\\\\\\\\\"p\\\\\\\\\\\\\\",{},[\\\\\\\\\\\\\\"span\\\\\\\\\\\\\\",{\\\\\\\\\\\\\\"data-type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"text\\\\\\\\\\\\\\"},[\\\\\\\\\\\\\\"span\\\\\\\\\\\\\\",{\\\\\\\\\\\\\\"data-type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"leaf\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"测试动态创建整体评论-2\\\\\\\\\\\\\\"]]]]}\\",\\n \\"author\\": {\\n \\"aliyunPk\\": \\"235671547828975455\\",\\n \\"name\\": \\"codeup\\",\\n \\"username\\": \\"test-codeup\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"email\\": \\"[email protected]\\\\n\\",\\n \\"id\\": 567035\\n },\\n \\"relatedPatchSet\\": {\\n \\"patchSetNo\\": \\"1\\",\\n \\"patchSetBizId\\": \\"513fcfd81a9142d2bb0db4f72c0aa15b\\",\\n \\"patchSetName\\": \\"版本1\\",\\n \\"commitId\\": \\"1a072f5367c21f9de3464b8c0ee8546e47764d2d\\",\\n \\"shortId\\": \\"1a072f53\\",\\n \\"relatedMergeItemType\\": \\"MERGE_SOURCE\\",\\n \\"createdAt\\": \\"2022-03-18 14:24:54\\"\\n },\\n \\"lineNumber\\": \\"3\\",\\n \\"filePath\\": \\"src/main/test.java\\",\\n \\"parentCommentBizId\\": \\"4c5dcec6a8dc41e69c369737dadc1841\\",\\n \\"rootCommentBizId\\": \\"dcf2b23cebfc418f98dbd35e423d9fd3\\\\n\\"\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'CreateComment' => [ + 'summary' => '创建评论', + 'path' => '/api/v4/projects/code_reviews/comments/create_comment', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '214317', + 'abilityTreeNodes' => [ + 'FEATURErdcI7YZMH', + ], + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryIdentity', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'localId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'content' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + 'commentType' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'GLOBAL_COMMENT', + ], + 'parentCommentBizId' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2666ac1ac53841b0ba1b042e383279cc', + ], + 'resolved' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'filePath' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '/src/main/test.java', + ], + 'lineNumber' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'patchSetBizId' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'b7d8386be17c4ca68a07140db4836257', + ], + 'draft' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'fromPachSetBizId' => [ + 'type' => 'string', + ], + 'toPatchSetBizId' => [ + 'type' => 'string', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'."\n", + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'commentBizId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '5c399e3685e542a28db16d93e9f82abb', + ], + 'commentType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'GLOBAL_COMMENT', + ], + 'state' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OPENED', + ], + 'resolved' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'deleted' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'commentTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54'."\n", + ], + 'lastEditTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54'."\n", + ], + 'content' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'author' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'aliyunPk' => [ + 'description' => '', + 'type' => 'string', + 'example' => '284692704493684695', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'username' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'state' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'email' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19927', + ], + ], + ], + 'relatedPatchSet' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'patchSetNo' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'patchSetBizId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '513fcfd81a9142d2bb0db4f72c0aa15b', + ], + 'patchSetName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'commitId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1a072f5367c21f9de3464b8c0ee8546e47764d2d', + ], + 'shortId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1a072f53', + ], + 'relatedMergeItemType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'MERGE_SOURCE', + ], + 'createdAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54'."\n", + ], + ], + ], + 'lineNumber' => [ + 'description' => '', + 'type' => 'string', + 'example' => '3', + ], + 'filePath' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'src/main/update.txt', + ], + 'parentCommentBizId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '4c5dcec6a8dc41e69c369737dadc1841', + ], + 'rootCommentBizId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'dcf2b23cebfc418f98dbd35e423d9fd3', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\\\n\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"result\\": {\\n \\"commentBizId\\": \\"5c399e3685e542a28db16d93e9f82abb\\",\\n \\"commentType\\": \\"GLOBAL_COMMENT\\",\\n \\"state\\": \\"OPENED\\",\\n \\"resolved\\": false,\\n \\"deleted\\": false,\\n \\"commentTime\\": \\"2022-03-18 14:24:54\\\\n\\",\\n \\"lastEditTime\\": \\"2022-03-18 14:24:54\\\\n\\",\\n \\"content\\": \\"xxxx\\",\\n \\"author\\": {\\n \\"aliyunPk\\": \\"xxx\\",\\n \\"name\\": \\"test-codeup\\",\\n \\"username\\": \\"test-codeup\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"头像地址\\\\n\\\\nhttps://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"email\\": \\"[email protected]\\",\\n \\"id\\": 19927\\n },\\n \\"relatedPatchSet\\": {\\n \\"patchSetNo\\": \\"1\\",\\n \\"patchSetBizId\\": \\"513fcfd81a9142d2bb0db4f72c0aa15b\\",\\n \\"patchSetName\\": \\"版本1\\",\\n \\"commitId\\": \\"1a072f5367c21f9de3464b8c0ee8546e47764d2d\\",\\n \\"shortId\\": \\"1a072f53\\",\\n \\"relatedMergeItemType\\": \\"MERGE_SOURCE\\",\\n \\"createdAt\\": \\"2022-03-18 14:24:54\\\\n\\"\\n },\\n \\"lineNumber\\": \\"3\\",\\n \\"filePath\\": \\"src/main/update.txt\\",\\n \\"parentCommentBizId\\": \\"4c5dcec6a8dc41e69c369737dadc1841\\",\\n \\"rootCommentBizId\\": \\"dcf2b23cebfc418f98dbd35e423d9fd3\\"\\n }\\n}","type":"json"}]', + ], + 'GetCompareDetail' => [ + 'summary' => '获取比较详情', + 'path' => '/repository/{repositoryId}/commits/compare/detail', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => '5ebbc0228123212b59xxxxx', + 'required' => true, + 'title' => 'A short description of struct', + 'type' => 'string', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'example' => '2369234', + 'format' => 'int64', + 'required' => true, + 'type' => 'integer', + ], + ], + [ + 'name' => 'from', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => 'c9fb781f3d66ef6ee60bdd5c414f5106454b1426', + 'required' => true, + 'type' => 'string', + ], + ], + [ + 'name' => 'to', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => 'b8f6f28520b1936aafe2e638373e19ccafa42b02', + 'required' => true, + 'type' => 'string', + ], + ], + [ + 'name' => 'mergeBase', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => 'false', + 'required' => false, + 'type' => 'boolean', + ], + ], + [ + 'name' => 'maxDiffFile', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => '5000', + 'format' => 'int32', + 'required' => false, + 'type' => 'integer', + ], + ], + [ + 'name' => 'maxDiffByte', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => '24 * 1024 * 1024', + 'format' => 'int32', + 'required' => false, + 'type' => 'integer', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Schema of Response', + 'properties' => [ + 'requestId' => [ + 'description' => '', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + 'title' => 'Id of the request', + 'type' => 'string', + ], + 'errorCode' => [ + 'description' => '', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + 'type' => 'string', + ], + 'errorMessage' => [ + 'description' => '', + 'example' => '""', + 'type' => 'string', + ], + 'success' => [ + 'description' => '', + 'example' => 'true', + 'type' => 'boolean', + ], + 'result' => [ + 'description' => '', + 'properties' => [ + 'messages' => [ + 'description' => '', + 'items' => [ + 'description' => '', + 'example' => '""', + 'type' => 'string', + ], + 'type' => 'array', + ], + 'commits' => [ + 'description' => '', + 'items' => [ + 'description' => '', + 'properties' => [ + 'id' => [ + 'description' => '', + 'example' => 'b8f6f28520b1936aafe2e638373e19ccafa42b02', + 'type' => 'string', + ], + 'shortId' => [ + 'description' => '', + 'example' => 'b8f6f285', + 'type' => 'string', + ], + 'title' => [ + 'description' => '', + 'example' => '', + 'type' => 'string', + ], + 'message' => [ + 'description' => '', + 'example' => '""', + 'type' => 'string', + ], + 'authorName' => [ + 'description' => '', + 'example' => '', + 'type' => 'string', + ], + 'authorEmail' => [ + 'description' => '', + 'example' => '[email protected]', + 'type' => 'string', + ], + 'authoredDate' => [ + 'description' => '', + 'example' => '2023-01-03T15:41:26+08:00', + 'type' => 'string', + ], + 'createdAt' => [ + 'description' => '', + 'example' => '2023-01-03T15:41:26+08:00', + 'type' => 'string', + ], + 'committerName' => [ + 'description' => '', + 'example' => '', + 'type' => 'string', + ], + 'committerEmail' => [ + 'description' => '', + 'example' => '[email protected]', + 'type' => 'string', + ], + 'committedDate' => [ + 'description' => '', + 'example' => '2023-01-03T15:41:26+08:00', + 'type' => 'string', + ], + 'parentIds' => [ + 'description' => '', + 'items' => [ + 'description' => '', + 'example' => 'c9fb781f3d66ef6ee60bdd5c414f5106454b1426', + 'type' => 'string', + ], + 'type' => 'array', + ], + 'author' => [ + 'description' => '', + 'properties' => [ + 'id' => [ + 'description' => '', + 'example' => '21396', + 'format' => 'int64', + 'type' => 'integer', + ], + 'name' => [ + 'description' => '', + 'example' => '', + 'type' => 'string', + ], + 'username' => [ + 'description' => '', + 'example' => 'Codeup', + 'type' => 'string', + ], + 'state' => [ + 'description' => '', + 'example' => 'active', + 'type' => 'string', + ], + 'avatarUrl' => [ + 'description' => '', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + 'type' => 'string', + ], + 'email' => [ + 'description' => '', + 'example' => '[email protected]', + 'type' => 'string', + ], + ], + 'type' => 'object', + ], + 'committer' => [ + 'description' => '', + 'properties' => [ + 'id' => [ + 'description' => '', + 'example' => '43910', + 'format' => 'int64', + 'type' => 'integer', + ], + 'name' => [ + 'description' => '', + 'example' => '', + 'type' => 'string', + ], + 'username' => [ + 'description' => '', + 'example' => 'Codeup-commiter', + 'type' => 'string', + ], + 'state' => [ + 'description' => '', + 'example' => 'active', + 'type' => 'string', + ], + 'avatarUrl' => [ + 'description' => '', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + 'type' => 'string', + ], + 'email' => [ + 'description' => '', + 'example' => '[email protected]', + 'type' => 'string', + ], + ], + 'type' => 'object', + ], + 'commentsCount' => [ + 'description' => '', + 'example' => '1', + 'format' => 'int64', + 'type' => 'integer', + ], + ], + 'type' => 'object', + ], + 'type' => 'array', + ], + 'diffs' => [ + 'description' => '', + 'items' => [ + 'description' => '', + 'properties' => [ + 'diff' => [ + 'description' => '', + 'example' => '', + 'type' => 'string', + ], + 'newPath' => [ + 'description' => '', + 'example' => 'new_test.txt', + 'type' => 'string', + ], + 'oldPath' => [ + 'description' => '', + 'example' => 'test.txt', + 'type' => 'string', + ], + 'aMode' => [ + 'description' => '', + 'example' => '100644', + 'type' => 'string', + ], + 'bMode' => [ + 'description' => '', + 'example' => '100644', + 'type' => 'string', + ], + 'newFile' => [ + 'description' => '', + 'example' => 'false', + 'type' => 'boolean', + ], + 'renamedFile' => [ + 'description' => '', + 'example' => 'false', + 'type' => 'boolean', + ], + 'deletedFile' => [ + 'description' => '', + 'example' => 'false', + 'type' => 'boolean', + ], + 'isBinary' => [ + 'description' => '', + 'example' => 'false', + 'type' => 'boolean', + ], + 'oldId' => [ + 'description' => '', + 'example' => '6c268061a546378276559c713d0ad377d4dsjfh', + 'type' => 'string', + ], + 'newId' => [ + 'description' => '', + 'example' => 'cb75846da2df3d3d7f290c3569236fcf3dd17224', + 'type' => 'string', + ], + 'isNewLfs' => [ + 'description' => '', + 'example' => 'false', + 'type' => 'boolean', + ], + 'isOldLfs' => [ + 'description' => '', + 'example' => 'false', + 'type' => 'boolean', + ], + ], + 'type' => 'object', + ], + 'type' => 'array', + ], + ], + 'type' => 'object', + ], + ], + 'title' => 'Schema of Response', + 'type' => 'object', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"messages\\": [\\n \\"\\\\\\"\\\\\\"\\"\\n ],\\n \\"commits\\": [\\n {\\n \\"id\\": \\"b8f6f28520b1936aafe2e638373e19ccafa42b02\\",\\n \\"shortId\\": \\"b8f6f285\\",\\n \\"title\\": \\"提交标题\\",\\n \\"message\\": \\"\\\\\\"\\\\\\"\\",\\n \\"authorName\\": \\"云效Codeup\\",\\n \\"authorEmail\\": \\"[email protected]\\",\\n \\"authoredDate\\": \\"2023-01-03T15:41:26+08:00\\",\\n \\"createdAt\\": \\"2023-01-03T15:41:26+08:00\\",\\n \\"committerName\\": \\"云效CodeupCommitter\\",\\n \\"committerEmail\\": \\"[email protected]\\",\\n \\"committedDate\\": \\"2023-01-03T15:41:26+08:00\\",\\n \\"parentIds\\": [\\n \\"c9fb781f3d66ef6ee60bdd5c414f5106454b1426\\"\\n ],\\n \\"author\\": {\\n \\"id\\": 21396,\\n \\"name\\": \\"云效\\",\\n \\"username\\": \\"Codeup\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"externUid\\": \\"5f969843cd2214ba0e24327d\\",\\n \\"email\\": \\"[email protected]\\",\\n \\"websiteUrl\\": \\"“”\\"\\n },\\n \\"committer\\": {\\n \\"id\\": 43910,\\n \\"name\\": \\"云效Committer\\",\\n \\"username\\": \\"Codeup-commiter\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"externUid\\": \\"5f969843cd2214ba0e24327d\\",\\n \\"email\\": \\"[email protected]\\",\\n \\"websiteUrl\\": \\"\\\\\\"\\\\\\"\\"\\n },\\n \\"commentsCount\\": 1\\n }\\n ],\\n \\"diffs\\": [\\n {\\n \\"diff\\": \\"--- /dev/null\\\\\\\\n+++ b/mr_error.txt\\\\\\\\n@@ -0,0 +1,3 @@\\\\\\\\n+first\\\\\\\\n+\\\\\\\\n+提交2\\\\\\\\n\\\\\\\\\\\\\\\\ No newline at end of file\\\\\\\\n\\",\\n \\"newPath\\": \\"new_test.txt\\",\\n \\"oldPath\\": \\"test.txt\\",\\n \\"aMode\\": \\"100644\\",\\n \\"bMode\\": \\"100644\\",\\n \\"newFile\\": false,\\n \\"renamedFile\\": false,\\n \\"deletedFile\\": false,\\n \\"isBinary\\": false,\\n \\"oldId\\": \\"6c268061a546378276559c713d0ad377d4dsjfh\\",\\n \\"newId\\": \\"cb75846da2df3d3d7f290c3569236fcf3dd17224\\",\\n \\"isNewLfs\\": false,\\n \\"isOldLfs\\": false\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'CreateCommitStatus' => [ + 'summary' => '创建提交状态记录', + 'path' => '/api/v4/projects/repository/commit_statuses/create_commit_status', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryIdentity', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2080972', + ], + ], + [ + 'name' => 'sha', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'e0c1a1299a2656bfc155650bbd2df5e628fa1f4c', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'state' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'success', + ], + 'description' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'targetUrl' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + 'context' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '020F71F3-F063-5B8B-8978-2B01833216BB', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30815', + ], + 'sha' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'c0ca103441b9fa7f369be8d24a6f20db44dfddf7', + ], + 'context' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'default', + ], + 'state' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'targetUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + 'description' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'creator' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'aliyunPk' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '204485087002425236', + ], + 'login' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'codeup', + ], + 'avatarUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'type' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'User', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"020F71F3-F063-5B8B-8978-2B01833216BB\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"result\\": {\\n \\"id\\": 30815,\\n \\"sha\\": \\"c0ca103441b9fa7f369be8d24a6f20db44dfddf7\\",\\n \\"context\\": \\"default\\",\\n \\"state\\": \\"success\\",\\n \\"targetUrl\\": \\"xxx\\",\\n \\"description\\": \\"提交状态描述内容\\",\\n \\"creator\\": {\\n \\"aliyunPk\\": 204485087002425250,\\n \\"login\\": \\"codeup\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"type\\": \\"User\\"\\n }\\n }\\n}","type":"json"}]', + ], + 'ListCommitStatuses' => [ + 'summary' => '查询提交状态列表', + 'path' => '/api/v4/projects/repository/commit_statuses/list_commit_statuses', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryIdentity', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'sha', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '61cc69557962d29f737a91730b3e86f497f083a3', + ], + ], + [ + 'name' => 'page', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'total' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '28', + ], + 'result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19285', + ], + 'sha' => [ + 'description' => '', + 'type' => 'string', + 'example' => '61cc69557962d29f737a91730b3e86f497f083a3', + ], + 'context' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-commit-status-context', + ], + 'state' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'targetUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + 'description' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'creator' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'aliyunPk' => [ + 'description' => '', + 'type' => 'string', + 'example' => '235671547828975455', + ], + 'login' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'codeup', + ], + 'avatarUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'type' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'User', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"total\\": 28,\\n \\"result\\": [\\n {\\n \\"id\\": 19285,\\n \\"sha\\": \\"61cc69557962d29f737a91730b3e86f497f083a3\\",\\n \\"context\\": \\"test-commit-status-context\\",\\n \\"state\\": \\"success\\",\\n \\"targetUrl\\": \\"xxx\\",\\n \\"description\\": \\"描述信息的具体内容\\\\n\\",\\n \\"creator\\": {\\n \\"aliyunPk\\": \\"235671547828975455\\",\\n \\"login\\": \\"codeup\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"type\\": \\"User\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + ], + 'CreateCheckRun' => [ + 'summary' => '添加检查运行记录', + 'path' => '/api/v4/projects/check_runs/create_check_run', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryIdentity', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'my-check-ci', + ], + 'headSha' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '40f4ccfe019cdd4a62d4acb0c57130106fc7e1be', + ], + 'status' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'completed', + ], + 'conclusion' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'success', + ], + 'startedAt' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2023-03-15T08:00:00Z', + ], + 'completedAt' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2023-03-15T08:00:00Z', + ], + 'externalId' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '42', + ], + 'detailsUrl' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + 'output' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'title' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'Mighty Readme report', + ], + 'summary' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + 'text' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'images' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'alt' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'test-image-alt', + ], + 'imageUrl' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'xxx', + ], + 'caption' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'annotations' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'path' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'demo/test.txt', + ], + 'startLine' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + 'endLine' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2', + ], + 'startColumn' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3', + ], + 'endColumn' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5', + ], + 'annotationLevel' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'notice', + ], + 'message' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + 'title' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'rawDetails' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '524836', + ], + 'createdAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-01-14T21:08:26+08:00', + ], + 'updatedAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-01-14T21:08:26+08:00', + ], + 'startedAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2023-03-15T08:00:00Z', + ], + 'completedAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2023-03-15T08:00:00Z', + ], + 'externalId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '42', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'my-check-ci'."\n", + ], + 'headSha' => [ + 'description' => '', + 'type' => 'string', + 'example' => '40f4ccfe019cdd4a62d4acb0c57130106fc7e1be', + ], + 'status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'completed', + ], + 'conclusion' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'detailsUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + 'checkSuite' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + 'writer' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + 'type' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'User', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'slug' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'logoUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + 'output' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'title' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Mighty Readme report'."\n", + ], + 'summary' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'text' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'images' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'alt' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-image-alt', + ], + 'imageUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + 'caption' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + 'annotations' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'path' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'demo/test.txt', + ], + 'startLine' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'endLine' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'startColumn' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'endColumn' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'annotationLevel' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'notice', + ], + 'message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'title' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'rawDetails' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"result\\": {\\n \\"id\\": 524836,\\n \\"createdAt\\": \\"2022-01-14T21:08:26+08:00\\",\\n \\"updatedAt\\": \\"2022-01-14T21:08:26+08:00\\",\\n \\"startedAt\\": \\"2023-03-15T08:00:00Z\\",\\n \\"completedAt\\": \\"2023-03-15T08:00:00Z\\",\\n \\"externalId\\": \\"42\\",\\n \\"name\\": \\"my-check-ci\\\\n\\",\\n \\"headSha\\": \\"40f4ccfe019cdd4a62d4acb0c57130106fc7e1be\\",\\n \\"status\\": \\"completed\\",\\n \\"conclusion\\": \\"success\\",\\n \\"detailsUrl\\": \\"xxx\\",\\n \\"checkSuite\\": {\\n \\"id\\": 1\\n },\\n \\"writer\\": {\\n \\"id\\": \\"xxx\\",\\n \\"type\\": \\"User\\",\\n \\"name\\": \\"test-codeup\\",\\n \\"slug\\": \\"test-codeup\\",\\n \\"logoUrl\\": \\"xxx\\"\\n },\\n \\"output\\": {\\n \\"title\\": \\"Mighty Readme report\\\\n\\",\\n \\"summary\\": \\"摘要信息内容\\\\n\\",\\n \\"text\\": \\"详情信息内容\\\\n\\",\\n \\"images\\": [\\n {\\n \\"alt\\": \\"test-image-alt\\",\\n \\"imageUrl\\": \\"xxx\\",\\n \\"caption\\": \\"test\\"\\n }\\n ]\\n },\\n \\"annotations\\": [\\n {\\n \\"id\\": 2,\\n \\"path\\": \\"demo/test.txt\\",\\n \\"startLine\\": 1,\\n \\"endLine\\": 2,\\n \\"startColumn\\": 3,\\n \\"endColumn\\": 5,\\n \\"annotationLevel\\": \\"notice\\",\\n \\"message\\": \\"回写检查注释的简要描述信息\\\\n\\",\\n \\"title\\": \\"检查注释的标题\\",\\n \\"rawDetails\\": \\"详情信息\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'UpdateCheckRun' => [ + 'summary' => '更新检查运行记录', + 'path' => '/api/v4/projects/check_runs/update_check_run', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryIdentity', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'checkRunId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'my-check-ci'."\n", + ], + 'startedAt' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2023-03-15T08:00:00Z'."\n", + ], + 'completedAt' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2023-03-15T08:00:00Z'."\n", + ], + 'externalId' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '42', + ], + 'detailsUrl' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'xx', + ], + 'status' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'completed', + ], + 'conclusion' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'success', + ], + 'output' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'title' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Mighty Readme report', + ], + 'summary' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + 'text' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'images' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'alt' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'test-image-alt'."\n", + ], + 'imageUrl' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'xxx', + ], + 'caption' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'annotations' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'path' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'demo/test.txt'."\n", + ], + 'startLine' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + 'endLine' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2', + ], + 'startColumn' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3', + ], + 'endColumn' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5', + ], + 'annotationLevel' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'failure', + ], + 'message' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + 'title' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'rawDetails' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '524836', + ], + 'createdAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-01-14T21:08:26+08:00'."\n", + ], + 'updatedAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-01-14T21:08:26+08:00'."\n", + ], + 'startedAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2023-03-15T08:00:00Z'."\n", + ], + 'completedAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2023-03-15T08:00:00Z'."\n", + ], + 'externalId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '42', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'my-check-ci'."\n", + ], + 'headSha' => [ + 'description' => '', + 'type' => 'string', + 'example' => '40f4ccfe019cdd4a62d4acb0c57130106fc7e1be'."\n", + ], + 'status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'completed', + ], + 'conclusion' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'detailsUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + 'checkSuite' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + 'writer' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxx'."\n", + ], + 'type' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'User', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-codeup'."\n", + ], + 'slug' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-codeup'."\n", + ], + 'logoUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxx'."\n", + ], + ], + ], + 'output' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'title' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Mighty Readme report'."\n", + ], + 'summary' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'text' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'images' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'alt' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-image-alt'."\n", + ], + 'imageUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + 'caption' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test'."\n", + ], + ], + ], + ], + ], + ], + 'annotations' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'path' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'demo/test.txt'."\n", + ], + 'startLine' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'endLine' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'startColumn' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'endColumn' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'annotationLevel' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'warning', + ], + 'message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'title' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'rawDetails' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"result\\": {\\n \\"id\\": 524836,\\n \\"createdAt\\": \\"2022-01-14T21:08:26+08:00\\\\n\\",\\n \\"updatedAt\\": \\"2022-01-14T21:08:26+08:00\\\\n\\",\\n \\"startedAt\\": \\"2023-03-15T08:00:00Z\\\\n\\",\\n \\"completedAt\\": \\"2023-03-15T08:00:00Z\\\\n\\",\\n \\"externalId\\": \\"42\\",\\n \\"name\\": \\"my-check-ci\\\\n\\",\\n \\"headSha\\": \\"40f4ccfe019cdd4a62d4acb0c57130106fc7e1be\\\\n\\",\\n \\"status\\": \\"completed\\",\\n \\"conclusion\\": \\"success\\",\\n \\"detailsUrl\\": \\"xxx\\",\\n \\"checkSuite\\": {\\n \\"id\\": 1\\n },\\n \\"writer\\": {\\n \\"id\\": \\"xxx\\\\n\\",\\n \\"type\\": \\"User\\",\\n \\"name\\": \\"test-codeup\\\\n\\",\\n \\"slug\\": \\"test-codeup\\\\n\\",\\n \\"logoUrl\\": \\"xxx\\\\n\\"\\n },\\n \\"output\\": {\\n \\"title\\": \\"Mighty Readme report\\\\n\\",\\n \\"summary\\": \\"摘要信息内容\\\\n\\",\\n \\"text\\": \\"详情信息内容\\",\\n \\"images\\": [\\n {\\n \\"alt\\": \\"test-image-alt\\\\n\\",\\n \\"imageUrl\\": \\"xxx\\",\\n \\"caption\\": \\"test\\\\n\\"\\n }\\n ]\\n },\\n \\"annotations\\": [\\n {\\n \\"id\\": 1,\\n \\"path\\": \\"demo/test.txt\\\\n\\",\\n \\"startLine\\": 1,\\n \\"endLine\\": 2,\\n \\"startColumn\\": 3,\\n \\"endColumn\\": 5,\\n \\"annotationLevel\\": \\"warning\\",\\n \\"message\\": \\"回写检查注释的简要描述信息\\\\n\\",\\n \\"title\\": \\"检查注释的标题\\\\n\\",\\n \\"rawDetails\\": \\"详情信息\\\\n\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'GetCheckRun' => [ + 'summary' => '查询检查运行', + 'path' => '/api/v4/projects/check_runs/get_check_run', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryIdentity', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'checkRunId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5240', + ], + 'createdAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-01-14T21:08:26+08:00'."\n", + ], + 'updatedAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-01-14T21:08:26+08:00'."\n", + ], + 'startedAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2023-03-15T08:00:00Z'."\n", + ], + 'completedAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2023-03-15T08:00:00Z'."\n", + ], + 'externalId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '42', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'my-check-ci'."\n", + ], + 'headSha' => [ + 'description' => '', + 'type' => 'string', + 'example' => '40f4ccfe019cdd4a62d4acb0c57130106fc7e1be', + ], + 'status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'completed', + ], + 'conclusion' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'detailsUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + 'checkSuite' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + 'writer' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + 'type' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'User', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-codeup'."\n", + ], + 'slug' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'logoUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + 'output' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'title' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Mighty Readme report'."\n", + ], + 'summary' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'text' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'images' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'alt' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-image-alt'."\n", + ], + 'imageUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + 'caption' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + 'annotations' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'path' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'demo/test.txt'."\n", + ], + 'startLine' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'endLine' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'startColumn' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'endColumn' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + ], + 'annotationLevel' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'warning', + ], + 'message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'title' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'rawDetails' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"result\\": {\\n \\"id\\": 5240,\\n \\"createdAt\\": \\"2022-01-14T21:08:26+08:00\\\\n\\",\\n \\"updatedAt\\": \\"2022-01-14T21:08:26+08:00\\\\n\\",\\n \\"startedAt\\": \\"2023-03-15T08:00:00Z\\\\n\\",\\n \\"completedAt\\": \\"2023-03-15T08:00:00Z\\\\n\\",\\n \\"externalId\\": \\"42\\",\\n \\"name\\": \\"my-check-ci\\\\n\\",\\n \\"headSha\\": \\"40f4ccfe019cdd4a62d4acb0c57130106fc7e1be\\",\\n \\"status\\": \\"completed\\",\\n \\"conclusion\\": \\"success\\",\\n \\"detailsUrl\\": \\"xxx\\",\\n \\"checkSuite\\": {\\n \\"id\\": 1\\n },\\n \\"writer\\": {\\n \\"id\\": \\"xxx\\",\\n \\"type\\": \\"User\\",\\n \\"name\\": \\"test-codeup\\\\n\\",\\n \\"slug\\": \\"test-codeup\\",\\n \\"logoUrl\\": \\"xxx\\"\\n },\\n \\"output\\": {\\n \\"title\\": \\"Mighty Readme report\\\\n\\",\\n \\"summary\\": \\"摘要信息内容\\\\n\\",\\n \\"text\\": \\"详情信息内容\\\\n\\",\\n \\"images\\": [\\n {\\n \\"alt\\": \\"test-image-alt\\\\n\\",\\n \\"imageUrl\\": \\"xxx\\",\\n \\"caption\\": \\"test\\"\\n }\\n ]\\n },\\n \\"annotations\\": [\\n {\\n \\"id\\": 1,\\n \\"path\\": \\"demo/test.txt\\\\n\\",\\n \\"startLine\\": 1,\\n \\"endLine\\": 2,\\n \\"startColumn\\": 3,\\n \\"endColumn\\": 4,\\n \\"annotationLevel\\": \\"warning\\",\\n \\"message\\": \\"回写检查注释的简要描述信息\\\\n\\",\\n \\"title\\": \\"检查注释的标题\\\\n\\",\\n \\"rawDetails\\": \\"详情信息\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListCheckRuns' => [ + 'summary' => '查询检查运行列表', + 'path' => '/api/v4/projects/check_runs/list_check_runs', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513'."\n", + ], + ], + [ + 'name' => 'repositoryIdentity', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'ref', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '40f4ccfe019cdd4a62d4acb0c57130106fc7e1be', + ], + ], + [ + 'name' => 'page', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'createdAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-01-14T21:08:26+08:00'."\n", + ], + 'updatedAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-01-14T21:08:26+08:00'."\n", + ], + 'startedAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2023-03-15T08:00:00Z'."\n", + ], + 'completedAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2023-03-15T08:00:00Z'."\n", + ], + 'externalId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '42', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'my-check-ci'."\n", + ], + 'headSha' => [ + 'description' => '', + 'type' => 'string', + 'example' => '40f4ccfe019cdd4a62d4acb0c57130106fc7e1be', + ], + 'status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'completed', + ], + 'conclusion' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'detailsUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + 'checkSuite' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + 'writer' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + 'type' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'User', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-codeup'."\n", + ], + 'slug' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-codeup'."\n", + ], + 'logoUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + 'output' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'title' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Mighty Readme report'."\n", + ], + 'summary' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'text' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'images' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'alt' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-image-alt'."\n", + ], + 'imageUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + 'caption' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + 'annotations' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11806', + ], + 'path' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'demo/test.txt'."\n", + ], + 'startLine' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'endLine' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'startColumn' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'endColumn' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'annotationLevel' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'warning', + ], + 'message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'title' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'rawDetails' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"result\\": [\\n {\\n \\"id\\": 1,\\n \\"createdAt\\": \\"2022-01-14T21:08:26+08:00\\\\n\\",\\n \\"updatedAt\\": \\"2022-01-14T21:08:26+08:00\\\\n\\",\\n \\"startedAt\\": \\"2023-03-15T08:00:00Z\\\\n\\",\\n \\"completedAt\\": \\"2023-03-15T08:00:00Z\\\\n\\",\\n \\"externalId\\": \\"42\\",\\n \\"name\\": \\"my-check-ci\\\\n\\",\\n \\"headSha\\": \\"40f4ccfe019cdd4a62d4acb0c57130106fc7e1be\\",\\n \\"status\\": \\"completed\\",\\n \\"conclusion\\": \\"success\\",\\n \\"detailsUrl\\": \\"xxx\\",\\n \\"checkSuite\\": {\\n \\"id\\": 1\\n },\\n \\"writer\\": {\\n \\"id\\": \\"xxx\\",\\n \\"type\\": \\"User\\",\\n \\"name\\": \\"test-codeup\\\\n\\",\\n \\"slug\\": \\"test-codeup\\\\n\\",\\n \\"logoUrl\\": \\"xxx\\"\\n },\\n \\"output\\": {\\n \\"title\\": \\"Mighty Readme report\\\\n\\",\\n \\"summary\\": \\"摘要信息内容\\",\\n \\"text\\": \\"详情信息内容\\",\\n \\"images\\": [\\n {\\n \\"alt\\": \\"test-image-alt\\\\n\\",\\n \\"imageUrl\\": \\"xxx\\",\\n \\"caption\\": \\"test\\"\\n }\\n ]\\n },\\n \\"annotations\\": [\\n {\\n \\"id\\": 11806,\\n \\"path\\": \\"demo/test.txt\\\\n\\",\\n \\"startLine\\": 1,\\n \\"endLine\\": 2,\\n \\"startColumn\\": 3,\\n \\"endColumn\\": 5,\\n \\"annotationLevel\\": \\"warning\\",\\n \\"message\\": \\"回写检查注释的简要描述信息\\\\n\\",\\n \\"title\\": \\"检查注释的标题\\",\\n \\"rawDetails\\": \\"详情信息\\\\n\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'CreateTag' => [ + 'summary' => '创建标签Tag', + 'path' => '/repository/{repositoryId}/tags/create', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2080972', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'tagName' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'v1.0', + ], + 'ref' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'master', + ], + 'message' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0e3b6aa5eab2b086b59fde74766b28d4e5faab0d', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'v1.0', + ], + 'message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'commit' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'e0297d8fb0393c833a8531e7cc8832739e3cba6d', + ], + 'shortId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'e0297d8f', + ], + 'title' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'createdAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 10:00:00', + ], + 'authorName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'authorEmail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'authoredDate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 10:00:00', + ], + 'committerName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'committerEmail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'committedDate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 09:00:00', + ], + 'parentIds' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '34d2c47c7ce46a5c4639c5ffe208a66dda975a05', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F7B85D1B-D1C2-140F-A039-341859F130B9\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"id\\": \\"0e3b6aa5eab2b086b59fde74766b28d4e5faab0d\\",\\n \\"name\\": \\"v1.0\\",\\n \\"message\\": \\"描述内容\\",\\n \\"commit\\": {\\n \\"id\\": \\"e0297d8fb0393c833a8531e7cc8832739e3cba6d\\",\\n \\"shortId\\": \\"e0297d8f\\",\\n \\"title\\": \\"提交标题\\\\n\\",\\n \\"message\\": \\"具体的提交内容\\\\n\\",\\n \\"createdAt\\": \\"2022-03-18 10:00:00\\",\\n \\"authorName\\": \\"阿里云云效\\",\\n \\"authorEmail\\": \\"[email protected]\\",\\n \\"authoredDate\\": \\"2022-03-18 10:00:00\\",\\n \\"committerName\\": \\"阿里云云效committer\\",\\n \\"committerEmail\\": \\"[email protected]\\",\\n \\"committedDate\\": \\"2022-03-18 09:00:00\\",\\n \\"parentIds\\": [\\n \\"34d2c47c7ce46a5c4639c5ffe208a66dda975a05\\"\\n ]\\n }\\n }\\n}","type":"json"}]', + ], + 'DeleteTag' => [ + 'summary' => '删除标签', + 'path' => '/repository/{repositoryId}/tags/delete', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '609633ffd40eb063bac8165a', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2289464', + ], + ], + [ + 'name' => 'tagName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'v1.0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '60945D4F-CF6D-5CFF-89ED-1D1F6657032C', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'tagName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'v1.0', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"60945D4F-CF6D-5CFF-89ED-1D1F6657032C\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"tagName\\": \\"v1.0\\"\\n }\\n}","type":"json"}]', + ], + 'GetRepositoryTag' => [ + 'summary' => '查询单个标签', + 'path' => '/repository/{repositoryId}/tag/info', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2369234', + ], + ], + [ + 'name' => 'tagName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'tag v1.0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'CE7353E3-F989-56A9-B97C-897ABBDB9A01', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'string', + 'example' => '9a494e7b88ca35cde00579af2df4ab46136c022e', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'tag v1.0'."\n", + ], + 'message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'commit' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'e0297d8fb0393c833a8531e7cc8832739e3cba6d', + ], + 'shortId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'e0297d8f', + ], + 'title' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'createdAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 10:00:00', + ], + 'parentIds' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '34d2c47c7ce46a5c4639c5ffe208a66dda975a05', + ], + ], + 'authorName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'authorEmail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'authoredDate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 08:00:00', + ], + 'committerName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'committerEmail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'committedDate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 09:00:00', + ], + 'signature' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'gpgKeyId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'verificationStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'verified', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CE7353E3-F989-56A9-B97C-897ABBDB9A01\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"id\\": \\"9a494e7b88ca35cde00579af2df4ab46136c022e\\",\\n \\"name\\": \\"tag v1.0\\\\n\\",\\n \\"message\\": \\"具体的描述内容\\",\\n \\"commit\\": {\\n \\"id\\": \\"e0297d8fb0393c833a8531e7cc8832739e3cba6d\\",\\n \\"shortId\\": \\"e0297d8f\\",\\n \\"title\\": \\"提交标题\\",\\n \\"message\\": \\"具体的提交内容\\",\\n \\"createdAt\\": \\"2022-03-18 10:00:00\\",\\n \\"parentIds\\": [\\n \\"34d2c47c7ce46a5c4639c5ffe208a66dda975a05\\"\\n ],\\n \\"authorName\\": \\"阿里云云效\\",\\n \\"authorEmail\\": \\"[email protected]\\",\\n \\"authoredDate\\": \\"2022-03-18 08:00:00\\",\\n \\"committerName\\": \\"阿里云云效Committer\\",\\n \\"committerEmail\\": \\"[email protected]\\",\\n \\"committedDate\\": \\"2022-03-18 09:00:00\\",\\n \\"signature\\": {\\n \\"gpgKeyId\\": \\"\\\\\\"\\\\\\"\\",\\n \\"verificationStatus\\": \\"verified\\"\\n }\\n }\\n }\\n}","type":"json"}]', + ], + 'ListRepositoryTags' => [ + 'summary' => '查询标签列表', + 'path' => '/repository/{repositoryId}/tag/list', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '611b75680fc7bf0dbe1dce55', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2709413', + ], + ], + [ + 'name' => 'page', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'sort', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'updated_desc', + ], + ], + [ + 'name' => 'search', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Demo', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'total' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'string', + 'example' => '9a494e7b88ca35cde00579af2df4ab46136c022e', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'tag v1.0', + ], + 'message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'commit' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'de02b625ba8488f92eb204bcb3773a40c1b4ddac', + ], + 'shortId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'de02b625', + ], + 'title' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'createdAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 10:00:00', + ], + 'authorName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'authorEmail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'authoredDate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 10:00:00', + ], + 'committerName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'committerEmail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'committedDate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 09:00:00', + ], + 'parentIds' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '34d2c47c7ce46a5c4639c5ffe208a66dda975a05', + ], + ], + 'signature' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'gpgKeyId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'verificationStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'verified', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"total\\": 30,\\n \\"result\\": [\\n {\\n \\"id\\": \\"9a494e7b88ca35cde00579af2df4ab46136c022e\\",\\n \\"name\\": \\"tag v1.0\\",\\n \\"message\\": \\"具体的描述内容\\",\\n \\"commit\\": {\\n \\"id\\": \\"de02b625ba8488f92eb204bcb3773a40c1b4ddac\\",\\n \\"shortId\\": \\"de02b625\\",\\n \\"title\\": \\"提交标题\\",\\n \\"message\\": \\"修改main.txt文件\\",\\n \\"createdAt\\": \\"2022-03-18 10:00:00\\",\\n \\"authorName\\": \\"阿里云云效\\",\\n \\"authorEmail\\": \\"[email protected]\\",\\n \\"authoredDate\\": \\"2022-03-18 10:00:00\\",\\n \\"committerName\\": \\"阿里云云效Committer\\",\\n \\"committerEmail\\": \\"[email protected]\\",\\n \\"committedDate\\": \\"2022-03-18 09:00:00\\",\\n \\"parentIds\\": [\\n \\"34d2c47c7ce46a5c4639c5ffe208a66dda975a05\\"\\n ],\\n \\"signature\\": {\\n \\"gpgKeyId\\": \\"\\\\\\"\\\\\\"\\",\\n \\"verificationStatus\\": \\"verified\\"\\n }\\n }\\n }\\n ]\\n}","type":"json"}]', + ], + 'CreateProjectLabel' => [ + 'summary' => '创建代码库Label', + 'path' => '/api/v4/projects/labels', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryIdentity', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + 'color' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '#006AD4', + ], + 'description' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'A7586FEB-E48D-5579-983F-74981FBFF627', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'b5b5738b94954bc6aa5a293316ed1d24', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'color' => [ + 'description' => '', + 'type' => 'string', + 'example' => '#006AD4', + ], + 'description' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A7586FEB-E48D-5579-983F-74981FBFF627\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"result\\": {\\n \\"id\\": \\"b5b5738b94954bc6aa5a293316ed1d24\\",\\n \\"name\\": \\"新特性\\",\\n \\"color\\": \\"#006AD4\\",\\n \\"description\\": \\"新的特性或需求\\\\n\\"\\n }\\n}","type":"json"}]', + ], + 'UpdateProjectLabel' => [ + 'summary' => '更新代码库Label', + 'path' => '/api/v4/projects/labels/{labelId}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'labelId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '54e2699e538b4ba985177d6eb4d16cee', + ], + ], + [ + 'name' => 'repositoryIdentity', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'color' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '#EF433B', + ], + 'description' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'string', + 'example' => '8d84d73cf315473683400760f02dbfc1', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'color' => [ + 'description' => '', + 'type' => 'string', + 'example' => '#EF433B', + ], + 'description' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F7B85D1B-D1C2-140F-A039-341859F130B9\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"result\\": {\\n \\"id\\": \\"8d84d73cf315473683400760f02dbfc1\\",\\n \\"name\\": \\"缺陷\\",\\n \\"color\\": \\"#EF433B\\",\\n \\"description\\": \\"需要进行修复的缺陷\\"\\n }\\n}","type":"json"}]', + ], + 'DeleteProjectLabel' => [ + 'summary' => '删除代码库Label', + 'path' => '/api/v4/projects/labels/{labelId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'labelId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '54e2699e538b4ba985177d6eb4d16cee', + ], + ], + [ + 'name' => 'repositoryIdentity', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"result\\": {\\n \\"result\\": true\\n }\\n}","type":"json"}]', + ], + 'ListProjectLabels' => [ + 'summary' => '查询代码库Label列表', + 'path' => '/api/v4/projects/labels', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryIdentity', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'search', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'TEST', + ], + ], + [ + 'name' => 'page', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'orderBy', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'label_name', + ], + ], + [ + 'name' => 'sort', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + [ + 'name' => 'withCounts', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'total' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'f2bf0e0b4ce34a348b2d971c69a1d11f', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'color' => [ + 'description' => '', + 'type' => 'string', + 'example' => '#A16AD7', + ], + 'description' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'openMergeRequestsCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"total\\": 30,\\n \\"result\\": [\\n {\\n \\"id\\": \\"f2bf0e0b4ce34a348b2d971c69a1d11f\\",\\n \\"name\\": \\"优化\\",\\n \\"color\\": \\"#A16AD7\\",\\n \\"description\\": \\"已有内容的优化或重构\\",\\n \\"openMergeRequestsCount\\": 1\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListMergeRequestLabels' => [ + 'summary' => '查询合并请求Label列表', + 'path' => '/api/v4/projects/merge_requests/labels', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513'."\n", + ], + ], + [ + 'name' => 'repositoryIdentity', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'localId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '4D6AF7CC-B43B-5454-86AB-023D25E44868', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Invalid.IdNotFound', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'f2bf0e0b4ce34a348b2d971c69a1d11f', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'description' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'color' => [ + 'description' => '', + 'type' => 'string', + 'example' => '#A16AD7', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"4D6AF7CC-B43B-5454-86AB-023D25E44868\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"Invalid.IdNotFound\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"result\\": [\\n {\\n \\"id\\": \\"f2bf0e0b4ce34a348b2d971c69a1d11f\\",\\n \\"name\\": \\"优化\\",\\n \\"description\\": \\"已有内容的优化或重构\\",\\n \\"color\\": \\"#A16AD7\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'LinkMergeRequestLabel' => [ + 'summary' => '关联合并请求Label', + 'path' => '/api/v4/projects/merge_requests/link_labels', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryIdentity', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'localId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'labelIds' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f2bf0e0b4ce34a348b2d971c69a1d11f', + ], + 'required' => true, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"result\\": {\\n \\"result\\": true\\n }\\n}","type":"json"}]', + ], + 'AddWebhook' => [ + 'summary' => '添加代码库Webhook', + 'path' => '/repository/{repositoryId}/webhooks/create', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '2835387', + 'isFileTransferUrl' => false, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'url' => [ + 'title' => 'hook url', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'https://xxxxx', + ], + 'pushEvents' => [ + 'title' => '分支推送事件', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'mergeRequestsEvents' => [ + 'title' => '合并请求事件', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'tagPushEvents' => [ + 'title' => '标签推送事件', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'noteEvents' => [ + 'title' => '评论事件', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'enableSslVerification' => [ + 'title' => '使用ssl认证', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'description' => [ + 'title' => 'webhook描述', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'secretToken' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'xxxx', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '“”', + ], + 'requestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '6177543A-8D54-5736-A93B-E0195A1512CB', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_NOT_FOUND_ERROR', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'pushEvents' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'repositoryId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2835387', + ], + 'createdAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-12 12:00:00', + ], + 'url' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://xxxxx', + ], + 'tagPushEvents' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'lastTestResult' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ok', + ], + 'description' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'mergeRequestsEvents' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'secretToken' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'noteEvents' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30815', + ], + 'enableSslVerification' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'SystemError.UnKnownError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"errorMessage\\": \\"“”\\",\\n \\"requestId\\": \\"6177543A-8D54-5736-A93B-E0195A1512CB\\",\\n \\"errorCode\\": \\"SYSTEM_NOT_FOUND_ERROR\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"pushEvents\\": true,\\n \\"repositoryId\\": 2835387,\\n \\"createdAt\\": \\"2022-03-12 12:00:00\\",\\n \\"url\\": \\"https://xxxxx\\",\\n \\"tagPushEvents\\": true,\\n \\"lastTestResult\\": \\"ok\\",\\n \\"description\\": \\"线下测试\\",\\n \\"mergeRequestsEvents\\": true,\\n \\"secretToken\\": \\"xxxx\\",\\n \\"noteEvents\\": false,\\n \\"id\\": 30815,\\n \\"enableSslVerification\\": false\\n }\\n}","errorExample":""},{"type":"xml","example":"<AddWebhookResponse>\\n <errorMessage>“”</errorMessage>\\n <requestId>6177543A-8D54-5736-A93B-E0195A1512CB</requestId>\\n <errorCode>SYSTEM_NOT_FOUND_ERROR</errorCode>\\n <success>true</success>\\n <result>\\n <pushEvents>true</pushEvents>\\n <repositoryId>2835387</repositoryId>\\n <createdAt>2022-03-12 12:00:00</createdAt>\\n <url>https://xxxxx</url>\\n <tagPushEvents>true</tagPushEvents>\\n <lastTestResult>ok</lastTestResult>\\n <description>线下测试</description>\\n <mergeRequestsEvents>true</mergeRequestsEvents>\\n <secretToken>xxxx</secretToken>\\n <noteEvents>false</noteEvents>\\n <id>30815</id>\\n <enableSslVerification>false</enableSslVerification>\\n </result>\\n</AddWebhookResponse>","errorExample":""}]', + ], + 'DeleteRepositoryWebhook' => [ + 'summary' => '删除代码库Webhook', + 'path' => '/repository/{repositoryId}/hooks/{hookId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513'."\n", + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2369234', + ], + ], + [ + 'name' => 'hookId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '524836', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '524836', + ], + 'url' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://xxxxx', + ], + 'createdAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54', + ], + 'projectId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2369234', + ], + 'pushEvents' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'issuesEvents' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'mergeRequestsEvents' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'tagPushEvents' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'buildEvents' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'noteEvents' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'enableSslVerification' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'lastTestResult' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'description' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'secretToken' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'type' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ProjectHook', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F7B85D1B-D1C2-140F-A039-341859F130B9\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"id\\": 524836,\\n \\"url\\": \\"https://xxxxx\\",\\n \\"createdAt\\": \\"2022-03-18 14:24:54\\",\\n \\"projectId\\": 2369234,\\n \\"pushEvents\\": true,\\n \\"issuesEvents\\": false,\\n \\"mergeRequestsEvents\\": true,\\n \\"tagPushEvents\\": true,\\n \\"buildEvents\\": false,\\n \\"noteEvents\\": true,\\n \\"enableSslVerification\\": false,\\n \\"lastTestResult\\": \\"\\\\\\"\\\\\\"\\",\\n \\"description\\": \\"Webhook描述内容\\",\\n \\"secretToken\\": \\"xxxx\\",\\n \\"type\\": \\"ProjectHook\\"\\n }\\n}","type":"json"}]', + ], + 'ListRepositoryWebhook' => [ + 'summary' => '查询代码库Webhook列表', + 'path' => '/repository/{repositoryId}/webhooks/list', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'title' => 'accessToken', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => '企业Id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'title' => '代码仓库Id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '', + 'isFileTransferUrl' => false, + ], + ], + [ + 'name' => 'page', + 'in' => 'query', + 'schema' => [ + 'title' => '页码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页数据量', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '100', + 'minimum' => '0', + 'example' => '10', + 'default' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'requestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'HC93CE1A-8D7A-13A9-8306-7465DE2E5C0F', + ], + 'total' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'pushEvents' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'projectId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '', + ], + 'createdAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54', + ], + 'url' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://xxxx', + ], + 'tagPushEvents' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'lastTestResult' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'mergeRequestsEvents' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'description' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'noteEvents' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'secretToken' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '16776', + ], + 'enableSslVerification' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'SystemError.UnKnownError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"errorMessage\\": \\"“”\\",\\n \\"requestId\\": \\"HC93CE1A-8D7A-13A9-8306-7465DE2E5C0F\\",\\n \\"total\\": 100,\\n \\"success\\": true,\\n \\"errorCode\\": \\"SYSTEM_NOT_FOUND_ERROR\\",\\n \\"result\\": [\\n {\\n \\"pushEvents\\": false,\\n \\"projectId\\": 2825387,\\n \\"createdAt\\": \\"2022-03-18 14:24:54\\",\\n \\"url\\": \\"https://xxxx\\",\\n \\"tagPushEvents\\": false,\\n \\"lastTestResult\\": \\"ok\\",\\n \\"mergeRequestsEvents\\": true,\\n \\"description\\": \\"线下测试\\",\\n \\"noteEvents\\": false,\\n \\"secretToken\\": \\"xxxx\\",\\n \\"id\\": 16776,\\n \\"enableSslVerification\\": false\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListRepositoryWebhookResponse>\\n <errorMessage>“”</errorMessage>\\n <requestId>HC93CE1A-8D7A-13A9-8306-7465DE2E5C0F</requestId>\\n <total>100</total>\\n <success>true</success>\\n <errorCode>SYSTEM_NOT_FOUND_ERROR</errorCode>\\n <result>\\n <pushEvents>false</pushEvents>\\n <projectId>2825387</projectId>\\n <createdAt>2022-03-18 14:24:54</createdAt>\\n <url>https://xxxx</url>\\n <tagPushEvents>false</tagPushEvents>\\n <lastTestResult>OK</lastTestResult>\\n <mergeRequestsEvents>true</mergeRequestsEvents>\\n <description>线下测试</description>\\n <noteEvents>false</noteEvents>\\n <secretToken>xxxx</secretToken>\\n <id>16776</id>\\n <enableSslVerification>false</enableSslVerification>\\n </result>\\n</ListRepositoryWebhookResponse>","errorExample":""}]', + ], + 'CreateRepositoryGroup' => [ + 'summary' => '创建代码组', + 'path' => '/repository/groups/create', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'test-create-group', + ], + 'path' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'test-create-group', + ], + 'visibilityLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + 'parentId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '26842', + ], + 'description' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'avatarUrl' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '18685', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-create-group', + ], + 'path' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-create-group', + ], + 'description' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'avatarUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'webUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'pathWithNamespace' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'codeup-test-org/test-create-group', + ], + 'nameWithNamespace' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'type' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Group', + ], + 'visibilityLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'parentId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '26842', + ], + 'ownerId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19230', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F7B85D1B-D1C2-140F-A039-341859F130B9\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"id\\": 18685,\\n \\"name\\": \\"test-create-group\\",\\n \\"path\\": \\"test-create-group\\",\\n \\"description\\": \\"描述信息的具体内容\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"webUrl\\": \\"\\\\\\"\\\\\\"\\",\\n \\"pathWithNamespace\\": \\"codeup-test-org/test-create-group\\",\\n \\"nameWithNamespace\\": \\"codeup-test-org / test-create-group （斜杠两侧有空格）\\",\\n \\"type\\": \\"Group\\",\\n \\"visibilityLevel\\": 10,\\n \\"parentId\\": 26842,\\n \\"ownerId\\": 19230\\n }\\n}","type":"json"}]', + ], + 'DeleteRepositoryGroup' => [ + 'summary' => '删除代码组', + 'path' => '/repository/groups/{groupId}/remove', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '624666bd54d036291ae13a36', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '22901', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'reason' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '30F2DA15-2877-5FC9-BC71-F7F394717907', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"30F2DA15-2877-5FC9-BC71-F7F394717907\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"result\\": true\\n }\\n}","type":"json"}]', + ], + 'UpdateGroup' => [ + 'summary' => '更新单个代码组信息', + 'path' => '/groups/modify', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1e9903d8b3f1xxxxxf9286ef5', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61dxxxxxxx975a93f9129d2513', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'pathWithNamespace' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'org/group/subgroup/here', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'codeup_group', + ], + 'path' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'codeup_group', + ], + 'visibilityLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + 'description' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'avatarUrl' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'InvalidParam.NoPermission', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30815', + ], + 'pathWithNamespace' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'codeup-test-org/test-codeup', + ], + 'nameWithNamespace' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'codeup', + ], + 'path' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'ownerId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19230', + ], + 'parentId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '26842', + ], + 'description' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'avatarUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c4ef67f1bea827c4/w/100/h/100', + ], + 'webUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'type' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Group', + ], + 'visibilityLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorCode\\": \\"success\\",\\n \\"errorMessage\\": \\"InvalidParam.NoPermission\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"id\\": 30815,\\n \\"pathWithNamespace\\": \\"codeup-test-org/test-codeup\\",\\n \\"nameWithNamespace\\": \\"codeup-test-org / codeup（斜杠两侧有空格）\\",\\n \\"name\\": \\"codeup\\",\\n \\"path\\": \\"test-codeup\\",\\n \\"ownerId\\": 19230,\\n \\"parentId\\": 26842,\\n \\"description\\": \\"描述信息的具体内容\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c4ef67f1bea827c4/w/100/h/100\\",\\n \\"webUrl\\": \\"\\\\\\"\\\\\\"\\",\\n \\"type\\": \\"Group\\",\\n \\"visibilityLevel\\": 10\\n }\\n}","type":"json"}]', + ], + 'GetGroupDetail' => [ + 'summary' => '查询代码组信息', + 'path' => '/repository/groups/get_detail', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '6218766746d4d2ca636d0497', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'groupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '36612', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '4CA06B0B-5867-5DE6-A0FA-9F39C97B524C', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '36612', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-group-detail', + ], + 'path' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-group-detail', + ], + 'description' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'avatarUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'webUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'pathWithNamespace' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'codeup-test-org/test-group-detail', + ], + 'nameWithNamespace' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'type' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Group', + ], + 'visibilityLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'parentId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '26842', + ], + 'ownerId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19230', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"4CA06B0B-5867-5DE6-A0FA-9F39C97B524C\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"id\\": 36612,\\n \\"name\\": \\"test-group-detail\\",\\n \\"path\\": \\"test-group-detail\\",\\n \\"description\\": \\"描述信息的具体内容\\\\n\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"webUrl\\": \\"\\\\\\"\\\\\\"\\",\\n \\"pathWithNamespace\\": \\"codeup-test-org/test-group-detail\\",\\n \\"nameWithNamespace\\": \\"codeup-test-org / test-group-detail（斜杠两侧有空格）\\",\\n \\"type\\": \\"Group\\",\\n \\"visibilityLevel\\": 10,\\n \\"parentId\\": 26842,\\n \\"ownerId\\": 19230\\n }\\n}","type":"json"}]', + ], + 'GetGroupByPath' => [ + 'summary' => '根据路径查询代码组', + 'path' => '/api/4/groups/find_by_path', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'identity', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957/test-group', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '6177543A-8D54-5736-A93B-E0195A1512CB', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30815', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-group', + ], + 'path' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-group', + ], + 'pathWithNamespace' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'codeup-test-org/test-group', + ], + 'nameWithNamespace' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'visibilityLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'description' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'avatarUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'webUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + 'parentId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '26842', + ], + 'ownerId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '19230', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"6177543A-8D54-5736-A93B-E0195A1512CB\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"result\\": {\\n \\"id\\": 30815,\\n \\"name\\": \\"test-group\\",\\n \\"path\\": \\"test-group\\",\\n \\"pathWithNamespace\\": \\"codeup-test-org/test-group\\",\\n \\"nameWithNamespace\\": \\"codeup-test-org / test-group（斜杠两侧有空格）\\",\\n \\"visibilityLevel\\": 0,\\n \\"description\\": \\"描述内容\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"webUrl\\": \\"xxx\\",\\n \\"parentId\\": \\"26842\\",\\n \\"ownerId\\": \\"19230\\"\\n }\\n}","type":"json"}]', + ], + 'ListRepositoryGroups' => [ + 'summary' => '查询代码组列表', + 'path' => '/repository/groups/get/all', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'parentId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '26842', + ], + ], + [ + 'name' => 'page', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'search', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Demo', + ], + ], + [ + 'name' => 'orderBy', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'updated_at', + ], + ], + [ + 'name' => 'sort', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + [ + 'name' => 'includePersonal', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'total' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19285', + ], + 'path' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'nameWithNamespace' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'pathWithNamespace' => [ + 'description' => '', + 'type' => 'string', + 'example' => '60de7a6852743a5162b5f957/test-codeup', + ], + 'visibilityLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'avatarUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'webUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'type' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Group', + ], + 'description' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'parentId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '26842', + ], + 'ownerId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19230', + ], + 'accessLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + 'projectCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'groupCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'createdAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54', + ], + 'updatedAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F7B85D1B-D1C2-140F-A039-341859F130B9\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"total\\": 100,\\n \\"result\\": [\\n {\\n \\"id\\": 19285,\\n \\"path\\": \\"test-codeup\\",\\n \\"name\\": \\"test-codeup\\",\\n \\"nameWithNamespace\\": \\"60de7a6852743a5162b5f957 / test-codeup（斜杠两侧有空格）\\",\\n \\"pathWithNamespace\\": \\"60de7a6852743a5162b5f957/test-codeup\\",\\n \\"visibilityLevel\\": 0,\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"webUrl\\": \\"\\\\\\"\\\\\\"\\",\\n \\"type\\": \\"Group\\",\\n \\"description\\": \\"描述信息的具体内容\\",\\n \\"parentId\\": 26842,\\n \\"ownerId\\": 19230,\\n \\"accessLevel\\": 40,\\n \\"projectCount\\": 10,\\n \\"groupCount\\": 10,\\n \\"createdAt\\": \\"2022-03-18 14:24:54\\",\\n \\"updatedAt\\": \\"2022-03-18 14:24:54\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListGroupRepositories' => [ + 'summary' => '查询代码组下的库列表', + 'path' => '/repository/groups/{groupId}/projects', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '60ee8a814690c27532d412f8', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '35117', + ], + ], + [ + 'name' => 'page', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'search', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Demo', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '9293CBDA-B5BC-5AD6-A8F4-C7873AC7A3DF', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'total' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '89616', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-group-repo', + ], + 'path' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-group-repo', + ], + 'nameWithNamespace' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'pathWithNamespace' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'codeup-test-org/test-group-repo', + ], + 'lastActivityAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54', + ], + 'createdAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54', + ], + 'updatedAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54', + ], + 'visibilityLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'starCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'webUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'sshUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'git@xxx:xxx/test/test.git', + ], + 'httpUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://xxx/test/test', + ], + 'description' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'privateFlag' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'creatorId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19238', + ], + 'issuesEnabled' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'mergeRequestsEnabled' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'wikiEnabled' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'namespaceId' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => '100003', + ], + 'snippetsEnabled' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'importUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'http://xxx/x', + ], + 'archived' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'commitCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'isStared' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"9293CBDA-B5BC-5AD6-A8F4-C7873AC7A3DF\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": true,\\n \\"total\\": 2,\\n \\"result\\": [\\n {\\n \\"id\\": 89616,\\n \\"name\\": \\"test-group-repo\\",\\n \\"path\\": \\"test-group-repo\\",\\n \\"nameWithNamespace\\": \\"codeup-test-org / test-group-repo（斜杠两侧有空格）\\",\\n \\"pathWithNamespace\\": \\"codeup-test-org/test-group-repo\\",\\n \\"lastActivityAt\\": \\"2022-03-18 14:24:54\\",\\n \\"createdAt\\": \\"2022-03-18 14:24:54\\",\\n \\"updatedAt\\": \\"2022-03-18 14:24:54\\",\\n \\"visibilityLevel\\": 0,\\n \\"starCount\\": 0,\\n \\"webUrl\\": \\"\\\\\\"\\\\\\"\\",\\n \\"sshUrl\\": \\"git@xxx:xxx/test/test.git\\",\\n \\"httpUrl\\": \\"https://xxx/test/test\\",\\n \\"description\\": \\"描述详情内容\\",\\n \\"privateFlag\\": true,\\n \\"creatorId\\": 19238,\\n \\"issuesEnabled\\": true,\\n \\"mergeRequestsEnabled\\": true,\\n \\"wikiEnabled\\": true,\\n \\"namespaceId\\": true,\\n \\"snippetsEnabled\\": false,\\n \\"importUrl\\": \\"http://xxx/x\\",\\n \\"archived\\": false,\\n \\"commitCount\\": 10,\\n \\"isStared\\": true\\n }\\n ]\\n}","type":"json"}]', + ], + 'UpdatePushReviewOnOff' => [ + 'summary' => '推送评审模式开关', + 'path' => '/repository/{repositoryId}/settings/trunk_mode', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2813489', + ], + ], + [ + 'name' => 'trunkMode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '6177543A-8D54-5736-A93B-E0195A1512CB', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"6177543A-8D54-5736-A93B-E0195A1512CB\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"result\\": true\\n }\\n}","type":"json"}]', + ], + 'CreatePushRule' => [ + 'summary' => '创建推送规则', + 'path' => '/api/v4/projects/{repositoryId}/push_rule', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '187687', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ruleInfos' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'checkerName' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'CommitMessageChecker', + ], + 'extraMessage' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '[email protected]', + ], + 'checkerType' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'warn', + ], + 'fileRuleRegexes' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '\\.java$', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2077', + ], + 'ruleInfos' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'checkerName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ForcePushChecker', + ], + 'checkerType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'warn', + ], + 'extraMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'disabled', + ], + 'fileRuleRegexes' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '\\.java$'."\n", + ], + ], + ], + ], + ], + 'gmtCreate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2023-09-03T18:20:06+08:00', + ], + 'gmtModified' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2023-09-03T18:20:06+08:00', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"id\\": 2077,\\n \\"ruleInfos\\": [\\n {\\n \\"checkerName\\": \\"ForcePushChecker\\",\\n \\"checkerType\\": \\"warn\\",\\n \\"extraMessage\\": \\"disabled\\",\\n \\"fileRuleRegexes\\": [\\n \\"\\\\\\\\.java$\\\\n\\"\\n ]\\n }\\n ],\\n \\"gmtCreate\\": \\"2023-09-03T18:20:06+08:00\\",\\n \\"gmtModified\\": \\"2023-09-03T18:20:06+08:00\\"\\n }\\n}","type":"json"}]', + ], + 'UpdatePushRule' => [ + 'summary' => '更新推送规则', + 'path' => '/api/v4/projects/{repositoryId}/push_rule/{pushRuleId}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2709413', + ], + ], + [ + 'name' => 'pushRuleId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2077', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ruleInfos' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'checkerName' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'CommitAuthorChecker', + ], + 'extraMessage' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + 'checkerType' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'warn', + ], + 'fileRuleRegexes' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '\\.java$', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'ruleInfos' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'checkerName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CommitAuthorChecker', + ], + 'checkerType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'warn', + ], + 'extraMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'on', + ], + 'fileRuleRegexes' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '\\.java$', + ], + ], + ], + ], + ], + 'gmtCreate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2023-09-03T18:20:06+08:00', + ], + 'gmtModified' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2023-09-03T18:20:06+08:00', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"id\\": 30815,\\n \\"ruleInfos\\": [\\n {\\n \\"checkerName\\": \\"CommitAuthorChecker\\",\\n \\"checkerType\\": \\"warn\\",\\n \\"extraMessage\\": \\"on\\",\\n \\"fileRuleRegexes\\": [\\n \\"\\\\\\\\.java$\\"\\n ]\\n }\\n ],\\n \\"gmtCreate\\": \\"2023-09-03T18:20:06+08:00\\",\\n \\"gmtModified\\": \\"2023-09-03T18:20:06+08:00\\"\\n }\\n}","type":"json"}]', + ], + 'DeletePushRule' => [ + 'summary' => '删除推送规则', + 'path' => '/api/v4/projects/{repositoryId}/push_rule/{pushRuleId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '60d54f3daccf2bbd6659f3ad', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2813489', + ], + ], + [ + 'name' => 'pushRuleId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2077', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'InvalidParam.NotFound', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorCode\\": \\"InvalidParam.NotFound\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": \\"true\\",\\n \\"result\\": {\\n \\"result\\": true\\n }\\n}","type":"json"}]', + ], + 'ListPushRules' => [ + 'summary' => '查询推送规则列表', + 'path' => '/api/v4/projects/{repositoryId}/push_rule/push_rules/list', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '60d54f3daccf2bbd6659f3ad', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '889910', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'total' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2077', + ], + 'ruleInfos' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'checkerName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CommitFilesChecker', + ], + 'checkerType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'warn', + ], + 'extraMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'fileRuleRegexes' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '\\.java$', + ], + ], + ], + ], + ], + 'gmtCreate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2023-09-03T18:20:06+08:00', + ], + 'gmtModified' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2023-09-03T18:20:06+08:00', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"total\\": 2,\\n \\"result\\": [\\n {\\n \\"id\\": 2077,\\n \\"ruleInfos\\": [\\n {\\n \\"checkerName\\": \\"CommitFilesChecker\\",\\n \\"checkerType\\": \\"warn\\",\\n \\"extraMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"fileRuleRegexes\\": [\\n \\"\\\\\\\\.java$\\"\\n ]\\n }\\n ],\\n \\"gmtCreate\\": \\"2023-09-03T18:20:06+08:00\\",\\n \\"gmtModified\\": \\"2023-09-03T18:20:06+08:00\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'CreateDeployKey' => [ + 'summary' => '创建部署密钥', + 'path' => '/repository/{repositoryId}/keys/create', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2813489', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'title' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + 'key' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '""', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '502385', + ], + 'title' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'key' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'fingerprint' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xx:xx:xx:xx', + ], + 'createdAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"id\\": 502385,\\n \\"title\\": \\"测试密钥\\",\\n \\"key\\": \\"\\\\\\"\\\\\\"\\",\\n \\"fingerprint\\": \\"xx:xx:xx:xx\\",\\n \\"createdAt\\": \\"2022-03-18 14:24:54\\"\\n }\\n}","type":"json"}]', + ], + 'EnableDeployKey' => [ + 'summary' => '启用部署密钥', + 'path' => '/repository/{repositoryId}/keys/{keyId}/enable', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2709413', + ], + ], + [ + 'name' => 'keyId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '50998', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"result\\": true\\n }\\n}","type":"json"}]', + ], + 'CreateUserKey' => [ + 'summary' => '创建SSH Key密钥', + 'path' => '/api/v3/user/keys/create', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513'."\n", + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'publicKey' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'xxx', + ], + 'title' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'SSH Title', + ], + 'keyScope' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ALL', + ], + 'expireTime' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2022-03-12 12:00:00', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11072', + ], + 'title' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'My Title', + ], + 'publicKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + 'fingerPrint' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + 'keyScope' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ALL', + ], + 'createdAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-12 12:00:00', + ], + 'expireTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-12 12:00:00', + ], + 'lastUsedTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-12 12:00:00', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"errorMessage\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"id\\": 11072,\\n \\"title\\": \\"My Title\\",\\n \\"publicKey\\": \\"xxx\\",\\n \\"fingerPrint\\": \\"xxx\\",\\n \\"keyScope\\": \\"ALL\\",\\n \\"createdAt\\": \\"2022-03-12 12:00:00\\",\\n \\"expireTime\\": \\"2022-03-12 12:00:00\\",\\n \\"lastUsedTime\\": \\"2022-03-12 12:00:00\\"\\n }\\n}","type":"json"}]', + ], + 'DeleteUserKey' => [ + 'summary' => '删除用户的SSH Key', + 'path' => '/api/v3/user/keys/{keyId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'keyId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '50998', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50998', + ], + 'createdAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54', + ], + 'updatedAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54', + ], + 'title' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'fingerPrint' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + 'shaContext' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + 'publicKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + 'context' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + 'expireTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54'."\n", + ], + 'lastUsedTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54'."\n", + ], + 'keyScope' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ALL', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"errorMessage\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"id\\": 50998,\\n \\"createdAt\\": \\"2022-03-18 14:24:54\\",\\n \\"updatedAt\\": \\"2022-03-18 14:24:54\\",\\n \\"title\\": \\"密钥标题\\",\\n \\"fingerPrint\\": \\"xxx\\",\\n \\"shaContext\\": \\"xxx\\",\\n \\"publicKey\\": \\"xxx\\",\\n \\"context\\": \\"xxx\\",\\n \\"expireTime\\": \\"2022-03-18 14:24:54\\\\n\\",\\n \\"lastUsedTime\\": \\"2022-03-18 14:24:54\\\\n\\",\\n \\"keyScope\\": \\"ALL\\"\\n }\\n}","type":"json"}]', + ], + 'ListUserKeys' => [ + 'summary' => '查询当前用户的SSH Key列表', + 'path' => '/api/v3/user/keys', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513'."\n", + ], + ], + [ + 'name' => 'page', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'sort', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + [ + 'name' => 'orderBy', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'created_at', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5240', + ], + 'title' => [ + 'type' => 'string', + ], + 'publicKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + 'fingerPrint' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + 'keyScope' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ALL', + ], + 'createdAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54', + ], + 'expireTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54', + ], + 'lastUsedTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F7B85D1B-D1C2-140F-A039-341859F130B9\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"errorMessage\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"result\\": [\\n {\\n \\"id\\": 5240,\\n \\"title\\": \\"My Title\\",\\n \\"publicKey\\": \\"xxx\\",\\n \\"fingerPrint\\": \\"xxx\\",\\n \\"keyScope\\": \\"ALL\\",\\n \\"createdAt\\": \\"2022-03-18 14:24:54\\",\\n \\"expireTime\\": \\"2022-03-18 14:24:54\\",\\n \\"lastUsedTime\\": \\"2022-03-18 14:24:54\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListSearchSourceCode' => [ + 'summary' => '搜索代码片段', + 'path' => '/search/code', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '66c0c9fffeb86b450c199fcd', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'keyword' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + 'page' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'pageSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + 'sort' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + 'order' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + 'scope' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'all', + ], + 'repoPath' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'value' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + 'operatorType' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'equal', + ], + 'matchType' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'term', + ], + ], + 'required' => false, + ], + 'filePath' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'value' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'orgId/test-group/spring-boot-demo/test.java', + ], + 'operatorType' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'equal', + ], + 'matchType' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'term', + ], + ], + 'required' => false, + ], + 'language' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Java', + ], + 'isCodeBlock' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => ' '."\n" + .'SYSTEM_UNKNOWN_ERROR', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'total' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'docId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '60d54f3daccf2bbd6659f3ad/gitlabhq/master/spec/frontend/snippets/test_utils.js', + ], + 'highlightTextMap' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'organizationId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '60de7a6852743a5162b5f957', + ], + 'fileName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test.java', + ], + 'clob' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + 'language' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'java', + ], + ], + ], + 'source' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'repoPath' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'codeup/test-repo', + ], + 'fileName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test_utils.js', + ], + 'filePath' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'spec/frontend/snippets/test_utils.js', + ], + 'language' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'JavaScript', + ], + 'checkinDate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-10-10 10:00:00', + ], + 'branch' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'master', + ], + 'organizationId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '60de7a6852743a5162b5f957', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\t\\\\nSYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": true,\\n \\"total\\": 2,\\n \\"result\\": [\\n {\\n \\"docId\\": \\"60d54f3daccf2bbd6659f3ad/gitlabhq/master/spec/frontend/snippets/test_utils.js\\",\\n \\"highlightTextMap\\": {\\n \\"organizationId\\": \\"60de7a6852743a5162b5f957\\",\\n \\"fileName\\": \\"test.java\\",\\n \\"clob\\": \\"xxx\\",\\n \\"language\\": \\"java\\"\\n },\\n \\"source\\": {\\n \\"repoPath\\": \\"codeup/test-repo\\",\\n \\"fileName\\": \\"test_utils.js\\",\\n \\"filePath\\": \\"spec/frontend/snippets/test_utils.js\\",\\n \\"language\\": \\"JavaScript\\",\\n \\"checkinDate\\": \\"2022-10-10 10:00:00\\",\\n \\"branch\\": \\"master\\",\\n \\"organizationId\\": \\"60de7a6852743a5162b5f957\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListSearchRepository' => [ + 'summary' => '搜索代码仓库数据', + 'path' => '/search/repo', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '61e54b0e0bb300d827e1ae27', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'keyword' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + 'aliyunPk' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1840004904455497', + ], + 'visibilityLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'page' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'pageSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + 'sort' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + 'order' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + 'scope' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'all', + ], + 'repoPath' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'value' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'orgId/test-group/spring-boot-demo', + ], + 'operatorType' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'equal', + ], + 'matchType' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'term', + ], + ], + 'required' => false, + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'total' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'docId' => [ + 'description' => '', + 'type' => 'string', + 'example' => ' '."\n" + .'60d54f3daccf2bbd6659f3ad/gitlabhq/master/config/environments/test.rb', + ], + 'highlightTextMap' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'organizationId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '60de7a6852743a5162b5f957', + ], + 'creatorUserId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + 'repoPath' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'codeup/test-repo', + ], + 'repoNameWithNamespace' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'codeup/test-repo', + ], + 'readMe' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xx', + ], + 'description' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + 'source' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'repoName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-repo', + ], + 'repoPath' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'codeup/test-repo', + ], + 'description' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'visibilityLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'createTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-10-10 10:10:10', + ], + 'lastActivityTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-11-11 11:11:11', + ], + 'readMe' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + 'organizationId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '62a94a8611fc0f0c9e2a7bc1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F7B85D1B-D1C2-140F-A039-341859F130B9\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"total\\": 30,\\n \\"result\\": [\\n {\\n \\"docId\\": \\"\\\\t\\\\n60d54f3daccf2bbd6659f3ad/gitlabhq/master/config/environments/test.rb\\",\\n \\"highlightTextMap\\": {\\n \\"organizationId\\": \\"60de7a6852743a5162b5f957\\",\\n \\"creatorUserId\\": \\"xxx\\",\\n \\"repoPath\\": \\"codeup/test-repo\\",\\n \\"repoNameWithNamespace\\": \\"codeup/test-repo\\",\\n \\"readMe\\": \\"xx\\",\\n \\"description\\": \\"描述内容\\"\\n },\\n \\"source\\": {\\n \\"repoName\\": \\"test-repo\\",\\n \\"repoPath\\": \\"codeup/test-repo\\",\\n \\"description\\": \\"描述内容\\",\\n \\"visibilityLevel\\": 0,\\n \\"createTime\\": \\"2022-10-10 10:10:10\\",\\n \\"lastActivityTime\\": \\"2022-11-11 11:11:11\\",\\n \\"readMe\\": \\"xxx\\",\\n \\"organizationId\\": \\"62a94a8611fc0f0c9e2a7bc1\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListSearchCommit' => [ + 'summary' => '搜索代码提交数据', + 'path' => '/search/commit', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '60d54f3daccf2bbd6659f3ad', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'keyword' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + 'page' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'pageSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + 'order' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + 'sort' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + 'scope' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'all', + ], + 'repoPath' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'value' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'orgId/test-group/spring-boot-demo', + ], + 'operatorType' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'equal', + ], + 'matchType' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'term', + ], + ], + 'required' => false, + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'total' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'docId' => [ + 'description' => '', + 'type' => 'string', + 'example' => ' '."\n" + .'60d54f3daccf2bbd6659f3ad/gitlabhq/master/config/environments/test.rb', + ], + 'highlightTextMap' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'commitId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'df1b701cb0f3f7ca92320d49d31995821f2d045c', + ], + 'title' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'commitMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'organizationId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '60de7a6852743a5162b5f957', + ], + ], + ], + 'source' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'commitId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'a748f5ecb17a93900d4808944bfcc96dc158ee2d', + ], + 'title' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'commitMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'authorTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-11-11 11:11:11', + ], + 'repoPath' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'codeup/test-repo', + ], + 'organizationId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '61133b011bd96aa110f1b500', + ], + 'author' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'email' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F7B85D1B-D1C2-140F-A039-341859F130B9\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": true,\\n \\"total\\": 10,\\n \\"result\\": [\\n {\\n \\"docId\\": \\"\\\\t\\\\n60d54f3daccf2bbd6659f3ad/gitlabhq/master/config/environments/test.rb\\",\\n \\"highlightTextMap\\": {\\n \\"commitId\\": \\"df1b701cb0f3f7ca92320d49d31995821f2d045c\\",\\n \\"title\\": \\"提交标题\\",\\n \\"commitMessage\\": \\"提交内容\\",\\n \\"organizationId\\": \\"60de7a6852743a5162b5f957\\"\\n },\\n \\"source\\": {\\n \\"commitId\\": \\"a748f5ecb17a93900d4808944bfcc96dc158ee2d\\",\\n \\"title\\": \\"提交标题\\",\\n \\"commitMessage\\": \\"提交信息\\",\\n \\"authorTime\\": \\"2022-11-11 11:11:11\\",\\n \\"repoPath\\": \\"codeup/test-repo\\",\\n \\"organizationId\\": \\"61133b011bd96aa110f1b500\\",\\n \\"author\\": {\\n \\"name\\": \\"云效\\",\\n \\"email\\": \\"[email protected]\\"\\n }\\n }\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetSearchCodePreview' => [ + 'summary' => '预览代码片段', + 'path' => '/search/code_preview', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '627475075b46541dd2ff01bc', + ], + ], + [ + 'name' => 'docId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '60d54f3daccf2bbd6659f3ad/gitlabhq/master/config/environments/test.rb', + ], + ], + [ + 'name' => 'keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'isDsl', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'A7586FEB-E48D-5579-983F-74981FBFF627', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'docId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + 'highlightTextMap' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'organizationId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '5ffd468b1e45db3c1cc26ad6', + ], + 'fileName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test.rb', + ], + 'clob' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + 'source' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'repoPath' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'codeup/test-repo', + ], + 'fileName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test.rb', + ], + 'filePath' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'config/environments/test.rb', + ], + 'language' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Ruby', + ], + 'checkinDate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-12-12 12:12:12', + ], + 'branch' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'master', + ], + 'organizationId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '5f9f9f6122a8c7ff3934f99a', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A7586FEB-E48D-5579-983F-74981FBFF627\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"docId\\": \\"xxx\\",\\n \\"highlightTextMap\\": {\\n \\"organizationId\\": \\"5ffd468b1e45db3c1cc26ad6\\",\\n \\"fileName\\": \\"test.rb\\",\\n \\"clob\\": \\"xxx\\"\\n },\\n \\"source\\": {\\n \\"repoPath\\": \\"codeup/test-repo\\",\\n \\"fileName\\": \\"test.rb\\",\\n \\"filePath\\": \\"config/environments/test.rb\\",\\n \\"language\\": \\"Ruby\\",\\n \\"checkinDate\\": \\"2022-12-12 12:12:12\\",\\n \\"branch\\": \\"master\\",\\n \\"organizationId\\": \\"5f9f9f6122a8c7ff3934f99a\\"\\n }\\n }\\n}","type":"json"}]', + ], + 'GetCodeupOrganization' => [ + 'summary' => '获取企业信息', + 'path' => '/api/organization/{identity}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'identity', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'requestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'InvalidTagGroup.IdNotFound', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'namespaceId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100003', + ], + 'userRole' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ORG_MEMBER', + ], + 'path' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'createdAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-12 12:00:00', + ], + 'updatedAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54', + ], + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3624', + ], + 'organizationId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '60de7a6852743a5162b5f957', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'SystemError.UnKnownError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorCode\\": \\"InvalidTagGroup.IdNotFound\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"namespaceId\\": 100003,\\n \\"userRole\\": \\"ORG_MEMBER\\",\\n \\"path\\": \\"test-codeup\\",\\n \\"createdAt\\": \\"2022-03-12 12:00:00\\",\\n \\"updatedAt\\": \\"2022-03-18 14:24:54\\",\\n \\"id\\": 3624,\\n \\"organizationId\\": \\"60de7a6852743a5162b5f957\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetCodeupOrganizationResponse>\\n <ErrorMessage>The specified product does not exist.</ErrorMessage>\\n <RequestId>88694059-DD0C-52BD-B6F2-8501C7B666F9</RequestId>\\n <ErrorCode>500</ErrorCode>\\n <Success>true</Success>\\n <Result>\\n <NamespaceId>124</NamespaceId>\\n <UserRole>ORG_MEMBER</UserRole>\\n <Path>yunxiao-test-org</Path>\\n <CreatedAt>2020-10-26T17:35:16+08:00</CreatedAt>\\n <UpdatedAt>2020-10-26T17:35:16+08:00</UpdatedAt>\\n <Id>53424</Id>\\n <OrganizationId>5f96984d93de7825187241c9</OrganizationId>\\n </Result>\\n</GetCodeupOrganizationResponse>","errorExample":""}]', + ], + 'ListOrganizations' => [ + 'summary' => '查询用户企业列表', + 'path' => '/organizations/list', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'accessLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'minAccessLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '60', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '95FE5953-FF5B-5F80-94AD-FFF97D990FE0', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'total' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5240', + ], + 'accessLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'organizationId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '60de7a6852743a5162b5f957', + ], + 'organizationName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'organizationRole' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ORG_ADMIN', + ], + 'organizationAlias' => [ + 'type' => 'string', + ], + 'namespaceId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"95FE5953-FF5B-5F80-94AD-FFF97D990FE0\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"total\\": 2,\\n \\"success\\": true,\\n \\"result\\": [\\n {\\n \\"id\\": 5240,\\n \\"accessLevel\\": 60,\\n \\"organizationId\\": \\"60de7a6852743a5162b5f957\\",\\n \\"organizationName\\": \\"云效Codeup\\",\\n \\"organizationRole\\": \\"ORG_ADMIN\\",\\n \\"organizationAlias\\": \\"alias-云效Codeup\\",\\n \\"namespaceId\\": \\"600002\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetUserInfo' => [ + 'summary' => '查询当前用户信息', + 'path' => '/users/current', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '61e54b0e0bb300d827e1ae27', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4205', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'username' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'email' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'avatarUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F7B85D1B-D1C2-140F-A039-341859F130B9\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"id\\": 4205,\\n \\"name\\": \\"云效Codeup\\",\\n \\"username\\": \\"my-codeup-login-account\\",\\n \\"email\\": \\"[email protected]\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\"\\n }\\n}","type":"json"}]', + ], + 'ListUserResources' => [ + 'summary' => '查询用户有权限的资源（代码库、组）', + 'path' => '/api/v4/user/vision/user_resources', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513'."\n", + ], + ], + [ + 'name' => 'userIds', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1,2,3', + ], + ], + [ + 'name' => 'page', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'A35869D5-BB29-5F84-A4DD-B09985EA2AFA', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'total' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'userInfo' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19230', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'username' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'state' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'email' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + ], + ], + 'groupInfos' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'groupInfo' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '35268', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-group', + ], + 'path' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-group', + ], + 'nameWithNamespace' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'pathWithNamespace' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-org/test-group', + ], + 'parentId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1183319', + ], + 'ownerId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'createdAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-01-14T21:08:26+08:00'."\n", + ], + 'updatedAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-01-14T21:08:26+08:00'."\n", + ], + 'visibilityLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'description' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-group', + ], + ], + ], + 'groupRole' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'sourceId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '35268', + ], + 'sourceType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Namespace', + ], + 'accessLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + 'cnRoleName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'enRoleName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Admin', + ], + ], + ], + ], + ], + ], + 'repositoryInfos' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'repositoryInfo' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '37229', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-repo', + ], + 'path' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-repo', + ], + 'description' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'nameWithNamespace' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'pathWithNamespace' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-org/test-group/test-repo', + ], + 'visibilityLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'lastActivityAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-01-14T21:08:26+08:00'."\n", + ], + 'namespaceId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '600002', + ], + 'accessLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + 'createdAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-01-14T21:08:26+08:00', + ], + 'updatedAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-01-14T21:08:26+08:00', + ], + 'archived' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'creatorId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12679', + ], + 'encrypted' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + 'repositoryRole' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'sourceId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '37229', + ], + 'sourceType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Project', + ], + 'accessLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + 'cnRoleName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'enRoleName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Admin', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A35869D5-BB29-5F84-A4DD-B09985EA2AFA\\",\\n \\"success\\": true,\\n \\"errorMessage\\": \\"”“\\",\\n \\"errorCode\\": \\"success\\",\\n \\"total\\": 2,\\n \\"result\\": [\\n {\\n \\"userInfo\\": {\\n \\"id\\": 19230,\\n \\"name\\": \\"test-codeup\\",\\n \\"username\\": \\"test-codeup\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"email\\": \\"[email protected]\\"\\n },\\n \\"groupInfos\\": [\\n {\\n \\"groupInfo\\": {\\n \\"id\\": 35268,\\n \\"name\\": \\"test-group\\",\\n \\"path\\": \\"test-group\\",\\n \\"nameWithNamespace\\": \\"test-org / test-group（斜杠两侧有空格）\\",\\n \\"pathWithNamespace\\": \\"test-org/test-group\\",\\n \\"parentId\\": 1183319,\\n \\"ownerId\\": 1234,\\n \\"createdAt\\": \\"2022-01-14T21:08:26+08:00\\\\n\\",\\n \\"updatedAt\\": \\"2022-01-14T21:08:26+08:00\\\\n\\",\\n \\"visibilityLevel\\": 0,\\n \\"description\\": \\"test-group\\"\\n },\\n \\"groupRole\\": {\\n \\"sourceId\\": 35268,\\n \\"sourceType\\": \\"Namespace\\",\\n \\"accessLevel\\": 40,\\n \\"cnRoleName\\": \\"管理员\\",\\n \\"enRoleName\\": \\"Admin\\"\\n }\\n }\\n ],\\n \\"repositoryInfos\\": [\\n {\\n \\"repositoryInfo\\": {\\n \\"id\\": 37229,\\n \\"name\\": \\"test-repo\\",\\n \\"path\\": \\"test-repo\\",\\n \\"description\\": \\"具体的描述内容\\",\\n \\"nameWithNamespace\\": \\"test-org / test-group / test-repo（斜杠两侧有空格）\\",\\n \\"pathWithNamespace\\": \\"test-org/test-group/test-repo\\",\\n \\"visibilityLevel\\": 0,\\n \\"lastActivityAt\\": \\"2022-01-14T21:08:26+08:00\\\\n\\",\\n \\"namespaceId\\": 600002,\\n \\"accessLevel\\": 40,\\n \\"createdAt\\": \\"2022-01-14T21:08:26+08:00\\",\\n \\"updatedAt\\": \\"2022-01-14T21:08:26+08:00\\",\\n \\"archived\\": false,\\n \\"creatorId\\": 12679,\\n \\"encrypted\\": false\\n },\\n \\"repositoryRole\\": {\\n \\"sourceId\\": 37229,\\n \\"sourceType\\": \\"Project\\",\\n \\"accessLevel\\": 40,\\n \\"cnRoleName\\": \\"管理员\\",\\n \\"enRoleName\\": \\"Admin\\"\\n }\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'CreateOAuthToken' => [ + 'summary' => '创建OAuth令牌', + 'path' => '/login/oauth/create', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'clientId' => [ + 'title' => 'clientId'."\n", + 'description' => 'clientId'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dc7e0b3c00a3e58f46', + ], + 'clientSecret' => [ + 'title' => 'client_secret', + 'description' => 'client_secret', + 'type' => 'string', + 'required' => true, + 'example' => 'a433294edea39cae7e7870', + ], + 'grantType' => [ + 'title' => '授权类型：code，token', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'code', + ], + 'scope' => [ + 'title' => '授权范围.例如：read:repo,write:repo', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'read:repo', + ], + 'code' => [ + 'title' => '当前grantType=code时必传', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '86df532f74454e189740d100ac97f4b9', + ], + 'login' => [ + 'title' => 'code = token时必传', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'username', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'errorMessage' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'requestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'C2F153F6-BB43-50C4-9F4F-40593203E19A', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'true', + ], + 'result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'accessToken' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2aeb4cd012af879e54f0d37dfa526f51', + ], + 'scope' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'read:repo', + ], + 'tokenType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'code', + ], + 'id' => [ + 'description' => 'id', + 'type' => 'string', + 'example' => '30815', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"errorMessage\\": \\"”“\\",\\n \\"requestId\\": \\"C2F153F6-BB43-50C4-9F4F-40593203E19A\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": \\"true\\",\\n \\"result\\": {\\n \\"accessToken\\": \\"2aeb4cd012af879e54f0d37dfa526f51\\",\\n \\"scope\\": \\"read:repo\\",\\n \\"tokenType\\": \\"bearer\\",\\n \\"id\\": \\"30815\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateOAuthTokenResponse>\\n <errorMessage>”“</errorMessage>\\n <requestId>C2F153F6-BB43-50C4-9F4F-40593203E19A</requestId>\\n <errorCode>Openapi.RequestError</errorCode>\\n <success>true</success>\\n <result>\\n <accessToken>2aeb4cd012af879e54f0d37dfa526f51</accessToken>\\n <scope>repo:read</scope>\\n <tokenType>code</tokenType>\\n <id>30815</id>\\n </result>\\n</CreateOAuthTokenResponse>","errorExample":""}]', + ], + 'CreateServiceConnection' => [ + 'summary' => '创建服务连接', + 'path' => '/organization/{organizationId}/createServiceConnection', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATURErdcCL5BE0', + ], + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'connectionType' => [ + 'title' => '连接类型', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ecs', + 'enum' => [ + 'ecs', + 'ack', + 'oss', + 'edas', + 'sae', + 'ros', + 'fc', + 'emas', + 'customGitlab', + 'git', + 'gitlab', + 'bitbucket', + 'docker_register_aliyun', + 'ess', + ], + ], + 'connectionName' => [ + 'title' => '连接名称', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + 'serviceAuthId' => [ + 'title' => '', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '111', + ], + 'scope' => [ + 'title' => '可见范围：如PERSON，GLOBAL，CUSTOM', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'PERSON', + 'enum' => [ + 'PERSONAL', + 'GLOBAL', + 'CUSTOM', + ], + ], + 'authType' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'CREDENTIAL', + 'enum' => [ + 'CREDENTIAL', + 'AUTHENTICATION', + ], + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'."\n", + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19224', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\\\n\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"id\\": 19224\\n}","type":"json"}]', + ], + 'CreateServiceAuth' => [ + 'summary' => '创建服务授权', + 'path' => '/organization/{organizationId}/serviceAuths', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'serviceAuthType', + 'in' => 'query', + 'schema' => [ + 'title' => '授权类型，目前只支持RAM', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'RAM', + 'enum' => [ + 'RAM', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'."\n", + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'id' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1223', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\\\n\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"”“\\",\\n \\"success\\": true,\\n \\"id\\": \\"1223\\"\\n}","type":"json"}]', + ], + 'CreateServiceCredential' => [ + 'summary' => '创建用户名密码类型的证书', + 'path' => '/organization/{organizationId}/serviceCredentials', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '证书名称', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '张三的Git证书', + 'maxLength' => 100, + ], + 'type' => [ + 'title' => '证书类型，默认USERNAME_PASSWORD', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'USERNAME_PASSWORD', + 'default' => 'USERNAME_PASSWORD', + 'enum' => [ + 'USERNAME_PASSWORD', + ], + ], + 'scope' => [ + 'title' => '可见范围：如PERSON', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'PERSON', + 'default' => 'PERSON', + 'enum' => [ + 'PERSON', + ], + ], + 'username' => [ + 'title' => '用户名', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'zhangsan', + ], + 'password' => [ + 'title' => '密码', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'zhangsan', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + 'default' => '默认值', + ], + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11222', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"id\\": 11222\\n}","type":"json"}]', + ], + 'ListServiceCredentials' => [ + 'summary' => '获取服务证书列表', + 'path' => '/organization/{organizationId}/serviceCredentials', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'serviceCredentialType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'username_password', + 'enum' => [ + 'USERNAME_PASSWORD', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + 'default' => '默认值', + ], + 'serviceCredentials' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '服务证书id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'ownerName' => [ + 'title' => '服务证书名称', + 'description' => '', + 'type' => 'string', + 'example' => '张三', + ], + 'type' => [ + 'title' => '服务证书类型', + 'description' => '', + 'type' => 'string', + 'example' => 'Codeup', + ], + 'ownerStaffId' => [ + 'title' => '授权用户的 StaffId', + 'description' => '', + 'type' => 'string', + 'example' => '123456789', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"serviceCredentials\\": [\\n {\\n \\"id\\": 123,\\n \\"ownerName\\": \\"张三\\",\\n \\"type\\": \\"Codeup\\",\\n \\"ownerStaffId\\": \\"123456789\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListServiceAuths' => [ + 'summary' => '获取服务授权列表', + 'path' => '/organization/{organizationId}/serviceAuths', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'serviceAuthType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'RAM', + 'enum' => [ + 'RAM', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + 'default' => '默认值', + ], + 'serviceAuths' => [ + 'title' => '服务授权', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '服务授权id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'ownerName' => [ + 'title' => '服务授权名称', + 'description' => '', + 'type' => 'string', + 'example' => '张三', + ], + 'type' => [ + 'title' => '服务授权类型', + 'description' => '', + 'type' => 'string', + 'example' => 'Codeup', + ], + 'ownerStaffId' => [ + 'title' => '授权用户的 StaffId', + 'description' => '', + 'type' => 'string', + 'example' => '123456789', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"serviceAuths\\": [\\n {\\n \\"id\\": 123,\\n \\"ownerName\\": \\"张三\\",\\n \\"type\\": \\"Codeup\\",\\n \\"ownerStaffId\\": \\"123456789\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListServiceConnections' => [ + 'summary' => '获取服务连接列表', + 'path' => '/organization/{organizationId}/serviceConnections', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'sericeConnectionType', + 'in' => 'query', + 'schema' => [ + 'title' => 'aliyun_code 阿里云代码 Codeup Codeup Gitee 码云 github Github ack 容器服务Kubernetes(ACK) docker_register_aliyun 容器镜像服务(ACR) ecs 对象存储(OSS) edas 企业级分布式应用(EDAS) emas 移动研发平台(EMAS) fc 阿里云函数计算(FC) kubernetes 自建k8s集群 oss 对象存储(OSS) PACKAGES 制品仓库 ros 资源编排服务(ROS) sae Serverless应用引擎(SAE)', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'codeup', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'serviceConnections' => [ + 'title' => '服务连接', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ownerAccountId' => [ + 'title' => '拥有者阿里云账号id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1212123212121212', + ], + 'name' => [ + 'title' => '服务连接名称', + 'description' => '', + 'type' => 'string', + 'example' => '张三的oss服务连接', + ], + 'id' => [ + 'title' => '服务连接Id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'type' => [ + 'title' => '服务连接类型', + 'description' => '', + 'type' => 'string', + 'example' => 'oss', + ], + 'createTime' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1586863220000', + ], + 'uuid' => [ + 'title' => 'uuid', + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"serviceConnections\\": [\\n {\\n \\"ownerAccountId\\": 1212123212121212,\\n \\"name\\": \\"张三的oss服务连接\\",\\n \\"id\\": 123,\\n \\"type\\": \\"oss\\",\\n \\"createTime\\": 1586863220000,\\n \\"uuid\\": \\"\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListServiceConnectionsResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>\\"\\"</errorMessage>\\n <errorCode>\\"\\"</errorCode>\\n <success>true</success>\\n <serviceConnections>\\n <ownerAccountId>1212123212121212</ownerAccountId>\\n <name>张三的oss服务连接</name>\\n <id>123</id>\\n <type>oss</type>\\n <createTime>1586863220000</createTime>\\n </serviceConnections>\\n</ListServiceConnectionsResponse>","errorExample":""}]', + ], + 'StopVMDeployOrder' => [ + 'summary' => '取消部署单', + 'path' => '/organization/{organizationId}/pipelines/{pipelineId}/deploy/{deployOrderId}/stop', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => [ + 'title' => '12222', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '12222', + ], + ], + [ + 'name' => 'deployOrderId', + 'in' => 'path', + 'schema' => [ + 'title' => '部署单ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1111', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true 接口调用成功，false 接口调用失败', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCluster.NotFound', + 'errorMessage' => 'No cluster is available to generate the workspace.', + ], + [ + 'errorCode' => 'InvalidCodeUrl.NotSupportSVN', + 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', + ], + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFoun', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFound', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', + 'errorMessage' => 'Resource owner cannot be deleted.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberNotExists', + 'errorMessage' => 'The resource member does not exist.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization.', + ], + [ + 'errorCode' => 'InvalidWorkspaceStatus.NotSuccess', + 'errorMessage' => 'The workspace status is invalid. You can only operate workspaces with the SUCCESS status.', + ], + [ + 'errorCode' => 'InvalidWorkspaceTemplate.NotFound', + 'errorMessage' => 'The parameter workspaceTemplate is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + [ + 'errorCode' => 'InvalidWorkspace.NotFound', + 'errorMessage' => 'The workspace is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\"\\n}","type":"json"}]', + ], + 'SkipVMDeployMachine' => [ + 'summary' => '跳过机器部署', + 'path' => '/organization/{organizationId}/pipelines/{pipelineId}/deploy/{deployOrderId}/machine/{machineSn}/skip', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => [ + 'title' => '12222', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '111111111', + ], + ], + [ + 'name' => 'deployOrderId', + 'in' => 'path', + 'schema' => [ + 'title' => '部署单ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '111111111', + ], + ], + [ + 'name' => 'machineSn', + 'in' => 'path', + 'schema' => [ + 'title' => '机器SN', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'asssssssxsx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true 接口调用成功，false 接口调用失败', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCluster.NotFound', + 'errorMessage' => 'No cluster is available to generate the workspace.', + ], + [ + 'errorCode' => 'InvalidCodeUrl.NotSupportSVN', + 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', + ], + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFoun', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFound', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', + 'errorMessage' => 'Resource owner cannot be deleted.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberNotExists', + 'errorMessage' => 'The resource member does not exist.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization.', + ], + [ + 'errorCode' => 'InvalidWorkspaceStatus.NotSuccess', + 'errorMessage' => 'The workspace status is invalid. You can only operate workspaces with the SUCCESS status.', + ], + [ + 'errorCode' => 'InvalidWorkspaceTemplate.NotFound', + 'errorMessage' => 'The parameter workspaceTemplate is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + [ + 'errorCode' => 'InvalidWorkspace.NotFound', + 'errorMessage' => 'The workspace is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\"\\n}","type":"json"}]', + ], + 'RetryVMDeployMachine' => [ + 'summary' => '重试机器部署', + 'path' => '/organization/{organizationId}/pipelines/{pipelineId}/deploy/{deployOrderId}/machine/{machineSn}/retry', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => [ + 'title' => '12222', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1111', + ], + ], + [ + 'name' => 'deployOrderId', + 'in' => 'path', + 'schema' => [ + 'title' => '部署单ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '11111111', + ], + ], + [ + 'name' => 'machineSn', + 'in' => 'path', + 'schema' => [ + 'title' => '机器SN', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'assssssss', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true 接口调用成功，false 接口调用失败', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCluster.NotFound', + 'errorMessage' => 'No cluster is available to generate the workspace.', + ], + [ + 'errorCode' => 'InvalidCodeUrl.NotSupportSVN', + 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', + ], + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFoun', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFound', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', + 'errorMessage' => 'Resource owner cannot be deleted.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberNotExists', + 'errorMessage' => 'The resource member does not exist.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization.', + ], + [ + 'errorCode' => 'InvalidWorkspaceStatus.NotSuccess', + 'errorMessage' => 'The workspace status is invalid. You can only operate workspaces with the SUCCESS status.', + ], + [ + 'errorCode' => 'InvalidWorkspaceTemplate.NotFound', + 'errorMessage' => 'The parameter workspaceTemplate is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + [ + 'errorCode' => 'InvalidWorkspace.NotFound', + 'errorMessage' => 'The workspace is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\"\\n}","type":"json"}]', + ], + 'ResumeVMDeployOrder' => [ + 'summary' => '继续部署', + 'path' => '/organization/{organizationId}/pipelines/{pipelineId}/deploy/{deployOrderId}/resume', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => [ + 'title' => '12222', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '111111', + ], + ], + [ + 'name' => 'deployOrderId', + 'in' => 'path', + 'schema' => [ + 'title' => '部署单ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '11111', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true 接口调用成功，false 接口调用失败', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCluster.NotFound', + 'errorMessage' => 'No cluster is available to generate the workspace.', + ], + [ + 'errorCode' => 'InvalidCodeUrl.NotSupportSVN', + 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', + ], + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFoun', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFound', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', + 'errorMessage' => 'Resource owner cannot be deleted.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberNotExists', + 'errorMessage' => 'The resource member does not exist.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization.', + ], + [ + 'errorCode' => 'InvalidWorkspaceStatus.NotSuccess', + 'errorMessage' => 'The workspace status is invalid. You can only operate workspaces with the SUCCESS status.', + ], + [ + 'errorCode' => 'InvalidWorkspaceTemplate.NotFound', + 'errorMessage' => 'The parameter workspaceTemplate is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + [ + 'errorCode' => 'InvalidWorkspace.NotFound', + 'errorMessage' => 'The workspace is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\"\\n}","type":"json"}]', + ], + 'GetVMDeployOrder' => [ + 'summary' => '获取部署单信息', + 'path' => '/organization/{organizationId}/pipelines/{pipelineId}/deploy/{deployOrderId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => [ + 'title' => '12222', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1222', + ], + ], + [ + 'name' => 'deployOrderId', + 'in' => 'path', + 'schema' => [ + 'title' => '部署单ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '11111', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true 接口调用成功，false 接口调用失败', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'deployOrder' => [ + 'title' => '部署单', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'deployOrderId' => [ + 'title' => '部署单ID', + 'description' => '', + 'type' => 'string', + 'example' => '11111', + ], + 'createTime' => [ + 'title' => '创建时时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '111111111111', + ], + 'updateTime' => [ + 'title' => '修改时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11111111111', + ], + 'creator' => [ + 'title' => '创建人', + 'description' => '', + 'type' => 'string', + 'example' => 'ssaassa', + ], + 'currentBatch' => [ + 'title' => '当前发布批次', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'totalBatch' => [ + 'title' => '总发布批次', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'status' => [ + 'title' => '发布状态', + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'exceptionCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'deployMachineInfo' => [ + 'title' => '部署机器信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'hostGroupId' => [ + 'title' => '主机组ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1111', + ], + 'batchNum' => [ + 'title' => '发布批次', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11', + ], + 'deployMachines' => [ + 'title' => '部署机器列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'createTime' => [ + 'title' => '开始时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1111111111', + ], + 'updateTime' => [ + 'title' => '修改时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11111111', + ], + 'status' => [ + 'title' => '部署状态', + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'machineSn' => [ + 'title' => '机器sn', + 'description' => '', + 'type' => 'string', + 'example' => 'sasssasa', + ], + 'clientStatus' => [ + 'title' => '机器状态', + 'description' => '', + 'type' => 'string', + 'example' => 'ok', + ], + 'ip' => [ + 'title' => '机器IP', + 'description' => '', + 'type' => 'string', + 'example' => '127.0.0.1', + ], + 'actions' => [ + 'title' => '后续action', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'title' => 'Action', + 'description' => '', + 'type' => 'string', + 'example' => 'RetryVMDeployMachine', + ], + 'disable' => [ + 'title' => '是否可用', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'params' => [ + 'title' => '', + 'description' => '', + 'type' => 'any', + 'example' => '{}', + ], + ], + ], + ], + 'batchNum' => [ + 'title' => '部署批次', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '22', + ], + ], + ], + ], + ], + ], + 'actions' => [ + 'title' => '后续action', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'title' => 'Action', + 'description' => '', + 'type' => 'string', + 'example' => 'StopVMDeployOrder', + ], + 'disable' => [ + 'title' => '是否可用', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'params' => [ + 'title' => '', + 'description' => '', + 'type' => 'any', + 'example' => '{}', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCluster.NotFound', + 'errorMessage' => 'No cluster is available to generate the workspace.', + ], + [ + 'errorCode' => 'InvalidCodeUrl.NotSupportSVN', + 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', + ], + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFoun', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFound', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', + 'errorMessage' => 'Resource owner cannot be deleted.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberNotExists', + 'errorMessage' => 'The resource member does not exist.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization.', + ], + [ + 'errorCode' => 'InvalidWorkspaceStatus.NotSuccess', + 'errorMessage' => 'The workspace status is invalid. You can only operate workspaces with the SUCCESS status.', + ], + [ + 'errorCode' => 'InvalidWorkspaceTemplate.NotFound', + 'errorMessage' => 'The parameter workspaceTemplate is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + [ + 'errorCode' => 'InvalidWorkspace.NotFound', + 'errorMessage' => 'The workspace is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\",\\n \\"deployOrder\\": {\\n \\"deployOrderId\\": \\"11111\\",\\n \\"createTime\\": 111111111111,\\n \\"updateTime\\": 11111111111,\\n \\"creator\\": \\"ssaassa\\",\\n \\"currentBatch\\": 2,\\n \\"totalBatch\\": 3,\\n \\"status\\": \\"Success\\",\\n \\"exceptionCode\\": \\"错误信息\\",\\n \\"deployMachineInfo\\": {\\n \\"hostGroupId\\": 1111,\\n \\"batchNum\\": 11,\\n \\"deployMachines\\": [\\n {\\n \\"createTime\\": 1111111111,\\n \\"updateTime\\": 11111111,\\n \\"status\\": \\"Success\\",\\n \\"machineSn\\": \\"sasssasa\\",\\n \\"clientStatus\\": \\"ok\\",\\n \\"ip\\": \\"127.0.0.1\\",\\n \\"actions\\": [\\n {\\n \\"type\\": \\"RetryVMDeployMachine\\",\\n \\"disable\\": true,\\n \\"params\\": {}\\n }\\n ],\\n \\"batchNum\\": 22\\n }\\n ]\\n },\\n \\"actions\\": [\\n {\\n \\"type\\": \\"StopVMDeployOrder\\",\\n \\"disable\\": true,\\n \\"params\\": {}\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetVMDeployOrderResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>”“</errorMessage>\\n <success>false</success>\\n <errorCode>”“</errorCode>\\n <deployOrder>\\n <deployOrderId>11111</deployOrderId>\\n <createTime>111111111111</createTime>\\n <updateTime>11111111111</updateTime>\\n <creator>ssaassa</creator>\\n <currentBatch>2</currentBatch>\\n <totalBatch>3</totalBatch>\\n <status>Success</status>\\n <exceptionCode>错误信息</exceptionCode>\\n <deployMachineInfo>\\n <hostGroupId>1111</hostGroupId>\\n <batchNum>11</batchNum>\\n <deployMachines>\\n <createTime>1111111111</createTime>\\n <updateTime>11111111</updateTime>\\n <status>Success</status>\\n <machineSn>sasssasa</machineSn>\\n <clientStatus>ok</clientStatus>\\n <ip>127.0.0.1</ip>\\n <actions>\\n <type>RetryVMDeployMachine</type>\\n <disable>true</disable>\\n </actions>\\n <batchNum>22</batchNum>\\n </deployMachines>\\n </deployMachineInfo>\\n <actions>\\n <type>StopVMDeployOrder</type>\\n <disable>true</disable>\\n </actions>\\n </deployOrder>\\n</GetVMDeployOrderResponse>","errorExample":""}]', + ], + 'LogVMDeployMachine' => [ + 'summary' => '获取机器部署日志', + 'path' => '/organization/{organizationId}/pipelines/{pipelineId}/deploy/{deployOrderId}/machine/{machineSn}/log', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => [ + 'title' => '12222', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1111', + ], + ], + [ + 'name' => 'deployOrderId', + 'in' => 'path', + 'schema' => [ + 'title' => '部署单ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1111', + ], + ], + [ + 'name' => 'machineSn', + 'in' => 'path', + 'schema' => [ + 'title' => '机器SN', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'sasassasa', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true 接口调用成功，false 接口调用失败', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'deployMachineLog' => [ + 'title' => '部署单', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'deployLog' => [ + 'title' => '部署日志', + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'aliyunRegion' => [ + 'title' => '部署地域', + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'deployLogPath' => [ + 'title' => '部署日志路径', + 'description' => '', + 'type' => 'string', + 'example' => '/tmp/log', + ], + 'deployBeginTime' => [ + 'title' => '部署开始时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11111111111', + ], + 'deployEndTime' => [ + 'title' => '部署结束时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12222222', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCluster.NotFound', + 'errorMessage' => 'No cluster is available to generate the workspace.', + ], + [ + 'errorCode' => 'InvalidCodeUrl.NotSupportSVN', + 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', + ], + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFoun', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFound', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', + 'errorMessage' => 'Resource owner cannot be deleted.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberNotExists', + 'errorMessage' => 'The resource member does not exist.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization.', + ], + [ + 'errorCode' => 'InvalidWorkspaceStatus.NotSuccess', + 'errorMessage' => 'The workspace status is invalid. You can only operate workspaces with the SUCCESS status.', + ], + [ + 'errorCode' => 'InvalidWorkspaceTemplate.NotFound', + 'errorMessage' => 'The parameter workspaceTemplate is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + [ + 'errorCode' => 'InvalidWorkspace.NotFound', + 'errorMessage' => 'The workspace is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\",\\n \\"deployMachineLog\\": {\\n \\"deployLog\\": \\"success\\",\\n \\"aliyunRegion\\": \\"cn-hangzhou\\",\\n \\"deployLogPath\\": \\"/tmp/log\\",\\n \\"deployBeginTime\\": 11111111111,\\n \\"deployEndTime\\": 1719312026\\n }\\n}","type":"json"}]', + ], + 'CreatePipelineGroup' => [ + 'summary' => '创建流水线分组', + 'path' => '/organization/{organizationId}/pipelineGroups', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [], + 'produces' => [], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + 'maxLength' => 40, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'pipelineGroup' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '111', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"pipelineGroup\\": {\\n \\"id\\": 111,\\n \\"name\\": \\"流水线分组名称\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreatePipelineGroupResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>\\"\\"</errorMessage>\\n <success>true</success>\\n <errorCode>\\"\\"</errorCode>\\n <pipelineGroup>\\n <id>111</id>\\n <name>流水线分组名称</name>\\n </pipelineGroup>\\n</CreatePipelineGroupResponse>","errorExample":""}]', + ], + 'DeletePipelineGroup' => [ + 'summary' => '删除流水线分组', + 'path' => '/organization/{organizationId}/pipelineGroups/{groupId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [], + 'produces' => [], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '111', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\"\\n}","errorExample":""},{"type":"xml","example":"<DeletePipelineGroupResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>\\"\\"</errorMessage>\\n <success>true</success>\\n <errorCode>“”</errorCode>\\n</DeletePipelineGroupResponse>","errorExample":""}]', + ], + 'JoinPipelineGroup' => [ + 'summary' => '加入流水线分组', + 'path' => '/organization/{organizationId}/pipelineGroups/join', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [], + 'produces' => [], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pipelineIds', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '122,122', + ], + ], + [ + 'name' => 'groupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '11', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', + ], + 'UpdatePipelineGroup' => [ + 'summary' => '更新流水线分组', + 'path' => '/organization/{organizationId}/pipelineGroups/{groupId}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [], + 'produces' => [], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + 'maxLength' => 40, + ], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '111', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdatePipelineGroupResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>\\"\\"</errorMessage>\\n <success>true</success>\\n <errorCode>\\"\\"</errorCode>\\n</UpdatePipelineGroupResponse>","errorExample":""}]', + ], + 'GetPipelineGroup' => [ + 'summary' => '获取流水线分组', + 'path' => '/organization/{organizationId}/pipelineGroups/{groupId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [], + 'produces' => [], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '111', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'pipelineGroup' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'createTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1586863220000', + ], + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '111', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"pipelineGroup\\": {\\n \\"createTime\\": 1586863220000,\\n \\"id\\": 111,\\n \\"name\\": \\"流水线分组名称\\"\\n }\\n}","type":"json"}]', + ], + 'ListPipelineGroupPipelines' => [ + 'summary' => '获取流水线分组下流水线列表列表', + 'path' => '/organization/{organizationId}/pipelineGroups/{groupId}/pipelines', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [], + 'produces' => [], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '50', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'aaaa', + ], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '111', + ], + ], + [ + 'name' => 'pipelineName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'executeStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1586863220000', + ], + ], + [ + 'name' => 'executeEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1586863220000', + ], + ], + [ + 'name' => 'createStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1586863220000', + ], + ], + [ + 'name' => 'resultStatusList', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'RUNNING,SUCCESS', + ], + ], + [ + 'name' => 'createEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1586863220000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'pipelines' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'pipelineName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'createTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1586863220000', + ], + 'pipelineId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1111', + ], + ], + ], + ], + 'totalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'nextToken' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'aaaa', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"pipelines\\": [\\n {\\n \\"pipelineName\\": \\"流水线名称\\",\\n \\"createTime\\": 1586863220000,\\n \\"pipelineId\\": 1111\\n }\\n ],\\n \\"totalCount\\": 20,\\n \\"nextToken\\": \\"aaaa\\"\\n}","errorExample":""},{"type":"xml","example":"<ListPipelineGroupPipelinesResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>\\"\\"</errorMessage>\\n <success>true</success>\\n <errorCode>\\"\\"</errorCode>\\n <pipelines>\\n <pipelineName>流水线名称</pipelineName>\\n <createTime>1586863220000</createTime>\\n <pipelineId>1111</pipelineId>\\n </pipelines>\\n <totalCount>20</totalCount>\\n <nextToken>aaaa</nextToken>\\n</ListPipelineGroupPipelinesResponse>","errorExample":""}]', + ], + 'ListPipelineGroups' => [ + 'summary' => '获取流水线分组列表', + 'path' => '/organization/{organizationId}/pipelineGroups', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [], + 'produces' => [], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '50', + 'minimum' => '1', + 'example' => '20', + 'default' => '10', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'aaaaaaaaaa', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'pipelineGroups' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '111', + ], + 'createTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1586863220000', + ], + ], + ], + ], + 'totalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'nextToken' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ssaassasass', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"pipelineGroups\\": [\\n {\\n \\"name\\": \\"流水线分组名称\\",\\n \\"id\\": 111,\\n \\"createTime\\": 1586863220000\\n }\\n ],\\n \\"totalCount\\": 50,\\n \\"nextToken\\": \\"ssaassasass\\"\\n}","type":"json"}]', + ], + 'CreateFlowTag' => [ + 'summary' => '创建标签', + 'path' => '/organization/{organizationId}/flow/tags', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + 'maxLength' => 20, + ], + ], + [ + 'name' => 'color', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '#1F9AEF', + 'enum' => [ + '#1F9AEF', + '#E63A3A', + '#FA8C15', + '#15AD31', + '#7978E5', + '#8C8C8C', + ], + ], + ], + [ + 'name' => 'flowTagGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '111', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true 接口调用成功，false 接口调用失败', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '111', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCluster.NotFound', + 'errorMessage' => 'No cluster is available to generate the workspace.', + ], + [ + 'errorCode' => 'InvalidCodeUrl.NotSupportSVN', + 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', + ], + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFoun', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFound', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', + 'errorMessage' => 'Resource owner cannot be deleted.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberNotExists', + 'errorMessage' => 'The resource member does not exist.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidIdentifier.NotFound', + 'errorMessage' => 'space id is error or not exist.', + ], + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + [ + 'errorCode' => 'InvalidWorkspace.NotFound', + 'errorMessage' => 'The workspace is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\",\\n \\"id\\": 111\\n}","type":"json"}]', + ], + 'CreateFlowTagGroup' => [ + 'summary' => '创建标签分类', + 'path' => '/organization/{organizationId}/flow/tagGroups', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + 'maxLength' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true 接口调用成功，false 接口调用失败', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'id' => [ + 'title' => '标签分类', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1223', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCluster.NotFound', + 'errorMessage' => 'No cluster is available to generate the workspace.', + ], + [ + 'errorCode' => 'InvalidCodeUrl.NotSupportSVN', + 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', + ], + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFoun', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFound', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', + 'errorMessage' => 'Resource owner cannot be deleted.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberNotExists', + 'errorMessage' => 'The resource member does not exist.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization.', + ], + [ + 'errorCode' => 'InvalidWorkspaceStatus.NotSuccess', + 'errorMessage' => 'The workspace status is invalid. You can only operate workspaces with the SUCCESS status.', + ], + [ + 'errorCode' => 'InvalidWorkspaceTemplate.NotFound', + 'errorMessage' => 'The parameter workspaceTemplate is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + [ + 'errorCode' => 'InvalidWorkspace.NotFound', + 'errorMessage' => 'The workspace is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\",\\n \\"id\\": 1223\\n}","type":"json"}]', + ], + 'DeleteFlowTagGroup' => [ + 'summary' => '删除标签分类', + 'path' => '/organization/{organizationId}/flow/tagGroups/{id}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'id', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '111', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true 接口调用成功，false 接口调用失败', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCluster.NotFound', + 'errorMessage' => 'No cluster is available to generate the workspace.', + ], + [ + 'errorCode' => 'InvalidCodeUrl.NotSupportSVN', + 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', + ], + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFoun', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFound', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', + 'errorMessage' => 'Resource owner cannot be deleted.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberNotExists', + 'errorMessage' => 'The resource member does not exist.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization.', + ], + [ + 'errorCode' => 'InvalidWorkspaceStatus.NotSuccess', + 'errorMessage' => 'The workspace status is invalid. You can only operate workspaces with the SUCCESS status.', + ], + [ + 'errorCode' => 'InvalidWorkspaceTemplate.NotFound', + 'errorMessage' => 'The parameter workspaceTemplate is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + [ + 'errorCode' => 'InvalidWorkspace.NotFound', + 'errorMessage' => 'The workspace is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\"\\n}","type":"json"}]', + ], + 'DeleteFlowTag' => [ + 'summary' => '删除标签', + 'path' => '/organization/{organizationId}/flow/tags/{id}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'id', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1111', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true 接口调用成功，false 接口调用失败', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCluster.NotFound', + 'errorMessage' => 'No cluster is available to generate the workspace.', + ], + [ + 'errorCode' => 'InvalidCodeUrl.NotSupportSVN', + 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', + ], + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFoun', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFound', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', + 'errorMessage' => 'Resource owner cannot be deleted.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberNotExists', + 'errorMessage' => 'The resource member does not exist.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidIdentifier.NotFound', + 'errorMessage' => 'space id is error or not exist.', + ], + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + [ + 'errorCode' => 'InvalidWorkspace.NotFound', + 'errorMessage' => 'The workspace is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteFlowTagResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>”“</errorMessage>\\n <success>false</success>\\n <errorCode>”“</errorCode>\\n</DeleteFlowTagResponse>","errorExample":""}]', + ], + 'UpdateFlowTag' => [ + 'summary' => '更新标签', + 'path' => '/organization/{organizationId}/flow/tags/{id}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'id', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1111', + ], + ], + [ + 'name' => 'color', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '#1F9AEF', + 'enum' => [ + '#1F9AEF', + '#E63A3A', + '#FA8C15', + '#15AD31', + '#7978E5', + '#8C8C8C', + ], + ], + ], + [ + 'name' => 'flowTagGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '11', + ], + ], + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + 'maxLength' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true 接口调用成功，false 接口调用失败', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCodeUrl.NotSupportSVN', + 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', + ], + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFoun', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFound', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', + 'errorMessage' => 'Resource owner cannot be deleted.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberNotExists', + 'errorMessage' => 'The resource member does not exist.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidIdentifier.NotFound', + 'errorMessage' => 'space id is error or not exist.', + ], + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + [ + 'errorCode' => 'InvalidWorkspace.NotFound', + 'errorMessage' => 'The workspace is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\"\\n}","type":"json"}]', + ], + 'UpdateFlowTagGroup' => [ + 'summary' => '标签分类', + 'path' => '/organization/{organizationId}/flow/tagGroups/{id}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'id', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '111', + ], + ], + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + 'maxLength' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true 接口调用成功，false 接口调用失败', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCluster.NotFound', + 'errorMessage' => 'No cluster is available to generate the workspace.', + ], + [ + 'errorCode' => 'InvalidCodeUrl.NotSupportSVN', + 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', + ], + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFoun', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFound', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', + 'errorMessage' => 'Resource owner cannot be deleted.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberNotExists', + 'errorMessage' => 'The resource member does not exist.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization.', + ], + [ + 'errorCode' => 'InvalidWorkspaceStatus.NotSuccess', + 'errorMessage' => 'The workspace status is invalid. You can only operate workspaces with the SUCCESS status.', + ], + [ + 'errorCode' => 'InvalidWorkspaceTemplate.NotFound', + 'errorMessage' => 'The parameter workspaceTemplate is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + [ + 'errorCode' => 'InvalidWorkspace.NotFound', + 'errorMessage' => 'The workspace is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\"\\n}","type":"json"}]', + ], + 'GetFlowTagGroup' => [ + 'summary' => '获取标签分类', + 'path' => '/organization/{organizationId}/flow/tagGroups/{id}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'id', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '11', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true 接口调用成功，false 接口调用失败', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'flowTagGroup' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1111', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'creatorAccountId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1111111111111', + ], + 'modiferAccountId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1111111111111', + ], + 'flowTagList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '111', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'color' => [ + 'description' => '', + 'type' => 'string', + 'example' => '#1F9AEF', + ], + 'creatorAccountId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1111111111111', + ], + 'modiferAccountId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1111111111111', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCluster.NotFound', + 'errorMessage' => 'No cluster is available to generate the workspace.', + ], + [ + 'errorCode' => 'InvalidCodeUrl.NotSupportSVN', + 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', + ], + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFoun', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFound', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', + 'errorMessage' => 'Resource owner cannot be deleted.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberNotExists', + 'errorMessage' => 'The resource member does not exist.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization.', + ], + [ + 'errorCode' => 'InvalidWorkspaceStatus.NotSuccess', + 'errorMessage' => 'The workspace status is invalid. You can only operate workspaces with the SUCCESS status.', + ], + [ + 'errorCode' => 'InvalidWorkspaceTemplate.NotFound', + 'errorMessage' => 'The parameter workspaceTemplate is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + [ + 'errorCode' => 'InvalidWorkspace.NotFound', + 'errorMessage' => 'The workspace is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\",\\n \\"flowTagGroup\\": {\\n \\"id\\": 1111,\\n \\"name\\": \\"标签分类名称\\",\\n \\"creatorAccountId\\": \\"1111111111111\\",\\n \\"modiferAccountId\\": \\"1111111111111\\",\\n \\"flowTagList\\": [\\n {\\n \\"id\\": 111,\\n \\"name\\": \\"标签名称\\",\\n \\"color\\": \\"#1F9AEF\\",\\n \\"creatorAccountId\\": \\"1111111111111\\",\\n \\"modiferAccountId\\": \\"1111111111111\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListFlowTagGroups' => [ + 'summary' => '获取标签分类列表', + 'path' => '/organization/{organizationId}/flow/tagGroups', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true 接口调用成功，false 接口调用失败', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'flowTagGroups' => [ + 'title' => '标签分类', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '标签分类id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '111', + ], + 'name' => [ + 'title' => '标签分类名称', + 'description' => '', + 'type' => 'string', + 'example' => '标签名称', + ], + 'creatorAccountId' => [ + 'title' => '创建人', + 'description' => '', + 'type' => 'string', + 'example' => '111111111', + ], + 'modiferAccountId' => [ + 'title' => '修改人', + 'description' => '', + 'type' => 'string', + 'example' => '11111111', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCluster.NotFound', + 'errorMessage' => 'No cluster is available to generate the workspace.', + ], + [ + 'errorCode' => 'InvalidCodeUrl.NotSupportSVN', + 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', + ], + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFoun', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFound', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', + 'errorMessage' => 'Resource owner cannot be deleted.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberNotExists', + 'errorMessage' => 'The resource member does not exist.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization.', + ], + [ + 'errorCode' => 'InvalidWorkspaceStatus.NotSuccess', + 'errorMessage' => 'The workspace status is invalid. You can only operate workspaces with the SUCCESS status.', + ], + [ + 'errorCode' => 'InvalidWorkspaceTemplate.NotFound', + 'errorMessage' => 'The parameter workspaceTemplate is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + [ + 'errorCode' => 'InvalidWorkspace.NotFound', + 'errorMessage' => 'The workspace is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\",\\n \\"flowTagGroups\\": [\\n {\\n \\"id\\": 111,\\n \\"name\\": \\"标签名称\\",\\n \\"creatorAccountId\\": \\"111111111\\",\\n \\"modiferAccountId\\": \\"11111111\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'CreateSshKey' => [ + 'summary' => '创建企业公钥', + 'path' => '/organization/{organizationId}/sshKey', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'sshKey' => [ + 'title' => '企业公钥', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'publicKey' => [ + 'title' => '企业公钥', + 'description' => '', + 'type' => 'string', + 'example' => 'assssssssssss', + ], + 'id' => [ + 'title' => '企业公钥id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"sshKey\\": {\\n \\"publicKey\\": \\"assssssssssss\\",\\n \\"id\\": 123\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateSshKeyResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>\\"\\"</errorMessage>\\n <errorCode>\\"\\"</errorCode>\\n <success>true</success>\\n <sshKey>\\n <publicKey>assssssssssss</publicKey>\\n <id>123</id>\\n </sshKey>\\n</CreateSshKeyResponse>","errorExample":""}]', + ], + 'ResetSshKey' => [ + 'summary' => '重置企业公钥', + 'path' => '/organization/{organizationId}/sshKey', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'sshKey' => [ + 'title' => '企业公钥', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'publicKey' => [ + 'title' => '企业公钥', + 'description' => '', + 'type' => 'string', + 'example' => 'saaaaaaaaaaaaaaaa', + ], + 'id' => [ + 'title' => '企业公钥id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1212', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"sshKey\\": {\\n \\"publicKey\\": \\"saaaaaaaaaaaaaaaa\\",\\n \\"id\\": 1212\\n }\\n}","errorExample":""},{"type":"xml","example":"<ResetSshKeyResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>\\"\\"</errorMessage>\\n <errorCode>\\"\\"</errorCode>\\n <success>true</success>\\n <sshKey>\\n <publicKey>saaaaaaaaaaaaaaaa</publicKey>\\n <id>1212</id>\\n </sshKey>\\n</ResetSshKeyResponse>","errorExample":""}]', + ], + 'CreateResourceMember' => [ + 'summary' => '插入资源成员', + 'path' => '/organization/{organizationId}/{resourceType}/{resourceId}/members', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'resourceType', + 'in' => 'path', + 'schema' => [ + 'title' => '资源id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'maximum' => '999999999999999', + 'minimum' => '1', + 'example' => 'pipeline', + 'enum' => [ + 'pipeline', + 'hostGroup', + ], + ], + ], + [ + 'name' => 'accountId', + 'in' => 'formData', + 'schema' => [ + 'title' => '用户id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1111111111111', + ], + ], + [ + 'name' => 'roleName', + 'in' => 'formData', + 'schema' => [ + 'title' => '角色部署组 deployGroup user 成员，使用权限 admin 管理员，使用编辑权限 流水线 pipeline admin 查看、运行、编辑权限 member 运行权限 viewer 查看权限', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'admin', + ], + ], + [ + 'name' => 'resourceId', + 'in' => 'path', + 'schema' => [ + 'title' => '资源类型 流水线 pipeline 部署组 deployGroup', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFoun', + 'errorMessage' => 'The member role is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateResourceMemberResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>\\"\\"</errorMessage>\\n <errorCode>\\"\\"</errorCode>\\n <success>true</success>\\n</CreateResourceMemberResponse>","errorExample":""}]', + ], + 'DeleteResourceMember' => [ + 'summary' => '删除资源成员', + 'path' => '/organization/{organizationId}/{resourceType}/{resourceId}/members/{accountId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'resourceType', + 'in' => 'path', + 'schema' => [ + 'title' => '资源id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'maximum' => '999999999999999', + 'minimum' => '1', + 'example' => 'pipeline', + 'enum' => [ + 'pipeline', + 'hostGroup', + ], + ], + ], + [ + 'name' => 'resourceId', + 'in' => 'path', + 'schema' => [ + 'title' => '资源类型流水线 pipeline 部署组 deployGroup', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'accountId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2211221', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberNotExists', + 'errorMessage' => 'The resource member does not exist.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', + 'errorMessage' => 'Resource owner cannot be deleted.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteResourceMemberResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>\\"\\"</errorMessage>\\n <errorCode>\\"\\"</errorCode>\\n <success>true</success>\\n</DeleteResourceMemberResponse>","errorExample":""}]', + ], + 'UpdateResourceMember' => [ + 'summary' => '更新资源成员', + 'path' => '/organization/{organizationId}/{resourceType}/{resourceId}/members/{accountId}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'resourceType', + 'in' => 'path', + 'schema' => [ + 'title' => '资源Id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'maximum' => '999999999999999', + 'minimum' => '1', + 'example' => 'pipeline', + 'enum' => [ + 'pipeline', + 'hostGroup', + ], + ], + ], + [ + 'name' => 'roleName', + 'in' => 'formData', + 'schema' => [ + 'title' => '角色部署组 deployGroup user 成员，使用权限 admin 管理员，使用编辑权限 owner 拥有者，所有权限 流水线 pipeline owner 拥有者，所有权限 admin 查看、运行、编辑权限 member 运行权限 viewer 查看权限', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'admin', + ], + ], + [ + 'name' => 'resourceId', + 'in' => 'path', + 'schema' => [ + 'title' => '资源类型 流水线 pipeline 部署组 deployGroup', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '111111', + ], + ], + [ + 'name' => 'accountId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '11111', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', + 'errorMessage' => 'Resource owner cannot be deleted.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberNotExists', + 'errorMessage' => 'The resource member does not exist.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFoun', + 'errorMessage' => 'The member role is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateResourceMemberResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>\\"\\"</errorMessage>\\n <errorCode>\\"\\"</errorCode>\\n <success>true</success>\\n</UpdateResourceMemberResponse>","errorExample":""}]', + ], + 'ListResourceMembers' => [ + 'summary' => '获取资源成员列表', + 'path' => '/organization/{organizationId}/{resourceType}/{resourceId}/members', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'resourceType', + 'in' => 'path', + 'schema' => [ + 'title' => '资源类型流水线 pipeline 部署组 deployGroup', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pipeline', + 'enum' => [ + 'pipeline', + 'hostGroup', + ], + ], + ], + [ + 'name' => 'resourceId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '122', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'resourceMembers' => [ + 'title' => '成员', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'accountId' => [ + 'title' => '账号id', + 'description' => '', + 'type' => 'string', + 'example' => '22212212', + ], + 'roleName' => [ + 'title' => '角色', + 'description' => '', + 'type' => 'string', + 'example' => 'admin', + ], + 'username' => [ + 'title' => '用户名称', + 'description' => '', + 'type' => 'string', + 'example' => '张三', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"resourceMembers\\": [\\n {\\n \\"accountId\\": \\"22212212\\",\\n \\"roleName\\": \\"admin\\",\\n \\"username\\": \\"张三\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListResourceMembersResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>\\"\\"</errorMessage>\\n <errorCode>\\"\\"</errorCode>\\n <success>true</success>\\n <resourceMembers>\\n <accountId>22212212</accountId>\\n <roleName>admin</roleName>\\n <username>张三</username>\\n </resourceMembers>\\n</ListResourceMembersResponse>","errorExample":""}]', + ], + 'CreateHostGroup' => [ + 'summary' => '创建主机组', + 'path' => '/organization/{organizationId}/hostGroups', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'type', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ECS', + 'enum' => [ + 'ECS', + ], + ], + ], + [ + 'name' => 'envId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'name', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'serviceConnectionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'tagIds', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '12,234', + ], + ], + [ + 'name' => 'ecsType', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ECS_ALIYUN', + 'enum' => [ + 'ECS_ALIYUN', + ], + ], + ], + [ + 'name' => 'ecsLabelKey', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'ecsLabelValue', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'aliyunRegion', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'machineInfos', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '[{"aliyunRegionId":"cn-beijing","machineSn":"i-sssssss","instanceName":"ceshi","ip":"120.0.0.0"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'hostGroupId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"hostGroupId\\": 123\\n}","errorExample":""},{"type":"xml","example":"<CreateHostGroupResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>\\"\\"</errorMessage>\\n <errorCode>\\"\\"</errorCode>\\n <success>true</success>\\n <hostGroupId>123</hostGroupId>\\n</CreateHostGroupResponse>","errorExample":""}]', + ], + 'DeleteHostGroup' => [ + 'summary' => '删除主机组', + 'path' => '/organization/{organizationId}/hostGroups/{id}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'id', + 'in' => 'path', + 'schema' => [ + 'title' => '部署组Id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '11222', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteHostGroupResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>\\"\\"</errorMessage>\\n <errorCode>\\"\\"</errorCode>\\n <success>true</success>\\n</DeleteHostGroupResponse>","errorExample":""}]', + ], + 'UpdateHostGroup' => [ + 'summary' => '更新主机组', + 'path' => '/organization/{organizationId}/hostGroups/{id}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATURErdcI0DEJM', + ], + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'type', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ECS', + 'enum' => [ + 'ECS', + ], + ], + ], + [ + 'name' => 'envId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'name', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'serviceConnectionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'tagIds', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '12,23', + ], + ], + [ + 'name' => 'ecsType', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ECS_ALIYUN', + 'enum' => [ + 'ECS_ALIYUN', + ], + ], + ], + [ + 'name' => 'ecsLabelKey', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'ecsLabelValue', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'aliyunRegion', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'machineInfos', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '[{"aliyunRegionId":"cn-beijing","machineSn":"i-sssssss","instanceName":"ceshi","ip":"120.0.0.0"}]', + ], + ], + [ + 'name' => 'id', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateHostGroupResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>”“</errorMessage>\\n <errorCode>\\"\\"</errorCode>\\n <success>true</success>\\n</UpdateHostGroupResponse>","errorExample":""}]', + ], + 'GetHostGroup' => [ + 'summary' => '获取主机组信息', + 'path' => '/organization/{organizationId}/hostGroups/{id}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'id', + 'in' => 'path', + 'schema' => [ + 'title' => '主机组id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '21221', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'hostGroup' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'creatorAccountId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '111111', + ], + 'upateTIme' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1586863220000', + ], + 'hostNum' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'modifierAccountId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '11111', + ], + 'description' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'type' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ECS', + ], + 'createTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1586863220000', + ], + 'ecsType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ECS_ALIYUN', + ], + 'aliyunRegion' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-bejing', + ], + 'ecsLabelKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ecs', + ], + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'serviceConnectionId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'hostInfos' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'updateTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1586863220000', + ], + 'creatorAccountId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '11111', + ], + 'instanceName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ceshi', + ], + 'modifierAccountId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '11111111111', + ], + 'ip' => [ + 'description' => '', + 'type' => 'string', + 'example' => '127.0.0.1', + ], + 'createTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1586863220000', + ], + 'objectType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'MachineInfo', + ], + 'aliyunRegionId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'machineSn' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1ssasa', + ], + ], + ], + ], + 'ecsLabelValue' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ecs', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"hostGroup\\": {\\n \\"creatorAccountId\\": \\"111111\\",\\n \\"upateTIme\\": 1586863220000,\\n \\"hostNum\\": 1,\\n \\"modifierAccountId\\": \\"11111\\",\\n \\"description\\": \\"主机组描述\\",\\n \\"type\\": \\"ECS\\",\\n \\"createTime\\": 1586863220000,\\n \\"ecsType\\": \\"ECS_ALIYUN\\",\\n \\"aliyunRegion\\": \\"cn-bejing\\",\\n \\"ecsLabelKey\\": \\"ecs\\",\\n \\"id\\": 1234,\\n \\"name\\": \\"主机组名称\\",\\n \\"serviceConnectionId\\": 1234,\\n \\"hostInfos\\": [\\n {\\n \\"updateTime\\": 1586863220000,\\n \\"creatorAccountId\\": \\"11111\\",\\n \\"instanceName\\": \\"ceshi\\",\\n \\"modifierAccountId\\": \\"11111111111\\",\\n \\"ip\\": \\"127.0.0.1\\",\\n \\"createTime\\": 1586863220000,\\n \\"objectType\\": \\"MachineInfo\\",\\n \\"aliyunRegionId\\": \\"cn-hangzhou\\",\\n \\"machineSn\\": \\"1ssasa\\"\\n }\\n ],\\n \\"ecsLabelValue\\": \\"ecs\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetHostGroupResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>\\"\\"</errorMessage>\\n <errorCode>\\"\\"</errorCode>\\n <success>true</success>\\n <hostGroup>\\n <creatorAccountId>111111</creatorAccountId>\\n <upateTIme>1586863220000</upateTIme>\\n <hostNum>1</hostNum>\\n <modifierAccountId>11111</modifierAccountId>\\n <description>主机组描述</description>\\n <type>ECS</type>\\n <createTime>1586863220000</createTime>\\n <ecsType>ECS_ALIYUN</ecsType>\\n <aliyunRegion>cn-bejing</aliyunRegion>\\n <ecsLabelKey>ecs</ecsLabelKey>\\n <id>1234</id>\\n <name>主机组名称</name>\\n <serviceConnectionId>1234</serviceConnectionId>\\n <hostInfos>\\n <updateTime>1586863220000</updateTime>\\n <creatorAccountId>11111</creatorAccountId>\\n <instanceName>ceshi</instanceName>\\n <modifierAccountId>11111111111</modifierAccountId>\\n <ip>127.0.0.1</ip>\\n <createTime>1586863220000</createTime>\\n <objectType>MachineInfo</objectType>\\n <aliyunRegionId>cn-hangzhou</aliyunRegionId>\\n <machineSn>1ssasa</machineSn>\\n </hostInfos>\\n <ecsLabelValue>ecs</ecsLabelValue>\\n </hostGroup>\\n</GetHostGroupResponse>","errorExample":""}]', + ], + 'ListHostGroups' => [ + 'summary' => '获取主机组列表', + 'path' => '/organization/{organizationId}/hostGroups', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'ids', + 'in' => 'query', + 'schema' => [ + 'title' => '主机组id，多个逗号分割', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '121,1212121232', + ], + ], + [ + 'name' => 'createStartTime', + 'in' => 'query', + 'schema' => [ + 'title' => '主机组创建时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1586863220000', + ], + ], + [ + 'name' => 'createEndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '主机组结束时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1586863220000', + ], + ], + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => [ + 'title' => '主机组名称', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '主机组', + ], + ], + [ + 'name' => 'creatorAccountIds', + 'in' => 'query', + 'schema' => [ + 'title' => '创建阿里云账号id，多个逗号分割', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1112122121,3223332', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'title' => '分页token', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '221212221', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'title' => '结果返回个数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'pageSort', + 'in' => 'query', + 'schema' => [ + 'title' => '排序条件ID', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ID', + ], + ], + [ + 'name' => 'pageOrder', + 'in' => 'query', + 'schema' => [ + 'title' => '排序顺序', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'DESC', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'hostGroups' => [ + 'title' => '主机组', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'creatorAccountId' => [ + 'title' => '创建人阿里云账号id', + 'description' => '', + 'type' => 'string', + 'example' => '2222222222222', + ], + 'updateTime' => [ + 'title' => '更新时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1586863220000', + ], + 'hostNum' => [ + 'title' => '主机个数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'modifierAccountId' => [ + 'title' => '修改人阿里云账号id', + 'description' => '', + 'type' => 'string', + 'example' => '211111111', + ], + 'description' => [ + 'title' => '描述', + 'description' => '', + 'type' => 'string', + 'example' => '主机组', + ], + 'type' => [ + 'title' => '类型', + 'description' => '', + 'type' => 'string', + 'example' => 'ECS', + ], + 'createTime' => [ + 'title' => '主机时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1586863220000', + ], + 'ecsType' => [ + 'title' => '主机类型', + 'description' => '', + 'type' => 'string', + 'example' => 'ECS_ALIYUN', + ], + 'aliyunRegion' => [ + 'title' => '阿里云区域', + 'description' => '', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'ecsLabelKey' => [ + 'title' => 'ecs标签Key', + 'description' => '', + 'type' => 'string', + 'example' => 'ecs', + ], + 'name' => [ + 'title' => '部署组名称', + 'description' => '', + 'type' => 'string', + 'example' => '部署组', + ], + 'id' => [ + 'title' => '323232', + 'description' => '323232', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '部署组Id', + ], + 'serviceConnectionId' => [ + 'title' => '服务连接Id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1212122', + ], + 'ecsLabelValue' => [ + 'title' => 'Ecs标签值', + 'description' => '', + 'type' => 'string', + 'example' => 'value', + ], + ], + ], + ], + 'totalCount' => [ + 'title' => '总数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50', + ], + 'nextToken' => [ + 'title' => '分页token,空表示最后一页', + 'description' => '', + 'type' => 'string', + 'example' => 'asassasassa', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"hostGroups\\": [\\n {\\n \\"creatorAccountId\\": \\"2222222222222\\",\\n \\"updateTime\\": 1586863220000,\\n \\"hostNum\\": 3,\\n \\"modifierAccountId\\": \\"211111111\\",\\n \\"description\\": \\"主机组\\",\\n \\"type\\": \\"ECS\\",\\n \\"createTime\\": 1586863220000,\\n \\"ecsType\\": \\"ECS_ALIYUN\\",\\n \\"aliyunRegion\\": \\"cn-beijing\\",\\n \\"ecsLabelKey\\": \\"ecs\\",\\n \\"name\\": \\"部署组\\",\\n \\"id\\": 0,\\n \\"serviceConnectionId\\": 1212122,\\n \\"ecsLabelValue\\": \\"value\\"\\n }\\n ],\\n \\"totalCount\\": 50,\\n \\"nextToken\\": \\"asassasassa\\"\\n}","errorExample":""},{"type":"xml","example":"<ListHostGroupsResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>\\"\\"</errorMessage>\\n <errorCode>\\"\\"</errorCode>\\n <success>true</success>\\n <hostGroups>\\n <creatorAccountId>2222222222222</creatorAccountId>\\n <updateTime>1586863220000</updateTime>\\n <hostNum>3</hostNum>\\n <modifierAccountId>211111111</modifierAccountId>\\n <description>主机组</description>\\n <type>ECS</type>\\n <createTime>1586863220000</createTime>\\n <ecsType>ECS_ALIYUN</ecsType>\\n <aliyunRegion>cn-beijing</aliyunRegion>\\n <ecsLabelKey>ecs</ecsLabelKey>\\n <name>部署组</name>\\n <serviceConnectionId>1212122</serviceConnectionId>\\n <ecsLabelValue>value</ecsLabelValue>\\n </hostGroups>\\n <totalCount>50</totalCount>\\n <nextToken>asassasassa</nextToken>\\n</ListHostGroupsResponse>","errorExample":""}]', + ], + 'CreateVariableGroup' => [ + 'summary' => '创建变量组', + 'path' => '/organization/{organizationId}/variableGroups', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'name', + 'in' => 'formData', + 'schema' => [ + 'title' => '变量组名称', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '变量组', + ], + ], + [ + 'name' => 'description', + 'in' => 'formData', + 'schema' => [ + 'title' => '变量组描述', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '变量组', + ], + ], + [ + 'name' => 'variables', + 'in' => 'formData', + 'schema' => [ + 'title' => '变量信息json字符串 isEncrypted 是否加密 name 变量名称 value 变量值', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '[{"isEncrypted":true,"name":"name1","value":"vaue1"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'variableGroupId' => [ + 'title' => '新建的变量组id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"errorCode\\": \\"”“\\",\\n \\"success\\": true,\\n \\"variableGroupId\\": 1234\\n}","errorExample":""},{"type":"xml","example":"<CreateVariableGroupResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>”“</errorMessage>\\n <errorCode>”“</errorCode>\\n <success>true</success>\\n <variableGroupId>1234</variableGroupId>\\n</CreateVariableGroupResponse>","errorExample":""}]', + ], + 'DeleteVariableGroup' => [ + 'summary' => '删除变量组', + 'path' => '/organization/{organizationId}/variableGroups/{id}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'id', + 'in' => 'path', + 'schema' => [ + 'title' => '变量组id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"errorCode\\": \\"”“\\",\\n \\"success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteVariableGroupResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>”“</errorMessage>\\n <errorCode>”“</errorCode>\\n <success>true</success>\\n</DeleteVariableGroupResponse>","errorExample":""}]', + ], + 'UpdateVariableGroup' => [ + 'summary' => '更新变量组', + 'path' => '/organization/{organizationId}/variableGroups/{id}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'name', + 'in' => 'formData', + 'schema' => [ + 'title' => '变量组名称', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '变量组', + ], + ], + [ + 'name' => 'description', + 'in' => 'formData', + 'schema' => [ + 'title' => '变量组描述', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '变量组', + ], + ], + [ + 'name' => 'variables', + 'in' => 'formData', + 'schema' => [ + 'title' => '变量信息json字符串 isEncrypted 是否加密 name 变量名称 value 变量值', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '[{"isEncrypted":true,"name":"name1","value":"vaue1"}]', + ], + ], + [ + 'name' => 'id', + 'in' => 'path', + 'schema' => [ + 'title' => '变量组id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"errorCode\\": \\"”“\\",\\n \\"success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateVariableGroupResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>”“</errorMessage>\\n <errorCode>”“</errorCode>\\n <success>true</success>\\n</UpdateVariableGroupResponse>","errorExample":""}]', + ], + 'GetVariableGroup' => [ + 'summary' => '获取变量组', + 'path' => '/organization/{organizationId}/variableGroups/{id}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'id', + 'in' => 'path', + 'schema' => [ + 'title' => '变量组id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'variableGroup' => [ + 'title' => '变量组', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ccreatorAccountId' => [ + 'title' => '创建人阿里云账号id', + 'description' => '', + 'type' => 'string', + 'example' => '13232343434343', + ], + 'description' => [ + 'title' => '变量组描述', + 'description' => '', + 'type' => 'string', + 'example' => '变量组', + ], + 'updateTime' => [ + 'title' => '更新时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1586863220000', + ], + 'id' => [ + 'title' => '变量组id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12234', + ], + 'modifierAccountId' => [ + 'title' => '更新人阿里云账号id', + 'description' => '', + 'type' => 'string', + 'example' => '13232343434343', + ], + 'name' => [ + 'title' => '变量组名称', + 'description' => '', + 'type' => 'string', + 'example' => '变量组', + ], + 'relatedPipelines' => [ + 'title' => '关联的流水线', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '关联的流水线Id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'name' => [ + 'title' => '关联的流水线名称', + 'description' => '', + 'type' => 'string', + 'example' => '流水线', + ], + ], + ], + ], + 'variables' => [ + 'title' => '变量', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'value' => [ + 'title' => '变量值', + 'description' => '', + 'type' => 'string', + 'example' => 'value1', + ], + 'name' => [ + 'title' => '变量名', + 'description' => '', + 'type' => 'string', + 'example' => 'name1', + ], + 'isEncrypted' => [ + 'title' => '是否加密', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + 'createTime' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1586863220000', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"variableGroup\\": {\\n \\"ccreatorAccountId\\": \\"13232343434343\\",\\n \\"description\\": \\"变量组\\",\\n \\"updateTime\\": 1586863220000,\\n \\"id\\": 12234,\\n \\"modifierAccountId\\": \\"13232343434343\\",\\n \\"name\\": \\"变量组\\",\\n \\"relatedPipelines\\": [\\n {\\n \\"id\\": 1234,\\n \\"name\\": \\"流水线\\"\\n }\\n ],\\n \\"variables\\": [\\n {\\n \\"value\\": \\"value1\\",\\n \\"name\\": \\"name1\\",\\n \\"isEncrypted\\": true\\n }\\n ],\\n \\"createTime\\": 1586863220000\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetVariableGroupResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>\\"\\"</errorMessage>\\n <errorCode>\\"\\"</errorCode>\\n <success>true</success>\\n <variableGroup>\\n <ccreatorAccountId>13232343434343</ccreatorAccountId>\\n <description>变量组</description>\\n <updateTime>1586863220000</updateTime>\\n <id>12234</id>\\n <modifierAccountId>13232343434343</modifierAccountId>\\n <name>变量组</name>\\n <relatedPipelines>\\n <id>1234</id>\\n <name>流水线</name>\\n </relatedPipelines>\\n <variables>\\n <value>value1</value>\\n <name>name1</name>\\n <isEncrypted>true</isEncrypted>\\n </variables>\\n <createTime>1586863220000</createTime>\\n </variableGroup>\\n</GetVariableGroupResponse>","errorExample":""}]', + ], + 'ListVariableGroups' => [ + 'summary' => '获取变量组列表', + 'path' => '/organization/{organizationId}/variableGroups', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pageSort', + 'in' => 'query', + 'schema' => [ + 'title' => '排序条件', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ID', + ], + ], + [ + 'name' => 'pageOrder', + 'in' => 'query', + 'schema' => [ + 'title' => '排序顺序', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'DESC', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'title' => '分页token，上一次请求的出参nextToken', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'aaaaaa', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'title' => '最大返回数，默认30', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'variableGroups' => [ + 'title' => '变量组', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'creatorAccountId' => [ + 'title' => '创建人阿里云账号id', + 'description' => '', + 'type' => 'string', + 'example' => '13232343434343', + ], + 'updateTime' => [ + 'title' => '更新时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1586863220000', + ], + 'modifierAccountId' => [ + 'title' => '更新人阿里云账号id', + 'description' => '', + 'type' => 'string', + 'example' => '13232343434343', + ], + 'description' => [ + 'title' => '变量组描述', + 'description' => '', + 'type' => 'string', + 'example' => '变量组', + ], + 'name' => [ + 'title' => '变量组名称', + 'description' => '', + 'type' => 'string', + 'example' => '变量组', + ], + 'id' => [ + 'title' => '变量组id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12234', + ], + 'relatedPipelines' => [ + 'title' => '关联的流水线', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '关联的流水线Id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'name' => [ + 'title' => '关联的流水线名称', + 'description' => '', + 'type' => 'string', + 'example' => '流水线', + ], + ], + ], + ], + 'variables' => [ + 'title' => '变量', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'value' => [ + 'title' => '变量值', + 'description' => '', + 'type' => 'string', + 'example' => 'value1', + ], + 'name' => [ + 'title' => '变量名', + 'description' => '', + 'type' => 'string', + 'example' => 'name1', + ], + 'isEncrypted' => [ + 'title' => '是否加密', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + 'createTime' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1586863220000', + ], + ], + ], + ], + 'totalCount' => [ + 'title' => '变量组总数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'nextToken' => [ + 'title' => '下一次查询的token，为空表示最后一页', + 'description' => '', + 'type' => 'string', + 'example' => 'assassa', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"variableGroups\\": [\\n {\\n \\"creatorAccountId\\": \\"13232343434343\\",\\n \\"updateTime\\": 1586863220000,\\n \\"modifierAccountId\\": \\"13232343434343\\",\\n \\"description\\": \\"变量组\\",\\n \\"name\\": \\"变量组\\",\\n \\"id\\": 12234,\\n \\"relatedPipelines\\": [\\n {\\n \\"id\\": 1234,\\n \\"name\\": \\"流水线\\"\\n }\\n ],\\n \\"variables\\": [\\n {\\n \\"value\\": \\"value1\\",\\n \\"name\\": \\"name1\\",\\n \\"isEncrypted\\": true\\n }\\n ],\\n \\"createTime\\": 1586863220000\\n }\\n ],\\n \\"totalCount\\": 30,\\n \\"nextToken\\": \\"assassa\\"\\n}","errorExample":""},{"type":"xml","example":"<ListVariableGroupsResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>\\"\\"</errorMessage>\\n <errorCode>\\"\\"</errorCode>\\n <success>true</success>\\n <variableGroups>\\n <creatorAccountId>13232343434343</creatorAccountId>\\n <updateTime>1586863220000</updateTime>\\n <modifierAccountId>13232343434343</modifierAccountId>\\n <description>变量组</description>\\n <name>变量组</name>\\n <id>12234</id>\\n <relatedPipelines>\\n <id>1234</id>\\n <name>流水线</name>\\n </relatedPipelines>\\n <variables>\\n <value>value1</value>\\n <name>name1</name>\\n <isEncrypted>true</isEncrypted>\\n </variables>\\n <createTime>1586863220000</createTime>\\n </variableGroups>\\n <totalCount>30</totalCount>\\n <nextToken>assassa</nextToken>\\n</ListVariableGroupsResponse>","errorExample":""}]', + ], + 'CreatePipeline' => [ + 'summary' => '创建流水线。', + 'path' => '/organization/{organizationId}/pipelines', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'name', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'content', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'pipelinId' => [ + 'title' => '流水线id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11XXX', + ], + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'."\n", + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"success\\": true,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"pipelinId\\": 0,\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\\\n\\"\\n}","type":"json"}]', + ], + 'DeletePipeline' => [ + 'summary' => '删除流水线', + 'path' => '/organization/{organizationId}/pipelines/{pipelineId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => [ + 'title' => '流水线ID，可在流水线链接中获取，如 https:// flow.aliyun.com/pipelines/【PipelineId】/current', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '999999999999999', + 'minimum' => '1', + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeletePipelineResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>\\"\\"</errorMessage>\\n <errorCode>\\"\\"</errorCode>\\n <success>true</success>\\n</DeletePipelineResponse>","errorExample":""}]', + ], + 'DeletePipelineRelations' => [ + 'summary' => '删除流水线关联', + 'path' => '/organization/{organizationId}/{pipelineId}/pipelineRelations', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => [ + 'title' => '流水线ID，可在流水线链接中获取，如https://flow.aliyun.com/pipelines/【PipelineId】/current', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '11', + ], + ], + [ + 'name' => 'relObjectType', + 'in' => 'query', + 'schema' => [ + 'title' => '关联的资源类型，目前只支持VARIABLE_GROUP', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'VARIABLE_GROUP', + 'enum' => [ + 'VARIABLE_GROUP', + ], + ], + ], + [ + 'name' => 'relObjectId', + 'in' => 'query', + 'schema' => [ + 'title' => '关联的资源id，目前只支持变量组id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '11', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true\\n}","type":"json"}]', + ], + 'UpdatePipeline' => [ + 'summary' => '更新流水线。', + 'path' => '/organization/{organizationId}/pipelines/update', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'name', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'content', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '111xxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + ], + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"success\\": true,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\"\\n}","type":"json"}]', + ], + 'StartPipelineRun' => [ + 'summary' => '运行流水线', + 'path' => '/organizations/{organizationId}/pipelines/{pipelineId}/run', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => [ + 'title' => '流水线ID，可在流水线链接中获取，如 https:// flow.aliyun.com/pipelines/【PipelineId】/current', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'params', + 'in' => 'formData', + 'schema' => [ + 'title' => '流水线运行参数,json字符串 branchModeBranchs 分支模式运行的分支 envs 环境变量 runningBranchs 运行分支 runningTags 运行代码tag comment 运行备注', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{ "branchModeBranchs":[ "branch1", "branch2" ], "envs":{ "k1":"v1", "k2":"v2", "k3":"v3" }, "runningBranchs":{ "https://codeup.aliyun.com/60c1abb32c5969c370c5fcd0/Codeup-Demo.git":"master1" }, "runningTags":{ "https://codeup.aliyun.com/60c1abb32c5969c370c5fcd0/Codeup-Demo.git":"1.0" } }', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'pipelineRunId' => [ + 'title' => '流水线运行实例id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"pipelineRunId\\": 1,\\n \\"success\\": true,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\"\\n}","errorExample":""},{"type":"xml","example":"<StartPipelineRunResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>\\"\\"</errorMessage>\\n <pipelineRunId>1</pipelineRunId>\\n <success>true</success>\\n <errorCode>\\"\\"</errorCode>\\n</StartPipelineRunResponse>","errorExample":""}]', + ], + 'StopPipelineJobRun' => [ + 'summary' => '终止流水线任务运行', + 'path' => '/organization/{organizationId}/pipelines/{pipelineId}/pipelineRuns/{pipelineRunId}/jobs/{jobId}/stop', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => [ + 'title' => '流水线ID，可在流水线链接中获取，如 https:// flow.aliyun.com/pipelines/【PipelineId】/current', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'pipelineRunId', + 'in' => 'path', + 'schema' => [ + 'title' => '流水线运行实例id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '3', + ], + ], + [ + 'name' => 'jobId', + 'in' => 'path', + 'schema' => [ + 'title' => '流水线运行任务Id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2324334', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '"\'', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\'\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true\\n}","errorExample":""},{"type":"xml","example":"<StopPipelineJobRunResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>\\"\'</errorMessage>\\n <errorCode>\\"\\"</errorCode>\\n <success>true</success>\\n</StopPipelineJobRunResponse>","errorExample":""}]', + ], + 'StopPipelineRun' => [ + 'summary' => '终止流水线运行', + 'path' => '/organization/{organizationId}/pipelines/{pipelineId}/pipelineRuns/{pipelineRunId}/stop', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => [ + 'title' => '流水线ID，可在流水线链接中获取，如 https:// flow.aliyun.com/pipelines/【PipelineId】/current', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '12', + ], + ], + [ + 'name' => 'pipelineRunId', + 'in' => 'path', + 'schema' => [ + 'title' => '流水线运行实例id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '223', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"errorCode\\": \\"”“\\",\\n \\"success\\": true\\n}","errorExample":""},{"type":"xml","example":"<StopPipelineRunResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>”“</errorMessage>\\n <errorCode>”“</errorCode>\\n <success>true</success>\\n</StopPipelineRunResponse>","errorExample":""}]', + ], + 'UpdatePipelineBaseInfo' => [ + 'summary' => '删除标签', + 'path' => '/organization/{organizationId}/pipelines/{pipelineId}/baseInfo', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '12', + ], + ], + [ + 'name' => 'pipelineName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'envId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + 'enum' => [ + '0', + '1', + '2', + ], + ], + ], + [ + 'name' => 'tagList', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '"11,222,33"', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true 接口调用成功，false 接口调用失败', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCluster.NotFound', + 'errorMessage' => 'No cluster is available to generate the workspace.', + ], + [ + 'errorCode' => 'InvalidCodeUrl.NotSupportSVN', + 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', + ], + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFoun', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFound', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', + 'errorMessage' => 'Resource owner cannot be deleted.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberNotExists', + 'errorMessage' => 'The resource member does not exist.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidIdentifier.NotFound', + 'errorMessage' => 'space id is error or not exist.', + ], + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + [ + 'errorCode' => 'InvalidWorkspace.NotFound', + 'errorMessage' => 'The workspace is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\"\\n}","type":"json"}]', + ], + 'RetryPipelineJobRun' => [ + 'summary' => '重试流水线运行', + 'path' => '/organization/{organizationId}/pipelines/{pipelineId}/pipelineRuns/{pipelineRunId}/jobs/{jobId}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'pipelineRunId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'jobId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RetryPipelineJobRunResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>\\"\\"</errorMessage>\\n <errorCode>\\"\\"</errorCode>\\n <success>true</success>\\n</RetryPipelineJobRunResponse>","errorExample":""}]', + ], + 'SkipPipelineJobRun' => [ + 'summary' => '跳过流水线任务运行', + 'path' => '/organization/{organizationId}/pipelines/{pipelineId}/pipelineRuns/{pipelineRunId}/jobs/{jobId}/skip', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'pipelineRunId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'jobId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true\\n}","type":"json"}]', + ], + 'PassPipelineValidate' => [ + 'summary' => '通过人工卡点', + 'path' => '/organization/{organizationId}/pipelines/{pipelineId}/pipelineRuns/{pipelineRunId}/jobs/{jobId}/pass', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => [ + 'title' => '流水线ID，可在流水线链接中获取，如https://flow.aliyun.com/pipelines/【PipelineId】/current', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '11222', + ], + ], + [ + 'name' => 'pipelineRunId', + 'in' => 'path', + 'schema' => [ + 'title' => '流水线运行实例id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1111', + ], + ], + [ + 'name' => 'jobId', + 'in' => 'path', + 'schema' => [ + 'title' => '1111', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '111', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCluster.NotFound', + 'errorMessage' => 'No cluster is available to generate the workspace.', + ], + [ + 'errorCode' => 'InvalidCodeUrl.NotSupportSVN', + 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', + ], + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFoun', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFound', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', + 'errorMessage' => 'Resource owner cannot be deleted.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberNotExists', + 'errorMessage' => 'The resource member does not exist.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization.', + ], + [ + 'errorCode' => 'InvalidWorkspaceStatus.NotSuccess', + 'errorMessage' => 'The workspace status is invalid. You can only operate workspaces with the SUCCESS status.', + ], + [ + 'errorCode' => 'InvalidWorkspaceTemplate.NotFound', + 'errorMessage' => 'The parameter workspaceTemplate is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + [ + 'errorCode' => 'InvalidWorkspace.NotFound', + 'errorMessage' => 'The workspace is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', + ], + 'RefusePipelineValidate' => [ + 'summary' => '拒绝人工卡点', + 'path' => '/organization/{organizationId}/pipelines/{pipelineId}/pipelineRuns/{pipelineRunId}/jobs/{jobId}/refuse', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => [ + 'title' => '12222', + 'description' => '12222', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '流水线ID，可在流水线链接中获取，如https://flow.aliyun.com/pipelines/【PipelineId】/current', + ], + ], + [ + 'name' => 'pipelineRunId', + 'in' => 'path', + 'schema' => [ + 'title' => '1', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '流水线运行实例id', + ], + ], + [ + 'name' => 'jobId', + 'in' => 'path', + 'schema' => [ + 'title' => '11111', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1111', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCluster.NotFound', + 'errorMessage' => 'No cluster is available to generate the workspace.', + ], + [ + 'errorCode' => 'InvalidCodeUrl.NotSupportSVN', + 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', + ], + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFoun', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFound', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', + 'errorMessage' => 'Resource owner cannot be deleted.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberNotExists', + 'errorMessage' => 'The resource member does not exist.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization.', + ], + [ + 'errorCode' => 'InvalidWorkspaceStatus.NotSuccess', + 'errorMessage' => 'The workspace status is invalid. You can only operate workspaces with the SUCCESS status.', + ], + [ + 'errorCode' => 'InvalidWorkspaceTemplate.NotFound', + 'errorMessage' => 'The parameter workspaceTemplate is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + [ + 'errorCode' => 'InvalidWorkspace.NotFound', + 'errorMessage' => 'The workspace is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\"\\n}","errorExample":""},{"type":"xml","example":"<RefusePipelineValidateResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>错误信息</errorMessage>\\n <success>false</success>\\n <errorCode>错误码</errorCode>\\n</RefusePipelineValidateResponse>","errorExample":""}]', + ], + 'AddPipelineRelations' => [ + 'summary' => '添加流水线关联', + 'path' => '/organization/{organizationId}/{pipelineId}/pipelineRelations', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => [ + 'title' => '流水线ID，可在流水线链接中获取，如https://flow.aliyun.com/pipelines/【PipelineId】/current', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '11', + ], + ], + [ + 'name' => 'relObjectType', + 'in' => 'query', + 'schema' => [ + 'title' => '关联的资源类型，暂只支持VARIABLE_GROUP', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'VARIABLE_GROUP', + 'enum' => [ + 'VARIABLE_GROUP', + ], + ], + ], + [ + 'name' => 'relObjectIds', + 'in' => 'query', + 'schema' => [ + 'title' => '关联的资源id，暂只支持变量组id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '11,22', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true\\n}","type":"json"}]', + ], + 'GetPipeline' => [ + 'summary' => '获取流水线', + 'path' => '/organization/{organizationId}/pipelines/{pipelineId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => [ + 'title' => '流水线ID，可在流水线链接中获取，如 https:// flow.aliyun.com/pipelines/【PipelineId】/current', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'pipeline' => [ + 'title' => '流水线', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'creatorAccountId' => [ + 'title' => '创建者阿里云账号id', + 'description' => '', + 'type' => 'string', + 'example' => '112222122', + ], + 'envId' => [ + 'title' => '环境id 0 日常环境 1预发环境 2正式环境', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'envName' => [ + 'title' => '环境名称', + 'description' => '', + 'type' => 'string', + 'example' => '日常环境', + ], + 'createTime' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1586863220000', + ], + 'updateTime' => [ + 'title' => '更新时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1586863220000', + ], + 'groupId' => [ + 'title' => '流水线分组id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1111', + ], + 'modifierAccountId' => [ + 'title' => '更新人阿里云账号id', + 'description' => '', + 'type' => 'string', + 'example' => '112222122', + ], + 'name' => [ + 'title' => '流水线名称', + 'description' => '', + 'type' => 'string', + 'example' => '流水线', + ], + 'tagList' => [ + 'title' => '标签', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '标签id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '22', + ], + 'name' => [ + 'title' => '标签名称', + 'description' => '', + 'type' => 'string', + 'example' => '标签1', + ], + ], + ], + ], + 'pipelineConfig' => [ + 'title' => '流水线配置', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'flow' => [ + 'title' => '流水线配置信息', + 'description' => '', + 'type' => 'string', + 'example' => 'schema: tb pipeline: - name: 执行命令 stages: - driven: AUTO jobs: - displayName: 执行命令 task: execution-component-production@10 identifier: \'10_1626147407245\' templateType: task templateSign: \'\' templateBatchUpdate: \'N\' extraInfo: \'\' params: version1: pre-jdk1.62 steps: - name: 执行命令 stepType: exec-shell stepIdentifier: \'10_1626147407245__11_1626147407249\' command: | # input your command here echo hello,world! ARTIFACTS: \'\' JSONEncoding: true freeInTaskGroupModeFields: - ARTIFACTS source: 132504-sss_ddd_3mvJ ENGINE_PIPELINE_NAME: \'${INPUTS.ENGINE_PIPELINE_NAME}\' ENGINE_PIPELINE_ID: \'${INPUTS.ENGINE_PIPELINE_ID}\' ENGINE_PIPELINE_INST_ID: \'${INPUTS.ENGINE_PIPELINE_INST_ID}\' ENGINE_PIPELINE_INST_NUMBER: \'${INPUTS.ENGINE_PIPELINE_INST_NUMBER}\' buildNodeGroup: K8S-4 plugins: [] output: [] freeInTaskGroupModeFields: []', + ], + 'settings' => [ + 'title' => '流水线环境变量等', + 'description' => '', + 'type' => 'string', + 'example' => '{}', + ], + 'sources' => [ + 'title' => '代码源', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'sign' => [ + 'title' => '代码源唯一标识', + 'description' => '', + 'type' => 'string', + 'example' => 'xxsxsxs', + ], + 'type' => [ + 'title' => '代码源类型aliyunGit 阿里云代码库 customGitlab 自建git giteeGit 码云 codeup Codeup git 通用git gitlab gitlab bitbucket bitbucket githubOAuth github', + 'description' => '', + 'type' => 'string', + 'example' => 'Codeup', + ], + 'data' => [ + 'title' => '代码数据', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'branch' => [ + 'title' => '分支', + 'description' => '', + 'type' => 'string', + 'example' => 'master', + ], + 'serviceConnectionId' => [ + 'title' => '服务连接Id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'label' => [ + 'title' => '代码源显示标签', + 'description' => '', + 'type' => 'string', + 'example' => 'cdup/ss', + ], + 'isTrigger' => [ + 'title' => '是否提交触发', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'repo' => [ + 'title' => '代码库地址', + 'description' => '', + 'type' => 'string', + 'example' => 'https://codeup.aliyun.com/test.git', + ], + 'triggerFilter' => [ + 'title' => '触发过滤条件', + 'description' => '', + 'type' => 'string', + 'example' => '.*', + ], + 'webhook' => [ + 'title' => 'webhhook地址', + 'description' => '', + 'type' => 'string', + 'example' => 'https://flow.aliyun/webhook/asassasa', + ], + 'events' => [ + 'title' => '触发事件', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'push', + ], + ], + 'isBranchMode' => [ + 'title' => '是否分支模式', + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'isSubmodule' => [ + 'title' => '是否子模块', + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'isCloneDepth' => [ + 'title' => '是否设置clone深度', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'cloneDepth' => [ + 'title' => '克隆深度', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'credentialId' => [ + 'title' => 'Credential Id', + 'description' => 'Credential Id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '222', + ], + 'credentialType' => [ + 'title' => 'Credential Type', + 'description' => 'Credential Type', + 'type' => 'string', + 'example' => 'region-ssh', + ], + 'credentialLabel' => [ + 'title' => 'Credential Label', + 'description' => 'Credential Label', + 'type' => 'string', + 'example' => '企业公钥', + ], + 'namespace' => [ + 'title' => 'github命名空间', + 'description' => '', + 'type' => 'string', + 'example' => 'asasasas', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"pipeline\\": {\\n \\"creatorAccountId\\": \\"112222122\\",\\n \\"envId\\": 0,\\n \\"envName\\": \\"日常环境\\",\\n \\"createTime\\": 1586863220000,\\n \\"updateTime\\": 1586863220000,\\n \\"groupId\\": 1111,\\n \\"modifierAccountId\\": \\"112222122\\",\\n \\"name\\": \\"流水线\\",\\n \\"tagList\\": [\\n {\\n \\"id\\": 22,\\n \\"name\\": \\"标签1\\"\\n }\\n ],\\n \\"pipelineConfig\\": {\\n \\"flow\\": \\"schema: tb pipeline: - name: 执行命令 stages: - driven: AUTO jobs: - displayName: 执行命令 task: execution-component-production@10 identifier: \'10_1626147407245\' templateType: task templateSign: \'\' templateBatchUpdate: \'N\' extraInfo: \'\' params: version1: pre-jdk1.62 steps: - name: 执行命令 stepType: exec-shell stepIdentifier: \'10_1626147407245__11_1626147407249\' command: | # input your command here echo hello,world! ARTIFACTS: \'\' JSONEncoding: true freeInTaskGroupModeFields: - ARTIFACTS source: 132504-sss_ddd_3mvJ ENGINE_PIPELINE_NAME: \'${INPUTS.ENGINE_PIPELINE_NAME}\' ENGINE_PIPELINE_ID: \'${INPUTS.ENGINE_PIPELINE_ID}\' ENGINE_PIPELINE_INST_ID: \'${INPUTS.ENGINE_PIPELINE_INST_ID}\' ENGINE_PIPELINE_INST_NUMBER: \'${INPUTS.ENGINE_PIPELINE_INST_NUMBER}\' buildNodeGroup: K8S-4 plugins: [] output: [] freeInTaskGroupModeFields: []\\",\\n \\"settings\\": \\"{}\\",\\n \\"sources\\": [\\n {\\n \\"sign\\": \\"xxsxsxs\\",\\n \\"type\\": \\"Codeup\\",\\n \\"data\\": {\\n \\"branch\\": \\"master\\",\\n \\"serviceConnectionId\\": 12,\\n \\"label\\": \\"cdup/ss\\",\\n \\"isTrigger\\": true,\\n \\"repo\\": \\"https://codeup.aliyun.com/test.git\\",\\n \\"triggerFilter\\": \\".*\\",\\n \\"webhook\\": \\"https://flow.aliyun/webhook/asassasa\\",\\n \\"events\\": [\\n \\"push\\"\\n ],\\n \\"isBranchMode\\": false,\\n \\"isSubmodule\\": false,\\n \\"isCloneDepth\\": true,\\n \\"cloneDepth\\": 1,\\n \\"credentialId\\": 222,\\n \\"credentialType\\": \\"region-ssh\\",\\n \\"credentialLabel\\": \\"企业公钥\\",\\n \\"namespace\\": \\"asasasas\\"\\n }\\n }\\n ]\\n }\\n },\\n \\"success\\": true,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\"\\n}","errorExample":""},{"type":"xml","example":"<GetPipelineResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>\\"\\"</errorMessage>\\n <pipeline>\\n <creatorAccountId>112222122</creatorAccountId>\\n <envId>0</envId>\\n <envName>日常环境</envName>\\n <createTime>1586863220000</createTime>\\n <updateTime>1586863220000</updateTime>\\n <groupId>1111</groupId>\\n <modifierAccountId>112222122</modifierAccountId>\\n <name>流水线</name>\\n <tagList>\\n <id>22</id>\\n <name>标签1</name>\\n </tagList>\\n <pipelineConfig>\\n <flow>schema: tb pipeline: - name: 执行命令 stages: - driven: AUTO jobs: - displayName: 执行命令 task: execution-component-production@10 identifier: \'10_1626147407245\' templateType: task templateSign: \'\' templateBatchUpdate: \'N\' extraInfo: \'\' params: version1: pre-jdk1.62 steps: - name: 执行命令 stepType: exec-shell stepIdentifier: \'10_1626147407245__11_1626147407249\' command: | # input your command here echo hello,world! ARTIFACTS: \'\' JSONEncoding: true freeInTaskGroupModeFields: - ARTIFACTS source: 132504-sss_ddd_3mvJ ENGINE_PIPELINE_NAME: \'${INPUTS.ENGINE_PIPELINE_NAME}\' ENGINE_PIPELINE_ID: \'${INPUTS.ENGINE_PIPELINE_ID}\' ENGINE_PIPELINE_INST_ID: \'${INPUTS.ENGINE_PIPELINE_INST_ID}\' ENGINE_PIPELINE_INST_NUMBER: \'${INPUTS.ENGINE_PIPELINE_INST_NUMBER}\' buildNodeGroup: K8S-4 plugins: [] output: [] freeInTaskGroupModeFields: []</flow>\\n <settings>{}</settings>\\n <sources>\\n <sign>xxsxsxs</sign>\\n <type>Codeup</type>\\n <data>\\n <branch>master</branch>\\n <serviceConnectionId>12</serviceConnectionId>\\n <label>cdup/ss</label>\\n <isTrigger>true</isTrigger>\\n <repo>https://codeup.aliyun.com/test.git</repo>\\n <triggerFilter>.*</triggerFilter>\\n <webhook>https://flow.aliyun/webhook/asassasa</webhook>\\n <events>push</events>\\n <isBranchMode>false</isBranchMode>\\n <isSubmodule>false</isSubmodule>\\n <isCloneDepth>true</isCloneDepth>\\n <cloneDepth>1</cloneDepth>\\n <credentialId>222</credentialId>\\n <credentialType>region-ssh</credentialType>\\n <credentialLabel>企业公钥</credentialLabel>\\n <namespace>asasasas</namespace>\\n </data>\\n </sources>\\n </pipelineConfig>\\n </pipeline>\\n <success>true</success>\\n <errorCode>\\"\\"</errorCode>\\n</GetPipelineResponse>","errorExample":""}]', + ], + 'GetPipelineRun' => [ + 'summary' => '获取流水线运行信息', + 'path' => '/organization/{organizationId}/pipelines/{pipelineId}/pipelineRuns/{pipelineRunId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => [ + 'title' => '流水线id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '12222', + ], + ], + [ + 'name' => 'pipelineRunId', + 'in' => 'path', + 'schema' => [ + 'title' => '流水线运行实例id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'pipelineRun' => [ + 'title' => '流水线运行实例', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'creatorAccountId' => [ + 'title' => '创建者阿里云账号id', + 'description' => '', + 'type' => 'string', + 'example' => '1111111111', + ], + 'createTime' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1586863220000', + ], + 'updateTime' => [ + 'title' => '更新时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1586863220000', + ], + 'modifierAccountId' => [ + 'title' => '更新人阿里云账号id', + 'description' => '', + 'type' => 'string', + 'example' => '11111111111', + ], + 'pipelineId' => [ + 'title' => '流水线Id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'pipelineRunId' => [ + 'title' => '流水线运行实例id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'status' => [ + 'title' => '状态 FAIL 运行失败 SUCCESS 运行成功 RUNNING 运行中', + 'description' => '', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'triggerMode' => [ + 'title' => '触发模式 1人工触发 2定时触发 3代码提交触发', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'stageGroup' => [ + 'title' => '阶段拓扑信息', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'Group', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '阶段名称', + ], + ], + ], + 'sources' => [ + 'title' => '代码源', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'sign' => [ + 'title' => '代码源唯一标识', + 'description' => '', + 'type' => 'string', + 'example' => 'assaaaaaasasasa', + ], + 'type' => [ + 'title' => '代码库类型', + 'description' => '', + 'type' => 'string', + 'example' => 'Codeup', + ], + 'data' => [ + 'title' => '代码源信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'branch' => [ + 'title' => '分支', + 'description' => '', + 'type' => 'string', + 'example' => 'master', + ], + 'commint' => [ + 'title' => '提交信息 json数据', + 'description' => '', + 'type' => 'string', + 'example' => '{}', + ], + 'repo' => [ + 'title' => '代码库地址', + 'description' => '', + 'type' => 'string', + 'example' => 'http://codeup.aliyun.com/a.git', + ], + ], + ], + ], + ], + ], + 'stages' => [ + 'title' => '阶段信息', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '阶段名称', + 'description' => '', + 'type' => 'string', + 'example' => 'Java构建', + ], + 'stageInfo' => [ + 'title' => '阶段详情', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'endTime' => [ + 'title' => '结束时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1586863220000', + ], + 'startTime' => [ + 'title' => '开始时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1586863220000', + ], + 'name' => [ + 'title' => '阶段名称', + 'description' => '', + 'type' => 'string', + 'example' => 'Java构建', + ], + 'status' => [ + 'title' => '状态', + 'description' => '', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'jobs' => [ + 'title' => '任务', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'endTime' => [ + 'title' => '结束时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1586863220000', + ], + 'id' => [ + 'title' => '任务Id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '21212', + ], + 'name' => [ + 'title' => '任务名称', + 'description' => '', + 'type' => 'string', + 'example' => 'java构建', + ], + 'params' => [ + 'title' => '触发参数', + 'description' => '', + 'type' => 'string', + 'example' => '{}', + ], + 'status' => [ + 'title' => '状态', + 'description' => '', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'startTime' => [ + 'title' => '开始时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1586863220000', + ], + 'actions' => [ + 'title' => '后续操作', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'title' => 'API名称', + 'description' => '', + 'type' => 'string', + 'example' => 'PassPipelineValidate', + ], + 'disable' => [ + 'title' => '是否可用', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'params' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + ], + 'example' => '{}', + 'title' => '', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"pipelineRun\\": {\\n \\"creatorAccountId\\": \\"1111111111\\",\\n \\"createTime\\": 1586863220000,\\n \\"updateTime\\": 1586863220000,\\n \\"modifierAccountId\\": \\"11111111111\\",\\n \\"pipelineId\\": 1234,\\n \\"pipelineRunId\\": 1,\\n \\"status\\": \\"SUCCESS\\",\\n \\"triggerMode\\": 1,\\n \\"stageGroup\\": [\\n [\\n \\"阶段名称\\"\\n ]\\n ],\\n \\"sources\\": [\\n {\\n \\"sign\\": \\"assaaaaaasasasa\\",\\n \\"type\\": \\"Codeup\\",\\n \\"data\\": {\\n \\"branch\\": \\"master\\",\\n \\"commint\\": \\"{}\\",\\n \\"repo\\": \\"http://codeup.aliyun.com/a.git\\"\\n }\\n }\\n ],\\n \\"stages\\": [\\n {\\n \\"name\\": \\"Java构建\\",\\n \\"stageInfo\\": {\\n \\"endTime\\": 1586863220000,\\n \\"startTime\\": 1586863220000,\\n \\"name\\": \\"Java构建\\",\\n \\"status\\": \\"RUNNING\\",\\n \\"jobs\\": [\\n {\\n \\"endTime\\": 1586863220000,\\n \\"id\\": 21212,\\n \\"name\\": \\"Java构建\\",\\n \\"params\\": \\"{}\\",\\n \\"status\\": \\"RUNNING\\",\\n \\"startTime\\": 1586863220000,\\n \\"actions\\": [\\n {\\n \\"type\\": \\"PassPipelineValidate\\",\\n \\"disable\\": true,\\n \\"params\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n ]\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"success\\": true,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', + ], + 'ListPipelineRuns' => [ + 'summary' => '获取流水线运行历史', + 'path' => '/organization/{organizationId}/pipelines/{pipelineId}/pipelineRuns', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'startTime', + 'in' => 'query', + 'schema' => [ + 'title' => '开始时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1586863220000', + ], + ], + [ + 'name' => 'endTime', + 'in' => 'query', + 'schema' => [ + 'title' => '结束时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1586863220000', + ], + ], + [ + 'name' => 'status', + 'in' => 'query', + 'schema' => [ + 'title' => '状态 状态 FAIL 运行失败 SUCCESS 运行成功 RUNNING 运行中', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'RUNNING', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'title' => '最大返回数量', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'title' => '分页Token', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'aaaaaa', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => [ + 'title' => '流水线id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1233', + ], + ], + [ + 'name' => 'triggerMode', + 'in' => 'query', + 'schema' => [ + 'title' => '触发模式 1人工触发 2定时触发 3代码提交触发', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'totalCount' => [ + 'title' => '总数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50', + ], + 'nextToken' => [ + 'title' => '下一个分页token，为空时，表示没有下一页', + 'description' => '', + 'type' => 'string', + 'example' => 'xzxsasasaas', + ], + 'pipelineRuns' => [ + 'title' => '流水线运行实例', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'pipelineId' => [ + 'title' => '流水线id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'startTime' => [ + 'title' => '开始时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1586863220000', + ], + 'creatorAccountId' => [ + 'title' => '运行人阿里云账号id', + 'description' => '', + 'type' => 'string', + 'example' => '1222222222', + ], + 'endTime' => [ + 'title' => '结束时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1586863220000', + ], + 'pipelineRunId' => [ + 'title' => '流水线实例id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11', + ], + 'triggerMode' => [ + 'title' => '触发模式', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'status' => [ + 'title' => '运行状态', + 'description' => '', + 'type' => 'string', + 'example' => '状态 FAIL 运行失败 SUCCESS 运行成功 RUNNING 运行中', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"errorCode\\": \\"”“\\",\\n \\"success\\": true,\\n \\"totalCount\\": 50,\\n \\"nextToken\\": \\"xzxsasasaas\\",\\n \\"pipelineRuns\\": [\\n {\\n \\"pipelineId\\": 1234,\\n \\"startTime\\": 1586863220000,\\n \\"creatorAccountId\\": \\"1222222222\\",\\n \\"endTime\\": 1586863220000,\\n \\"pipelineRunId\\": 11,\\n \\"triggerMode\\": 1,\\n \\"status\\": \\"状态 FAIL 运行失败 SUCCESS 运行成功 RUNNING 运行中\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListPipelineRunsResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>”“</errorMessage>\\n <errorCode>”“</errorCode>\\n <success>true</success>\\n <totalCount>50</totalCount>\\n <nextToken>xzxsasasaas</nextToken>\\n <pipelineRuns>\\n <pipelineId>1234</pipelineId>\\n <startTime>1586863220000</startTime>\\n <creatorAccountId>1222222222</creatorAccountId>\\n <endTime>1586863220000</endTime>\\n <pipelineRunId>11</pipelineRunId>\\n <triggerMode>1</triggerMode>\\n <status>状态 FAIL 运行失败 SUCCESS 运行成功 RUNNING 运行中</status>\\n </pipelineRuns>\\n</ListPipelineRunsResponse>","errorExample":""}]', + ], + 'ListPipelines' => [ + 'summary' => '获取流水线列表', + 'path' => '/organization/{organizationId}/pipelines', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pipelineName', + 'in' => 'query', + 'schema' => [ + 'title' => '流水线名称', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '流水线', + ], + ], + [ + 'name' => 'creatorAccountIds', + 'in' => 'query', + 'schema' => [ + 'title' => '创建人阿里云账号Id', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '112122121', + ], + ], + [ + 'name' => 'executeAccountIds', + 'in' => 'query', + 'schema' => [ + 'title' => '执行人阿里云账号id', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1111111', + ], + ], + [ + 'name' => 'statusList', + 'in' => 'query', + 'schema' => [ + 'title' => '状态列表，多个逗号分割', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'RUNNING,SUCCESS', + ], + ], + [ + 'name' => 'createStartTime', + 'in' => 'query', + 'schema' => [ + 'title' => '创建开始时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1586863220000', + ], + ], + [ + 'name' => 'createEndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '创建结束时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1586863220000', + ], + ], + [ + 'name' => 'executeStartTime', + 'in' => 'query', + 'schema' => [ + 'title' => '执行开始时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1586863220000', + ], + ], + [ + 'name' => 'executeEndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '执行结束时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1586863220000', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'title' => '返回的总数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'title' => '分页Token', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'aaaaaaaaaa', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'totalCount' => [ + 'title' => '总数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50', + ], + 'nextToken' => [ + 'title' => '分页Token', + 'description' => '', + 'type' => 'string', + 'example' => 'ssaassasass', + ], + 'pipelines' => [ + 'title' => '流水线', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'pipelineName' => [ + 'title' => '流水线名称', + 'description' => '', + 'type' => 'string', + 'example' => '流水线', + ], + 'pipelineId' => [ + 'title' => '流水线id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '124', + ], + 'createTime' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1586863220000', + ], + 'creatorAccountId' => [ + 'title' => '创建人阿里云账号id', + 'description' => '', + 'type' => 'string', + 'example' => '22121222', + ], + 'groupId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"totalCount\\": 50,\\n \\"nextToken\\": \\"ssaassasass\\",\\n \\"pipelines\\": [\\n {\\n \\"pipelineName\\": \\"流水线\\",\\n \\"pipelineId\\": 124,\\n \\"createTime\\": 1586863220000,\\n \\"creatorAccountId\\": \\"22121222\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListPipelinesResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>\\"\\"</errorMessage>\\n <errorCode>\\"\\"</errorCode>\\n <success>true</success>\\n <totalCount>50</totalCount>\\n <nextToken>ssaassasass</nextToken>\\n <pipelines>\\n <pipelineName>流水线</pipelineName>\\n <pipelineId>124</pipelineId>\\n <createTime>1586863220000</createTime>\\n <creatorAccountId>22121222</creatorAccountId>\\n </pipelines>\\n</ListPipelinesResponse>","errorExample":""}]', + ], + 'GetPipelineArtifactUrl' => [ + 'summary' => '获取构建物下载链接', + 'path' => '/organization/{organizationId}/pipeline/getArtifactDownloadUrl', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'filePath', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '/test/test/test.tgz', + 'maxLength' => 1000, + ], + ], + [ + 'name' => 'fileName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'test.tgz', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true 接口调用成功，false 接口调用失败', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'fileUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'http://aliyun.com/', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCluster.NotFound', + 'errorMessage' => 'No cluster is available to generate the workspace.', + ], + [ + 'errorCode' => 'InvalidCodeUrl.NotSupportSVN', + 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', + ], + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFoun', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFound', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', + 'errorMessage' => 'Resource owner cannot be deleted.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberNotExists', + 'errorMessage' => 'The resource member does not exist.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidIdentifier.NotFound', + 'errorMessage' => 'space id is error or not exist.', + ], + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + [ + 'errorCode' => 'InvalidWorkspace.NotFound', + 'errorMessage' => 'The workspace is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\",\\n \\"fileUrl\\": \\"http://aliyun.com/\\"\\n}","type":"json"}]', + ], + 'GetPipelineEmasArtifactUrl' => [ + 'summary' => '获取emase构建物下载链接', + 'path' => '/organization/{organizationId}/pipeline/{pipelineId}/pipelineRun/{pipelineRunId}/emas/artifact/{emasJobInstanceId}/{md5}', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'emasJobInstanceId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'Psaxsa', + ], + ], + [ + 'name' => 'md5', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'assasas', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1111', + ], + ], + [ + 'name' => 'pipelineRunId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'serviceConnectionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '122', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true 接口调用成功，false 接口调用失败', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'fileUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'http://aliyun.com', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCluster.NotFound', + 'errorMessage' => 'No cluster is available to generate the workspace.', + ], + [ + 'errorCode' => 'InvalidCodeUrl.NotSupportSVN', + 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', + ], + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFoun', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFound', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', + 'errorMessage' => 'Resource owner cannot be deleted.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberNotExists', + 'errorMessage' => 'The resource member does not exist.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidIdentifier.NotFound', + 'errorMessage' => 'space id is error or not exist.', + ], + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + [ + 'errorCode' => 'InvalidWorkspace.NotFound', + 'errorMessage' => 'The workspace is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\",\\n \\"fileUrl\\": \\"http://aliyun.com\\"\\n}","type":"json"}]', + ], + 'GetPipelineScanReportUrl' => [ + 'summary' => '获取扫描报告下载链接', + 'path' => '/organization/{organizationId}/pipeline/getPipelineScanReportUrl', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'reportPath', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '/test/test/test.html', + 'maxLength' => 1000, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true 接口调用成功，false 接口调用失败', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'reportUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'http://aliyun.com', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCluster.NotFound', + 'errorMessage' => 'No cluster is available to generate the workspace.', + ], + [ + 'errorCode' => 'InvalidCodeUrl.NotSupportSVN', + 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', + ], + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFound', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', + 'errorMessage' => 'Resource owner cannot be deleted.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberNotExists', + 'errorMessage' => 'The resource member does not exist.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidIdentifier.NotFound', + 'errorMessage' => 'space id is error or not exist.', + ], + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + [ + 'errorCode' => 'InvalidWorkspace.NotFound', + 'errorMessage' => 'The workspace is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\",\\n \\"reportUrl\\": \\"http://aliyun.com\\"\\n}","type":"json"}]', + ], + 'ListPipelineJobHistorys' => [ + 'summary' => '获取流水线运行过的任务历史', + 'path' => '/organization/{organizationId}/pipeline/{pipelineId}/job/historys', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '123', + 'maxLength' => 1000, + ], + ], + [ + 'name' => 'category', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'DEPLOY', + 'enum' => [ + 'DEPLOY', + ], + ], + ], + [ + 'name' => 'identifier', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '10_ssasasa', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'xsaxsa', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'maximum' => '50', + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true 接口调用成功，false 接口调用失败', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'jobs' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'jobName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'identifier' => [ + 'description' => '', + 'type' => 'string', + 'example' => '10_xaxxsxa', + ], + 'pipelineId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'executeNumber' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'jobId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'pipelineRunId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'sources' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{}', + ], + 'status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'operatorAccountId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ssaasssa', + ], + ], + ], + ], + 'nextToken' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xsxxs', + ], + 'totalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCluster.NotFound', + 'errorMessage' => 'No cluster is available to generate the workspace.', + ], + [ + 'errorCode' => 'InvalidCodeUrl.NotSupportSVN', + 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', + ], + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFoun', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFound', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', + 'errorMessage' => 'Resource owner cannot be deleted.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberNotExists', + 'errorMessage' => 'The resource member does not exist.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidIdentifier.NotFound', + 'errorMessage' => 'space id is error or not exist.', + ], + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + [ + 'errorCode' => 'InvalidWorkspace.NotFound', + 'errorMessage' => 'The workspace is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\",\\n \\"jobs\\": [\\n {\\n \\"jobName\\": \\"任务名称\\",\\n \\"identifier\\": \\"10_xaxxsxa\\",\\n \\"pipelineId\\": 123,\\n \\"executeNumber\\": 1,\\n \\"jobId\\": 123,\\n \\"pipelineRunId\\": 123,\\n \\"sources\\": \\"{}\\",\\n \\"status\\": \\"SUCCESS\\",\\n \\"operatorAccountId\\": \\"ssaasssa\\"\\n }\\n ],\\n \\"nextToken\\": \\"xsxxs\\",\\n \\"totalCount\\": 20\\n}","type":"json"}]', + ], + 'ListPipelineJobs' => [ + 'summary' => '获取流水线运行过的任务', + 'path' => '/organization/{organizationId}/pipeline/{pipelineId}/jobs', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1111', + 'maxLength' => 1000, + ], + ], + [ + 'name' => 'category', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'DEPLOY', + 'enum' => [ + 'DEPLOY', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true 接口调用成功，false 接口调用失败', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'jobs' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'jobName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'identifier' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ss_saxsxsxs', + ], + 'lastJobId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'lastJobParams' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{}', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCluster.NotFound', + 'errorMessage' => 'No cluster is available to generate the workspace.', + ], + [ + 'errorCode' => 'InvalidCodeUrl.NotSupportSVN', + 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', + ], + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFoun', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFound', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', + 'errorMessage' => 'Resource owner cannot be deleted.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberNotExists', + 'errorMessage' => 'The resource member does not exist.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidIdentifier.NotFound', + 'errorMessage' => 'space id is error or not exist.', + ], + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + [ + 'errorCode' => 'InvalidWorkspace.NotFound', + 'errorMessage' => 'The workspace is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\",\\n \\"jobs\\": [\\n {\\n \\"jobName\\": \\"任务名称\\",\\n \\"identifier\\": \\"ss_saxsxsxs\\",\\n \\"lastJobId\\": 123,\\n \\"lastJobParams\\": \\"{}\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'LogPipelineJobRun' => [ + 'summary' => '获取流水线运行任务日志', + 'path' => '/organization/{organizationId}/pipeline/{pipelineId}/pipelineRun/{pipelineRunId}/job/{jobId}/logs', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => [ + 'title' => '流水线ID，可在流水线链接中获取，如https://flow.aliyun.com/pipelines/【PipelineId】/current', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '12222', + ], + ], + [ + 'name' => 'jobId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '12', + ], + ], + [ + 'name' => 'pipelineRunId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'log' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'more' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'content' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCluster.NotFound', + 'errorMessage' => 'No cluster is available to generate the workspace.', + ], + [ + 'errorCode' => 'InvalidCodeUrl.NotSupportSVN', + 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', + ], + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFoun', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFound', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', + 'errorMessage' => 'Resource owner cannot be deleted.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberNotExists', + 'errorMessage' => 'The resource member does not exist.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization.', + ], + [ + 'errorCode' => 'InvalidWorkspaceStatus.NotSuccess', + 'errorMessage' => 'The workspace status is invalid. You can only operate workspaces with the SUCCESS status.', + ], + [ + 'errorCode' => 'InvalidWorkspaceTemplate.NotFound', + 'errorMessage' => 'The parameter workspaceTemplate is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + [ + 'errorCode' => 'InvalidWorkspace.NotFound', + 'errorMessage' => 'The workspace is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"log\\": {\\n \\"more\\": true,\\n \\"content\\": \\"success\\"\\n },\\n \\"success\\": true,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\"\\n}","errorExample":""},{"type":"xml","example":"<LogPipelineJobRunResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>\\"\\"</errorMessage>\\n <log>\\n <more>true</more>\\n <content>success</content>\\n </log>\\n <success>true</success>\\n <errorCode>\\"\\"</errorCode>\\n</LogPipelineJobRunResponse>","errorExample":""}]', + ], + 'ListPipelineRelations' => [ + 'summary' => '获取流水线关联列表', + 'path' => '/organization/{organizationId}/{pipelineId}/pipelineRelations', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => [ + 'title' => '流水线ID，可在流水线链接中获取，如https://flow.aliyun.com/pipelines/【PipelineId】/current', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '11', + ], + ], + [ + 'name' => 'relObjectType', + 'in' => 'query', + 'schema' => [ + 'title' => '关联的资源类型，暂只支持VARIABLE_GROUP', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'VARIABLE_GROUP', + 'enum' => [ + 'VARIABLE_GROUP', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'pipelineRelations' => [ + 'title' => '变量组', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'refObjectId' => [ + 'title' => '变量组id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12234', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"pipelineRelations\\": [\\n {\\n \\"refObjectId\\": 12234\\n }\\n ]\\n}","type":"json"}]', + ], + 'WorkitemAttachmentCreate' => [ + 'summary' => '工作项附件创建', + 'path' => '/organization/{organizationId}/workitem/{workitemIdentifier}/attachment', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'workitemIdentifier', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '11234455454355', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'fileKey' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1106473328927498/1106473328927498/5ec071g0e5ij85fche8cddchje.xlsx', + ], + 'originalFilename' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'xxx.tgz', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'F590C9D8-E908-5B6C-95AC-56B7E8011FFA', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'InvalidTagGroup.IdNotFoundntraceId: 2137844496.4337.16624448853053831', + ], + 'success' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F590C9D8-E908-5B6C-95AC-56B7E8011FFA\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"errorMessage\\": \\"InvalidTagGroup.IdNotFoundntraceId: 2137844496.4337.16624448853053831\\",\\n \\"success\\": \\"true\\"\\n}","type":"json"}]', + ], + 'ListWorkitemAttachments' => [ + 'summary' => '获取工作项的附件列表', + 'path' => '/organization/{organizationId}/workitem/{workitemIdentifier}/attachments', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'workitemIdentifier', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '11234455454355', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9', + ], + 'errorMsg' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'error', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'attachments' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'fileIdentifier' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'dflkjlsdddsdl234lkjfg', + ], + 'fileName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Artifacts_1565193_1.tgz', + ], + 'fileSuffix' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'tgz', + ], + 'size' => [ + 'description' => '', + 'type' => 'string', + 'example' => '50', + ], + 'url' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'http://grace-share.oss-cn-hangzhou.aliyuncs.com/qf%2Fheap.bin?Expires=1675750082&OSSAccessKeyId=LTAI5t8irN2Wu3BGrBpffZue&Signature=RqRUEuHiwW8wuahYz6CenHaWWs4%3D', + ], + 'gmtCreate' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1545726028000', + ], + 'creator' => [ + 'description' => '', + 'type' => 'string', + 'example' => '237109', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F7B85D1B-D1C2-140F-A039-341859F130B9\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": true,\\n \\"attachments\\": [\\n {\\n \\"fileIdentifier\\": \\"dflkjlsdddsdl234lkjfg\\",\\n \\"fileName\\": \\"Artifacts_1565193_1.tgz\\",\\n \\"fileSuffix\\": \\"tgz\\",\\n \\"size\\": \\"50\\",\\n \\"url\\": \\"http://grace-share.oss-cn-hangzhou.aliyuncs.com/qf%2Fheap.bin?Expires=1675750082&OSSAccessKeyId=xxxxxxxx&Signature=xxxxx%3D\\",\\n \\"gmtCreate\\": 1545726028000,\\n \\"creator\\": \\"237109\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'CreateWorkitemV2' => [ + 'summary' => '创建工作项', + 'path' => '/organization/{organizationId}/workitem', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [], + 'produces' => [], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'subject' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + 'description' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'assignedTo' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '19xxxx31947xxxx', + ], + 'spaceIdentifier' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'asd345xxxxx9q9845xxxxx34', + ], + 'category' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'Req', + ], + 'workitemTypeIdentifier' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '9uy29901re573f561d69jn40', + ], + 'fieldValueList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'fieldIdentifier' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '6aexxxxxa1d98c09c60xxxx16', + ], + 'value' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'parentIdentifier' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '11223331122', + ], + 'versions' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '[1111,1223]', + ], + 'required' => false, + ], + 'sprintIdentifier' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '455532323455', + ], + 'tags' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '[1112,3344]', + ], + 'required' => false, + ], + 'trackers' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1123344', + ], + 'required' => false, + ], + 'participants' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1234454', + ], + 'required' => false, + ], + 'verifier' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1561159309......', + ], + ], + 'required' => true, + 'docRequired' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'EAE03103-5497-58D1-9169-E524DDE8604C', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'InvalidTagGroup.IdNotFound', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'success' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'true', + ], + 'workitemIdentifier' => [ + 'description' => '', + 'type' => 'string', + 'example' => '11234455454355', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"EAE03103-5497-58D1-9169-E524DDE8604C\\",\\n \\"errorCode\\": \\"InvalidTagGroup.IdNotFound\\",\\n \\"errorMessage\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": \\"true\\",\\n \\"workitemIdentifier\\": \\"11234455454355\\"\\n}","type":"json"}]', + ], + 'CreateWorkitemRecord' => [ + 'summary' => '登记实际工时', + 'path' => '/organization/{organizationId}/workitems/record', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1e9903d8b3f1xxxxxf9286ef5', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'workitemIdentifier' => [ + 'title' => '工作项id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '9144ef6b72d8exxxxx9e61a4d0', + ], + 'actualTime' => [ + 'title' => '花费工时，最大为9999', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '12', + ], + 'type' => [ + 'title' => '类型，从获取工时类型接口获取', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'deafe5f33xxxxx6a259d8dafd', + ], + 'description' => [ + 'title' => '描述', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'recordUserIdentifier' => [ + 'title' => '登记人,为用户的aliyunPk', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1316458xxxxx41068', + ], + 'gmtStart' => [ + 'title' => '开始时间', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1667205617061', + ], + 'gmtEnd' => [ + 'title' => '结束时间，开始时间不能大于结束时间', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1646323200000', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMsg' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'error', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'WorkitemTime' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'identifier' => [ + 'title' => '工时唯一标识', + 'description' => '', + 'type' => 'string', + 'example' => 'deafe5f33xxxxx6a259d8dafd', + ], + 'workitemIdentifier' => [ + 'title' => '工作项id', + 'description' => '', + 'type' => 'string', + 'example' => '9144ef6b72d8exxxxx9e61a4d0', + ], + 'actualTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'type' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'deafe5f33xxxxx6a259d8dafd', + ], + 'description' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'recordUser' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'account' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1316458xxxxx41068', + ], + 'identifier' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'deafe5f33xxxxx6a259d8dafd', + ], + 'realName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'nickName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'avatar' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112m7150e256dbba0d6456bafbb65c81f90d/w/200/h/200', + ], + 'stamp' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'nameEn' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'wangwu', + ], + 'gender' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'mobile' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'email' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'nickNamePinyin' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'wangwu'."\n", + ], + 'realNamePinyin' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'wangwu', + ], + 'displayNickName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'displayRealName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'displayName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'dingTalkId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xx12322', + ], + 'tbRoleId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1e9903d8b3f1xxxxxf9286ef5', + ], + 'isDisabled' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true/false', + ], + ], + ], + 'gmtStart' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1667205617061', + ], + 'gmtEnd' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1667205617089', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"success\\",\\n \\"success\\": true,\\n \\"WorkitemTime\\": {\\n \\"identifier\\": \\"deafe5f33xxxxx6a259d8dafd\\",\\n \\"workitemIdentifier\\": \\"9144ef6b72d8exxxxx9e61a4d0\\",\\n \\"actualTime\\": 12,\\n \\"type\\": \\"deafe5f33xxxxx6a259d8dafd\\",\\n \\"description\\": \\"这是一段描述\\",\\n \\"recordUser\\": {\\n \\"account\\": \\"1316458xxxxx41068\\",\\n \\"identifier\\": \\"deafe5f33xxxxx6a259d8dafd\\",\\n \\"realName\\": \\"王五\\",\\n \\"nickName\\": \\"王武\\",\\n \\"avatar\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112m7150e256dbba0d6456bafbb65c81f90d/w/200/h/200\\",\\n \\"stamp\\": \\"null标识普通用户\\",\\n \\"nameEn\\": \\"wangwu\\",\\n \\"gender\\": \\"保留字段\\",\\n \\"mobile\\": \\"保留字段\\",\\n \\"email\\": \\"[email protected]\\",\\n \\"nickNamePinyin\\": \\"wangwu\\\\n\\",\\n \\"realNamePinyin\\": \\"wangwu\\",\\n \\"displayNickName\\": \\"王五\\",\\n \\"displayRealName\\": \\"王五\\",\\n \\"displayName\\": \\"王五\\",\\n \\"dingTalkId\\": \\"xx12322\\",\\n \\"tbRoleId\\": \\"1e9903d8b3f1xxxxxf9286ef5\\",\\n \\"isDisabled\\": true\\n },\\n \\"gmtStart\\": 1667205617061,\\n \\"gmtEnd\\": 1667205617089\\n }\\n}","type":"json"}]', + ], + 'CreateWorkitem' => [ + 'summary' => '新建工作项', + 'path' => '/organization/{organizationId}/workitems/create', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'subject' => [ + 'title' => '标题', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '测试工作项', + ], + 'description' => [ + 'title' => '工作项内容', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '测试内容', + ], + 'descriptionFormat' => [ + 'title' => '内容格式', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'RICHTEXT', + ], + 'assignedTo' => [ + 'title' => '工作项负责人的account id，或者企业中的用户名', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '19xxxx31947xxxx', + ], + 'space' => [ + 'title' => '项目id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'asd345xxxxx9q9845xxxxx34', + ], + 'spaceIdentifier' => [ + 'title' => '项目id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'asd345xxxxx9q9845xxxxx34', + ], + 'spaceType' => [ + 'title' => '资源类型', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'Project', + ], + 'category' => [ + 'title' => '工作项的类型id，比如：Bug、Task对应id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'Req', + ], + 'workitemType' => [ + 'title' => '工作项小类型id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '9uyxxxxxre573f561dxxn40', + ], + 'fieldValueList' => [ + 'title' => '自定义字段', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'fieldIdentifier' => [ + 'title' => '字段唯一标识', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '6aexxxxxa1d98c09c60xxxx16', + ], + 'value' => [ + 'title' => '字段值，写入时使用', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '77c7fb03c4186c8691d6...', + ], + 'workitemIdentifier' => [ + 'title' => '工作项的唯一标识', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'null', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'sprint' => [ + 'title' => '要关联迭代', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '81be62xxxxxb63e291bdcxxxxa4', + ], + 'required' => false, + ], + 'tracker' => [ + 'title' => '抄送人account id列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1561159309......', + ], + 'required' => false, + ], + 'participant' => [ + 'title' => '参与人account id列表，或者企业名称列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1561159309......', + ], + 'required' => false, + ], + 'verifier' => [ + 'title' => '验证者account id列表，或者企业名称列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1561159309......', + ], + 'required' => false, + ], + 'parent' => [ + 'title' => '所属父工作项的唯一标识', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '3a0c9cdd24ae1e1995b8...', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMsg' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => 'error', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'title' => 'true或者false', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'workitem' => [ + 'title' => '工作项信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'identifier' => [ + 'title' => '工作项唯一标识', + 'description' => '', + 'type' => 'string', + 'example' => 'e8bxxxxxxxxxxxxxxxx23', + ], + 'subject' => [ + 'title' => '工作项标题', + 'description' => '', + 'type' => 'string', + 'example' => '测试工作项', + ], + 'document' => [ + 'title' => '工作项内容', + 'description' => '', + 'type' => 'string', + 'example' => 'html格式', + ], + 'assignedTo' => [ + 'title' => '负责人', + 'description' => '', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'status' => [ + 'title' => '状态名称', + 'description' => '', + 'type' => 'string', + 'example' => '待处理', + ], + 'statusStageIdentifier' => [ + 'title' => '状态阶段id', + 'description' => '', + 'type' => 'string', + 'example' => '100005', + ], + 'spaceIdentifier' => [ + 'title' => '所属项目id', + 'description' => '', + 'type' => 'string', + 'example' => 'e8b26xxxxx6e76aa20xxxxx23', + ], + 'spaceName' => [ + 'title' => '所属项目名称', + 'description' => '', + 'type' => 'string', + 'example' => '需求项目', + ], + 'spaceType' => [ + 'title' => '项目类型', + 'description' => '', + 'type' => 'string', + 'example' => 'Project', + ], + 'logicalStatus' => [ + 'title' => '逻辑状态', + 'description' => '', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'categoryIdentifier' => [ + 'title' => '工作项的类型id', + 'description' => '', + 'type' => 'string', + 'example' => 'Req', + ], + 'parentIdentifier' => [ + 'title' => '父工作项id', + 'description' => '', + 'type' => 'string', + 'example' => 'e8bxxxxxxxxxxxxxxxx24', + ], + 'workitemTypeIdentifier' => [ + 'title' => '工作项类型id', + 'description' => '', + 'type' => 'string', + 'example' => '9uxxxxxxre573f5xxxxxx0', + ], + 'updateStatusAt' => [ + 'title' => '状态更新时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1640850328000', + ], + 'serialNumber' => [ + 'title' => '编号', + 'description' => '', + 'type' => 'string', + 'example' => 'ABCD-1', + ], + 'gmtCreate' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1640850318000', + ], + 'gmtModified' => [ + 'title' => '修改时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1640850318000', + ], + 'creator' => [ + 'title' => '创建人', + 'description' => '', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'modifier' => [ + 'title' => '修改人', + 'description' => '', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'statusIdentifier' => [ + 'title' => '状态唯一标识id', + 'description' => '', + 'type' => 'string', + 'example' => '28', + ], + 'sprintIdentifier' => [ + 'title' => '迭代的id', + 'description' => '', + 'type' => 'string', + 'example' => '75528f17703e92e5a568......', + ], + 'documentFormat' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"workitem\\": {\\n \\"identifier\\": \\"e8bxxxxxxxxxxxxxxxx23\\",\\n \\"subject\\": \\"测试工作项\\",\\n \\"document\\": \\"html格式\\",\\n \\"assignedTo\\": \\"19xx7043xxxxxxx914\\",\\n \\"status\\": \\"待处理\\",\\n \\"statusStageIdentifier\\": \\"100005\\",\\n \\"spaceIdentifier\\": \\"e8b26xxxxx6e76aa20xxxxx23\\",\\n \\"spaceName\\": \\"需求项目\\",\\n \\"spaceType\\": \\"Project\\",\\n \\"logicalStatus\\": \\"NORMAL\\",\\n \\"categoryIdentifier\\": \\"Req\\",\\n \\"parentIdentifier\\": \\"e8bxxxxxxxxxxxxxxxx24\\",\\n \\"workitemTypeIdentifier\\": \\"9uxxxxxxre573f5xxxxxx0\\",\\n \\"updateStatusAt\\": 1640850328000,\\n \\"serialNumber\\": \\"ABCD-1\\",\\n \\"gmtCreate\\": 1640850318000,\\n \\"gmtModified\\": 1640850318000,\\n \\"creator\\": \\"19xx7043xxxxxxx914\\",\\n \\"modifier\\": \\"19xx7043xxxxxxx914\\",\\n \\"statusIdentifier\\": \\"28\\",\\n \\"sprintIdentifier\\": \\"75528f17703e92e5a568......\\",\\n \\"documentFormat\\": \\"RICHTEXT\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + ], + 'CreateWorkitemComment' => [ + 'summary' => '创建一个评论', + 'path' => '/organization/{organizationId}/workitems/comment', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '60811b5eed6e867404f6xxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'content' => [ + 'title' => '评论内容', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + 'workitemIdentifier' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1e9903d8b3f12xxxxxf9286ef5', + ], + 'formatType' => [ + 'title' => '目前支持RICHTEXT/MARKDOWN 二选一', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'RICHTEXT/MARKDOWN', + ], + 'parentId' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '26842', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMsg' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'error', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'success' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Comment' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '唯一标识', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '26842', + ], + 'content' => [ + 'title' => '内容', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'user' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'account' => [ + 'description' => '', + 'type' => 'string', + 'example' => '13164xxxxx41068', + ], + 'identifier' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1e9903d8bxxxxxxe9df9286ef5', + ], + 'realName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'nickName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'avatar' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://xxxxx/thumbnail/112m7150e256dbba0d6456bafbb65c81f90d/w/200/h/200', + ], + 'displayName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'targetType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'workitem', + ], + ], + ], + 'targetType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'workitem', + ], + 'targetIdentifier' => [ + 'description' => '', + 'type' => 'string', + 'example' => '79d523806bdxxxxx95612a5154', + ], + 'parentId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '26842', + ], + 'createTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1667202662000', + ], + 'modifiedTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1637995553000', + ], + 'isTop' => [ + 'title' => '是否置顶', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true/false', + ], + 'topTime' => [ + 'title' => '置顶时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1667202662000', + ], + 'formatType' => [ + 'title' => '评论类型', + 'description' => '', + 'type' => 'string', + 'example' => 'RICHTEXT/MARKDOWN ', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"success\\",\\n \\"success\\": \\"true 接口调用成功，false 接口调用失败\\",\\n \\"Comment\\": {\\n \\"Id\\": 26842,\\n \\"content\\": \\"有关于黑龙江地区旅店业室内广告屏出租\\",\\n \\"user\\": {\\n \\"account\\": \\"13164xxxxx41068\\",\\n \\"identifier\\": \\"1e9903d8bxxxxxxe9df9286ef5\\",\\n \\"realName\\": \\"王五\\",\\n \\"nickName\\": \\"王五\\",\\n \\"avatar\\": \\"https://xxxxx/thumbnail/112m7150e256dbba0d6456bafbb65c81f90d/w/200/h/200\\",\\n \\"displayName\\": \\"王五\\",\\n \\"targetType\\": \\"workitem\\"\\n },\\n \\"targetType\\": \\"workitem\\",\\n \\"targetIdentifier\\": \\"79d523806bdxxxxx95612a5154\\",\\n \\"parentId\\": 26842,\\n \\"createTime\\": 1667202662000,\\n \\"modifiedTime\\": 1637995553000,\\n \\"isTop\\": true,\\n \\"topTime\\": 1667202662000,\\n \\"formatType\\": \\"RICHTEXT/MARKDOWN \\"\\n }\\n}","type":"json"}]', + ], + 'DeleteWorkitemComment' => [ + 'summary' => '删除单条评论', + 'path' => '/organization/{organizationId}/workitems/deleteComent', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'identifier' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'e8b2xxxxxx2abdxxxxxxxx23', + ], + 'commentId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '12xx34', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMsg' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'error', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'success' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'true', + ], + 'deleteFlag' => [ + 'title' => '是否删除成功', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true/false', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"success\\",\\n \\"success\\": \\"true\\",\\n \\"deleteFlag\\": true\\n}","type":"json"}]', + ], + 'DeleteWorkitemAllComment' => [ + 'summary' => '删除所有评论', + 'path' => '/organization/{organizationId}/workitems/deleteAllComment', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'identifier', + 'in' => 'query', + 'schema' => [ + 'title' => '工作项id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'deafe5f33xxxxx6a259d8dafd', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'A7586FEB-E48D-5579-983F-74981FBFF627', + ], + 'errorMsg' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'error', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'success' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'true', + ], + 'deleteFlag' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true/false', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A7586FEB-E48D-5579-983F-74981FBFF627\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"success\\",\\n \\"success\\": \\"true\\",\\n \\"deleteFlag\\": true\\n}","type":"json"}]', + ], + 'UpdateWorkitemComment' => [ + 'summary' => '更新工作项评论', + 'path' => '/organization/{organizationId}/workitems/commentUpdate', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'content' => [ + 'title' => '工作项内容', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + 'formatType' => [ + 'title' => '内容格式 目前支持MARKDOWN/RICHTEXT', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'MARKDOWN/RICHTEXT', + ], + 'workitemIdentifier' => [ + 'title' => '工作项id'."\n", + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '9144ef6b72d8exxxxx9e61a4d0', + ], + 'commentId' => [ + 'title' => '工作项id'."\n", + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1964584', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9', + ], + 'errorMsg' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'error', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'InvalidParam.NotFound', + ], + 'success' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'true', + ], + 'comment' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '评论唯一id'."\n", + 'description' => '', + 'type' => 'string', + 'example' => '1964584', + ], + 'content' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'targetType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'workitem', + ], + 'targetIdentifier' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'deafe5f33xxxxx6a259d8dafd', + ], + 'parentId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2684432', + ], + 'createTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1667205617061', + ], + 'modifiedTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1646323200000', + ], + 'isTop' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true/false', + ], + 'topTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1667205617089', + ], + 'formatType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'MARKDOWN/RICHTEXT', + ], + 'user' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'account' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1316458xxxxx41068', + ], + 'identifier' => [ + 'description' => '', + 'type' => 'string', + 'example' => '9144ef6b72d8exxxxx9e61a4d0', + ], + 'realName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'nickName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'avatar' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112m7150e256dbba0d6456bafbb65c81f90d/w/200/h/200', + ], + 'displayName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F7B85D1B-D1C2-140F-A039-341859F130B9\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"InvalidParam.NotFound\\",\\n \\"success\\": \\"true\\",\\n \\"comment\\": {\\n \\"id\\": \\"1964584\\",\\n \\"content\\": \\"这是更新后的评论内容\\",\\n \\"targetType\\": \\"workitem\\",\\n \\"targetIdentifier\\": \\"deafe5f33xxxxx6a259d8dafd\\",\\n \\"parentId\\": 2684432,\\n \\"createTime\\": 1667205617061,\\n \\"modifiedTime\\": 1646323200000,\\n \\"isTop\\": true,\\n \\"topTime\\": 1667205617089,\\n \\"formatType\\": \\"MARKDOWN/RICHTEXT\\",\\n \\"user\\": {\\n \\"account\\": \\"1316458xxxxx41068\\",\\n \\"identifier\\": \\"9144ef6b72d8exxxxx9e61a4d0\\",\\n \\"realName\\": \\"王五\\",\\n \\"nickName\\": \\"王五\\",\\n \\"avatar\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112m7150e256dbba0d6456bafbb65c81f90d/w/200/h/200\\",\\n \\"displayName\\": \\"王五\\"\\n }\\n }\\n}","type":"json"}]', + ], + 'UpdateWorkItem' => [ + 'summary' => '更新工作项信息', + 'path' => '/organization/{organizationId}/workitems/update', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => '更新的信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'propertyKey' => [ + 'title' => '更新的字段名', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'subject', + ], + 'propertyValue' => [ + 'title' => '更新后的值', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'newValue', + ], + 'identifier' => [ + 'title' => '工作项唯一标识id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'e8b2xxxxxx2abdxxxxxxxx23', + ], + 'fieldType' => [ + 'title' => '更新字段的类型，标题：subject/自定义字段：customField/状态：status/描述：document/基本字段：basic(包括负责人、迭代、参与人等)', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'subject', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '工作项请求结果', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => 'error', + ], + 'success' => [ + 'title' => 'true或者false', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'workitem' => [ + 'title' => '工作项信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'identifier' => [ + 'title' => '工作项唯一标识', + 'description' => '', + 'type' => 'string', + 'example' => 'e8bxxxxxxxxxxxxxxxx23', + ], + 'subject' => [ + 'title' => '工作项标题', + 'description' => '', + 'type' => 'string', + 'example' => '测试工作项', + ], + 'document' => [ + 'title' => '工作项内容', + 'description' => '', + 'type' => 'string', + 'example' => 'html格式', + ], + 'documentFormat' => [ + 'type' => 'string', + ], + 'assignedTo' => [ + 'title' => '负责人', + 'description' => '', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'status' => [ + 'title' => '状态名称', + 'description' => '', + 'type' => 'string', + 'example' => '待处理', + ], + 'statusStageIdentifier' => [ + 'title' => '状态阶段id', + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'spaceIdentifier' => [ + 'title' => '所属项目id', + 'description' => '', + 'type' => 'string', + 'example' => 'e8b26xxxxx6e76aa20xxxxx23', + ], + 'spaceName' => [ + 'title' => '所属项目名称', + 'description' => '', + 'type' => 'string', + 'example' => '需求项目', + ], + 'spaceType' => [ + 'title' => '项目类型', + 'description' => '', + 'type' => 'string', + 'example' => 'Project', + ], + 'logicalStatus' => [ + 'title' => '逻辑状态', + 'description' => '', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'categoryIdentifier' => [ + 'title' => '工作项的类型id', + 'description' => '', + 'type' => 'string', + 'example' => 'Req', + ], + 'parentIdentifier' => [ + 'title' => '父工作项id', + 'description' => '', + 'type' => 'string', + 'example' => 'e8bxxxxxxxxxxxxxxxx24', + ], + 'workitemTypeIdentifier' => [ + 'title' => '工作项类型id', + 'description' => '', + 'type' => 'string', + 'example' => '9uxxxxxxre573f5xxxxxx0', + ], + 'updateStatusAt' => [ + 'title' => '状态更新时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1640850328000', + ], + 'serialNumber' => [ + 'title' => '编号', + 'description' => '', + 'type' => 'string', + 'example' => 'ACFS-1', + ], + 'gmtCreate' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1640850318000', + ], + 'gmtModified' => [ + 'title' => '修改时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1640850318000', + ], + 'creator' => [ + 'title' => '创建人', + 'description' => '', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'modifier' => [ + 'title' => '修改人', + 'description' => '', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'statusIdentifier' => [ + 'title' => '状态id', + 'description' => '', + 'type' => 'string', + 'example' => '111000', + ], + 'sprintIdentifier' => [ + 'title' => '迭代id', + 'description' => '', + 'type' => 'string', + 'example' => '75528f17703e92e5a568......', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"errorMessage\\": \\"error\\",\\n \\"success\\": true,\\n \\"workitem\\": {\\n \\"identifier\\": \\"e8bxxxxxxxxxxxxxxxx23\\",\\n \\"subject\\": \\"测试工作项\\",\\n \\"document\\": \\"html格式\\",\\n \\"documentFormat\\": \\"RICHTEXT\\",\\n \\"assignedTo\\": \\"19xx7043xxxxxxx914\\",\\n \\"status\\": \\"待处理\\",\\n \\"statusStageIdentifier\\": \\"1\\",\\n \\"spaceIdentifier\\": \\"e8b26xxxxx6e76aa20xxxxx23\\",\\n \\"spaceName\\": \\"需求项目\\",\\n \\"spaceType\\": \\"Project\\",\\n \\"logicalStatus\\": \\"NORMAL\\",\\n \\"categoryIdentifier\\": \\"Req\\",\\n \\"parentIdentifier\\": \\"e8bxxxxxxxxxxxxxxxx24\\",\\n \\"workitemTypeIdentifier\\": \\"9uxxxxxxre573f5xxxxxx0\\",\\n \\"updateStatusAt\\": 1640850328000,\\n \\"serialNumber\\": \\"ACFS-1\\",\\n \\"gmtCreate\\": 1640850318000,\\n \\"gmtModified\\": 1640850318000,\\n \\"creator\\": \\"19xx7043xxxxxxx914\\",\\n \\"modifier\\": \\"19xx7043xxxxxxx914\\",\\n \\"statusIdentifier\\": \\"111000\\",\\n \\"sprintIdentifier\\": \\"75528f17703e92e5a568......\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<UpdateWorkItemResponse>\\n <success>true</success>\\n <errorMessage/>\\n <errorCode/>\\n <workitem>\\n <identifier>6fc04b35d8cb62128b55......</identifier>\\n <statusStageIdentifier>1</statusStageIdentifier>\\n <gmtModified>1645078744000</gmtModified>\\n <creator>1967043931......</creator>\\n <serialNumber>AVDC-2</serialNumber>\\n <spaceType>Project</spaceType>\\n <subject>testSubject</subject>\\n <document><p style=\\"text-align: left;text-indent: 0;margin-left: 0;\\"><span></span></p></document>\\n <modifier>1967043931......</modifier>\\n <spaceIdentifier>8fb83debd69a6c7c6626......</spaceIdentifier>\\n <workitemTypeIdentifier>9uy29901re573f561d......</workitemTypeIdentifier>\\n <categoryIdentifier>Req</categoryIdentifier>\\n <gmtCreate>1644572109000</gmtCreate>\\n <assignedTo>1967043931......</assignedTo>\\n <spaceName>111122222233</spaceName>\\n <logicalStatus>NORMAL</logicalStatus>\\n <statusIdentifier>100005</statusIdentifier>\\n <status>待处理</status>\\n <sprintIdentifier>75528f17703e92e5a568......</sprintIdentifier>\\n </workitem>\\n</UpdateWorkItemResponse>","errorExample":""}]', + ], + 'GetWorkitemAttachmentCreatemeta' => [ + 'summary' => '获取附件上传的元信息', + 'path' => '/organization/{organizationId}/workitem/{workitemIdentifier}/attachment/createmeta', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'workitemIdentifier', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '11234455454355', + ], + ], + [ + 'name' => 'fileName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'application.jar', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Invalid.IdNotFound', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Forbidden.UserNotInCurrentOrganization', + ], + 'success' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'true', + ], + 'uploadInfo' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'accessid' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxxxxx', + ], + 'policy' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxxxxx', + ], + 'signature' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xdWcrl/yTmIUA0kE7a3B0Ox4Vu8=', + ], + 'dir' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ddd/dddd', + ], + 'host' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxxx', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorCode\\": \\"Invalid.IdNotFound\\",\\n \\"errorMessage\\": \\"Forbidden.UserNotInCurrentOrganization\\",\\n \\"success\\": \\"true\\",\\n \\"uploadInfo\\": {\\n \\"accessid\\": \\"xxxxxxx\\",\\n \\"policy\\": \\"xxxxxxx\\",\\n \\"signature\\": \\"xdWcrl/yTmIUA0kE7a3B0Ox4Vu8=\\",\\n \\"dir\\": \\"ddd/dddd\\",\\n \\"host\\": \\"xxxxx\\"\\n }\\n}","type":"json"}]', + ], + 'GetWorkitemTimeTypeList' => [ + 'summary' => '获得一个企业下所有工时类型', + 'path' => '/organization/{organizationId}/workitems/type/list', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'HC93CE1A-8D7A-13A9-8306-7465DE2E5C0F', + ], + 'errorMsg' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'error', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Invalid.IdNotFound', + ], + 'success' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'true', + ], + 'timeType' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'identifier' => [ + 'description' => '', + 'type' => 'string', + 'example' => '67fb001005aac8d3d2a3372416', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + ], + 'displayName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'deploy', + ], + 'description' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'position' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"HC93CE1A-8D7A-13A9-8306-7465DE2E5C0F\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"Invalid.IdNotFound\\",\\n \\"success\\": \\"true\\",\\n \\"timeType\\": [\\n {\\n \\"identifier\\": \\"67fb001005aac8d3d2a3372416\\",\\n \\"name\\": \\"\\",\\n \\"displayName\\": \\"deploy\\",\\n \\"description\\": \\"描述文案\\",\\n \\"position\\": 1\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetWorkitemRelations' => [ + 'summary' => '获得一个工作项的指定关联项', + 'path' => '/organization/{organizationId}/workitems/{workitemId}/getRelations', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业id'."\n", + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'workitemId', + 'in' => 'path', + 'schema' => [ + 'title' => '工作项id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '8876ad01xxxxx65d9710b2631', + ], + ], + [ + 'name' => 'relationType', + 'in' => 'query', + 'schema' => [ + 'title' => '一共有BLOCKING，BLOCKED，ASSOCIATED， DUPLICATED，SUB， PARENT，一共6个待选值，只会获得工作项类型的关系项', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'SUB' => 'SUB', + 'PARENT' => 'PARENT', + 'BLOCKED' => 'BLOCKED', + 'DUPLICATED' => 'DUPLICATED', + 'BLOCKING' => 'BLOCKING', + 'ASSOCIATED' => 'ASSOCIATED', + ], + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMsg' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'error', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'InvalidGroup.IdNotFound', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'relationList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'identifier' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'deafe5f33xxxxx6a259d8dafd', + ], + 'subject' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'assignedTo' => [ + 'description' => '', + 'type' => 'string', + 'example' => ' aliyun_1384605', + ], + 'spaceIdentifier' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2b856dxxxxxxb61d93676255ba', + ], + 'categoryIdentifier' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Req', + ], + 'workitemTypeIdentifier' => [ + 'description' => '', + 'type' => 'string', + 'example' => '9uy29901re573f561d69jn40', + ], + 'gmtCreate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1667205617061', + ], + 'gmtModified' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1667205617089', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"InvalidGroup.IdNotFound\\",\\n \\"success\\": true,\\n \\"relationList\\": [\\n {\\n \\"identifier\\": \\"deafe5f33xxxxx6a259d8dafd\\",\\n \\"subject\\": \\"标题内容\\",\\n \\"assignedTo\\": \\" aliyun_1384605\\",\\n \\"spaceIdentifier\\": \\"2b856dxxxxxxb61d93676255ba\\",\\n \\"categoryIdentifier\\": \\"Req\\",\\n \\"workitemTypeIdentifier\\": \\"9uy29901re573f561d69jn40\\",\\n \\"gmtCreate\\": \\"1667205617061\\",\\n \\"gmtModified\\": \\"1667205617089\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetWorkitemCommentList' => [ + 'summary' => '获得所有评论', + 'path' => '/organization/{organizationId}/workitems/{workitemId}/commentList', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业号', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'workitemId', + 'in' => 'path', + 'schema' => [ + 'title' => '工作项id'."\n", + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ce2xxxx21580baxxxx633f13', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMsg' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'error', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'commentList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6573', + ], + 'content' => [ + 'description' => '', + 'type' => 'string', + 'example' => '066961', + ], + 'targetType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'workitem', + ], + 'targetIdentifier' => [ + 'description' => '', + 'type' => 'string', + 'example' => '9144ef6b72d8exxxxx9e61a4d0', + ], + 'parentId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1013131897677566', + ], + 'createTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1667205617061', + ], + 'modifiedTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1646323200000', + ], + 'isTop' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true/false', + ], + 'topTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1667205617089', + ], + 'formatType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'RICHTEXT/MARKDOWN', + ], + 'user' => [ + 'type' => 'object', + 'properties' => [ + 'account' => [ + 'type' => 'string', + ], + 'identifier' => [ + 'type' => 'string', + ], + 'realName' => [ + 'type' => 'string', + ], + 'nickName' => [ + 'type' => 'string', + ], + 'avatar' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": \\"true 接口调用成功，false 接口调用失败\\",\\n \\"commentList\\": [\\n {\\n \\"id\\": 6573,\\n \\"content\\": \\"066961\\",\\n \\"targetType\\": \\"workitem\\",\\n \\"targetIdentifier\\": \\"9144ef6b72d8exxxxx9e61a4d0\\",\\n \\"parentId\\": 1013131897677566,\\n \\"createTime\\": 1667205617061,\\n \\"modifiedTime\\": 1646323200000,\\n \\"isTop\\": true,\\n \\"topTime\\": 1667205617089,\\n \\"formatType\\": \\"RICHTEXT/MARKDOWN\\",\\n \\"user\\": {\\n \\"account\\": \\"null\\",\\n \\"identifier\\": \\"123xxxxxxx222\\",\\n \\"realName\\": \\"张三\\",\\n \\"nickName\\": \\"李四\\",\\n \\"avatar\\": \\"null\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + ], + 'CreateWorkitemEstimate' => [ + 'summary' => '登记预计工时', + 'path' => '/organization/{organizationId}/workitems/estimate', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'workitemIdentifier' => [ + 'title' => '工作项id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1e9903d8b3f1xxxxxf9286ef5', + ], + 'spentTime' => [ + 'title' => '花费工时，最大为9999', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '21', + ], + 'type' => [ + 'title' => '类型', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '9144ef6b72d8exxxxx9e61a4d0'."\n", + ], + 'description' => [ + 'title' => '描述', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'recordUserIdentifier' => [ + 'title' => '登记人,为用户的aliyunPk', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1316458xxxxx41068', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMsg' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'error', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => '', + ], + 'WorkitemTimeEstimate' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'identifier' => [ + 'title' => '工时唯一标识', + 'description' => '', + 'type' => 'string', + 'example' => 'deafe5f33xxxxx6a259d8dafd', + ], + 'workitemIdentifier' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1e9903d8b3f1xxxxxf9286ef5', + ], + 'spentTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11', + ], + 'type' => [ + 'description' => '', + 'type' => 'string', + 'example' => '9144ef6b72d8exxxxx9e61a4d0', + ], + 'description' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'recordUser' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'account' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => '1316458xxxxx41068', + ], + 'identifier' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'deafe5f33xxxxx6a259d8dafd', + ], + 'realName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'nickName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'avatar' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112m7150e256dbba0d6456bafbb65c81f90d/w/200/h/200', + ], + 'stamp' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'nameEn' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'wangwu', + ], + 'gender' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'mobile' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'email' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'nickNamePinyin' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'wangwu', + ], + 'realNamePinyin' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'wangwu', + ], + 'displayNickName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'wangwu', + ], + 'displayRealName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'wangwu', + ], + 'displayName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'dingTalkId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'fdsad12xxx11'."\n", + ], + 'tbRoleId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '9144ef6b72d8exxxxx9e61a4d0', + ], + 'isDisabled' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true/false', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"WorkitemTimeEstimate\\": {\\n \\"identifier\\": \\"deafe5f33xxxxx6a259d8dafd\\",\\n \\"workitemIdentifier\\": \\"1e9903d8b3f1xxxxxf9286ef5\\",\\n \\"spentTime\\": 11,\\n \\"type\\": \\"9144ef6b72d8exxxxx9e61a4d0\\",\\n \\"description\\": \\"蜜雪冰城甜蜜蜜\\",\\n \\"recordUser\\": {\\n \\"account\\": \\"1316458xxxxx41068\\",\\n \\"identifier\\": \\"deafe5f33xxxxx6a259d8dafd\\",\\n \\"realName\\": \\"王五\\",\\n \\"nickName\\": \\"王五\\",\\n \\"avatar\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112m7150e256dbba0d6456bafbb65c81f90d/w/200/h/200\\",\\n \\"stamp\\": \\"null 代表普通用户\\",\\n \\"nameEn\\": \\"wangwu\\",\\n \\"gender\\": \\"保留字段\\",\\n \\"mobile\\": \\"无效字段，保留\\",\\n \\"email\\": \\"[email protected]\\",\\n \\"nickNamePinyin\\": \\"wangwu\\",\\n \\"realNamePinyin\\": \\"wangwu\\",\\n \\"displayNickName\\": \\"wangwu\\",\\n \\"displayRealName\\": \\"wangwu\\",\\n \\"displayName\\": \\"王五\\",\\n \\"dingTalkId\\": \\"fdsad12xxx11\\\\n\\",\\n \\"tbRoleId\\": \\"9144ef6b72d8exxxxx9e61a4d0\\",\\n \\"isDisabled\\": true\\n }\\n }\\n}","type":"json"}]', + ], + 'GetCustomFieldOption' => [ + 'summary' => '获取自定义字段的选项值', + 'path' => '/organization/{organizationId}/fields/{fieldId}/getCustomOption', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'spaceIdentifier', + 'in' => 'query', + 'schema' => [ + 'title' => '项目id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'e8bxxxxxxxxxxxxxxxx23', + ], + ], + [ + 'name' => 'spaceType', + 'in' => 'query', + 'schema' => [ + 'title' => '类型', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'Project', + ], + ], + [ + 'name' => 'workitemTypeIdentifier', + 'in' => 'query', + 'schema' => [ + 'title' => '工作项类型id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '9uyxxxx1re573f561dxxxxx', + ], + ], + [ + 'name' => 'fieldId', + 'in' => 'path', + 'schema' => [ + 'title' => '字段id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1019xxxxx5f5c33xxxxx9920d44', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMsg' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => 'error', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'title' => 'true或者false', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'fileds' => [ + 'title' => '字段值信息', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'displayValue' => [ + 'title' => '展示的值', + 'description' => '', + 'type' => 'string', + 'example' => '223', + ], + 'fieldIdentifier' => [ + 'title' => '字段唯一标识', + 'description' => '', + 'type' => 'string', + 'example' => 'e8bxxxxxxxxxxxxxxxx23', + ], + 'identifier' => [ + 'title' => '迭代唯一标识符', + 'description' => '', + 'type' => 'string', + 'example' => '3345', + ], + 'level' => [ + 'title' => '展示级别，数字范围1~9，数字越大，颜色越浅', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'position' => [ + 'title' => '待选值顺序', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'value' => [ + 'title' => '字段中文名称', + 'description' => '', + 'type' => 'string', + 'example' => '223', + ], + 'valueEn' => [ + 'title' => '字段英文名称', + 'description' => '', + 'type' => 'string', + 'example' => '223', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"fileds\\": [\\n {\\n \\"displayValue\\": \\"223\\",\\n \\"fieldIdentifier\\": \\"e8bxxxxxxxxxxxxxxxx23\\",\\n \\"identifier\\": \\"3345\\",\\n \\"level\\": 1,\\n \\"position\\": 1,\\n \\"value\\": \\"223\\",\\n \\"valueEn\\": \\"223\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<GetCustomFieldOptionResponse>\\n <fileds>\\n <displayValue>紧急</displayValue>\\n <identifier>ec6b0daec1334292f636......</identifier>\\n <fieldIdentifier>priority</fieldIdentifier>\\n <valueEn>Urgent</valueEn>\\n <level>0</level>\\n <position>1</position>\\n <value>紧急</value>\\n </fileds>\\n <fileds>\\n <displayValue>高</displayValue>\\n <identifier>0ff8f91ced4ee913da7......</identifier>\\n <fieldIdentifier>priority</fieldIdentifier>\\n <valueEn>High</valueEn>\\n <level>1</level>\\n <position>2</position>\\n <value>高</value>\\n </fileds>\\n <fileds>\\n <displayValue>中</displayValue>\\n <identifier>77c7fb03c4186c8691d6......</identifier>\\n <fieldIdentifier>priority</fieldIdentifier>\\n <valueEn>Medium</valueEn>\\n <level>4</level>\\n <position>3</position>\\n <value>中</value>\\n </fileds>\\n <fileds>\\n <displayValue>低</displayValue>\\n <identifier>39a7dc21e2552dff2304......</identifier>\\n <fieldIdentifier>priority</fieldIdentifier>\\n <valueEn>Low</valueEn>\\n <level>9</level>\\n <position>4</position>\\n <value>低</value>\\n </fileds>\\n <requestId>76FE0461-3F2C-53D4-9833-96CA49......</requestId>\\n <success>true</success>\\n <errorCode/>\\n <errorMsg/>\\n</GetCustomFieldOptionResponse>","errorExample":""}]', + ], + 'GetWorkItemActivity' => [ + 'summary' => '获取工作项动态', + 'path' => '/organization/{organizationId}/workitems/{workitemId}/getActivity', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'workitemId', + 'in' => 'path', + 'schema' => [ + 'title' => '工作项id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'e8bxxxxxxxxxxxxxxxx23', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMsg' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => 'error', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'title' => 'true或者false', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'activities' => [ + 'title' => '动态信息', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'eventType' => [ + 'title' => '事件类型', + 'description' => '', + 'type' => 'string', + 'example' => 'workitem.updated', + ], + 'actionType' => [ + 'title' => '动作类型', + 'description' => '', + 'type' => 'string', + 'example' => 'update', + ], + 'eventTime' => [ + 'title' => '事件时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1640867079624', + ], + 'resourceIdentifier' => [ + 'title' => '操作对象', + 'description' => '', + 'type' => 'string', + 'example' => 'e8bxxxxxxxxxxxxxxxx23', + ], + 'operator' => [ + 'title' => '操作者', + 'description' => '', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'eventId' => [ + 'title' => '事件id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3201131', + ], + 'parentEventId' => [ + 'title' => '父事件id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3201132', + ], + 'property' => [ + 'title' => '修改属性', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'propertyName' => [ + 'title' => '属性key', + 'description' => '', + 'type' => 'string', + 'example' => 'subject', + ], + 'propertyType' => [ + 'title' => '类型', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'propertyIdentifier' => [ + 'title' => '资源id', + 'description' => '', + 'type' => 'string', + 'example' => 'subject', + ], + 'displayName' => [ + 'title' => '属性的展示名', + 'description' => '', + 'type' => 'string', + 'example' => '标题', + ], + ], + 'example' => 'public', + ], + 'oldValue' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'resourceType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Sprint', + ], + 'plainValue' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'bed1cca179badeb501a72d1194', + ], + 'displayValue' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Sprint-221124', + ], + ], + ], + ], + 'newValue' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'resourceType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Sprint', + ], + 'plainValue' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'bed1cca179badeb501a72d1194', + ], + 'displayValue' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Sprint-221124', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"activities\\": [\\n {\\n \\"eventType\\": \\"workitem.updated\\",\\n \\"actionType\\": \\"update\\",\\n \\"eventTime\\": 1640867079624,\\n \\"resourceIdentifier\\": \\"e8bxxxxxxxxxxxxxxxx23\\",\\n \\"operator\\": \\"19xx7043xxxxxxx914\\",\\n \\"eventId\\": 3201131,\\n \\"parentEventId\\": 3201132,\\n \\"property\\": {\\n \\"propertyName\\": \\"subject\\",\\n \\"propertyType\\": \\"null\\",\\n \\"propertyIdentifier\\": \\"subject\\",\\n \\"displayName\\": \\"标题\\"\\n },\\n \\"oldValue\\": [\\n {\\n \\"resourceType\\": \\"Sprint\\",\\n \\"plainValue\\": \\"bed1cca179badeb501a72d1194\\",\\n \\"displayValue\\": \\"Sprint-221124\\"\\n }\\n ],\\n \\"newValue\\": [\\n {\\n \\"resourceType\\": \\"Sprint\\",\\n \\"plainValue\\": \\"bed1cca179badeb501a72d1194\\",\\n \\"displayValue\\": \\"Sprint-221124\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<GetWorkItemActivityResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMsg>error</errorMsg>\\n <errorCode>Openapi.RequestError</errorCode>\\n <success>true</success>\\n <activities>\\n <eventType>workitem.updated</eventType>\\n <actionType>update</actionType>\\n <eventTime>1640867079624</eventTime>\\n <resourceIdentifier>e8bxxxxxxxxxxxxxxxx23</resourceIdentifier>\\n <operator>19xx7043xxxxxxx914</operator>\\n <eventId>3201131</eventId>\\n <parentEventId>3201132</parentEventId>\\n <property>\\n <propertyName>subject</propertyName>\\n <propertyType>null</propertyType>\\n <propertyIdentifier>subject</propertyIdentifier>\\n <displayName>标题</displayName>\\n </property>\\n </activities>\\n</GetWorkItemActivityResponse>","errorExample":""}]', + ], + 'GetWorkItemInfo' => [ + 'summary' => '根据id获取工作项详情', + 'path' => '/organization/{organizationId}/workitems/{workitemId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '118506', + 'abilityTreeNodes' => [ + 'FEATURErdcY249FB', + ], + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5e706xxxxxx01xxx96', + ], + ], + [ + 'name' => 'workitemId', + 'in' => 'path', + 'schema' => [ + 'title' => '工作项id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ce2xxxx21580baxxxx633f13', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '工作项请求结果', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => 'error', + ], + 'success' => [ + 'title' => 'true或者false', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'workitem' => [ + 'title' => '工作项信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'identifier' => [ + 'title' => '工作项唯一标识', + 'description' => '', + 'type' => 'string', + 'example' => 'e8bxxxxxxxxxxxxxxxx23', + ], + 'subject' => [ + 'title' => '工作项标题', + 'description' => '', + 'type' => 'string', + 'example' => '测试工作项', + ], + 'document' => [ + 'title' => '工作项内容', + 'description' => '', + 'type' => 'string', + 'example' => 'html格式', + ], + 'documentFormat' => [ + 'type' => 'string', + ], + 'assignedTo' => [ + 'title' => '负责人', + 'description' => '', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'status' => [ + 'title' => '状态名称', + 'description' => '', + 'type' => 'string', + 'example' => '待处理', + ], + 'statusStageIdentifier' => [ + 'title' => '状态阶段id', + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'spaceIdentifier' => [ + 'title' => '所属项目id', + 'description' => '', + 'type' => 'string', + 'example' => 'e8b26xxxxx6e76aa20xxxxx23', + ], + 'spaceName' => [ + 'title' => '所属项目名称', + 'description' => '', + 'type' => 'string', + 'example' => '需求项目', + ], + 'spaceType' => [ + 'title' => '项目类型', + 'description' => '', + 'type' => 'string', + 'example' => 'Project', + ], + 'logicalStatus' => [ + 'title' => '逻辑状态', + 'description' => '', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'categoryIdentifier' => [ + 'title' => '工作项的类型id', + 'description' => '', + 'type' => 'string', + 'example' => 'Req', + ], + 'parentIdentifier' => [ + 'title' => '父工作项id', + 'description' => '', + 'type' => 'string', + 'example' => 'e8bxxxxxxxxxxxxxxxx24', + ], + 'workitemTypeIdentifier' => [ + 'title' => '工作项类型id', + 'description' => '', + 'type' => 'string', + 'example' => '9uxxxxxxre573f5xxxxxx0', + ], + 'updateStatusAt' => [ + 'title' => '状态更新时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1640850328000', + ], + 'serialNumber' => [ + 'title' => '编号', + 'description' => '', + 'type' => 'string', + 'example' => 'ABCD-1', + ], + 'gmtCreate' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1640850318000', + ], + 'gmtModified' => [ + 'title' => '修改时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1640850318000', + ], + 'creator' => [ + 'title' => '创建人', + 'description' => '', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'modifier' => [ + 'title' => '修改人', + 'description' => '', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'statusIdentifier' => [ + 'title' => '状态id', + 'description' => '', + 'type' => 'string', + 'example' => '例：100005', + ], + 'sprint' => [ + 'title' => '关联的迭代id', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '81be626abf9b63e291bd......', + ], + ], + 'tag' => [ + 'title' => '标签id列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'c76e0e4bf64801cfad73......', + ], + ], + 'participant' => [ + 'title' => '参与人account id列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1561159309......', + ], + ], + 'tracker' => [ + 'title' => '抄送人的account id列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1561159309......', + ], + ], + 'verifier' => [ + 'title' => '验证者的account id列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1561159309......', + ], + ], + 'customFields' => [ + 'title' => '自定义字段列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'fieldIdentifier' => [ + 'title' => '字段的唯一标识', + 'description' => '', + 'type' => 'string', + 'example' => '例：80', + ], + 'fieldFormat' => [ + 'title' => '字段格式，便于查询数据', + 'description' => '', + 'type' => 'string', + 'example' => '例：input', + ], + 'fieldClassName' => [ + 'title' => '字段的className，便于数据查询', + 'description' => '', + 'type' => 'string', + 'example' => '例如：date', + ], + 'objectValue' => [ + 'title' => '值对象列表', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'value' => [ + 'title' => '字段值，写入时使用', + 'description' => '', + 'type' => 'string', + 'example' => '例：2022-01-06 00:00:00', + ], + 'workitemIdentifier' => [ + 'title' => '工作项的唯一标识', + 'description' => '', + 'type' => 'string', + 'example' => '5daa9a15c7fd55523996......', + ], + 'position' => [ + 'title' => '自定义字段值的position', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'level' => [ + 'title' => '展示级别，数字范围1~9，数字越大，颜色越浅。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'valueList' => [ + 'title' => '值对象列表，查询时使用', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'value' => [ + 'title' => '字段值', + 'description' => '', + 'type' => 'string', + 'example' => '2022-02-01 00:00:00', + ], + 'valueEn' => [ + 'title' => '字段英文值，目前只有列表类有英文值', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'displayValue' => [ + 'title' => '根据语言环境获取当前展示的值', + 'description' => '', + 'type' => 'string', + 'example' => '2022-02-01 00:00:00', + ], + 'identifier' => [ + 'title' => '字段值为对象类型时，值所对应的对象的唯一标识 例如：option表中的id', + 'description' => '', + 'type' => 'string', + 'example' => '2022-02-01 00:00:00', + ], + 'level' => [ + 'title' => '展示级别，数字范围1~9，数字越大，颜色越浅。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'finishTime' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'tagDetails' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'identifier' => [ + 'type' => 'string', + ], + 'name' => [ + 'type' => 'string', + ], + 'color' => [ + 'type' => 'string', + ], + ], + ], + ], + 'versions' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'identifier' => [ + 'type' => 'string', + ], + 'name' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"errorMessage\\": \\"error\\",\\n \\"success\\": true,\\n \\"workitem\\": {\\n \\"identifier\\": \\"e8bxxxxxxxxxxxxxxxx23\\",\\n \\"subject\\": \\"测试工作项\\",\\n \\"document\\": \\"html格式\\",\\n \\"documentFormat\\": \\"RICHTEXT\\",\\n \\"assignedTo\\": \\"19xx7043xxxxxxx914\\",\\n \\"status\\": \\"待处理\\",\\n \\"statusStageIdentifier\\": \\"1\\",\\n \\"spaceIdentifier\\": \\"e8b26xxxxx6e76aa20xxxxx23\\",\\n \\"spaceName\\": \\"需求项目\\",\\n \\"spaceType\\": \\"Project\\",\\n \\"logicalStatus\\": \\"NORMAL\\",\\n \\"categoryIdentifier\\": \\"Req\\",\\n \\"parentIdentifier\\": \\"e8bxxxxxxxxxxxxxxxx24\\",\\n \\"workitemTypeIdentifier\\": \\"9uxxxxxxre573f5xxxxxx0\\",\\n \\"updateStatusAt\\": 1640850328000,\\n \\"serialNumber\\": \\"ABCD-1\\",\\n \\"gmtCreate\\": 1640850318000,\\n \\"gmtModified\\": 1640850318000,\\n \\"creator\\": \\"19xx7043xxxxxxx914\\",\\n \\"modifier\\": \\"19xx7043xxxxxxx914\\",\\n \\"statusIdentifier\\": \\"例：100005\\",\\n \\"sprint\\": [\\n \\"81be626abf9b63e291bd......\\"\\n ],\\n \\"tag\\": [\\n \\"c76e0e4bf64801cfad73......\\"\\n ],\\n \\"participant\\": [\\n \\"1561159309......\\"\\n ],\\n \\"tracker\\": [\\n \\"1561159309......\\"\\n ],\\n \\"verifier\\": [\\n \\"1561159309......\\"\\n ],\\n \\"customFields\\": [\\n {\\n \\"fieldIdentifier\\": \\"例：80\\",\\n \\"fieldFormat\\": \\"例：input\\",\\n \\"fieldClassName\\": \\"例如：date\\",\\n \\"objectValue\\": \\"null\\",\\n \\"value\\": \\"例：2022-01-06 00:00:00\\",\\n \\"workitemIdentifier\\": \\"5daa9a15c7fd55523996......\\",\\n \\"position\\": 1,\\n \\"level\\": 1,\\n \\"valueList\\": [\\n {\\n \\"value\\": \\"2022-02-01 00:00:00\\",\\n \\"valueEn\\": \\"null\\",\\n \\"displayValue\\": \\"2022-02-01 00:00:00\\",\\n \\"identifier\\": \\"2022-02-01 00:00:00\\",\\n \\"level\\": 1\\n }\\n ]\\n }\\n ],\\n \\"finishTime\\": 1699366778000,\\n \\"tagDetails\\": [\\n {\\n \\"identifier\\": \\"8d859b4fce9d86bc324a9cf00c\\",\\n \\"name\\": \\"paymentcenter\\",\\n \\"color\\": \\"#1F9AEF\\"\\n }\\n ],\\n \\"versions\\": [\\n {\\n \\"identifier\\": \\"ec65ce5dbc84790b53c272cb43\\",\\n \\"name\\": \\"UAT\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetWorkItemInfoResponse>\\n <result>\\n <identifier>5daa9a15c7fd55523996......</identifier>\\n <subject>111000111</subject>\\n <document>test</document>\\n <assignedTo>1967043931......</assignedTo>\\n <status>待处理</status>\\n <statusIdentifier>100005</statusIdentifier>\\n <statusStageIdentifier>1</statusStageIdentifier>\\n <spaceIdentifier>8fb83debd69a6c7c6626......</spaceIdentifier>\\n <spaceName>111122222233</spaceName>\\n <spaceType>Project</spaceType>\\n <logicalStatus>NORMAL</logicalStatus>\\n <categoryIdentifier>Req</categoryIdentifier>\\n <parentIdentifier/>\\n <workitemTypeIdentifier>9uy29901re573f561d......</workitemTypeIdentifier>\\n <updateStatusAt/>\\n <serialNumber>5</serialNumber>\\n <gmtCreate>1644896556000</gmtCreate>\\n <gmtModified>1645003986000</gmtModified>\\n <creator>1967043931947914</creator>\\n <modifier/>\\n <sprint>dd9742a1c2ee285acdb7......</sprint>\\n <tag>c76e0e4bf64801cfad7......</tag>\\n <participant>1561159309......</participant>\\n <participant>1847535819......</participant>\\n <tracker>1062519337......</tracker>\\n <tracker>1847535819......</tracker>\\n <customFields>\\n <fieldIdentifier>79</fieldIdentifier>\\n <fieldFormat>input</fieldFormat>\\n <fieldClassName>date</fieldClassName>\\n <valueList>\\n <value>2022-01-06 00:00:00</value>\\n <valueEn/>\\n <displayValue>2022-01-06 00:00:00</displayValue>\\n <identifier>2022-01-06 00:00:00</identifier>\\n <level/>\\n </valueList>\\n <objectValue/>\\n <value>2022-01-06 00:00:00</value>\\n <workitemIdentifier>5daa9a15c7fd55523996......</workitemIdentifier>\\n <position/>\\n <level/>\\n </customFields>\\n <customFields>\\n <fieldIdentifier>80</fieldIdentifier>\\n <fieldFormat>input</fieldFormat>\\n <fieldClassName>date</fieldClassName>\\n <valueList>\\n <value>2022-02-01 00:00:00</value>\\n <valueEn/>\\n <displayValue>2022-02-01 00:00:00</displayValue>\\n <identifier>2022-02-01 00:00:00</identifier>\\n <level/>\\n </valueList>\\n <objectValue/>\\n <value>2022-02-01 00:00:00</value>\\n <workitemIdentifier>5daa9a15c7fd55523996......</workitemIdentifier>\\n <position/>\\n <level/>\\n </customFields>\\n <customFields>\\n <fieldIdentifier>priority</fieldIdentifier>\\n <fieldFormat>list</fieldFormat>\\n <fieldClassName>option</fieldClassName>\\n <valueList>\\n <value>中</value>\\n <valueEn>Medium</valueEn>\\n <displayValue>中</displayValue>\\n <identifier>77c7fb03c4186c8691d6......</identifier>\\n <level>4</level>\\n </valueList>\\n <objectValue/>\\n <value>77c7fb03c4186c8691d6......</value>\\n <workitemIdentifier>5daa9a15c7fd55523996......</workitemIdentifier>\\n <position/>\\n <level/>\\n </customFields>\\n </result>\\n <errorMsg/>\\n <requestId/>\\n <errorCode/>\\n <success>true</success>\\n</GetWorkItemInfoResponse>","errorExample":""}]', + ], + 'GetWorkItemWorkFlowInfo' => [ + 'summary' => '获取工作项工作流信息', + 'path' => '/organization/{organizationId}/workitems/{workitemId}/getWorkflowInfo', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'configurationId', + 'in' => 'query', + 'schema' => [ + 'title' => '项目id', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '711d33c738b9171c45fa......', + ], + ], + [ + 'name' => 'workitemId', + 'in' => 'path', + 'schema' => [ + 'title' => '工作项id', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'fd0xxxxx00d355b05df60xxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '工作项请求结果', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => 'error', + ], + 'success' => [ + 'title' => 'true或者false', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'workflow' => [ + 'title' => '工作项信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'identifier' => [ + 'title' => '工作流唯一标识', + 'description' => '', + 'type' => 'string', + 'example' => 'e8bxxxxxxxxxxxxxxxx23', + ], + 'name' => [ + 'title' => '工作流名称', + 'description' => '', + 'type' => 'string', + 'example' => '名称', + ], + 'description' => [ + 'title' => '工作流的描述', + 'description' => '', + 'type' => 'string', + 'example' => '工作流的描述', + ], + 'ownerSpaceIdentifier' => [ + 'title' => '工作流所属的团队空间或项目的identifier', + 'description' => '', + 'type' => 'string', + 'example' => 'e8b26xxxxx6e76aa20xxxxx23', + ], + 'ownerSpaceType' => [ + 'title' => '工作流所属的团队项目类型', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'defaultStatusIdentifier' => [ + 'title' => '工作流的默认状态', + 'description' => '', + 'type' => 'string', + 'example' => '100005', + ], + 'statusOrder' => [ + 'title' => '工作流的状态顺序', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'resourceType' => [ + 'title' => '资源类型', + 'description' => '', + 'type' => 'string', + 'example' => 'Project', + ], + 'source' => [ + 'title' => '工作流来源', + 'description' => '', + 'type' => 'string', + 'example' => 'system', + ], + 'gmtCreate' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1640850318000', + ], + 'gmtModified' => [ + 'title' => '修改时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1640850318000', + ], + 'creator' => [ + 'title' => '创建人', + 'description' => '', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'modifier' => [ + 'title' => '修改人', + 'description' => '', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'workflowActions' => [ + 'title' => '工作流的流转步骤', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '流转步骤的id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '16274887', + ], + 'name' => [ + 'title' => 'action的名称', + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + 'workflowIdentifier' => [ + 'title' => 'action对应的工作流', + 'description' => '', + 'type' => 'string', + 'example' => 'fd0xxxxxd00d355b05dxxxx26', + ], + 'workflowStatusIdentifier' => [ + 'title' => 'action对应的当前状态id', + 'description' => '', + 'type' => 'string', + 'example' => '100005', + ], + 'nextWorkflowStatusIdentifier' => [ + 'title' => 'action对应的下个状态的信息id', + 'description' => '', + 'type' => 'string', + 'example' => '100011', + ], + ], + ], + ], + 'statuses' => [ + 'title' => '状态列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'identifier' => [ + 'title' => '状态唯一标识', + 'description' => '', + 'type' => 'string', + 'example' => '156603', + ], + 'name' => [ + 'title' => '状态名', + 'description' => '', + 'type' => 'string', + 'example' => '待处理', + ], + 'workflowStageName' => [ + 'title' => '阶段信息-名称', + 'description' => '', + 'type' => 'string', + 'example' => '确认阶段', + ], + 'workflowStageIdentifier' => [ + 'title' => '阶段信息-阶段的唯一标识', + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'source' => [ + 'title' => '状态来源', + 'description' => '', + 'type' => 'string', + 'example' => 'system', + ], + 'gmtCreate' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1613805843000', + ], + 'gmtModified' => [ + 'title' => '修改时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1613805843000', + ], + 'creator' => [ + 'title' => '创建人', + 'description' => '', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'modifier' => [ + 'title' => '修改人', + 'description' => '', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'description' => [ + 'title' => '描述信息', + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + 'resourceType' => [ + 'title' => '资源来源', + 'description' => '', + 'type' => 'string', + 'example' => 'Workitem', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"errorMessage\\": \\"error\\",\\n \\"success\\": true,\\n \\"workflow\\": {\\n \\"identifier\\": \\"e8bxxxxxxxxxxxxxxxx23\\",\\n \\"name\\": \\"名称\\",\\n \\"description\\": \\"工作流的描述\\",\\n \\"ownerSpaceIdentifier\\": \\"e8b26xxxxx6e76aa20xxxxx23\\",\\n \\"ownerSpaceType\\": \\"null\\",\\n \\"defaultStatusIdentifier\\": \\"100005\\",\\n \\"statusOrder\\": \\"null\\",\\n \\"resourceType\\": \\"Project\\",\\n \\"source\\": \\"system\\",\\n \\"gmtCreate\\": 1640850318000,\\n \\"gmtModified\\": 1640850318000,\\n \\"creator\\": \\"19xx7043xxxxxxx914\\",\\n \\"modifier\\": \\"19xx7043xxxxxxx914\\",\\n \\"workflowActions\\": [\\n {\\n \\"id\\": 16274887,\\n \\"name\\": \\"xxx\\",\\n \\"workflowIdentifier\\": \\"fd0xxxxxd00d355b05dxxxx26\\",\\n \\"workflowStatusIdentifier\\": \\"100005\\",\\n \\"nextWorkflowStatusIdentifier\\": \\"100011\\"\\n }\\n ],\\n \\"statuses\\": [\\n {\\n \\"identifier\\": \\"156603\\",\\n \\"name\\": \\"待处理\\",\\n \\"workflowStageName\\": \\"确认阶段\\",\\n \\"workflowStageIdentifier\\": \\"1\\",\\n \\"source\\": \\"system\\",\\n \\"gmtCreate\\": 1613805843000,\\n \\"gmtModified\\": 1613805843000,\\n \\"creator\\": \\"19xx7043xxxxxxx914\\",\\n \\"modifier\\": \\"19xx7043xxxxxxx914\\",\\n \\"description\\": \\"xxx\\",\\n \\"resourceType\\": \\"Workitem\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + ], + 'ListProjectWorkitemTypes' => [ + 'summary' => '获取项目下开启的工作项类型', + 'path' => '/organization/{organizationId}/projects/{projectId}/getWorkitemType', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'title' => '项目id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'asd345xxxxx9q9845xxxxx34', + ], + ], + [ + 'name' => 'spaceType', + 'in' => 'query', + 'schema' => [ + 'title' => '空间类型', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'Project', + ], + ], + [ + 'name' => 'category', + 'in' => 'query', + 'schema' => [ + 'title' => '工作项类型', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'Req', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'openapi平台的request id', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorCode' => [ + 'title' => '错误返回码', + 'description' => '', + 'type' => 'string', + 'example' => '例：Openapi.RequestError', + ], + 'errorMessage' => [ + 'title' => '错误返回信息', + 'description' => '', + 'type' => 'string', + 'example' => 'errormessage', + ], + 'success' => [ + 'title' => '接口是否正常返回', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true或者false', + ], + 'workitemTypes' => [ + 'title' => '工作项类型', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'identifier' => [ + 'title' => '工作项类型id', + 'description' => '', + 'type' => 'string', + 'example' => 'dfexxxxxf4fee18xxxxx36', + ], + 'name' => [ + 'title' => '工作项类型的名称', + 'description' => '', + 'type' => 'string', + 'example' => '例：业务类需求', + ], + 'nameEn' => [ + 'title' => '工作项类型的英文名称', + 'description' => '', + 'type' => 'string', + 'example' => '例：Business Requirement', + ], + 'categoryIdentifier' => [ + 'title' => '工作项类型', + 'description' => '', + 'type' => 'string', + 'example' => 'Req', + ], + 'systemDefault' => [ + 'title' => '是否系统默认', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'gmtCreate' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1620455467000', + ], + 'creator' => [ + 'title' => '工作项类型创建人', + 'description' => '', + 'type' => 'string', + 'example' => '用户阿里云pk，例如19xxxx31947xxxx', + ], + 'description' => [ + 'title' => '描述', + 'description' => '', + 'type' => 'string', + 'example' => '该类型的具体信息', + ], + 'enable' => [ + 'title' => '是否启用', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true或者false', + ], + 'defaultType' => [ + 'title' => '在项目中是否为默认类型', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true或者false', + ], + 'gmtAdd' => [ + 'title' => '添加到项目中的时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1641870287000', + ], + 'addUser' => [ + 'title' => '添加到项目中的添加人', + 'description' => '', + 'type' => 'string', + 'example' => '用户阿里云pk，例如19xxxx31947xxxx', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorCode\\": \\"例：Openapi.RequestError\\",\\n \\"errorMessage\\": \\"errormessage\\",\\n \\"success\\": true,\\n \\"workitemTypes\\": [\\n {\\n \\"identifier\\": \\"dfexxxxxf4fee18xxxxx36\\",\\n \\"name\\": \\"例：业务类需求\\",\\n \\"nameEn\\": \\"例：Business Requirement\\",\\n \\"categoryIdentifier\\": \\"Req\\",\\n \\"systemDefault\\": true,\\n \\"gmtCreate\\": 1620455467000,\\n \\"creator\\": \\"用户阿里云pk，例如19xxxx31947xxxx\\",\\n \\"description\\": \\"该类型的具体信息\\",\\n \\"enable\\": true,\\n \\"defaultType\\": true,\\n \\"gmtAdd\\": 1641870287000,\\n \\"addUser\\": \\"用户阿里云pk，例如19xxxx31947xxxx\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListProjectWorkitemTypesResponse>\\n <workitemTypes>\\n <systemDefault>true</systemDefault>\\n <identifier>9uy29901re573f561d......</identifier>\\n <creator>AK-ADMIN</creator>\\n <enable>true</enable>\\n <addUser>1967043931......</addUser>\\n <name>产品类需求</name>\\n <description/>\\n <nameEn>Requirement</nameEn>\\n <gmtAdd>1644551256000</gmtAdd>\\n <categoryIdentifier>Req</categoryIdentifier>\\n <gmtCreate>1613978186000</gmtCreate>\\n <defaultType>true</defaultType>\\n </workitemTypes>\\n <requestId>D8B2431B-7A35-5DD5-985D-C62192......</requestId>\\n <success>true</success>\\n <errorMessage/>\\n <errorCode/>\\n</ListProjectWorkitemTypesResponse>","errorExample":""}]', + ], + 'ListWorkItemAllFields' => [ + 'summary' => '获取项目下工作项的所有字段', + 'path' => '/organization/{organizationId}/workitems/fields/listAll', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'spaceType', + 'in' => 'query', + 'schema' => [ + 'title' => '资源类型', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'Project', + ], + ], + [ + 'name' => 'spaceIdentifier', + 'in' => 'query', + 'schema' => [ + 'title' => '项目id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'e8bxxxxxxxxxxxxxxxx23', + ], + ], + [ + 'name' => 'workitemTypeIdentifier', + 'in' => 'query', + 'schema' => [ + 'title' => '工作项类型id，工作项类型的列表和id可以从ListProjectWorkitemType中获取', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'dfexxxxxf4fee18xxxxx36', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMsg' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => 'error', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'title' => 'true或者false', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'fields' => [ + 'title' => '字段信息', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'creator' => [ + 'title' => '创建人id', + 'description' => '', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'description' => [ + 'title' => '描述信息', + 'description' => '', + 'type' => 'string', + 'example' => '字段的具体信息', + ], + 'gmtCreate' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1623916393000', + ], + 'gmtModified' => [ + 'title' => '修改时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1623916393000', + ], + 'type' => [ + 'title' => '区分不同的类型，如系统字段、用户自定义字段', + 'description' => '', + 'type' => 'string', + 'example' => 'NativeField', + ], + 'identifier' => [ + 'title' => '字段唯一标识符', + 'description' => '', + 'type' => 'string', + 'example' => 'e8bxxxxxxxxxxxxxxxx23', + ], + 'modifier' => [ + 'title' => '修改人', + 'description' => '', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'name' => [ + 'title' => '字段名称', + 'description' => '', + 'type' => 'string', + 'example' => '负责人', + ], + 'format' => [ + 'title' => '字段格式', + 'description' => '', + 'type' => 'string', + 'example' => 'list', + ], + 'className' => [ + 'title' => '字段类型', + 'description' => '', + 'type' => 'string', + 'example' => '例：date', + ], + 'resourceType' => [ + 'title' => '区分不同的适用对象', + 'description' => '', + 'type' => 'string', + 'example' => '例：Workitem', + ], + 'defaultValue' => [ + 'title' => '默认值', + 'description' => '', + 'type' => 'string', + 'example' => '123', + ], + 'isRequired' => [ + 'title' => '是否必填', + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'isSystemRequired' => [ + 'title' => '是否是系统必须字段，比如：负责人、状态等。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'linkWithService' => [ + 'title' => '联动的服务，比如：迭代 迭代服务开启/关闭，这个字段字段加进/剔除出对应的模板； 字段模板里，这类字段不能手动添加或删除', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'isShowWhenCreate' => [ + 'title' => '创建时是否展示', + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'options' => [ + 'title' => '待选值', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'identifier' => [ + 'title' => '待选值的唯一标识', + 'description' => '', + 'type' => 'string', + 'example' => '重复的缺陷', + ], + 'fieldIdentifier' => [ + 'title' => '字段唯一标识', + 'description' => '', + 'type' => 'string', + 'example' => 'e8bxxxxxxxxxxxxxxxx23', + ], + 'value' => [ + 'title' => '待选值中文名称', + 'description' => '', + 'type' => 'string', + 'example' => '重复的缺陷', + ], + 'valueEn' => [ + 'title' => '待选值英文名称', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'displayValue' => [ + 'title' => '根据语言环境获取当前展示的值', + 'description' => '', + 'type' => 'string', + 'example' => '重复的缺陷', + ], + 'position' => [ + 'title' => '待选值顺序', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'level' => [ + 'title' => '展示级别，数字范围1~9，数字越大，颜色越浅。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"fields\\": [\\n {\\n \\"creator\\": \\"19xx7043xxxxxxx914\\",\\n \\"description\\": \\"字段的具体信息\\",\\n \\"gmtCreate\\": 1623916393000,\\n \\"gmtModified\\": 1623916393000,\\n \\"type\\": \\"NativeField\\",\\n \\"identifier\\": \\"e8bxxxxxxxxxxxxxxxx23\\",\\n \\"modifier\\": \\"19xx7043xxxxxxx914\\",\\n \\"name\\": \\"负责人\\",\\n \\"format\\": \\"list\\",\\n \\"className\\": \\"例：date\\",\\n \\"resourceType\\": \\"例：Workitem\\",\\n \\"defaultValue\\": \\"123\\",\\n \\"isRequired\\": false,\\n \\"isSystemRequired\\": false,\\n \\"linkWithService\\": \\"null\\",\\n \\"isShowWhenCreate\\": false,\\n \\"options\\": [\\n {\\n \\"identifier\\": \\"重复的缺陷\\",\\n \\"fieldIdentifier\\": \\"e8bxxxxxxxxxxxxxxxx23\\",\\n \\"value\\": \\"重复的缺陷\\",\\n \\"valueEn\\": \\"null\\",\\n \\"displayValue\\": \\"重复的缺陷\\",\\n \\"position\\": 1,\\n \\"level\\": 1\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + ], + 'ListWorkItemWorkFlowStatus' => [ + 'summary' => '查询工作项工作流的所有状态', + 'path' => '/organization/{organizationId}/workitems/workflow/listWorkflowStatus', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'spaceType', + 'in' => 'query', + 'schema' => [ + 'title' => '空间类型', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'Project', + ], + ], + [ + 'name' => 'workitemCategoryIdentifier', + 'in' => 'query', + 'schema' => [ + 'title' => '工作项大类型', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'Req', + ], + ], + [ + 'name' => 'workitemTypeIdentifier', + 'in' => 'query', + 'schema' => [ + 'title' => '工作项小类型id', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '例：5e7xxxxb3cd3711dd6xxx2c', + ], + ], + [ + 'name' => 'spaceIdentifier', + 'in' => 'query', + 'schema' => [ + 'title' => '项目id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '例：5e70xxxxxxcd000xxxxe96', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'openapi平台的request id', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorCode' => [ + 'title' => '错误返回码', + 'description' => '', + 'type' => 'string', + 'example' => '例：Openapi.RequestError', + ], + 'errorMessage' => [ + 'title' => '错误返回信息', + 'description' => '', + 'type' => 'string', + 'example' => 'errormessage', + ], + 'success' => [ + 'title' => '接口是否正常返回', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true或者false', + ], + 'statuses' => [ + 'title' => '工作流状态', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'identifier' => [ + 'title' => '工作流状态id', + 'description' => '', + 'type' => 'string', + 'example' => 'dfexxxxxf4fee18xxxxx36', + ], + 'name' => [ + 'title' => '工作流状态名称', + 'description' => '', + 'type' => 'string', + 'example' => '例：待处理', + ], + 'workflowStageName' => [ + 'title' => '阶段信息-名称', + 'description' => '', + 'type' => 'string', + 'example' => '例：确认阶段', + ], + 'workflowStageIdentifier' => [ + 'title' => '阶段信息-阶段的唯一标识', + 'description' => '', + 'type' => 'string', + 'example' => '例如：1', + ], + 'source' => [ + 'title' => '状态来源', + 'description' => '', + 'type' => 'string', + 'example' => 'system', + ], + 'gmtCreate' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1620455467000', + ], + 'creator' => [ + 'title' => '状态的创建人', + 'description' => '', + 'type' => 'string', + 'example' => '用户阿里云pk，例如19xxxx31947xxxx', + ], + 'description' => [ + 'title' => '描述', + 'description' => '', + 'type' => 'string', + 'example' => '该状态的具体信息', + ], + 'modifier' => [ + 'title' => '修改人', + 'description' => '', + 'type' => 'string', + 'example' => '用户阿里云pk，例如19xxxx31947xxxx', + ], + 'gmtModified' => [ + 'title' => '更新时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1641870287000', + ], + 'resourceType' => [ + 'title' => '状态作用的资源类型', + 'description' => '', + 'type' => 'string', + 'example' => 'Workitem', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorCode\\": \\"例：Openapi.RequestError\\",\\n \\"errorMessage\\": \\"errormessage\\",\\n \\"success\\": true,\\n \\"statuses\\": [\\n {\\n \\"identifier\\": \\"dfexxxxxf4fee18xxxxx36\\",\\n \\"name\\": \\"例：待处理\\",\\n \\"workflowStageName\\": \\"例：确认阶段\\",\\n \\"workflowStageIdentifier\\": \\"例如：1\\",\\n \\"source\\": \\"system\\",\\n \\"gmtCreate\\": 1620455467000,\\n \\"creator\\": \\"用户阿里云pk，例如19xxxx31947xxxx\\",\\n \\"description\\": \\"该状态的具体信息\\",\\n \\"modifier\\": \\"用户阿里云pk，例如19xxxx31947xxxx\\",\\n \\"gmtModified\\": 1641870287000,\\n \\"resourceType\\": \\"Workitem\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListWorkItemWorkFlowStatusResponse>\\n <requestId>B40562D3-6200-5F51-8290-7568B7......</requestId>\\n <success>true</success>\\n <errorMessage/>\\n <errorCode/>\\n <statuses>\\n <identifier>100005</identifier>\\n <creator>AK-ADMIN</creator>\\n <workflowStageName>确认阶段</workflowStageName>\\n <name>待处理</name>\\n <description/>\\n <source>system</source>\\n <gmtCreate>1613805843000</gmtCreate>\\n <workflowStageIdentifier>1</workflowStageIdentifier>\\n <resourceType>Workitem</resourceType>\\n </statuses>\\n <statuses>\\n <identifier>156603</identifier>\\n <creator>AK-ADMIN</creator>\\n <workflowStageName>设计阶段</workflowStageName>\\n <name>设计中</name>\\n <source>system</source>\\n <gmtCreate>1615190250000</gmtCreate>\\n <workflowStageIdentifier>7</workflowStageIdentifier>\\n <resourceType>Workitem</resourceType>\\n </statuses>\\n <statuses>\\n <identifier>142838</identifier>\\n <creator>AK-ADMIN</creator>\\n <workflowStageName>开发阶段</workflowStageName>\\n <name>开发中</name>\\n <source>system</source>\\n <gmtCreate>1618991351000</gmtCreate>\\n <workflowStageIdentifier>11</workflowStageIdentifier>\\n <resourceType>Workitem</resourceType>\\n </statuses>\\n <statuses>\\n <identifier>100012</identifier>\\n <creator>AK-ADMIN</creator>\\n <workflowStageName>测试阶段</workflowStageName>\\n <name>测试中</name>\\n <source>system</source>\\n <gmtCreate>1618992049000</gmtCreate>\\n <workflowStageIdentifier>12</workflowStageIdentifier>\\n <resourceType>Workitem</resourceType>\\n </statuses>\\n <statuses>\\n <identifier>100014</identifier>\\n <creator>AK-ADMIN</creator>\\n <workflowStageName>正常结束</workflowStageName>\\n <name>已完成</name>\\n <source>system</source>\\n <gmtCreate>1613996161000</gmtCreate>\\n <workflowStageIdentifier>4</workflowStageIdentifier>\\n <resourceType>Workitem</resourceType>\\n </statuses>\\n <statuses>\\n <identifier>141230</identifier>\\n <creator>AK-ADMIN</creator>\\n <workflowStageName>异常结束</workflowStageName>\\n <name>已取消</name>\\n <source>system</source>\\n <gmtCreate>1613996214000</gmtCreate>\\n <workflowStageIdentifier>5</workflowStageIdentifier>\\n <resourceType>Workitem</resourceType>\\n </statuses>\\n</ListWorkItemWorkFlowStatusResponse>","errorExample":""}]', + ], + 'ListWorkitems' => [ + 'summary' => '获取工作项列表', + 'path' => '/organization/{organizationId}/listWorkitems', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'spaceType', + 'in' => 'query', + 'schema' => [ + 'title' => '项目类型', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'Project', + ], + ], + [ + 'name' => 'spaceIdentifier', + 'in' => 'query', + 'schema' => [ + 'title' => '项目id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '8fb83debd69a6c7c6626......', + ], + ], + [ + 'name' => 'category', + 'in' => 'query', + 'schema' => [ + 'title' => '工作项类型，需求为Req，缺陷为Bug，任务为Task，风险为Risk', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'Req', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'title' => '分页中的起始序列', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '""', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'title' => '每页最大返回数量，0-200，默认值20', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'conditions', + 'in' => 'query', + 'schema' => [ + 'title' => '过滤条件', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{"conditionGroups":[]}', + ], + ], + [ + 'name' => 'extraConditions', + 'in' => 'query', + 'schema' => [ + 'title' => '额外条件', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{"conditionGroups":[]}', + ], + ], + [ + 'name' => 'groupCondition', + 'in' => 'query', + 'schema' => [ + 'title' => '分组条件', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{"fieldIdentifier":"tag","className":"tag","format":"multiList","value":["c76e0e4bf64801cfad73......"],"operator":"EQUALS"}', + ], + ], + [ + 'name' => 'orderBy', + 'in' => 'query', + 'schema' => [ + 'title' => '排序顺序', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{"fieldIdentifier":"status","format":"list","order":"desc","className":"status"}', + ], + ], + [ + 'name' => 'searchType', + 'in' => 'query', + 'schema' => [ + 'title' => '查询类型', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'LIST', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'totalCount' => [ + 'title' => '总数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'nextToken' => [ + 'title' => '分页Token，没有下一页则为空', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'maxResults' => [ + 'title' => '每页数量', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMsg' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => 'error', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'title' => 'true或者false', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'workitems' => [ + 'title' => '工作项信息', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'identifier' => [ + 'title' => '工作项唯一标识', + 'description' => '', + 'type' => 'string', + 'example' => 'e8bxxxxxxxxxxxxxxxx23', + ], + 'subject' => [ + 'title' => '工作项标题', + 'description' => '', + 'type' => 'string', + 'example' => '测试工作项', + ], + 'document' => [ + 'title' => '工作项内容', + 'description' => '', + 'type' => 'string', + 'example' => 'html格式', + ], + 'assignedTo' => [ + 'title' => '负责人aliyunPk', + 'description' => '', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'status' => [ + 'title' => '状态名称', + 'description' => '', + 'type' => 'string', + 'example' => '待处理', + ], + 'statusStageIdentifier' => [ + 'title' => '状态阶段id', + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'spaceIdentifier' => [ + 'title' => '所属项目id', + 'description' => '', + 'type' => 'string', + 'example' => 'e8b26xxxxx6e76aa20xxxxx23', + ], + 'spaceName' => [ + 'title' => '所属项目名称', + 'description' => '', + 'type' => 'string', + 'example' => '需求项目', + ], + 'spaceType' => [ + 'title' => '项目类型', + 'description' => '', + 'type' => 'string', + 'example' => 'Project', + ], + 'logicalStatus' => [ + 'title' => '逻辑状态', + 'description' => '', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'categoryIdentifier' => [ + 'title' => '工作项的类型id', + 'description' => '', + 'type' => 'string', + 'example' => 'Req', + ], + 'parentIdentifier' => [ + 'title' => '父工作项id', + 'description' => '', + 'type' => 'string', + 'example' => 'e8bxxxxxxxxxxxxxxxx24', + ], + 'workitemTypeIdentifier' => [ + 'title' => '工作项类型id', + 'description' => '', + 'type' => 'string', + 'example' => '9uxxxxxxre573f5xxxxxx0', + ], + 'updateStatusAt' => [ + 'title' => '状态更新时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1640850328000', + ], + 'serialNumber' => [ + 'title' => '编号', + 'description' => '', + 'type' => 'string', + 'example' => 'ABCD-1', + ], + 'gmtCreate' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1640850318000', + ], + 'gmtModified' => [ + 'title' => '修改时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1640850318000', + ], + 'creator' => [ + 'title' => '创建人aliyunPK', + 'description' => '', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'modifier' => [ + 'title' => '修改人aliyunPK', + 'description' => '', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'statusIdentifier' => [ + 'title' => '状态唯一标识', + 'description' => '', + 'type' => 'string', + 'example' => '100005', + ], + 'sprintIdentifier' => [ + 'title' => '迭代id', + 'description' => '', + 'type' => 'string', + 'example' => '75528f17703e92e5a568......', + ], + 'finishTime' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"totalCount\\": 10,\\n \\"nextToken\\": \\"\\\\\\"\\\\\\"\\",\\n \\"maxResults\\": 20,\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"workitems\\": [\\n {\\n \\"identifier\\": \\"e8bxxxxxxxxxxxxxxxx23\\",\\n \\"subject\\": \\"测试工作项\\",\\n \\"document\\": \\"xxx\\",\\n \\"assignedTo\\": \\"19xx7043xxxxxxx914\\",\\n \\"status\\": \\"待处理\\",\\n \\"statusStageIdentifier\\": \\"1\\",\\n \\"spaceIdentifier\\": \\"e8b26xxxxx6e76aa20xxxxx23\\",\\n \\"spaceName\\": \\"需求项目\\",\\n \\"spaceType\\": \\"Project\\",\\n \\"logicalStatus\\": \\"NORMAL\\",\\n \\"categoryIdentifier\\": \\"Req\\",\\n \\"parentIdentifier\\": \\"e8bxxxxxxxxxxxxxxxx24\\",\\n \\"workitemTypeIdentifier\\": \\"9uxxxxxxre573f5xxxxxx0\\",\\n \\"updateStatusAt\\": 1640850328000,\\n \\"serialNumber\\": \\"ABCD-1\\",\\n \\"gmtCreate\\": 1640850318000,\\n \\"gmtModified\\": 1640850318000,\\n \\"creator\\": \\"19xx7043xxxxxxx914\\",\\n \\"modifier\\": \\"19xx7043xxxxxxx914\\",\\n \\"statusIdentifier\\": \\"100005\\",\\n \\"sprintIdentifier\\": \\"75528f17703e92e5a568......\\",\\n \\"finishTime\\": 1699366778000\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + ], + 'ListWorkitemTime' => [ + 'summary' => '获取工作项工时明细列表', + 'path' => '/organization/{organizationId}/workitems/{workitemId}/time/list', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'workitemId', + 'in' => 'path', + 'schema' => [ + 'title' => '工作项唯一标识', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5daa9a15c7fd55523996......', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMsg' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => 'error', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'title' => 'true或者false', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'workitemTime' => [ + 'title' => '工时信息', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'workitemIdentifier' => [ + 'title' => '工作项id，唯一标识', + 'description' => '', + 'type' => 'string', + 'example' => '5daa9a15c7fd55523996......', + ], + 'identifier' => [ + 'title' => '工时唯一标识', + 'description' => '', + 'type' => 'string', + 'example' => 'a4ac3a81e90217db32b7......', + ], + 'gmtStart' => [ + 'title' => '开始时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1653235200000', + ], + 'gmtEnd' => [ + 'title' => '结束时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1653235200000', + ], + 'actualTime' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'type' => [ + 'title' => '工时类型', + 'description' => '', + 'type' => 'string', + 'example' => '研发', + ], + 'description' => [ + 'title' => '工时描述信息', + 'description' => '', + 'type' => 'string', + 'example' => '开发代码等', + ], + 'recordUser' => [ + 'title' => '登记人的account Id', + 'description' => '', + 'type' => 'string', + 'example' => '1967043931......', + ], + 'gmtCreate' => [ + 'title' => '工时记录的创建时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1653235200000', + ], + 'gmtModified' => [ + 'title' => '工时记录的修改时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1653235200000', + ], + ], + ], + ], + 'code' => [ + 'title' => '接口返回code', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"workitemTime\\": [\\n {\\n \\"workitemIdentifier\\": \\"5daa9a15c7fd55523996......\\",\\n \\"identifier\\": \\"a4ac3a81e90217db32b7......\\",\\n \\"gmtStart\\": 1653235200000,\\n \\"gmtEnd\\": 1653235200000,\\n \\"actualTime\\": 1,\\n \\"type\\": \\"研发\\",\\n \\"description\\": \\"开发代码等\\",\\n \\"recordUser\\": \\"1967043931......\\",\\n \\"gmtCreate\\": 1653235200000,\\n \\"gmtModified\\": 1653235200000\\n }\\n ],\\n \\"code\\": 200\\n}","errorExample":""},{"type":"xml","example":"<ListWorkitemTimeResponse>\\n <code>200</code>\\n <success>true</success>\\n <errorCode>success</errorCode>\\n <workitemTime>\\n <actualTime>3</actualTime>\\n <identifier>a4ac3a81e90217db32b7......</identifier>\\n <recordUser>1967043931......</recordUser>\\n <gmtModified>1653304358000</gmtModified>\\n <workitemIdentifier>9eb0f6ab3dfb3d23b40f......</workitemIdentifier>\\n <gmtEnd>1653235200000</gmtEnd>\\n <type>研发</type>\\n <gmtCreate>1653304358000</gmtCreate>\\n <gmtStart>1653235200000</gmtStart>\\n </workitemTime>\\n <workitemTime>\\n <actualTime>4</actualTime>\\n <identifier>9f1e959e2109d71baaa7......</identifier>\\n <recordUser>1967043931......</recordUser>\\n <gmtModified>1653304358000</gmtModified>\\n <workitemIdentifier>9eb0f6ab3dfb3d23b40f......</workitemIdentifier>\\n <gmtEnd>1653235200000</gmtEnd>\\n <description>test</description>\\n <type>测试</type>\\n <gmtCreate>1653304364000</gmtCreate>\\n <gmtStart>1653235200000</gmtStart>\\n </workitemTime>\\n <errorMsg/>\\n</ListWorkitemTimeResponse>","errorExample":""}]', + ], + 'ListWorkitemEstimate' => [ + 'summary' => '获取工作项预计工时明细列表', + 'path' => '/organization/{organizationId}/workitems/{workitemId}/estimate/list', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'workitemId', + 'in' => 'path', + 'schema' => [ + 'title' => '工作项唯一标识', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5daa9a15c7fd55523996......', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMsg' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => 'error', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'title' => 'true或者false', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'workitemTimeEstimate' => [ + 'title' => '工时信息', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'workitemIdentifier' => [ + 'title' => '工作项id，唯一标识', + 'description' => '', + 'type' => 'string', + 'example' => '5daa9a15c7fd55523996......', + ], + 'identifier' => [ + 'title' => '工时唯一标识', + 'description' => '', + 'type' => 'string', + 'example' => 'a4ac3a81e90217db32b7......', + ], + 'gmtStart' => [ + 'title' => '开始时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1653235200000', + ], + 'gmtEnd' => [ + 'title' => '结束时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1653235200000', + ], + 'spentTime' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '8', + ], + 'type' => [ + 'title' => '工时类型', + 'description' => '', + 'type' => 'string', + 'example' => '研发', + ], + 'description' => [ + 'title' => '工时描述信息', + 'description' => '', + 'type' => 'string', + 'example' => '开发代码等', + ], + 'recordUser' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'identifier' => [ + 'description' => '', + 'type' => 'string', + 'example' => '132xxxx123', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + 'gmtCreate' => [ + 'title' => '工时记录的创建时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1653235200000', + ], + 'gmtModified' => [ + 'title' => '工时记录的修改时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1653235200000', + ], + ], + ], + ], + 'code' => [ + 'title' => '接口返回code', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"workitemTimeEstimate\\": [\\n {\\n \\"workitemIdentifier\\": \\"5daa9a15c7fd55523996......\\",\\n \\"identifier\\": \\"a4ac3a81e90217db32b7......\\",\\n \\"gmtStart\\": 1653235200000,\\n \\"gmtEnd\\": 1653235200000,\\n \\"spentTime\\": 8,\\n \\"type\\": \\"研发\\",\\n \\"description\\": \\"开发代码等\\",\\n \\"recordUser\\": {\\n \\"identifier\\": \\"132xxxx123\\",\\n \\"name\\": \\"张三\\"\\n },\\n \\"gmtCreate\\": 1653235200000,\\n \\"gmtModified\\": 1653235200000\\n }\\n ],\\n \\"code\\": 200\\n}","type":"json"}]', + ], + 'UpdateWorkitemField' => [ + 'summary' => '批量更新工作项字段信息', + 'path' => '/organization/{organizationId}/workitems/updateWorkitemField', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '60ee8a814690c27532d412f8', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'workitemIdentifier' => [ + 'title' => '工作项id，同workitemId，工作项唯一标识', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '9144ef6b72d8exxxxx9e61a4d0', + ], + 'updateWorkitemPropertyRequest' => [ + 'title' => '更新工作项属性请求，数组形式', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'fieldIdentifier' => [ + 'title' => '需要更新的工作项字段id，可以从获取工作项所有字段接口获取相应的数据', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'tag', + ], + 'fieldValue' => [ + 'title' => '需要更新字段的属性值 (注：1.如果是人员类型的值必须要填写aliyunPK。2.如果是含有待选值的字段，填写相应的待选值的id。 3.如果多个值，需要用" , "进行分割，拼接成一个字符串。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMsg' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => 'error', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'title' => 'true或者false', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'workitem' => [ + 'title' => '工作项信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'identifier' => [ + 'title' => '工作项唯一标识', + 'description' => '', + 'type' => 'string', + 'example' => 'e8bxxxxxxxxxxxxxxxx23', + ], + 'subject' => [ + 'title' => '工作项标题', + 'description' => '', + 'type' => 'string', + 'example' => '测试工作项', + ], + 'document' => [ + 'title' => '工作项内容', + 'description' => '', + 'type' => 'string', + 'example' => 'html格式', + ], + 'assignedTo' => [ + 'title' => '负责人', + 'description' => '', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'status' => [ + 'title' => '状态名称', + 'description' => '', + 'type' => 'string', + 'example' => '待处理', + ], + 'statusStageIdentifier' => [ + 'title' => '状态阶段id', + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'spaceIdentifier' => [ + 'title' => '所属项目id', + 'description' => '', + 'type' => 'string', + 'example' => 'e8b26xxxxx6e76aa20xxxxx23', + ], + 'spaceName' => [ + 'title' => '所属项目名称', + 'description' => '', + 'type' => 'string', + 'example' => '需求项目', + ], + 'spaceType' => [ + 'title' => '项目类型', + 'description' => '', + 'type' => 'string', + 'example' => 'Project', + ], + 'logicalStatus' => [ + 'title' => '逻辑状态', + 'description' => '', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'categoryIdentifier' => [ + 'title' => '工作项的类型id', + 'description' => '', + 'type' => 'string', + 'example' => 'Req', + ], + 'parentIdentifier' => [ + 'title' => '父工作项id', + 'description' => '', + 'type' => 'string', + 'example' => 'e8bxxxxxxxxxxxxxxxx24', + ], + 'workitemTypeIdentifier' => [ + 'title' => '工作项类型id', + 'description' => '', + 'type' => 'string', + 'example' => '9uxxxxxxre573f5xxxxxx0', + ], + 'updateStatusAt' => [ + 'title' => '状态更新时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1640850328000', + ], + 'serialNumber' => [ + 'title' => '编号', + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'gmtCreate' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1640850318000', + ], + 'gmtModified' => [ + 'title' => '修改时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1640850318000', + ], + 'creator' => [ + 'title' => '创建人', + 'description' => '', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'modifier' => [ + 'title' => '修改人', + 'description' => '', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'statusIdentifier' => [ + 'title' => '状态唯一标识id', + 'description' => '', + 'type' => 'string', + 'example' => '28', + ], + 'sprintIdentifier' => [ + 'title' => '迭代的id', + 'description' => '', + 'type' => 'string', + 'example' => '75528f17703e92e5a568......', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"workitem\\": {\\n \\"identifier\\": \\"e8bxxxxxxxxxxxxxxxx23\\",\\n \\"subject\\": \\"测试工作项\\",\\n \\"document\\": \\"html格式\\",\\n \\"assignedTo\\": \\"19xx7043xxxxxxx914\\",\\n \\"status\\": \\"待处理\\",\\n \\"statusStageIdentifier\\": \\"1\\",\\n \\"spaceIdentifier\\": \\"e8b26xxxxx6e76aa20xxxxx23\\",\\n \\"spaceName\\": \\"需求项目\\",\\n \\"spaceType\\": \\"Project\\",\\n \\"logicalStatus\\": \\"NORMAL\\",\\n \\"categoryIdentifier\\": \\"Req\\",\\n \\"parentIdentifier\\": \\"e8bxxxxxxxxxxxxxxxx24\\",\\n \\"workitemTypeIdentifier\\": \\"9uxxxxxxre573f5xxxxxx0\\",\\n \\"updateStatusAt\\": 1640850328000,\\n \\"serialNumber\\": \\"1\\",\\n \\"gmtCreate\\": 1640850318000,\\n \\"gmtModified\\": 1640850318000,\\n \\"creator\\": \\"19xx7043xxxxxxx914\\",\\n \\"modifier\\": \\"19xx7043xxxxxxx914\\",\\n \\"statusIdentifier\\": \\"28\\",\\n \\"sprintIdentifier\\": \\"75528f17703e92e5a568......\\"\\n }\\n}","type":"json"}]', + ], + 'DeleteWorkitem' => [ + 'summary' => '删除工作项', + 'path' => '/organization/{organizationId}/workitem/delete', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'identifier', + 'in' => 'query', + 'schema' => [ + 'title' => '工作项id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '3ef2ef6018d254d660e65f87a6', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMsg' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => 'error', + ], + 'errorCode' => [ + 'title' => '错误状态码', + 'description' => '', + 'type' => 'string', + 'example' => 'InvalidTagGroup.IdNotFound', + ], + 'success' => [ + 'title' => 'true/false', + 'description' => 'true/false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'deleteFlag' => [ + 'title' => '是否成功', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true/false', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"InvalidTagGroup.IdNotFound\\",\\n \\"success\\": true,\\n \\"deleteFlag\\": true\\n}","type":"json"}]', + ], + 'GetWorkitemFile' => [ + 'summary' => '获取工作项文件信息', + 'path' => '/organization/{organizationId}/workitem/{workitemIdentifier}/files/{fileIdentifier}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '60811b5eed6e867404f6xxxx', + ], + ], + [ + 'name' => 'workitemIdentifier', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '11234455454355', + ], + ], + [ + 'name' => 'fileIdentifier', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'dfsdfdsgdsfdsfff', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMsg' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'error', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'success' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'true', + ], + 'workitemFile' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'sddrdfdf123df', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ddc.pdf', + ], + 'suffix' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pdf', + ], + 'size' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10001', + ], + 'url' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'http://tmaestro-oss.oss-cn-hongkong.aliyuncs.com/thread_1682129288279.log', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"success\\",\\n \\"success\\": \\"true\\",\\n \\"workitemFile\\": {\\n \\"id\\": \\"sddrdfdf123df\\",\\n \\"name\\": \\"ddc.pdf\\",\\n \\"suffix\\": \\"pdf\\",\\n \\"size\\": 10001,\\n \\"url\\": \\"http://tmaestro-oss.oss-cn-hongkong.aliyuncs.com/thread_1682129288279.log\\"\\n }\\n}","type":"json"}]', + ], + 'CreateProject' => [ + 'summary' => '创建项目', + 'path' => '/organization/{organizationId}/projects/createProject', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [], + 'produces' => [], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'templateIdentifier' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '704eaxxxx5efede61xxx5', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'name', + ], + 'scope' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'public', + ], + 'customCode' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ABCD', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMsg' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => 'error', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'title' => 'true或者false', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'project' => [ + 'title' => '项目信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'categoryIdentifier' => [ + 'title' => '空间大类id', + 'description' => '', + 'type' => 'string', + 'example' => 'Project', + ], + 'creator' => [ + 'title' => '创建人id', + 'description' => '', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'customCode' => [ + 'title' => '自定义编号', + 'description' => '', + 'type' => 'string', + 'example' => 'OJAY', + ], + 'description' => [ + 'title' => '描述信息', + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + 'gmtCreate' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1623916393000', + ], + 'gmtModified' => [ + 'title' => '修改时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1623916393000', + ], + 'icon' => [ + 'title' => '图标', + 'description' => '', + 'type' => 'string', + 'example' => 'https://xxxxxx.png', + ], + 'identifier' => [ + 'title' => '项目唯一标识符', + 'description' => '', + 'type' => 'string', + 'example' => 'e8bxxxxxxxxxxxxxxxx23', + ], + 'logicalStatus' => [ + 'title' => '项目状态', + 'description' => '', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'modifier' => [ + 'title' => '修改人', + 'description' => '', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'name' => [ + 'title' => '项目名称', + 'description' => '', + 'type' => 'string', + 'example' => 'demo示例项目', + ], + 'organizationIdentifier' => [ + 'title' => '企业id', + 'description' => '', + 'type' => 'string', + 'example' => '5e70xxxxxxcd000xxxxe96', + ], + 'scope' => [ + 'title' => '可见范围', + 'description' => '', + 'type' => 'string', + 'example' => 'public', + ], + 'statusIdentifier' => [ + 'title' => '状态id', + 'description' => '', + 'type' => 'string', + 'example' => '8a40xxxxxxxxxxxxx64', + ], + 'statusStageIdentifier' => [ + 'title' => '状态阶段', + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'typeIdentifier' => [ + 'title' => '空间小类id', + 'description' => '', + 'type' => 'string', + 'example' => 'CustomProject', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"project\\": {\\n \\"categoryIdentifier\\": \\"Project\\",\\n \\"creator\\": \\"19xx7043xxxxxxx914\\",\\n \\"customCode\\": \\"OJAY\\",\\n \\"description\\": \\"该项目用来跟进测试需求。\\",\\n \\"gmtCreate\\": 1623916393000,\\n \\"gmtModified\\": 1623916393000,\\n \\"icon\\": \\"https://xxxxxx.png\\",\\n \\"identifier\\": \\"e8bxxxxxxxxxxxxxxxx23\\",\\n \\"logicalStatus\\": \\"NORMAL\\",\\n \\"modifier\\": \\"19xx7043xxxxxxx914\\",\\n \\"name\\": \\"demo示例项目\\",\\n \\"organizationIdentifier\\": \\"5e70xxxxxxcd000xxxxe96\\",\\n \\"scope\\": \\"public\\",\\n \\"statusIdentifier\\": \\"8a40xxxxxxxxxxxxx64\\",\\n \\"statusStageIdentifier\\": \\"1\\",\\n \\"typeIdentifier\\": \\"CustomProject\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + ], + 'CreateSprint' => [ + 'summary' => '创建迭代', + 'path' => '/organization/{organizationId}/sprints/create', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [], + 'produces' => [], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '迭代名', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'xxx', + ], + 'spaceIdentifier' => [ + 'title' => '项目id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'asd345xxxxx9q9845xxxxx34', + ], + 'startDate' => [ + 'title' => '开始时间', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2021-12-01', + ], + 'endDate' => [ + 'title' => '结束时间', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2021-12-02', + ], + 'staffIds' => [ + 'title' => '负责人列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '19xx7043xxxxxxx914', + ], + 'required' => true, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMsg' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => 'error', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'title' => 'true或者false', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'sprint' => [ + 'title' => '迭代信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'creator' => [ + 'title' => '创建人id', + 'description' => '', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'description' => [ + 'title' => '描述信息', + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + 'gmtCreate' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1623916393000', + ], + 'gmtModified' => [ + 'title' => '修改时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1623916393000', + ], + 'endDate' => [ + 'title' => '结束时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1623916393000', + ], + 'startDate' => [ + 'title' => '开始时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1638403200000', + ], + 'identifier' => [ + 'title' => '迭代唯一标识符', + 'description' => '', + 'type' => 'string', + 'example' => 'e8bxxxxxxxxxxxxxxxx23', + ], + 'modifier' => [ + 'title' => '修改人', + 'description' => '', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'name' => [ + 'title' => '迭代名称', + 'description' => '', + 'type' => 'string', + 'example' => 'demo示例项目', + ], + 'spaceIdentifier' => [ + 'title' => '项目id', + 'description' => '', + 'type' => 'string', + 'example' => '5e70xxxxxxcd000xxxxe96', + ], + 'scope' => [ + 'title' => '可见范围', + 'description' => '', + 'type' => 'string', + 'example' => 'public', + ], + 'status' => [ + 'title' => '状态', + 'description' => '', + 'type' => 'string', + 'example' => 'TODO', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"sprint\\": {\\n \\"creator\\": \\"19xx7043xxxxxxx914\\",\\n \\"description\\": \\"xxx\\",\\n \\"gmtCreate\\": 1623916393000,\\n \\"gmtModified\\": 1623916393000,\\n \\"endDate\\": 1623916393000,\\n \\"startDate\\": 1638403200000,\\n \\"identifier\\": \\"e8bxxxxxxxxxxxxxxxx23\\",\\n \\"modifier\\": \\"19xx7043xxxxxxx914\\",\\n \\"name\\": \\"demo示例项目\\",\\n \\"spaceIdentifier\\": \\"5e70xxxxxxcd000xxxxe96\\",\\n \\"scope\\": \\"public\\",\\n \\"status\\": \\"TODO\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + ], + 'DeleteProject' => [ + 'summary' => '删除项目', + 'path' => '/organization/{organizationId}/projects/delete', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'identifier', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '7fb72727f32143574f7a...', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '接口返回数据', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMsg' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => 'error', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'title' => 'true或者false', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'title' => 'true或者false', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"result\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + ], + 'UpdateProjectMember' => [ + 'summary' => '添加项目成员', + 'path' => '/organization/{organizationId}/projects/{projectId}/updateMember', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'roleIdentifier' => [ + 'title' => '角色id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'project.admin', + ], + 'userIdentifier' => [ + 'title' => '用户id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '19xx7043xxxxxxx914', + ], + 'userType' => [ + 'title' => '用户类型', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'user', + ], + 'targetType' => [ + 'title' => '资源类型', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'Space', + ], + 'targetIdentifier' => [ + 'title' => '资源id，也就是项目id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5e70xxxxxxcd000xxxxe96', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'title' => '项目id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5e70xxxxxxcd000xxxxe96', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMsg' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => 'error', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'title' => 'true或者false', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'member' => [ + 'title' => '成员信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => 'id', + 'description' => '', + 'type' => 'string', + 'example' => '1124382', + ], + 'roleIdentifier' => [ + 'title' => '角色id', + 'description' => '', + 'type' => 'string', + 'example' => 'project.admin', + ], + 'userIdentifier' => [ + 'title' => '用户id', + 'description' => '', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'userType' => [ + 'title' => '用户类型', + 'description' => '', + 'type' => 'string', + 'example' => 'user', + ], + 'targetType' => [ + 'title' => '资源类型', + 'description' => '', + 'type' => 'string', + 'example' => 'Space', + ], + 'gmtCreate' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1623916393000', + ], + 'gmtModified' => [ + 'title' => '修改时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1623916393000', + ], + 'targetIdentifier' => [ + 'title' => '资源id，也就是项目id', + 'description' => '', + 'type' => 'string', + 'example' => '5e70xxxxxxcd000xxxxe96', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"member\\": {\\n \\"id\\": \\"1124382\\",\\n \\"roleIdentifier\\": \\"project.admin\\",\\n \\"userIdentifier\\": \\"19xx7043xxxxxxx914\\",\\n \\"userType\\": \\"user\\",\\n \\"targetType\\": \\"Space\\",\\n \\"gmtCreate\\": 1623916393000,\\n \\"gmtModified\\": 1623916393000,\\n \\"targetIdentifier\\": \\"5e70xxxxxxcd000xxxxe96\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<UpdateProjectMemberResponse>\\n <success>true</success>\\n <member>\\n <gmtModified>1645685457013</gmtModified>\\n <targetIdentifier>9dc9799adc31f7725462......</targetIdentifier>\\n <roleIdentifier>project.admin</roleIdentifier>\\n <userIdentifier>1967043931......</userIdentifier>\\n <targetType>Space</targetType>\\n <id>3964010</id>\\n <userType>user</userType>\\n <gmtCreate>1645685457013</gmtCreate>\\n </member>\\n <errorCode/>\\n <errorMsg/>\\n</UpdateProjectMemberResponse>","errorExample":""}]', + ], + 'UpdateProjectField' => [ + 'summary' => '更新项目属性与字段', + 'path' => '/organization/{organizationId}/project/{identifier}', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'identifier', + 'in' => 'path', + 'schema' => [ + 'title' => '更新项目的唯一标识，项目id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'deafe5f33xxxxx6a259d8dafd', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'updateBasicFieldRequestList' => [ + 'title' => '更新项目基础字段列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '更新项目基本字段对象，由属性key与属性value构成', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'propertyKey' => [ + 'title' => '基础属性key', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'scope' => 'scope', + 'name' => 'name', + 'description' => 'description', + 'customCode' => 'customCode', + ], + 'example' => 'name', + ], + 'propertyValue' => [ + 'title' => '基础属性value'."\n", + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'updateForOpenApiList' => [ + 'title' => '更新项目自定义字段列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '更新项目自定义字段对象', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'fieldIdentifier' => [ + 'title' => '自定义字段id', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'c4fd21xxxxxxxx9oj8jk', + ], + 'value' => [ + 'title' => '自定义字段value', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'statusIdentifier' => [ + 'title' => '更新后项目状态id', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'fdsaadsfasxxxxdddd', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => 'errormessage', + ], + 'success' => [ + 'title' => 'true/false', + 'description' => 'true/false', + 'type' => 'boolean', + 'example' => 'True', + ], + 'project' => [ + 'title' => '项目信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'category' => [ + 'title' => '空间大类', + 'description' => '', + 'type' => 'string', + 'example' => 'Project', + ], + 'categoryIdentifier' => [ + 'title' => '空间大类id，项目的值都是Project', + 'description' => '', + 'type' => 'string', + 'example' => 'Project', + ], + 'creator' => [ + 'title' => '创建人阿里云accountId', + 'description' => '', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'customCode' => [ + 'title' => '自定义编号，企业下唯一', + 'description' => '', + 'type' => 'string', + 'example' => 'OJAY', + ], + 'description' => [ + 'title' => '描述信息', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'gmtCreate' => [ + 'title' => '创建时间的时间戳，单位毫秒', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1623916393000', + ], + 'gmtModified' => [ + 'title' => '修改时间的时间戳，单位毫秒', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1684134690000', + ], + 'iconGroup' => [ + 'title' => '图标组，json格式字符串', + 'description' => '', + 'type' => 'string', + 'example' => '{"small":"https://xxxxxx.png","big":"https://img.yyyyyy.png"}', + ], + 'icon' => [ + 'title' => '图标', + 'description' => '', + 'type' => 'string', + 'example' => 'https://xxxxxx.png', + ], + 'iconBig' => [ + 'title' => '大图标', + 'description' => '', + 'type' => 'string', + 'example' => 'https://xxxxxx.png', + ], + 'iconSmall' => [ + 'title' => '小图标', + 'description' => '', + 'type' => 'string', + 'example' => 'https://img.yyyyyy.png', + ], + 'id' => [ + 'title' => '项目id', + 'description' => '', + 'type' => 'string', + 'example' => '66893', + ], + 'identifier' => [ + 'title' => '项目唯一标识符', + 'description' => '', + 'type' => 'string', + 'example' => '1e2ea73d24652d5874d001b351', + ], + 'identifierPath' => [ + 'title' => '空间路径', + 'description' => '', + 'type' => 'string', + 'example' => 'e8b2xxxxxx2abdxxxxxxxx23', + ], + 'logicalStatus' => [ + 'title' => '项目状态', + 'description' => '', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'modifier' => [ + 'title' => '修改人阿里云accountId', + 'description' => '', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'name' => [ + 'title' => '项目名称', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'organizationIdentifier' => [ + 'title' => '企业id', + 'description' => '', + 'type' => 'string', + 'example' => '5e70xxxxxxcd000xxxxe96', + ], + 'parentIdentifier' => [ + 'title' => '父项目id', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'scope' => [ + 'title' => '可见范围', + 'description' => '', + 'type' => 'string', + 'example' => 'public', + ], + 'statusIdentifier' => [ + 'title' => '状态id', + 'description' => '', + 'type' => 'string', + 'example' => '8a40xxxxxxxxxxxxx64', + ], + 'statusStageIdentifier' => [ + 'title' => '状态阶段id，项目状态默认有未开始、进行中、已完成，该字段为状态具体的id。', + 'description' => '', + 'type' => 'string', + 'example' => '8a4058a71159b68254......', + ], + 'subType' => [ + 'title' => ' '."\n" + .'空间小类', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'typeIdentifier' => [ + 'title' => '空间小类id，该字段已废弃', + 'description' => '', + 'type' => 'string', + 'example' => 'CustomProject', + ], + 'statusName' => [ + 'title' => '状态名称', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'fieldList' => [ + 'title' => '字段列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '字段对象', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'identifier' => [ + 'title' => '字段id', + 'description' => '', + 'type' => 'string', + 'example' => 'b787ff504c0b36f8b71d15a4fd', + ], + 'displayName' => [ + 'title' => '展示名称', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'valueType' => [ + 'title' => '字段类型', + 'description' => '', + 'type' => 'string', + 'example' => 'user', + ], + 'value' => [ + 'title' => '字段值', + 'description' => '', + 'type' => 'string', + 'example' => 'ace3wxxxxxxx7rff3ee', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"errorMessage\\": \\"errormessage\\",\\n \\"success\\": true,\\n \\"project\\": {\\n \\"category\\": \\"Project\\",\\n \\"categoryIdentifier\\": \\"Project\\",\\n \\"creator\\": \\"19xx7043xxxxxxx914\\",\\n \\"customCode\\": \\"OJAY\\",\\n \\"description\\": \\"api测试-创建\\",\\n \\"gmtCreate\\": 1623916393000,\\n \\"gmtModified\\": 1684134690000,\\n \\"iconGroup\\": \\"{\\\\\\"small\\\\\\":\\\\\\"https://xxxxxx.png\\\\\\",\\\\\\"big\\\\\\":\\\\\\"https://img.yyyyyy.png\\\\\\"}\\",\\n \\"icon\\": \\"https://xxxxxx.png\\",\\n \\"iconBig\\": \\"https://xxxxxx.png\\",\\n \\"iconSmall\\": \\"https://img.yyyyyy.png\\",\\n \\"id\\": \\"66893\\",\\n \\"identifier\\": \\"1e2ea73d24652d5874d001b351\\",\\n \\"identifierPath\\": \\"e8b2xxxxxx2abdxxxxxxxx23\\",\\n \\"logicalStatus\\": \\"NORMAL\\",\\n \\"modifier\\": \\"19xx7043xxxxxxx914\\",\\n \\"name\\": \\"demo示例项目\\",\\n \\"organizationIdentifier\\": \\"5e70xxxxxxcd000xxxxe96\\",\\n \\"parentIdentifier\\": \\"null\\",\\n \\"scope\\": \\"public\\",\\n \\"statusIdentifier\\": \\"8a40xxxxxxxxxxxxx64\\",\\n \\"statusStageIdentifier\\": \\"8a4058a71159b68254......\\",\\n \\"subType\\": \\"null\\",\\n \\"typeIdentifier\\": \\"CustomProject\\",\\n \\"statusName\\": \\"进行中\\",\\n \\"fieldList\\": [\\n {\\n \\"identifier\\": \\"b787ff504c0b36f8b71d15a4fd\\",\\n \\"displayName\\": \\"进行时\\",\\n \\"valueType\\": \\"user\\",\\n \\"value\\": \\"ace3wxxxxxxx7rff3ee\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'GetProjectInfo' => [ + 'summary' => '根据id获取项目详情-Projex', + 'path' => '/organization/{organizationId}/project/{projectId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'title' => '项目id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'e8b2xxxxxxx09b07d23', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'error', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'project' => [ + 'title' => '项目信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'category' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'categoryIdentifier' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Project', + ], + 'creator' => [ + 'description' => '', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'customCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OJAY', + ], + 'description' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + 'gmtCreate' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1623916393000', + ], + 'gmtModified' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1623916393000', + ], + 'iconGroup' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{"small":"https://xxxxxx.png","big":"https://img.yyyyyy.png"}', + ], + 'icon' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://xxxxxx.png', + ], + 'iconBig' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://xxxxxx.png', + ], + 'iconSmall' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://img.yyyyyy.png', + ], + 'id' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'identifier' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'e8bxxxxxxxxxxxxxxxx23', + ], + 'identifierPath' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'e8b2xxxxxx2abdxxxxxxxx23', + ], + 'logicalStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'modifier' => [ + 'description' => '', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'organizationIdentifier' => [ + 'description' => '', + 'type' => 'string', + 'example' => '5e70xxxxxxcd000xxxxe96', + ], + 'parentIdentifier' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'scope' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'public', + ], + 'statusIdentifier' => [ + 'description' => '', + 'type' => 'string', + 'example' => '8a40xxxxxxxxxxxxx64', + ], + 'statusStageIdentifier' => [ + 'description' => '', + 'type' => 'string', + 'example' => '8a4058a71159b68254......', + ], + 'subType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'typeIdentifier' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CustomProject', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"errorMessage\\": \\"error\\",\\n \\"success\\": true,\\n \\"project\\": {\\n \\"category\\": \\"null\\",\\n \\"categoryIdentifier\\": \\"Project\\",\\n \\"creator\\": \\"19xx7043xxxxxxx914\\",\\n \\"customCode\\": \\"OJAY\\",\\n \\"description\\": \\"xxx\\",\\n \\"gmtCreate\\": 1623916393000,\\n \\"gmtModified\\": 1623916393000,\\n \\"iconGroup\\": \\"{\\\\\\"small\\\\\\":\\\\\\"https://xxxxxx.png\\\\\\",\\\\\\"big\\\\\\":\\\\\\"https://img.yyyyyy.png\\\\\\"}\\",\\n \\"icon\\": \\"https://xxxxxx.png\\",\\n \\"iconBig\\": \\"https://xxxxxx.png\\",\\n \\"iconSmall\\": \\"https://img.yyyyyy.png\\",\\n \\"id\\": \\"null\\",\\n \\"identifier\\": \\"e8bxxxxxxxxxxxxxxxx23\\",\\n \\"identifierPath\\": \\"e8b2xxxxxx2abdxxxxxxxx23\\",\\n \\"logicalStatus\\": \\"NORMAL\\",\\n \\"modifier\\": \\"19xx7043xxxxxxx914\\",\\n \\"name\\": \\"demo示例项目\\",\\n \\"organizationIdentifier\\": \\"5e70xxxxxxcd000xxxxe96\\",\\n \\"parentIdentifier\\": \\"null\\",\\n \\"scope\\": \\"public\\",\\n \\"statusIdentifier\\": \\"8a40xxxxxxxxxxxxx64\\",\\n \\"statusStageIdentifier\\": \\"8a4058a71159b68254......\\",\\n \\"subType\\": \\"null\\",\\n \\"typeIdentifier\\": \\"CustomProject\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + ], + 'ListProjectMembers' => [ + 'summary' => '根据项目id获取项目所以成员', + 'path' => '/organization/{organizationId}/projects/{projectId}/listMembers', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'title' => '项目id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'e8bxxxxx2abd6e76aa209b07d23', + ], + ], + [ + 'name' => 'targetType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'Space', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMsg' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => 'error', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'title' => 'true或者false', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'members' => [ + 'title' => 'member信息', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'account' => [ + 'title' => '登陆账号', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'avatar' => [ + 'title' => '用户头像', + 'description' => '', + 'type' => 'string', + 'example' => 'https://xxxxxx.png', + ], + 'dingTalkId' => [ + 'title' => '钉钉id', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'displayName' => [ + 'title' => '展示名', + 'description' => '', + 'type' => 'string', + 'example' => '名称', + ], + 'displayNickName' => [ + 'title' => '展示昵称', + 'description' => '', + 'type' => 'string', + 'example' => 'mingcheng', + ], + 'displayRealName' => [ + 'title' => '展示真名', + 'description' => '', + 'type' => 'string', + 'example' => '名称', + ], + 'division' => [ + 'title' => '部门信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'identifier' => [ + 'title' => '部门唯一标识', + 'description' => '', + 'type' => 'string', + 'example' => '1345xxxxxxx947xxxx', + ], + ], + ], + 'email' => [ + 'title' => '邮箱', + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'gender' => [ + 'title' => '性别', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'identifier' => [ + 'title' => '用户唯一 标识符', + 'description' => '', + 'type' => 'string', + 'example' => '19xxxx31947xxxx', + ], + 'mobile' => [ + 'title' => '手机号', + 'description' => '', + 'type' => 'string', + 'example' => '135xxxxxxxxx', + ], + 'nameEn' => [ + 'title' => '英文名', + 'description' => '', + 'type' => 'string', + 'example' => 'name', + ], + 'nickName' => [ + 'title' => '昵称', + 'description' => '', + 'type' => 'string', + 'example' => '昵称', + ], + 'nickNamePinyin' => [ + 'title' => '昵称拼音', + 'description' => '', + 'type' => 'string', + 'example' => 'nicheng', + ], + 'organizationUserInfo' => [ + 'title' => '企业信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'organizationIdentifier' => [ + 'title' => '企业唯一标识符', + 'description' => '', + 'type' => 'string', + 'example' => '5e7xxxxb3cd3711dd6xxx2c', + ], + ], + ], + 'realName' => [ + 'title' => '真名', + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + 'realNamePinyin' => [ + 'title' => '真名拼音', + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + 'stamp' => [ + 'title' => '用户类型', + 'description' => '', + 'type' => 'string', + 'example' => 'User', + ], + 'tbRoleId' => [ + 'title' => '角色id', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'roleName' => [ + 'title' => '角色名称', + 'description' => '角色名称', + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + [ + [ + 'errorCode' => 'InvaildSpace.NotInCurrentOrganization', + 'errorMessage' => 'space not belong to this organization, please switch organization.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"members\\": [\\n {\\n \\"account\\": \\"null\\",\\n \\"avatar\\": \\"https://xxxxxx.png\\",\\n \\"dingTalkId\\": \\"null\\",\\n \\"displayName\\": \\"名称\\",\\n \\"displayNickName\\": \\"mingcheng\\",\\n \\"displayRealName\\": \\"名称\\",\\n \\"division\\": {\\n \\"identifier\\": \\"1345xxxxxxx947xxxx\\"\\n },\\n \\"email\\": \\"[email protected]\\",\\n \\"gender\\": \\"null\\",\\n \\"identifier\\": \\"19xxxx31947xxxx\\",\\n \\"mobile\\": \\"135xxxxxxxxx\\",\\n \\"nameEn\\": \\"name\\",\\n \\"nickName\\": \\"昵称\\",\\n \\"nickNamePinyin\\": \\"nicheng\\",\\n \\"organizationUserInfo\\": {\\n \\"organizationIdentifier\\": \\"5e7xxxxb3cd3711dd6xxx2c\\"\\n },\\n \\"realName\\": \\"xxx\\",\\n \\"realNamePinyin\\": \\"xxx\\",\\n \\"stamp\\": \\"User\\",\\n \\"tbRoleId\\": \\"null\\",\\n \\"roleName\\": \\"\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListProjectMembersResponse>\\n <requestId>A62F5DDC-B32C-571F-84F1-CBE93D......</requestId>\\n <success>true</success>\\n <members>\\n <division/>\\n <identifier>1967043931......</identifier>\\n <realName>云效助手</realName>\\n <organizationUserInfo/>\\n <displayName>云效助手</displayName>\\n <nickName>云效助手</nickName>\\n <avatar>https://tcs-devops.aliyuncs.com/thumbnail/112fcefd06c528b47117112402e55f....../w/100/h/100</avatar>\\n </members>\\n <errorCode/>\\n <errorMsg/>\\n</ListProjectMembersResponse>","errorExample":""}]', + ], + 'GetSprintInfo' => [ + 'summary' => '获取迭代详情', + 'path' => '/organization/{organizationId}/sprints/{sprintId}/getSprintinfo', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'sprintId', + 'in' => 'path', + 'schema' => [ + 'title' => '迭代id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'd061ca90d47a0b7cd4d2...', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'error', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'sprint' => [ + 'title' => '迭代信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'creator' => [ + 'title' => '创建人id', + 'description' => '', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'description' => [ + 'title' => '描述信息', + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + 'gmtCreate' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1623916393000', + ], + 'gmtModified' => [ + 'title' => '修改时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1623916393000', + ], + 'endDate' => [ + 'title' => '结束时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1623916393000', + ], + 'startDate' => [ + 'title' => '开始时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1638403200000', + ], + 'identifier' => [ + 'title' => '迭代唯一标识符', + 'description' => '', + 'type' => 'string', + 'example' => 'e8bxxxxxxxxxxxxxxxx23', + ], + 'modifier' => [ + 'title' => '修改人', + 'description' => '', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'name' => [ + 'title' => '迭代名称', + 'description' => '', + 'type' => 'string', + 'example' => 'demo示例项目', + ], + 'spaceIdentifier' => [ + 'title' => '项目id', + 'description' => '', + 'type' => 'string', + 'example' => '5e70xxxxxxcd000xxxxe96', + ], + 'scope' => [ + 'title' => '可见范围', + 'description' => '', + 'type' => 'string', + 'example' => 'public', + ], + 'status' => [ + 'title' => '状态', + 'description' => '', + 'type' => 'string', + 'example' => 'Todo', + ], + 'owners' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"errorMessage\\": \\"error\\",\\n \\"success\\": true,\\n \\"sprint\\": {\\n \\"creator\\": \\"19xx7043xxxxxxx914\\",\\n \\"description\\": \\"迭代详细描述\\",\\n \\"gmtCreate\\": 1623916393000,\\n \\"gmtModified\\": 1623916393000,\\n \\"endDate\\": 1623916393000,\\n \\"startDate\\": 1638403200000,\\n \\"identifier\\": \\"e8bxxxxxxxxxxxxxxxx23\\",\\n \\"modifier\\": \\"19xx7043xxxxxxx914\\",\\n \\"name\\": \\"demo示例项目\\",\\n \\"spaceIdentifier\\": \\"5e70xxxxxxcd000xxxxe96\\",\\n \\"scope\\": \\"public\\",\\n \\"status\\": \\"Todo\\",\\n \\"owners\\": [\\n \\"19xx7043xxxxxxx914\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetSprintInfoResponse>\\n <requestId>C79CF3C1-E25F-13BB-99C2-687E14...</requestId>\\n <success>true</success>\\n <sprint>\\n <identifier>4c0974066a1c9f88a91d...</identifier>\\n <gmtModified>1642409799000</gmtModified>\\n <name>000013</name>\\n <spaceIdentifier>7fb72727f32143574f7a...</spaceIdentifier>\\n <gmtCreate>1642409799000</gmtCreate>\\n <startDate>1638403200000</startDate>\\n <status>TODO</status>\\n </sprint>\\n <errorMessage/>\\n <errorCode/>\\n</GetSprintInfoResponse>","errorExample":""}]', + ], + 'ListProjects' => [ + 'summary' => '获取项目列表', + 'path' => '/organization/{organizationId}/listProjects', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'extraConditions', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'conditions', + 'in' => 'query', + 'schema' => [ + 'description' => '{"conditionGroups":[[]]}', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'category', + 'in' => 'query', + 'schema' => [ + 'title' => '项目类型', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'Project', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'title' => '分页中的起始序列', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '""', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'title' => '每页最大返回数量，0-200，默认值20', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'scope', + 'in' => 'query', + 'schema' => [ + 'title' => '公开类型', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'public', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'totalCount' => [ + 'title' => '总数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'nextToken' => [ + 'title' => '分页Token，没有下一页则为空', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'maxResults' => [ + 'title' => '每页数量', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMsg' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => 'error', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'title' => 'true或者false', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'projects' => [ + 'title' => '项目信息', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'creator' => [ + 'title' => '创建人', + 'description' => '', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'customCode' => [ + 'title' => '自定义编号', + 'description' => '', + 'type' => 'string', + 'example' => 'OJAY', + ], + 'deleteTime' => [ + 'title' => '删除时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'null', + ], + 'description' => [ + 'title' => '描述信息', + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + 'gmtCreate' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1640778694000', + ], + 'icon' => [ + 'title' => '项目封面', + 'description' => '', + 'type' => 'string', + 'example' => 'https://xxxxxx.png', + ], + 'identifier' => [ + 'title' => '项目唯一标识符', + 'description' => '', + 'type' => 'string', + 'example' => 'e8bxxxxxxxxxxxxxxxx23', + ], + 'name' => [ + 'title' => '项目名称', + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'scope' => [ + 'title' => '公开还是私有', + 'description' => '', + 'type' => 'string', + 'example' => 'public', + ], + 'typeIdentifier' => [ + 'title' => '类型id', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'statusStageIdentifier' => [ + 'title' => '状态阶段', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'logicalStatus' => [ + 'title' => '逻辑状态', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'categoryIdentifier' => [ + 'title' => '类型', + 'description' => '', + 'type' => 'string', + 'example' => 'Project', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"totalCount\\": 10,\\n \\"nextToken\\": \\"\\\\\\"\\\\\\"\\",\\n \\"maxResults\\": 20,\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"projects\\": [\\n {\\n \\"creator\\": \\"19xx7043xxxxxxx914\\",\\n \\"customCode\\": \\"OJAY\\",\\n \\"deleteTime\\": 0,\\n \\"description\\": \\"xxx\\",\\n \\"gmtCreate\\": 1640778694000,\\n \\"icon\\": \\"https://xxxxxx.png\\",\\n \\"identifier\\": \\"e8bxxxxxxxxxxxxxxxx23\\",\\n \\"name\\": \\"xxxx\\",\\n \\"scope\\": \\"public\\",\\n \\"typeIdentifier\\": \\"null\\",\\n \\"statusStageIdentifier\\": \\"null\\",\\n \\"logicalStatus\\": \\"null\\",\\n \\"categoryIdentifier\\": \\"Project\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListProjectsResponse>\\n <projects>\\n <identifier>9dc9799adc31f7725462......</identifier>\\n <creator>1811837656......</creator>\\n <scope>public</scope>\\n <icon>https://img.alicdn.com/imgextra/i1/O1CN01TcSBKH1k0vIWjGzXg_!!6000000......-2-tps-96-96.png</icon>\\n <name>测试项目</name>\\n <description/>\\n <gmtCreate>1645671160000</gmtCreate>\\n <categoryIdentifier>Project</categoryIdentifier>\\n <customCode>YKYK</customCode>\\n </projects>\\n <projects>\\n <identifier>be0e5269fce1cfe271a4......</identifier>\\n <creator>1967043931......</creator>\\n <scope>public</scope>\\n <name>12345690</name>\\n <gmtCreate>1645669608000</gmtCreate>\\n <categoryIdentifier>Project</categoryIdentifier>\\n <customCode>ASDFO</customCode>\\n </projects>\\n <nextToken>94239cc6cad0b0a23fc4......</nextToken>\\n <maxResults>20</maxResults>\\n <requestId>6592ADB6-A4B5-5BEB-82A1-C649BD......</requestId>\\n <success>true</success>\\n <errorCode/>\\n <totalCount>116</totalCount>\\n <errorMsg/>\\n</ListProjectsResponse>","errorExample":""}]', + ], + 'ListProjectTemplates' => [ + 'summary' => '获取项目模板列表', + 'path' => '/organization/{organizationId}/projects/listTemplates', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'category', + 'in' => 'query', + 'schema' => [ + 'title' => '模板类型', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'Project', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMsg' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => 'error', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'title' => 'true或者false', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'templates' => [ + 'title' => '项目模板信息', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'creator' => [ + 'title' => '创建人id', + 'description' => '', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'description' => [ + 'title' => '描述信息', + 'description' => '', + 'type' => 'string', + 'example' => '迭代的具体信息', + ], + 'gmtCreate' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1623916393000', + ], + 'gmtModified' => [ + 'title' => '修改时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1623916393000', + ], + 'type' => [ + 'title' => '模板类型 0-system/4-custom/16-instance', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + ], + 'icon' => [ + 'title' => '模板封面', + 'description' => '', + 'type' => 'string', + 'example' => 'https://img.xxxx.png', + ], + 'identifier' => [ + 'title' => '模板唯一标识符', + 'description' => '', + 'type' => 'string', + 'example' => 'e8bxxxxxxxxxxxxxxxx23', + ], + 'modifier' => [ + 'title' => '修改人', + 'description' => '', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'name' => [ + 'title' => '模板名称', + 'description' => '', + 'type' => 'string', + 'example' => '专用模板', + ], + 'nameEn' => [ + 'title' => '模板英文名称', + 'description' => '', + 'type' => 'string', + 'example' => 'Test Template', + ], + 'resourceCategory' => [ + 'title' => '所属资源类型', + 'description' => '', + 'type' => 'string', + 'example' => 'Project', + ], + 'copyFrom' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'resourceType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'spaceIdentifier' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'spaceType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"templates\\": [\\n {\\n \\"creator\\": \\"19xx7043xxxxxxx914\\",\\n \\"description\\": \\"迭代的具体信息\\",\\n \\"gmtCreate\\": 1623916393000,\\n \\"gmtModified\\": 1623916393000,\\n \\"type\\": 4,\\n \\"icon\\": \\"https://img.xxxx.png\\",\\n \\"identifier\\": \\"e8bxxxxxxxxxxxxxxxx23\\",\\n \\"modifier\\": \\"19xx7043xxxxxxx914\\",\\n \\"name\\": \\"专用模板\\",\\n \\"nameEn\\": \\"Test Template\\",\\n \\"resourceCategory\\": \\"Project\\",\\n \\"copyFrom\\": \\"null\\",\\n \\"resourceType\\": \\"null\\",\\n \\"spaceIdentifier\\": \\"null\\",\\n \\"spaceType\\": \\"null\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + ], + 'ListSprints' => [ + 'summary' => '获取迭代列表', + 'path' => '/organization/{organizationId}/sprints/list', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'spaceIdentifier', + 'in' => 'query', + 'schema' => [ + 'title' => '项目id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'e8bxxxxxxxxxxxxxxxx23', + ], + ], + [ + 'name' => 'spaceType', + 'in' => 'query', + 'schema' => [ + 'title' => '类型', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'Project', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'title' => '分页中的起始序列', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '""', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'title' => '每页最大返回数量，0-200，默认值20', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'totalCount' => [ + 'title' => '总数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'nextToken' => [ + 'title' => '分页Token，没有下一页则为空', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'maxResults' => [ + 'title' => '每页数量', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMsg' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => 'error', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'title' => 'true或者false', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'sprints' => [ + 'title' => '迭代信息', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'creator' => [ + 'title' => '创建人id', + 'description' => '', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'description' => [ + 'title' => '描述信息', + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + 'gmtCreate' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1623916393000', + ], + 'gmtModified' => [ + 'title' => '修改时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1623916393000', + ], + 'endDate' => [ + 'title' => '结束时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1623916393000', + ], + 'startDate' => [ + 'title' => '开始时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1638403200000', + ], + 'identifier' => [ + 'title' => '迭代唯一标识符', + 'description' => '', + 'type' => 'string', + 'example' => 'e8bxxxxxxxxxxxxxxxx23', + ], + 'modifier' => [ + 'title' => '修改人', + 'description' => '', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'name' => [ + 'title' => '迭代名称', + 'description' => '', + 'type' => 'string', + 'example' => 'demo示例项目', + ], + 'spaceIdentifier' => [ + 'title' => '项目id', + 'description' => '', + 'type' => 'string', + 'example' => '5e70xxxxxxcd000xxxxe96', + ], + 'scope' => [ + 'title' => '可见范围', + 'description' => '', + 'type' => 'string', + 'example' => 'public', + ], + 'status' => [ + 'title' => '状态，未开始:Todo, 进行中:Doing, 已完成:Done', + 'description' => '', + 'type' => 'string', + 'example' => 'TODO', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"totalCount\\": 10,\\n \\"nextToken\\": \\"\\\\\\"\\\\\\"\\",\\n \\"maxResults\\": 20,\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"sprints\\": [\\n {\\n \\"creator\\": \\"19xx7043xxxxxxx914\\",\\n \\"description\\": \\"xxx\\",\\n \\"gmtCreate\\": 1623916393000,\\n \\"gmtModified\\": 1623916393000,\\n \\"endDate\\": 1623916393000,\\n \\"startDate\\": 1638403200000,\\n \\"identifier\\": \\"e8bxxxxxxxxxxxxxxxx23\\",\\n \\"modifier\\": \\"19xx7043xxxxxxx914\\",\\n \\"name\\": \\"demo示例项目\\",\\n \\"spaceIdentifier\\": \\"5e70xxxxxxcd000xxxxe96\\",\\n \\"scope\\": \\"public\\",\\n \\"status\\": \\"TODO\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + ], + 'CreateTestCase' => [ + 'summary' => '创建测试用例', + 'path' => '/organization/{organizationId}/testhub/testcase', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'subject' => [ + 'title' => '测试用例标题', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + 'assignedTo' => [ + 'title' => '负责人id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '19xxxx31947xxxx', + ], + 'spaceIdentifier' => [ + 'title' => '用例库id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'asd345xxxxx9q9845xxxxx34', + ], + 'directoryIdentifier' => [ + 'title' => '目录id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'fdd395xxxxx9q9845xxxxx23'."\n", + ], + 'priority' => [ + 'title' => '用例优先级', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ik3dexxxxxfdfds1xxxxx23', + ], + 'tags' => [ + 'title' => '标签id数组', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'opwxsxxxxxf5434xxxxx12', + ], + 'required' => false, + ], + 'fieldValueList' => [ + 'title' => '自定义字段列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'fieldIdentifier' => [ + 'title' => '字段id', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '6aexxxxxa1d98c09c60xxxx16', + ], + 'value' => [ + 'title' => '字段值', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '77c7fb03c4186c8691d6...', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'testcaseStepContentInfo' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'precondition' => [ + 'title' => '前置条件', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'stepType' => [ + 'title' => '测试步骤格式，只有表格和文本两种形式', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'TABLE' => 'TABLE', + 'TEXT' => 'TEXT', + ], + 'example' => 'TEXT', + 'enum' => [ + 'TEXT', + 'TABLE', + ], + ], + 'stepResultList' => [ + 'title' => '测试用例步骤与内容，如果该内容为文本形式，则stepResultList只会取第一组值，并且可以给步骤内容和预期结果设置格式；如果该内容为表格形式，则会取到每一组步骤和内容值，但是无法设置步骤内容和预期结果的格式。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'step' => [ + 'title' => '测试步骤', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'expected' => [ + 'title' => '测试内容', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '18E50717-93A4-53BC-A30D-963F742A1CE6', + ], + 'errorMsg' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => 'error', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'testcase' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'identifier' => [ + 'title' => '测试用例id', + 'description' => '', + 'type' => 'string', + 'example' => '5a73f81c834d013361d92bdcce', + ], + 'subject' => [ + 'title' => '标题', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'assignedTo' => [ + 'title' => '负责人信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'assignIdentifier' => [ + 'title' => '用户Id', + 'description' => '', + 'type' => 'string', + 'example' => '134xxx343xxxxx', + ], + 'name' => [ + 'title' => '用户名称', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'tbRoleId' => [ + 'title' => '人员角色id', + 'description' => '', + 'type' => 'string', + 'example' => '3c2253c22xxxxxxxx53a', + ], + ], + ], + 'spaceIdentifier' => [ + 'title' => '用例库id', + 'description' => '', + 'type' => 'string', + 'example' => 'a18571eba8fe9267cd8375fc06', + ], + 'spaceType' => [ + 'title' => '空间类型，为TestRepo', + 'description' => '', + 'type' => 'string', + 'example' => 'TestRepo'."\n" + ."\n", + ], + 'categoryIdentifier' => [ + 'title' => '工作项类型id，一般为TestCase', + 'description' => '', + 'type' => 'string', + 'example' => 'TestCase'."\n" + ."\n", + ], + 'creator' => [ + 'title' => '创建人', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'createIdentifier' => [ + 'title' => '创建者id', + 'description' => '', + 'type' => 'string', + 'example' => '134xxx343xxxxx', + ], + 'name' => [ + 'title' => '创建者名称', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + 'modifier' => [ + 'title' => '修改人', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'modifyIdentifier' => [ + 'title' => '修改者id', + 'description' => '', + 'type' => 'string', + 'example' => '134xxx343xxxxx', + ], + 'name' => [ + 'title' => '修改者名称', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + 'directory' => [ + 'title' => '目录信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'directoryIdentifier' => [ + 'title' => '目录id', + 'description' => '', + 'type' => 'string', + 'example' => '0bc1150dcxxxxxxxx04c', + ], + 'name' => [ + 'title' => '目录名称', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'pathName' => [ + 'title' => '用例完整目录名', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + 'childIdentifier' => [ + 'title' => '子目录id', + 'description' => '', + 'type' => 'string', + 'example' => '0bc1150dcxxxxxxxx04c', + ], + ], + ], + 'detailInfo' => [ + 'title' => '用例详细信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'stepType' => [ + 'title' => '步骤类型', + 'description' => '', + 'type' => 'string', + 'example' => 'TEXT/TABLE', + ], + 'precondition' => [ + 'title' => '前置条件对象', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'preIdentifier' => [ + 'title' => '前置条件id', + 'description' => '', + 'type' => 'string', + 'example' => '59253164xxxxxxf2e98dbc7e27', + ], + 'preContent' => [ + 'title' => '前置条件内容', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'preContentType' => [ + 'title' => '前置条件格式', + 'description' => '', + 'type' => 'string', + 'example' => 'RICHTEXT', + ], + ], + ], + 'stepContent' => [ + 'title' => '测试步骤对象', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'stepIdentifier' => [ + 'title' => '测试步骤id', + 'description' => '', + 'type' => 'string', + 'example' => '59253164xxxxxxf2e98dbc7e27', + ], + 'stepContent' => [ + 'title' => '测试步骤内容', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'stepContentType' => [ + 'title' => '测试步骤格式', + 'description' => '', + 'type' => 'string', + 'example' => 'RICHTEXT', + ], + ], + ], + 'expectedResult' => [ + 'title' => '测试步骤对象', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'expectIdentifier' => [ + 'title' => '预期结果id', + 'description' => '', + 'type' => 'string', + 'example' => '59253164xxxxxxf2e98dbc7e27', + ], + 'expectContent' => [ + 'title' => '预期结果内容', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'expectContentType' => [ + 'title' => '预期结果格式', + 'description' => '', + 'type' => 'string', + 'example' => 'RICHTEXT', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"18E50717-93A4-53BC-A30D-963F742A1CE6\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"testcase\\": {\\n \\"identifier\\": \\"5a73f81c834d013361d92bdcce\\",\\n \\"subject\\": \\"标题\\",\\n \\"assignedTo\\": {\\n \\"assignIdentifier\\": \\"134xxx343xxxxx\\",\\n \\"name\\": \\"人员名称\\",\\n \\"tbRoleId\\": \\"3c2253c22xxxxxxxx53a\\"\\n },\\n \\"spaceIdentifier\\": \\"a18571eba8fe9267cd8375fc06\\",\\n \\"spaceType\\": \\"TestRepo\\\\n\\\\n\\",\\n \\"categoryIdentifier\\": \\"TestCase\\\\n\\\\n\\",\\n \\"creator\\": {\\n \\"createIdentifier\\": \\"134xxx343xxxxx\\",\\n \\"name\\": \\"人员名称\\"\\n },\\n \\"modifier\\": {\\n \\"modifyIdentifier\\": \\"134xxx343xxxxx\\",\\n \\"name\\": \\"人员名称\\"\\n },\\n \\"directory\\": {\\n \\"directoryIdentifier\\": \\"0bc1150dcxxxxxxxx04c\\",\\n \\"name\\": \\"全部目录\\",\\n \\"pathName\\": [\\n \\"[一级目录，二级目录]\\"\\n ],\\n \\"childIdentifier\\": \\"0bc1150dcxxxxxxxx04c\\"\\n },\\n \\"detailInfo\\": {\\n \\"stepType\\": \\"TEXT/TABLE\\",\\n \\"precondition\\": {\\n \\"preIdentifier\\": \\"59253164xxxxxxf2e98dbc7e27\\",\\n \\"preContent\\": \\"前置条件内容\\",\\n \\"preContentType\\": \\"RICHTEXT\\"\\n },\\n \\"stepContent\\": {\\n \\"stepIdentifier\\": \\"59253164xxxxxxf2e98dbc7e27\\",\\n \\"stepContent\\": \\"测试步骤内容\\",\\n \\"stepContentType\\": \\"RICHTEXT\\"\\n },\\n \\"expectedResult\\": {\\n \\"expectIdentifier\\": \\"59253164xxxxxxf2e98dbc7e27\\",\\n \\"expectContent\\": \\"预期结果\\",\\n \\"expectContentType\\": \\"RICHTEXT\\"\\n }\\n }\\n }\\n}","type":"json"}]', + ], + 'UpdateTestCase' => [ + 'summary' => '更新测试用例字段', + 'path' => '/organization/{organizationId}/testhub/testcase/{testcaseIdentifier}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'testcaseIdentifier', + 'in' => 'path', + 'schema' => [ + 'title' => '测试用例id，测试用例唯一标识', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '4e22xxxxxxxxc64c16037fe76', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'updateWorkitemPropertyRequest' => [ + 'title' => '更新测试用例属性请求，数组形式', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'fieldIdentifier' => [ + 'title' => '需要更新的测试用例字段id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'tc.type', + ], + 'fieldValue' => [ + 'title' => '需要更新字段的属性值 (注：1.如果是人员类型的值必须要填写aliyunPK。2.如果是含有待选值的字段，填写相应的待选值的id。 3.如果多个值，需要用" , "进行分割，拼接成一个字符串。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '0a032xx28107xxxx53e87a9', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMsg' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => 'error', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Testcase' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'identifier' => [ + 'title' => '测试用例id', + 'description' => '', + 'type' => 'string', + 'example' => 'c7f7033b021ead52cc42721382', + ], + 'subject' => [ + 'title' => '标题', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'assignedTo' => [ + 'title' => '负责人信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'assignIdentifier' => [ + 'title' => '用户Id', + 'description' => '', + 'type' => 'string', + 'example' => '1316xxxxxx8624xxx', + ], + 'name' => [ + 'title' => '用户名称', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'tbRoleId' => [ + 'title' => '人员角色id', + 'description' => '', + 'type' => 'string', + 'example' => 'xxxxxxxewdds12xxx'."\n", + ], + ], + ], + 'spaceIdentifier' => [ + 'title' => '用例库id', + 'description' => '', + 'type' => 'string', + 'example' => '1e7d7a412b91a2144ec4aa8411', + ], + 'spaceType' => [ + 'title' => '空间类型，为TestRepo', + 'description' => '', + 'type' => 'string', + 'example' => 'TestRepo', + ], + 'categoryIdentifier' => [ + 'title' => '工作项类型id，一般为TestCase', + 'description' => '', + 'type' => 'string', + 'example' => 'TestCase'."\n" + ."\n", + ], + 'creator' => [ + 'title' => '创建人', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'createIdentifier' => [ + 'title' => '创建者id', + 'description' => '', + 'type' => 'string', + 'example' => '1316xxxxxx8624xxx', + ], + 'name' => [ + 'title' => '创建者名称', + 'description' => '', + 'type' => 'string', + 'example' => 'xxxxxxx', + ], + ], + ], + 'modifier' => [ + 'title' => '修改人', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'modifyIdentifier' => [ + 'title' => '修改者id', + 'description' => '', + 'type' => 'string', + 'example' => '1316xxxxxx8624xxx', + ], + 'name' => [ + 'title' => '修改者名称', + 'description' => '', + 'type' => 'string', + 'example' => 'xxxxxxx', + ], + ], + ], + 'directory' => [ + 'title' => '目录信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'directoryIdentifier' => [ + 'title' => '目录id', + 'description' => '', + 'type' => 'string', + 'example' => 'e27b8eace6501ce51cf5d56784', + ], + 'name' => [ + 'title' => '目录名称', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'pathName' => [ + 'title' => '用例完整目录名', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + 'childIdentifier' => [ + 'title' => '子目录id', + 'description' => '', + 'type' => 'string', + 'example' => '2973f597c14c6f533fffdcd05c', + ], + ], + ], + 'detailInfo' => [ + 'title' => '用例详细信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'stepType' => [ + 'title' => '步骤类型', + 'description' => '', + 'type' => 'string', + 'example' => 'TEXT/TABLE', + ], + 'precondition' => [ + 'title' => '前置条件对象', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'preIdentifier' => [ + 'title' => '前置条件id', + 'description' => '', + 'type' => 'string', + 'example' => '3354596c7b3004480b635acf95', + ], + 'preContent' => [ + 'title' => '前置条件内容', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'preContentType' => [ + 'title' => '前置条件格式', + 'description' => '', + 'type' => 'string', + 'example' => 'MARKDOWN', + ], + ], + ], + 'stepContent' => [ + 'title' => '测试步骤对象', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'stepIdentifier' => [ + 'title' => '测试步骤id', + 'description' => '', + 'type' => 'string', + 'example' => 'ad504e6cdcd2165b28eb1e1b9f', + ], + 'stepContent' => [ + 'title' => '测试步骤内容', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'stepContentType' => [ + 'title' => '测试步骤格式', + 'description' => '', + 'type' => 'string', + 'example' => 'RICHTEXT', + ], + ], + ], + 'expectedResult' => [ + 'title' => '测试步骤对象', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'expectIdentifier' => [ + 'title' => '预期结果id', + 'description' => '', + 'type' => 'string', + 'example' => '685340d13127b01185335bd360', + ], + 'expectContent' => [ + 'title' => '预期结果内容', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'expectContentType' => [ + 'title' => '预期结果格式', + 'description' => '', + 'type' => 'string', + 'example' => 'MARKDOWN', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"Testcase\\": {\\n \\"identifier\\": \\"c7f7033b021ead52cc42721382\\",\\n \\"subject\\": \\"测试用例标题\\",\\n \\"assignedTo\\": {\\n \\"assignIdentifier\\": \\"1316xxxxxx8624xxx\\",\\n \\"name\\": \\"用户姓名\\",\\n \\"tbRoleId\\": \\"xxxxxxxewdds12xxx\\\\n\\"\\n },\\n \\"spaceIdentifier\\": \\"1e7d7a412b91a2144ec4aa8411\\",\\n \\"spaceType\\": \\"TestRepo\\",\\n \\"categoryIdentifier\\": \\"TestCase\\\\n\\\\n\\",\\n \\"creator\\": {\\n \\"createIdentifier\\": \\"1316xxxxxx8624xxx\\",\\n \\"name\\": \\"xxxxxxx\\"\\n },\\n \\"modifier\\": {\\n \\"modifyIdentifier\\": \\"1316xxxxxx8624xxx\\",\\n \\"name\\": \\"xxxxxxx\\"\\n },\\n \\"directory\\": {\\n \\"directoryIdentifier\\": \\"e27b8eace6501ce51cf5d56784\\",\\n \\"name\\": \\"全部用例目录\\",\\n \\"pathName\\": [\\n \\"[目录一，目录二]\\"\\n ],\\n \\"childIdentifier\\": \\"2973f597c14c6f533fffdcd05c\\"\\n },\\n \\"detailInfo\\": {\\n \\"stepType\\": \\"TEXT/TABLE\\",\\n \\"precondition\\": {\\n \\"preIdentifier\\": \\"3354596c7b3004480b635acf95\\",\\n \\"preContent\\": \\"前置条件内容\\",\\n \\"preContentType\\": \\"MARKDOWN\\"\\n },\\n \\"stepContent\\": {\\n \\"stepIdentifier\\": \\"ad504e6cdcd2165b28eb1e1b9f\\",\\n \\"stepContent\\": \\"测试步骤内容\\",\\n \\"stepContentType\\": \\"RICHTEXT\\"\\n },\\n \\"expectedResult\\": {\\n \\"expectIdentifier\\": \\"685340d13127b01185335bd360\\",\\n \\"expectContent\\": \\"预期结果内容\\",\\n \\"expectContentType\\": \\"MARKDOWN\\"\\n }\\n }\\n }\\n}","type":"json"}]', + ], + 'ListTestCaseFields' => [ + 'summary' => '获取测试用例全部字段', + 'path' => '/organization/{organizationId}/testhub/testcase/fields', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'spaceIdentifier', + 'in' => 'query', + 'schema' => [ + 'title' => '测试用例库id，测试用例库唯一标识', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'e8bxxxxxxxxxxxxxxxx23', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMsg' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => 'error', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'title' => 'true或者false', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'fields' => [ + 'title' => '字段信息', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'creator' => [ + 'title' => '创建人id', + 'description' => '', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'description' => [ + 'title' => '描述信息', + 'description' => '', + 'type' => 'string', + 'example' => '字段的具体信息', + ], + 'gmtCreate' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1623916393000', + ], + 'gmtModified' => [ + 'title' => '修改时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1623916393000', + ], + 'type' => [ + 'title' => '区分不同的类型，如系统字段、用户自定义字段', + 'description' => '', + 'type' => 'string', + 'example' => 'NativeField', + ], + 'identifier' => [ + 'title' => '字段唯一标识符', + 'description' => '', + 'type' => 'string', + 'example' => 'e8bxxxxxxxxxxxxxxxx23', + ], + 'modifier' => [ + 'title' => '修改人', + 'description' => '', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'name' => [ + 'title' => '字段名称', + 'description' => '', + 'type' => 'string', + 'example' => '负责人', + ], + 'format' => [ + 'title' => '字段格式', + 'description' => '', + 'type' => 'string', + 'example' => 'list', + ], + 'className' => [ + 'title' => '字段类型', + 'description' => '', + 'type' => 'string', + 'example' => '例：date', + ], + 'resourceType' => [ + 'title' => '区分不同的适用对象', + 'description' => '', + 'type' => 'string', + 'example' => '例：Workitem', + ], + 'defaultValue' => [ + 'title' => '默认值', + 'description' => '', + 'type' => 'string', + 'example' => '123', + ], + 'isRequired' => [ + 'title' => '是否必填', + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'isSystemRequired' => [ + 'title' => '是否是系统必须字段，比如：负责人、状态等。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'linkWithService' => [ + 'title' => '联动的服务，比如：迭代 迭代服务开启/关闭，这个字段字段加进/剔除出对应的模板； 字段模板里，这类字段不能手动添加或删除', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'isShowWhenCreate' => [ + 'title' => '创建时是否展示', + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'options' => [ + 'title' => '待选值', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'identifier' => [ + 'title' => '待选值的唯一标识', + 'description' => '', + 'type' => 'string', + 'example' => '重复的缺陷', + ], + 'fieldIdentifier' => [ + 'title' => '字段唯一标识', + 'description' => '', + 'type' => 'string', + 'example' => 'e8bxxxxxxxxxxxxxxxx23', + ], + 'value' => [ + 'title' => '待选值中文名称', + 'description' => '', + 'type' => 'string', + 'example' => '重复的缺陷', + ], + 'valueEn' => [ + 'title' => '待选值英文名称', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'displayValue' => [ + 'title' => '根据语言环境获取当前展示的值', + 'description' => '', + 'type' => 'string', + 'example' => '重复的缺陷', + ], + 'position' => [ + 'title' => '待选值顺序', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'null', + ], + 'level' => [ + 'title' => '展示级别，数字范围1~9，数字越大，颜色越浅。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"fields\\": [\\n {\\n \\"creator\\": \\"19xx7043xxxxxxx914\\",\\n \\"description\\": \\"字段的具体信息\\",\\n \\"gmtCreate\\": 1623916393000,\\n \\"gmtModified\\": 1623916393000,\\n \\"type\\": \\"NativeField\\",\\n \\"identifier\\": \\"e8bxxxxxxxxxxxxxxxx23\\",\\n \\"modifier\\": \\"19xx7043xxxxxxx914\\",\\n \\"name\\": \\"负责人\\",\\n \\"format\\": \\"list\\",\\n \\"className\\": \\"例：date\\",\\n \\"resourceType\\": \\"例：Workitem\\",\\n \\"defaultValue\\": \\"123\\",\\n \\"isRequired\\": false,\\n \\"isSystemRequired\\": false,\\n \\"linkWithService\\": \\"null\\",\\n \\"isShowWhenCreate\\": false,\\n \\"options\\": [\\n {\\n \\"identifier\\": \\"重复的缺陷\\",\\n \\"fieldIdentifier\\": \\"e8bxxxxxxxxxxxxxxxx23\\",\\n \\"value\\": \\"重复的缺陷\\",\\n \\"valueEn\\": \\"null\\",\\n \\"displayValue\\": \\"重复的缺陷\\",\\n \\"position\\": 0,\\n \\"level\\": 1\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetTestcaseList' => [ + 'summary' => '获取测试用例列表', + 'path' => '/organization/{organizationId}/testhub/testcases', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'spaceIdentifier' => [ + 'title' => '用例库id，用例库唯一标识', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '6d5984c7d92b23fa53d4743c37', + ], + 'directoryIdentifier' => [ + 'title' => '目录id，目录唯一标识，如果不填写，则默认该用例库下所有用例', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'e27b8eace6501ce51cf5d56784', + ], + 'conditions' => [ + 'title' => '过滤器条件', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"conditionGroups\\":[[{\\"fieldIdentifier\\":\\"status\\",\\"operator\\":\\"CONTAINS\\",\\"value\\":[\\"cc961a18adf770c6e423ccc5\\"],\\"toValue\\":null,,\\"className\\":\\"status\\",\\"format\\":\\"list\\"}]]}', + ], + 'nextToken' => [ + 'title' => '分页标识，第一页默认不用填写，下一页的参数从上一次调用结果获取', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2591861102250c4522380b33a6', + ], + 'maxResult' => [ + 'title' => '分页大小，默认返回数据为20个为一页', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '20', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'totalCount' => [ + 'title' => '总数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'nextToken' => [ + 'title' => '分页Token，没有下一页则为空', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'maxResults' => [ + 'title' => '每页数量', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMsg' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => 'error', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'title' => 'true或者false', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'testcase' => [ + 'title' => '工作项信息', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'identifier' => [ + 'title' => '测试用例Id，测试用例唯一标识', + 'description' => '', + 'type' => 'string', + 'example' => 'e8bxxxxxxxxxxxxxxxx23', + ], + 'subject' => [ + 'title' => '测试用例标题', + 'description' => '', + 'type' => 'string', + 'example' => '测试工作项', + ], + 'assignedTo' => [ + 'title' => '负责人信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'assignedToIdenttifier' => [ + 'title' => '负责人id，负责人唯一标识', + 'description' => '', + 'type' => 'string', + 'example' => '12xxxxx456', + ], + 'name' => [ + 'title' => '负责人姓名', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + 'space' => [ + 'title' => '用例库信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'spaceIdentifier' => [ + 'title' => '用例库id，用例库唯一标识', + 'description' => '', + 'type' => 'string', + 'example' => '22c32972b853cd703dbf0efe4c', + ], + 'type' => [ + 'title' => '空间类型', + 'description' => '', + 'type' => 'string', + 'example' => 'TestRepo', + ], + ], + ], + 'categoryIdentifier' => [ + 'title' => '测试用例的类型id', + 'description' => '', + 'type' => 'string', + 'example' => 'Req', + ], + 'gmtCreate' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1621578648000', + ], + 'customFields' => [ + 'title' => '自定义字段数组', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'fieldIdentifier' => [ + 'title' => '字段id，自定义字段唯一标识', + 'description' => '', + 'type' => 'string', + 'example' => '85702b33f14bfa82cb458173ba', + ], + 'value' => [ + 'title' => '自定义字段值', + 'description' => '', + 'type' => 'string', + 'example' => 'd7f112f9d023e2108fa1b0d8', + ], + 'fieldFormat' => [ + 'title' => '自定义字段格式', + 'description' => '', + 'type' => 'string', + 'example' => 'Input', + ], + 'fieldClassName' => [ + 'title' => '自定义字段类型', + 'description' => '', + 'type' => 'string', + 'example' => 'User', + ], + ], + ], + ], + 'tags' => [ + 'title' => '标签数据数组', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'tagIdentifier' => [ + 'title' => '标签id，标签唯一标识', + 'description' => '', + 'type' => 'string', + 'example' => '85702b33f14bxxxxxx58173ba', + ], + 'name' => [ + 'title' => '标签名称', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 10,\\n \\"nextToken\\": \\"\\\\\\"\\\\\\"\\",\\n \\"maxResults\\": 20,\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"testcase\\": [\\n {\\n \\"identifier\\": \\"e8bxxxxxxxxxxxxxxxx23\\",\\n \\"subject\\": \\"测试工作项\\",\\n \\"assignedTo\\": {\\n \\"assignedToIdenttifier\\": \\"12xxxxx456\\",\\n \\"name\\": \\"人员名称\\"\\n },\\n \\"space\\": {\\n \\"spaceIdentifier\\": \\"22c32972b853cd703dbf0efe4c\\",\\n \\"type\\": \\"TestRepo\\"\\n },\\n \\"categoryIdentifier\\": \\"Req\\",\\n \\"gmtCreate\\": 1621578648000,\\n \\"customFields\\": [\\n {\\n \\"fieldIdentifier\\": \\"85702b33f14bfa82cb458173ba\\",\\n \\"value\\": \\"d7f112f9d023e2108fa1b0d8\\",\\n \\"fieldFormat\\": \\"Input\\",\\n \\"fieldClassName\\": \\"User\\"\\n }\\n ],\\n \\"tags\\": [\\n {\\n \\"tagIdentifier\\": \\"85702b33f14bxxxxxx58173ba\\",\\n \\"name\\": \\"标签名称\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'UpdateTestResult' => [ + 'summary' => '更新了测试计划中测试用例的执行人与状态', + 'path' => '/organization/{organizationId}/testhub/testplan/{testPlanIdentifier}/testresult/{testcaseIdentifier}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'testPlanIdentifier', + 'in' => 'path', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'testcaseIdentifier', + 'in' => 'path', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'executor' => [ + 'title' => '测试计划中测试用例更新需要的执行人字段', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '131xxx38624xxxx68', + ], + 'status' => [ + 'title' => '测试计划中测试用例更新需要的状态字段', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'TO DO', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMsg' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => 'error', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'title' => 'true或者false，是否更新成功', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true\\n}","type":"json"}]', + ], + 'GetTestResultList' => [ + 'summary' => '获取测试计划中的测试用例列表', + 'path' => '/organization/{organizationId}/testhub/testplan/{testPlanIdentifier}/testresults', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'testPlanIdentifier', + 'in' => 'path', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'directoryIdentifier' => [ + 'title' => '目录唯一标识，测试计划中对应的目录id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'e27b8eace6501ce51cf5d56784', + ], + 'conditions' => [ + 'title' => '过滤器条件', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{\'conditionGroups\': [[{\'fieldIdentifier\': \'gmtModified\', \'operator\': \'MORE_THAN_AND_EQUAL\', \'value\': [\'2023-04-20 18:03:12.442140\'], \'className\': \'dateTime\', \'format\': \'input\'}]]}', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMsg' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => 'error', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'title' => 'true或者false', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'testResult' => [ + 'title' => '工作项信息', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'testResultIdentifier' => [ + 'title' => '测试结果的id', + 'type' => 'string', + 'example' => 'a8bxxxxxxxxxxxxxxxx54', + ], + 'testResultStatus' => [ + 'title' => '测试结果的状态', + 'type' => 'string', + 'example' => 'TO DO', + ], + 'testResultExecutor' => [ + 'title' => '测试计划执行人对象', + 'type' => 'object', + 'properties' => [ + 'executorIdentifier' => [ + 'title' => '执行人唯一标识，aliyunPk', + 'type' => 'string', + ], + 'name' => [ + 'title' => '执行人名称', + 'type' => 'string', + ], + ], + ], + 'testResultGmtCreate' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'testcaseIdentifier' => [ + 'type' => 'string', + ], + 'bugCount' => [ + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8', + ], + 'subject' => [ + 'title' => '测试用例标题', + 'type' => 'string', + 'example' => '测试工作项', + ], + 'assignedTo' => [ + 'title' => '负责人信息', + 'type' => 'object', + 'properties' => [ + 'assignedToIdenttifier' => [ + 'title' => '负责人id，负责人唯一标识', + 'type' => 'string', + ], + 'name' => [ + 'title' => '负责人姓名', + 'type' => 'string', + ], + ], + ], + 'spaceIdentifier' => [ + 'title' => '测试用例所属的测试库id', + 'type' => 'string', + ], + 'categoryIdentifier' => [ + 'title' => '测试用例的类型id', + 'type' => 'string', + 'example' => 'Req', + ], + 'gmtCreate' => [ + 'title' => '测试用例创建时间', + 'type' => 'integer', + 'format' => 'int64', + ], + 'customFields' => [ + 'title' => '自定义字段数组', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'fieldIdentifier' => [ + 'title' => '字段id，自定义字段唯一标识', + 'type' => 'string', + ], + 'value' => [ + 'title' => '自定义字段值', + 'type' => 'string', + ], + 'fieldFormat' => [ + 'title' => '自定义字段格式', + 'type' => 'string', + ], + 'fieldClassName' => [ + 'title' => '自定义字段类型', + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"testResult\\": [\\n {\\n \\"testResultIdentifier\\": \\"a8bxxxxxxxxxxxxxxxx54\\",\\n \\"testResultStatus\\": \\"TO DO\\",\\n \\"testResultExecutor\\": {\\n \\"executorIdentifier\\": \\"1243xxxxx234xx\\",\\n \\"name\\": \\"人员名称\\"\\n },\\n \\"testResultGmtCreate\\": 1621578648000,\\n \\"testcaseIdentifier\\": \\"943d20fe5e385a08fdd6b593fb\\",\\n \\"bugCount\\": 8,\\n \\"subject\\": \\"测试工作项\\",\\n \\"assignedTo\\": {\\n \\"assignedToIdenttifier\\": \\"1243xxxxx234xx\\",\\n \\"name\\": \\"人员名称\\"\\n },\\n \\"spaceIdentifier\\": \\"592531647d7b15f2e98dbc7e27\\",\\n \\"categoryIdentifier\\": \\"Req\\",\\n \\"gmtCreate\\": 1621578648000,\\n \\"customFields\\": [\\n {\\n \\"fieldIdentifier\\": \\"943d20fe5e385a08fdd6b593fb\\",\\n \\"value\\": \\"d7f112f9d023e2108fa1b0d8\\",\\n \\"fieldFormat\\": \\"Input\\",\\n \\"fieldClassName\\": \\"User\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'ExportWorkitemActivity' => [ + 'summary' => '导出Insight workitem_activity表数据', + 'path' => '/organization/{organizationId}/data/workitemActivities', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '61db9af2148974246bexxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'startTime' => [ + 'title' => '开始时间。和结束时间间隔不超过1年。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2024-05-01 00:00:00', + ], + 'endTime' => [ + 'title' => '结束时间。和开始时间间隔不超过1年。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2024-06-01 00:00:00', + ], + 'nextToken' => [ + 'title' => '下一页token', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'maxResults' => [ + 'title' => '最大结果条数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'totalCount' => [ + 'title' => '总条数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'nextToken' => [ + 'title' => '下一页token，为null表示没有下一页', + 'description' => '', + 'type' => 'string', + 'example' => '2', + ], + 'maxResults' => [ + 'title' => '返回条数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'workitem_activity', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '记录自增Id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4406380356', + ], + 'gmtEvent' => [ + 'title' => '事件时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1714961337000', + ], + 'identifier' => [ + 'title' => '唯一标识', + 'description' => '', + 'type' => 'string', + 'example' => '254662353', + ], + 'organizationId' => [ + 'title' => '企业id', + 'description' => '', + 'type' => 'string', + 'example' => '61db9af2148974246bexxxx', + ], + 'newValue' => [ + 'title' => '新值', + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'oldValue' => [ + 'title' => '旧值', + 'description' => '', + 'type' => 'string', + 'example' => '2', + ], + 'projectId' => [ + 'title' => '项目ID', + 'description' => '', + 'type' => 'string', + 'example' => '2a62349afcbef7f23d8f31xxxx', + ], + 'source' => [ + 'title' => '来源', + 'description' => '', + 'type' => 'string', + 'example' => 'projex', + ], + 'type' => [ + 'title' => '事件类型', + 'description' => '', + 'type' => 'string', + 'example' => 'workitem.update.priority', + ], + 'workitemId' => [ + 'title' => '工作项ID', + 'description' => '', + 'type' => 'string', + 'example' => 'ec69eae498acce08ff7260xxxx', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 100,\\n \\"nextToken\\": \\"2\\",\\n \\"maxResults\\": 10,\\n \\"result\\": [\\n {\\n \\"id\\": 4406380356,\\n \\"gmtEvent\\": 1714961337000,\\n \\"identifier\\": \\"254662353\\",\\n \\"organizationId\\": \\"61db9af2148974246bexxxx\\",\\n \\"newValue\\": \\"1\\",\\n \\"oldValue\\": \\"2\\",\\n \\"projectId\\": \\"2a62349afcbef7f23d8f31xxxx\\",\\n \\"source\\": \\"projex\\",\\n \\"type\\": \\"workitem.update.priority\\",\\n \\"workitemId\\": \\"ec69eae498acce08ff7260xxxx\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ExportInsightWorkitemVersion' => [ + 'summary' => '导出Insight workitem_version表数据', + 'path' => '/organization/{organizationId}/data/workitemVersions', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '61db9af2148974246bexxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'startTime' => [ + 'title' => '开始时间。和结束时间间隔不超过1年。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2024-05-01 00:00:00'."\n", + ], + 'endTime' => [ + 'title' => '结束时间。和开始时间间隔不超过1年。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2024-06-01 00:00:00'."\n", + ], + 'nextToken' => [ + 'title' => '下一页token', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'maxResults' => [ + 'title' => '最大结果条数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'totalCount' => [ + 'title' => '总条数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'nextToken' => [ + 'title' => '下一页token，为null表示没有下一页', + 'description' => '', + 'type' => 'string', + 'example' => '2', + ], + 'maxResults' => [ + 'title' => '返回条数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'workitem_version', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '记录自增Id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '648131', + ], + 'gmtCreate' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1704251228000', + ], + 'gmtModified' => [ + 'title' => '更新时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1704251228000', + ], + 'identifier' => [ + 'title' => '唯一标识', + 'description' => '', + 'type' => 'string', + 'example' => '7ba6e8261b973c976df76b7de1', + ], + 'isDeleted' => [ + 'title' => '是否删除(Y|N)', + 'description' => '', + 'type' => 'string', + 'example' => 'N', + ], + 'organizationId' => [ + 'title' => '企业id', + 'description' => '', + 'type' => 'string', + 'example' => '61db9af2148974246bexxxx', + ], + 'name' => [ + 'title' => '版本名称', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'gmtStart' => [ + 'title' => '版本开始时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1704297600000', + ], + 'gmtPublish' => [ + 'title' => '版本发布时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1704902400000', + ], + 'status' => [ + 'title' => '版本状态，10/50/100 -> TODO/DOING/ARCHIVED', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'lockStatus' => [ + 'title' => '版本是否锁定', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'targetType' => [ + 'title' => '所属空间类型', + 'description' => '', + 'type' => 'string', + 'example' => 'Project', + ], + 'targetId' => [ + 'title' => '所属空间类型id', + 'description' => '', + 'type' => 'string', + 'example' => '7eee44ec7f699d4e6980faxxxx', + ], + 'source' => [ + 'title' => '来源（projex/teambition）', + 'description' => '', + 'type' => 'string', + 'example' => 'projex', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 100,\\n \\"nextToken\\": \\"2\\",\\n \\"maxResults\\": 10,\\n \\"result\\": [\\n {\\n \\"id\\": 648131,\\n \\"gmtCreate\\": 1704251228000,\\n \\"gmtModified\\": 1704251228000,\\n \\"identifier\\": \\"7ba6e8261b973c976df76b7de1\\",\\n \\"isDeleted\\": \\"N\\",\\n \\"organizationId\\": \\"61db9af2148974246bexxxx\\",\\n \\"name\\": \\"版本0501\\",\\n \\"gmtStart\\": 1704297600000,\\n \\"gmtPublish\\": 1704902400000,\\n \\"status\\": 100,\\n \\"lockStatus\\": 0,\\n \\"targetType\\": \\"Project\\",\\n \\"targetId\\": \\"7eee44ec7f699d4e6980faxxxx\\",\\n \\"source\\": \\"projex\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ExportInsightWorkitemStatusJoinWorkitemDefectExtra' => [ + 'summary' => '导出Insight workitem_stauts表 join workitem_defect_extra表表数据', + 'path' => '/organization/{organizationId}/data/workitemStatusJoinWorkitemDefectExtras', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '61db9af2148974246bexxxx'."\n", + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'startTime' => [ + 'title' => '开始时间。和结束时间间隔不超过1年。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2024-05-01 00:00:00'."\n", + ], + 'endTime' => [ + 'title' => '结束时间。和开始时间间隔不超过1年。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2024-06-01 00:00:00'."\n", + ], + 'nextToken' => [ + 'title' => '下一页token', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'maxResults' => [ + 'title' => '最大结果条数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'totalCount' => [ + 'title' => '总条数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'nextToken' => [ + 'title' => '下一页token，为null表示没有下一页', + 'description' => '', + 'type' => 'string', + 'example' => '2', + ], + 'maxResults' => [ + 'title' => '返回条数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'workitem_status join workitem_defect_extra', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '记录自增Id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '701615370', + ], + 'gmtCreate' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1713430241000', + ], + 'gmtModified' => [ + 'title' => '更新时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1714755985000', + ], + 'workitemId' => [ + 'title' => '需求ID（工作项ID）', + 'description' => '', + 'type' => 'string', + 'example' => '636f661a612a945bbcdb4cxxxx', + ], + 'isDeleted' => [ + 'title' => '是否删除(Y|N)', + 'description' => '', + 'type' => 'string', + 'example' => 'N', + ], + 'organizationId' => [ + 'title' => '企业id', + 'description' => '', + 'type' => 'string', + 'example' => '61db9af2148974246bexxxx', + ], + 'assignedToId' => [ + 'title' => '指派人ID', + 'description' => '', + 'type' => 'string', + 'example' => '65e836b981d758be7a25xxxx', + ], + 'creatorId' => [ + 'title' => '创建人ID', + 'description' => '', + 'type' => 'string', + 'example' => '65e836b981d758be7a25xxxx', + ], + 'gmtClosed' => [ + 'title' => '实际关闭时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '33166339200000', + ], + 'gmtTodo' => [ + 'title' => '预计开始时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '33166339200000', + ], + 'gmtDue' => [ + 'title' => '预计完成时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '33166339200000', + ], + 'gmtStart' => [ + 'title' => '实际开始时间（需求排期或确认）', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '33166339200000', + ], + 'isArchived' => [ + 'title' => '是否归档(Y|N)', + 'description' => '', + 'type' => 'string', + 'example' => 'N', + ], + 'isDone' => [ + 'title' => '是否已完成（Y|N）', + 'description' => '', + 'type' => 'string', + 'example' => 'Y', + ], + 'parentId' => [ + 'title' => '父工作项ID', + 'description' => '', + 'type' => 'string', + 'example' => 'a80a203a9078a7a1b1f2c6xxxx', + ], + 'participantIds' => [ + 'title' => '参与人ID列表（逗号分隔）', + 'description' => '', + 'type' => 'string', + 'example' => '6135b21fb383ef39551cf02e,63466a385dc8531eebd764e9', + ], + 'phase' => [ + 'title' => '大阶段（10-100）,对应todo、doing、done', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'stage' => [ + 'title' => '小阶段（10-100）,对应projex的确认阶段、分析阶段、处理阶段、设计阶段、开发阶段等', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'priority' => [ + 'title' => '优先级（0-9）', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'productId' => [ + 'title' => '产品ID', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'projectId' => [ + 'title' => '项目ID', + 'description' => '', + 'type' => 'string', + 'example' => '6732a29d846bf998dc09e7xxxx', + ], + 'source' => [ + 'title' => '来源 teambition/projex', + 'description' => '', + 'type' => 'string', + 'example' => 'projex', + ], + 'sprintId' => [ + 'title' => '迭代ID', + 'description' => '', + 'type' => 'string', + 'example' => '731c83a40bbf3c2f080e07xxxx', + ], + 'status' => [ + 'title' => '状态名称', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'statusId' => [ + 'title' => '状态id', + 'description' => '', + 'type' => 'string', + 'example' => '100005', + ], + 'storyPoint' => [ + 'title' => '故事点数', + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '10.0', + ], + 'subject' => [ + 'title' => '标题', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'type' => [ + 'title' => '工作项大类型：需求，任务缺陷', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'subType' => [ + 'title' => '工作项子类型：技术类需求，产品类需求等', + 'description' => '', + 'type' => 'string', + 'example' => '9uy29901re573f561d69xxxx', + ], + 'versionId' => [ + 'title' => '版本ID', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'workTime' => [ + 'title' => '实际使用工时（分钟）', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'expectedWorkTime' => [ + 'title' => '预计使用工时（分钟）', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'versions' => [ + 'title' => '版本', + 'description' => '', + 'type' => 'string', + 'example' => '{6a8cdda167415bea1506c7262c}'."\n", + ], + 'extraId' => [ + 'title' => 'extra表自增id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'foundPhase' => [ + 'title' => '发现阶段（10-100）', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'gmtFixed' => [ + 'title' => '实际修复时间（秒）', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'isStupid' => [ + 'title' => '是否低级错误（Y|N）', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'reopenNum' => [ + 'title' => '重复开启次数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '', + ], + 'seriousLevel' => [ + 'title' => '严重程度（0-9）', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '', + ], + 'solution' => [ + 'title' => '解决方法类型', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'extraIsDeleted' => [ + 'title' => 'extra是否删除(归档)字段, Y(删除或归档) / N(正常)', + 'description' => '', + 'type' => 'string', + 'example' => 'N', + ], + 'verifierId' => [ + 'title' => '验证者id', + 'description' => '', + 'type' => 'string', + 'example' => '65e836b981d758be7a25xxxx', + ], + 'serialNumber' => [ + 'title' => '在空间内的编号', + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 100,\\n \\"nextToken\\": \\"2\\",\\n \\"maxResults\\": 10,\\n \\"result\\": [\\n {\\n \\"id\\": 701615370,\\n \\"gmtCreate\\": 1713430241000,\\n \\"gmtModified\\": 1714755985000,\\n \\"workitemId\\": \\"636f661a612a945bbcdb4cxxxx\\",\\n \\"isDeleted\\": \\"N\\",\\n \\"organizationId\\": \\"61db9af2148974246bexxxx\\",\\n \\"assignedToId\\": \\"65e836b981d758be7a25xxxx\\",\\n \\"creatorId\\": \\"65e836b981d758be7a25xxxx\\",\\n \\"gmtClosed\\": 33166339200000,\\n \\"gmtTodo\\": 33166339200000,\\n \\"gmtDue\\": 33166339200000,\\n \\"gmtStart\\": 33166339200000,\\n \\"isArchived\\": \\"N\\",\\n \\"isDone\\": \\"Y\\",\\n \\"parentId\\": \\"a80a203a9078a7a1b1f2c6xxxx\\",\\n \\"participantIds\\": \\"6135b21fb383ef39551cf02e,63466a385dc8531eebd764e9\\",\\n \\"phase\\": 10,\\n \\"stage\\": 10,\\n \\"priority\\": 2,\\n \\"productId\\": \\"无\\",\\n \\"projectId\\": \\"6732a29d846bf998dc09e7xxxx\\",\\n \\"source\\": \\"projex\\",\\n \\"sprintId\\": \\"731c83a40bbf3c2f080e07xxxx\\",\\n \\"status\\": \\"待处理\\",\\n \\"statusId\\": \\"100005\\",\\n \\"storyPoint\\": 10,\\n \\"subject\\": \\"测试\\",\\n \\"type\\": 1,\\n \\"subType\\": \\"9uy29901re573f561d69xxxx\\",\\n \\"versionId\\": \\"无\\",\\n \\"workTime\\": 10,\\n \\"expectedWorkTime\\": 10,\\n \\"versions\\": \\"{6a8cdda167415bea1506c7262c}\\\\n\\",\\n \\"extraId\\": 123,\\n \\"foundPhase\\": 10,\\n \\"gmtFixed\\": \\"无\\",\\n \\"isStupid\\": \\"无\\",\\n \\"reopenNum\\": 0,\\n \\"seriousLevel\\": 0,\\n \\"solution\\": \\"无\\",\\n \\"extraIsDeleted\\": \\"N\\",\\n \\"verifierId\\": \\"65e836b981d758be7a25xxxx\\",\\n \\"serialNumber\\": 66\\n }\\n ]\\n}","type":"json"}]', + ], + 'ExportInsightWorkitemStatus' => [ + 'summary' => '导出Insight workitem_stauts表数据', + 'path' => '/organization/{organizationId}/data/workitemStatuses', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '61db9af2148974246bexxxx'."\n", + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'startTime' => [ + 'title' => '开始时间。和结束时间间隔不超过1年。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2024-05-01 00:00:00'."\n", + ], + 'endTime' => [ + 'title' => '结束时间。和开始时间间隔不超过1年。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2024-06-01 00:00:00'."\n", + ], + 'nextToken' => [ + 'title' => '下一页token', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'maxResults' => [ + 'title' => '最大结果条数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'totalCount' => [ + 'title' => '总条数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'nextToken' => [ + 'title' => '下一页token，为null表示没有下一页', + 'description' => '', + 'type' => 'string', + 'example' => '2', + ], + 'maxResults' => [ + 'title' => '返回条数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'workitem_status', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '记录自增Id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '701615370', + ], + 'gmtCreate' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1713430241000', + ], + 'gmtModified' => [ + 'title' => '更新时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1713430241000', + ], + 'workitemId' => [ + 'title' => '需求ID（工作项ID）', + 'description' => '', + 'type' => 'string', + 'example' => '636f661a612a945bbcdb4cxxxx', + ], + 'isDeleted' => [ + 'title' => '是否删除(Y|N)', + 'description' => '', + 'type' => 'string', + 'example' => 'N', + ], + 'organizationId' => [ + 'title' => '企业id', + 'description' => '', + 'type' => 'string', + 'example' => '61db9af2148974246bexxxx', + ], + 'assignedToId' => [ + 'title' => '指派人ID', + 'description' => '', + 'type' => 'string', + 'example' => '65e836b981d758be7a25xxxx', + ], + 'creatorId' => [ + 'title' => '创建人ID', + 'description' => '', + 'type' => 'string', + 'example' => '65e836b981d758be7a25xxxx', + ], + 'gmtClosed' => [ + 'title' => '实际关闭时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '33166339200000', + ], + 'gmtTodo' => [ + 'title' => '预计开始时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '33166339200000', + ], + 'gmtDue' => [ + 'title' => '预计完成时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '33166339200000', + ], + 'gmtStart' => [ + 'title' => '实际开始时间（需求排期或确认）', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '33166339200000', + ], + 'isArchived' => [ + 'title' => '是否归档(Y|N)', + 'description' => '', + 'type' => 'string', + 'example' => 'N', + ], + 'isDone' => [ + 'title' => '是否已完成（Y|N）', + 'description' => '', + 'type' => 'string', + 'example' => 'Y', + ], + 'parentId' => [ + 'title' => '父工作项ID', + 'description' => '', + 'type' => 'string', + 'example' => 'c3640ab6233fcc10a7e3aaxxxx', + ], + 'participantIds' => [ + 'title' => '参与人ID列表（逗号分隔）', + 'description' => '', + 'type' => 'string', + 'example' => '6135b21fb383ef39551cxxxx,63466a385dc8531eebd7xxxx', + ], + 'phase' => [ + 'title' => '大阶段（10-100）,对应todo、doing、done', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'stage' => [ + 'title' => '小阶段（10-100）,对应projex的确认阶段、分析阶段、处理阶段、设计阶段、开发阶段等', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'priority' => [ + 'title' => '优先级（0-9）', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'productId' => [ + 'title' => '产品ID', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'projectId' => [ + 'title' => '项目ID', + 'description' => '', + 'type' => 'string', + 'example' => '505ac6433dfbda8df0b08bxxxx', + ], + 'source' => [ + 'title' => '来源 teambition/projex', + 'description' => '', + 'type' => 'string', + 'example' => 'projex', + ], + 'sprintId' => [ + 'title' => '迭代ID', + 'description' => '', + 'type' => 'string', + 'example' => '505ac6433dfbda8df0b08bxxxx', + ], + 'status' => [ + 'title' => '状态名称', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'statusId' => [ + 'title' => '状态id', + 'description' => '', + 'type' => 'string', + 'example' => '100005', + ], + 'storyPoint' => [ + 'title' => '故事点数', + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '10.0', + ], + 'subject' => [ + 'title' => '标题', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'type' => [ + 'title' => '工作项大类型：需求，任务缺陷', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'subType' => [ + 'title' => '工作项子类型：技术类需求，产品类需求等', + 'description' => '', + 'type' => 'string', + 'example' => '9uy29901re573f561d69xxxx', + ], + 'versionId' => [ + 'title' => '版本ID', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'workTime' => [ + 'title' => '实际使用工时（分钟）', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'expectedWorkTime' => [ + 'title' => '预计使用工时（分钟）', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'versions' => [ + 'title' => '版本', + 'description' => '', + 'type' => 'string', + 'example' => '[6a8cdda167415bea1506c7262c]', + ], + 'serialNumber' => [ + 'title' => '在空间内的编号', + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 100,\\n \\"nextToken\\": \\"2\\",\\n \\"maxResults\\": 10,\\n \\"result\\": [\\n {\\n \\"id\\": 701615370,\\n \\"gmtCreate\\": 1713430241000,\\n \\"gmtModified\\": 1713430241000,\\n \\"workitemId\\": \\"636f661a612a945bbcdb4cxxxx\\",\\n \\"isDeleted\\": \\"N\\",\\n \\"organizationId\\": \\"61db9af2148974246bexxxx\\",\\n \\"assignedToId\\": \\"65e836b981d758be7a25xxxx\\",\\n \\"creatorId\\": \\"65e836b981d758be7a25xxxx\\",\\n \\"gmtClosed\\": 33166339200000,\\n \\"gmtTodo\\": 33166339200000,\\n \\"gmtDue\\": 33166339200000,\\n \\"gmtStart\\": 33166339200000,\\n \\"isArchived\\": \\"N\\",\\n \\"isDone\\": \\"Y\\",\\n \\"parentId\\": \\"c3640ab6233fcc10a7e3aaxxxx\\",\\n \\"participantIds\\": \\"6135b21fb383ef39551cxxxx,63466a385dc8531eebd7xxxx\\",\\n \\"phase\\": 10,\\n \\"stage\\": 10,\\n \\"priority\\": 0,\\n \\"productId\\": \\"无\\",\\n \\"projectId\\": \\"505ac6433dfbda8df0b08bxxxx\\",\\n \\"source\\": \\"projex\\",\\n \\"sprintId\\": \\"505ac6433dfbda8df0b08bxxxx\\",\\n \\"status\\": \\"待处理\\",\\n \\"statusId\\": \\"100005\\",\\n \\"storyPoint\\": 10,\\n \\"subject\\": \\"测试\\",\\n \\"type\\": 1,\\n \\"subType\\": \\"9uy29901re573f561d69xxxx\\",\\n \\"versionId\\": \\"无\\",\\n \\"workTime\\": 10,\\n \\"expectedWorkTime\\": 10,\\n \\"versions\\": \\"[6a8cdda167415bea1506c7262c]\\",\\n \\"serialNumber\\": 66\\n }\\n ]\\n}","type":"json"}]', + ], + 'ExportInsightWorkTime' => [ + 'summary' => '导出Insight work_time表数据', + 'path' => '/organization/{organizationId}/data/workTimes', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '61db9af2148974246bexxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'startTime' => [ + 'title' => '开始时间。和结束时间间隔不超过1年。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2024-05-01 00:00:00'."\n", + ], + 'endTime' => [ + 'title' => '结束时间。和开始时间间隔不超过1年。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2024-06-01 00:00:00'."\n", + ], + 'nextToken' => [ + 'title' => '下一页token', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'maxResults' => [ + 'title' => '最大结果条数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'totalCount' => [ + 'title' => '总条数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'nextToken' => [ + 'title' => '下一页token，为null表示没有下一页', + 'description' => '', + 'type' => 'string', + 'example' => '2', + ], + 'maxResults' => [ + 'title' => '返回条数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'work_time', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '记录自增Id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '49506082', + ], + 'gmtCreate' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1714978610000', + ], + 'gmtModified' => [ + 'title' => '更新时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1714978610000', + ], + 'identifier' => [ + 'title' => '唯一标识', + 'description' => '', + 'type' => 'string', + 'example' => 'da70ce5824231ca3c04ef808e0', + ], + 'isDeleted' => [ + 'title' => '是否删除(Y|N)', + 'description' => '', + 'type' => 'string', + 'example' => 'N', + ], + 'organizationId' => [ + 'title' => '企业id', + 'description' => '', + 'type' => 'string', + 'example' => '61db9af2148974246bexxxx', + ], + 'recorderId' => [ + 'title' => '工时填报人', + 'description' => '', + 'type' => 'string', + 'example' => '65659358c319d2a0f912xxxx', + ], + 'source' => [ + 'title' => '来源: Projex or Teambition', + 'description' => '', + 'type' => 'string', + 'example' => 'projex', + ], + 'value' => [ + 'title' => '填报时长', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '120', + ], + 'workitemId' => [ + 'title' => '需求ID（工作项ID）', + 'description' => '', + 'type' => 'string', + 'example' => '17bc1cf9a037a15fc9ce76xxxx', + ], + 'projectId' => [ + 'title' => '项目id', + 'description' => '', + 'type' => 'string', + 'example' => '09670872890eb1a0bb998exxxx', + ], + 'type' => [ + 'title' => '实际工时类别', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'gmtStart' => [ + 'title' => '实际工时-开始时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1714924800000', + ], + 'gmtEnd' => [ + 'title' => '实际工时-结束时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1715011199999', + ], + 'uuid' => [ + 'title' => '工时拆分后的唯一标识', + 'description' => '', + 'type' => 'string', + 'example' => '000000000cd82d3df50d5e5a5c094094fd7b4461', + ], + 'actualValue' => [ + 'title' => '工时拆分后的值', + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '120', + ], + 'description' => [ + 'title' => '工时描述', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 100,\\n \\"nextToken\\": \\"2\\",\\n \\"maxResults\\": 10,\\n \\"result\\": [\\n {\\n \\"id\\": 49506082,\\n \\"gmtCreate\\": 1714978610000,\\n \\"gmtModified\\": 1714978610000,\\n \\"identifier\\": \\"da70ce5824231ca3c04ef808e0\\",\\n \\"isDeleted\\": \\"N\\",\\n \\"organizationId\\": \\"61db9af2148974246bexxxx\\",\\n \\"recorderId\\": \\"65659358c319d2a0f912xxxx\\",\\n \\"source\\": \\"projex\\",\\n \\"value\\": 120,\\n \\"workitemId\\": \\"17bc1cf9a037a15fc9ce76xxxx\\",\\n \\"projectId\\": \\"09670872890eb1a0bb998exxxx\\",\\n \\"type\\": \\"研发\\",\\n \\"gmtStart\\": 1714924800000,\\n \\"gmtEnd\\": 1715011199999,\\n \\"uuid\\": \\"000000000cd82d3df50d5e5a5c094094fd7b4461\\",\\n \\"actualValue\\": 120,\\n \\"description\\": \\"描述信息\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ExportInsightTagRef' => [ + 'summary' => '导出Insight tag_ref表数据', + 'path' => '/organization/{organizationId}/data/tagRefs', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '61db9af2148974246bexxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'startTime' => [ + 'title' => '开始时间。和结束时间间隔不超过1年。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2024-05-01 00:00:00'."\n", + ], + 'endTime' => [ + 'title' => '结束时间。和开始时间间隔不超过1年。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2024-06-01 00:00:00'."\n", + ], + 'nextToken' => [ + 'title' => '下一页token', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'maxResults' => [ + 'title' => '最大结果条数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'totalCount' => [ + 'title' => '总条数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'nextToken' => [ + 'title' => '下一页token，为null表示没有下一页', + 'description' => '', + 'type' => 'string', + 'example' => '2', + ], + 'maxResults' => [ + 'title' => '返回条数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'tag_ref', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '记录自增Id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '41317426', + ], + 'gmtCreate' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1696660187000', + ], + 'gmtModified' => [ + 'title' => '更新时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1696660187000', + ], + 'identifier' => [ + 'title' => '唯一标识', + 'description' => '', + 'type' => 'string', + 'example' => '8545272', + ], + 'isDeleted' => [ + 'title' => '是否删除(Y|N)', + 'description' => '', + 'type' => 'string', + 'example' => 'N', + ], + 'organizationId' => [ + 'title' => '企业id', + 'description' => '', + 'type' => 'string', + 'example' => '61db9af2148974246bexxxx', + ], + 'name' => [ + 'title' => '标签名字', + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'tagId' => [ + 'title' => '标签本身唯一标识', + 'description' => '', + 'type' => 'string', + 'example' => '19e0bc5348ccbe6c0d00fbxxxx', + ], + 'targetId' => [ + 'title' => '打标对象的资源id', + 'description' => '', + 'type' => 'string', + 'example' => 'bde89961b5a4acc8cf54eaxxxx', + ], + 'targetType' => [ + 'title' => '打标对象的资源类型，如workitem space code', + 'description' => '', + 'type' => 'string', + 'example' => 'Workitem', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 100,\\n \\"nextToken\\": \\"2\\",\\n \\"maxResults\\": 10,\\n \\"result\\": [\\n {\\n \\"id\\": 41317426,\\n \\"gmtCreate\\": 1696660187000,\\n \\"gmtModified\\": 1696660187000,\\n \\"identifier\\": \\"8545272\\",\\n \\"isDeleted\\": \\"N\\",\\n \\"organizationId\\": \\"61db9af2148974246bexxxx\\",\\n \\"name\\": \\"1\\",\\n \\"tagId\\": \\"19e0bc5348ccbe6c0d00fbxxxx\\",\\n \\"targetId\\": \\"bde89961b5a4acc8cf54eaxxxx\\",\\n \\"targetType\\": \\"Workitem\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ExportInsightSprint' => [ + 'summary' => '导出Insight sprint表数据', + 'path' => '/organization/{organizationId}/data/sprints', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '61db9af2148974246bexxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'startTime' => [ + 'title' => '开始时间。和结束时间间隔不超过1年。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2024-05-01 00:00:00'."\n", + ], + 'endTime' => [ + 'title' => '结束时间。和开始时间间隔不超过1年。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2024-06-01 00:00:00'."\n", + ], + 'nextToken' => [ + 'title' => '下一页token', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'maxResults' => [ + 'title' => '最大结果条数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'totalCount' => [ + 'title' => '总条数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'nextToken' => [ + 'title' => '下一页token，为null表示没有下一页', + 'description' => '', + 'type' => 'string', + 'example' => '2', + ], + 'maxResults' => [ + 'title' => '返回条数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'sprint', + 'type' => 'object', + 'properties' => [ + 'gmtCreate' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710989643000', + ], + 'id' => [ + 'title' => '记录自增Id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '18471761', + ], + 'gmtModified' => [ + 'title' => '更新时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1711936113000', + ], + 'identifier' => [ + 'title' => '唯一标识', + 'description' => '', + 'type' => 'string', + 'example' => 'e4895cadc86632f34dfaa7xxxx', + ], + 'isDeleted' => [ + 'title' => '是否删除(Y|N)', + 'description' => '', + 'type' => 'string', + 'example' => 'N', + ], + 'organizationId' => [ + 'title' => '企业id', + 'description' => '', + 'type' => 'string', + 'example' => '61db9af2148974246bexxxx', + ], + 'gmtEnd' => [ + 'title' => '迭代计划结束时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1711728000000', + ], + 'gmtStart' => [ + 'title' => '迭代计划开始时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1711936113000', + ], + 'actualStart' => [ + 'title' => '实际开始时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1711936113000', + ], + 'actualEnd' => [ + 'title' => '实际结束时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1711936113000', + ], + 'name' => [ + 'title' => '迭代名称', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'source' => [ + 'title' => '来源', + 'description' => '', + 'type' => 'string', + 'example' => 'projex', + ], + 'projectId' => [ + 'title' => '项目id', + 'description' => '', + 'type' => 'string', + 'example' => '385e7e5a4be6791f0a5185xxxx', + ], + 'workTimeCapacity' => [ + 'title' => '工时容量评估字段', + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '60.0', + ], + 'status' => [ + 'title' => '迭代状态：待开始，进行中，已完成/关闭', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 100,\\n \\"nextToken\\": \\"2\\",\\n \\"maxResults\\": 10,\\n \\"result\\": [\\n {\\n \\"gmtCreate\\": 1710989643000,\\n \\"id\\": 18471761,\\n \\"gmtModified\\": 1711936113000,\\n \\"identifier\\": \\"e4895cadc86632f34dfaa7xxxx\\",\\n \\"isDeleted\\": \\"N\\",\\n \\"organizationId\\": \\"61db9af2148974246bexxxx\\",\\n \\"gmtEnd\\": 1711728000000,\\n \\"gmtStart\\": 1711936113000,\\n \\"actualStart\\": 1711936113000,\\n \\"actualEnd\\": 1711936113000,\\n \\"name\\": \\"迭代0601\\",\\n \\"source\\": \\"projex\\",\\n \\"projectId\\": \\"385e7e5a4be6791f0a5185xxxx\\",\\n \\"workTimeCapacity\\": 60,\\n \\"status\\": 50\\n }\\n ]\\n}","type":"json"}]', + ], + 'ExportInsightSpaceRef' => [ + 'summary' => '导出Insight space_ref表数据', + 'path' => '/organization/{organizationId}/data/spaceRefs', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '61db9af2148974246bexxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'startTime' => [ + 'title' => '开始时间。和结束时间间隔不超过1年。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2024-05-01 00:00:00'."\n", + ], + 'endTime' => [ + 'title' => '结束时间。和开始时间间隔不超过1年。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2024-06-01 00:00:00'."\n", + ], + 'nextToken' => [ + 'title' => '下一页token', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'maxResults' => [ + 'title' => '最大结果条数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'totalCount' => [ + 'title' => '总条数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'nextToken' => [ + 'title' => '下一页token，为null表示没有下一页', + 'description' => '', + 'type' => 'string', + 'example' => '2', + ], + 'maxResults' => [ + 'title' => '返回条数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'space_ref', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '记录自增Id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '356525', + ], + 'gmtCreate' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1704267849000', + ], + 'gmtModified' => [ + 'title' => '更新时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1704267849000', + ], + 'identifier' => [ + 'title' => '唯一标识', + 'description' => '', + 'type' => 'string', + 'example' => '49565', + ], + 'isDeleted' => [ + 'title' => '是否删除(Y|N)', + 'description' => '', + 'type' => 'string', + 'example' => 'N', + ], + 'organizationId' => [ + 'title' => '企业id', + 'description' => '', + 'type' => 'string', + 'example' => '61db9af2148974246bexxxx', + ], + 'creatorId' => [ + 'title' => '创建人ID', + 'description' => '', + 'type' => 'string', + 'example' => '65659358c319d2a0f912xxxx', + ], + 'modifierId' => [ + 'title' => '修改人ID', + 'description' => '', + 'type' => 'string', + 'example' => '65659358c319d2a0f912xxxx', + ], + 'fromId' => [ + 'title' => '源空间id', + 'description' => '', + 'type' => 'string', + 'example' => '7bc2be989727d0d4c9801fxxxx', + ], + 'toId' => [ + 'title' => '目标空间id', + 'description' => '', + 'type' => 'string', + 'example' => '732026500a48d7a74f8b43xxxx', + ], + 'type' => [ + 'title' => '关联类型：项目集关联项目ASSOCIATED', + 'description' => '', + 'type' => 'string', + 'example' => 'ASSOCIATED', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 100,\\n \\"nextToken\\": \\"2\\",\\n \\"maxResults\\": 10,\\n \\"result\\": [\\n {\\n \\"id\\": 356525,\\n \\"gmtCreate\\": 1704267849000,\\n \\"gmtModified\\": 1704267849000,\\n \\"identifier\\": \\"49565\\",\\n \\"isDeleted\\": \\"N\\",\\n \\"organizationId\\": \\"61db9af2148974246bexxxx\\",\\n \\"creatorId\\": \\"65659358c319d2a0f912xxxx\\",\\n \\"modifierId\\": \\"65659358c319d2a0f912xxxx\\",\\n \\"fromId\\": \\"7bc2be989727d0d4c9801fxxxx\\",\\n \\"toId\\": \\"732026500a48d7a74f8b43xxxx\\",\\n \\"type\\": \\"ASSOCIATED\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ExportInsightSpace' => [ + 'summary' => '导出Insight space表数据', + 'path' => '/organization/{organizationId}/data/spaces', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '61db9af2148974246bexxxx'."\n", + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'startTime' => [ + 'title' => '开始时间。和结束时间间隔不超过1年。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2024-05-01 00:00:00'."\n", + ], + 'endTime' => [ + 'title' => '结束时间。和开始时间间隔不超过1年。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2024-06-01 00:00:00'."\n", + ], + 'nextToken' => [ + 'title' => '下一页token', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'maxResults' => [ + 'title' => '最大结果条数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'totalCount' => [ + 'title' => '总条数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'nextToken' => [ + 'title' => '下一页token，为null表示没有下一页', + 'description' => '', + 'type' => 'string', + 'example' => '2', + ], + 'maxResults' => [ + 'title' => '返回条数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'space', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '记录自增Id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11034222', + ], + 'gmtCreate' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1706510424000', + ], + 'gmtModified' => [ + 'title' => '更新时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1706511201000', + ], + 'identifier' => [ + 'title' => '唯一标识', + 'description' => '', + 'type' => 'string', + 'example' => '83a2861bbb43b270a04b42xxxx', + ], + 'isDeleted' => [ + 'title' => '是否删除(Y|N)', + 'description' => '', + 'type' => 'string', + 'example' => 'N', + ], + 'organizationId' => [ + 'title' => '企业id', + 'description' => '', + 'type' => 'string', + 'example' => '61db9af2148974246be6xxxx', + ], + 'description' => [ + 'title' => '空间描述', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'name' => [ + 'title' => '空间名称', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'type' => [ + 'title' => '空间类型，企业/项目/产品', + 'description' => '', + 'type' => 'string', + 'example' => 'Project', + ], + 'category' => [ + 'title' => '空间模板类型：敏捷研发，经典项目等', + 'description' => '', + 'type' => 'string', + 'example' => 'Project', + ], + 'source' => [ + 'title' => '空间来源', + 'description' => '', + 'type' => 'string', + 'example' => 'projex', + ], + 'status' => [ + 'title' => '项目状态', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'stage' => [ + 'title' => '项目状态阶段', + 'description' => '', + 'type' => 'string', + 'example' => '10', + ], + 'customCode' => [ + 'title' => '自定义编号', + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 100,\\n \\"nextToken\\": \\"2\\",\\n \\"maxResults\\": 10,\\n \\"result\\": [\\n {\\n \\"id\\": 11034222,\\n \\"gmtCreate\\": 1706510424000,\\n \\"gmtModified\\": 1706511201000,\\n \\"identifier\\": \\"83a2861bbb43b270a04b42xxxx\\",\\n \\"isDeleted\\": \\"N\\",\\n \\"organizationId\\": \\"61db9af2148974246be6xxxx\\",\\n \\"description\\": \\"项目描述\\",\\n \\"name\\": \\"研发项目\\",\\n \\"type\\": \\"Project\\",\\n \\"category\\": \\"Project\\",\\n \\"source\\": \\"projex\\",\\n \\"status\\": \\"未开始\\",\\n \\"stage\\": \\"10\\",\\n \\"customCode\\": \\"ABCD\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ExportInsightField' => [ + 'summary' => '导出Insight field表', + 'path' => '/organization/{organizationId}/data/fields', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '61db9af2148974246bexxxx'."\n", + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'startTime' => [ + 'title' => '开始时间。和结束时间间隔不超过1年。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2024-05-01 00:00:00'."\n", + ], + 'endTime' => [ + 'title' => '结束时间。和开始时间间隔不超过1年。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2024-06-01 00:00:00'."\n", + ], + 'nextToken' => [ + 'title' => '下一页token', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'maxResults' => [ + 'title' => '最大结果条数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'totalCount' => [ + 'title' => '总条数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'nextToken' => [ + 'title' => '下一页token，为null表示没有下一页', + 'description' => '', + 'type' => 'string', + 'example' => '2', + ], + 'maxResults' => [ + 'title' => '返回条数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'field', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '记录自增Id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '666666', + ], + 'fieldId' => [ + 'title' => '字段id，如自定义字段Id及标签id', + 'description' => '', + 'type' => 'string', + 'example' => '9798551', + ], + 'fieldName' => [ + 'title' => '字段名称', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'gmtCreate' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1713752162000', + ], + 'gmtModified' => [ + 'title' => '更新时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1714977502000', + ], + 'identifier' => [ + 'title' => '废弃', + 'description' => '', + 'type' => 'string', + 'example' => 'field-444153', + ], + 'isDeleted' => [ + 'title' => '是否删除(Y|N)', + 'description' => '', + 'type' => 'string', + 'example' => 'N', + ], + 'isSystem' => [ + 'title' => '是否系统字段(Y|N)', + 'description' => '', + 'type' => 'string', + 'example' => 'N', + ], + 'optionValue' => [ + 'title' => '字段可选值列表，如枚举有可选值', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'organizationId' => [ + 'title' => '企业id', + 'description' => '', + 'type' => 'string', + 'example' => '61db9af2148974246bexxxx', + ], + 'targetId' => [ + 'title' => '字段适用对象id, 如项目id, 企业id', + 'description' => '', + 'type' => 'string', + 'example' => '61db9af2148974246bexxxx', + ], + 'targetType' => [ + 'title' => '字段适用对象范围，如项目,企业等', + 'description' => '', + 'type' => 'string', + 'example' => 'organization', + ], + 'type' => [ + 'title' => '字段类型，如标签、枚举、文本、数值', + 'description' => '', + 'type' => 'string', + 'example' => 'string', + ], + 'position' => [ + 'title' => '字段顺序', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '150', + ], + 'scope' => [ + 'title' => '字段范围，space/global/system -> 项目内/全局/系统', + 'description' => '', + 'type' => 'string', + 'example' => 'global', + ], + 'source' => [ + 'title' => '字段来源系统，如projex/teambition', + 'description' => '', + 'type' => 'string', + 'example' => 'projex', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 100,\\n \\"nextToken\\": \\"2\\",\\n \\"maxResults\\": 10,\\n \\"result\\": [\\n {\\n \\"id\\": 666666,\\n \\"fieldId\\": \\"9798551\\",\\n \\"fieldName\\": \\"多选字段\\",\\n \\"gmtCreate\\": 1713752162000,\\n \\"gmtModified\\": 1714977502000,\\n \\"identifier\\": \\"field-444153\\",\\n \\"isDeleted\\": \\"N\\",\\n \\"isSystem\\": \\"N\\",\\n \\"optionValue\\": \\"\\\\\\"[\\\\\\\\\\\\\\"是\\\\\\\\\\\\\\"]\\\\\\"\\",\\n \\"organizationId\\": \\"61db9af2148974246bexxxx\\",\\n \\"targetId\\": \\"61db9af2148974246bexxxx\\",\\n \\"targetType\\": \\"organization\\",\\n \\"type\\": \\"string\\",\\n \\"position\\": 150,\\n \\"scope\\": \\"global\\",\\n \\"source\\": \\"projex\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ExportInsightExpectedWorkTime' => [ + 'summary' => '导出Insight expected_work_time表数据', + 'path' => '/organization/{organizationId}/data/expectedWorkTimes', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '61db9af2148974246bexxxx'."\n", + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'startTime' => [ + 'title' => '开始时间。和结束时间间隔不超过1年。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2024-05-01 00:00:00'."\n", + ], + 'endTime' => [ + 'title' => '结束时间。和开始时间间隔不超过1年。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2024-06-01 00:00:00'."\n", + ], + 'nextToken' => [ + 'title' => '下一页token', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'maxResults' => [ + 'title' => '最大结果条数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'totalCount' => [ + 'title' => '总条数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'nextToken' => [ + 'title' => '下一页token，为null表示没有下一页', + 'description' => '', + 'type' => 'string', + 'example' => '2', + ], + 'maxResults' => [ + 'title' => '返回条数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'expected_work_time', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '记录自增Id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '26281535', + ], + 'gmtCreate' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1714976497000', + ], + 'gmtModified' => [ + 'title' => '更新时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1714976520000', + ], + 'identifier' => [ + 'title' => '预计工时标识', + 'description' => '', + 'type' => 'string', + 'example' => 'bd4ddc7b0ea0ef2ab52699xxxx', + ], + 'isDeleted' => [ + 'title' => '是否删除(Y|N)', + 'description' => '', + 'type' => 'string', + 'example' => 'N'."\n", + ], + 'organizationId' => [ + 'title' => '租户隔离ID', + 'description' => '', + 'type' => 'string', + 'example' => '61db9af2148974246be6xxxx', + ], + 'projectId' => [ + 'title' => '项目id', + 'description' => '', + 'type' => 'string', + 'example' => '6c4687b0179e1d458fedf1xxxx', + ], + 'recorderId' => [ + 'title' => '预计工时填报人', + 'description' => '', + 'type' => 'string', + 'example' => '63466a385dc8531eebd7xxxx', + ], + 'source' => [ + 'title' => '工时来源', + 'description' => '', + 'type' => 'string', + 'example' => 'projex', + ], + 'type' => [ + 'title' => '工时类别', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'value' => [ + 'title' => '预计工时时长', + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '180', + ], + 'workitemId' => [ + 'title' => '工作项ID', + 'description' => '', + 'type' => 'string', + 'example' => 'de7c6fd3bd4b53f4d9e279xxxx', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 100,\\n \\"nextToken\\": \\"2\\",\\n \\"maxResults\\": 10,\\n \\"result\\": [\\n {\\n \\"id\\": 26281535,\\n \\"gmtCreate\\": 1714976497000,\\n \\"gmtModified\\": 1714976520000,\\n \\"identifier\\": \\"bd4ddc7b0ea0ef2ab52699xxxx\\",\\n \\"isDeleted\\": \\"N\\\\n\\",\\n \\"organizationId\\": \\"61db9af2148974246be6xxxx\\",\\n \\"projectId\\": \\"6c4687b0179e1d458fedf1xxxx\\",\\n \\"recorderId\\": \\"63466a385dc8531eebd7xxxx\\",\\n \\"source\\": \\"projex\\",\\n \\"type\\": \\"产品\\",\\n \\"value\\": 180,\\n \\"workitemId\\": \\"de7c6fd3bd4b53f4d9e279xxxx\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ExportInsightCustomValue' => [ + 'summary' => '导出Insight custom_value表', + 'path' => '/organization/{organizationId}/data/customValues', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '61db9af2148974246bexxxx'."\n", + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'startTime' => [ + 'title' => '开始时间。和结束时间间隔不超过1年。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2024-05-01 00:00:00'."\n", + ], + 'endTime' => [ + 'title' => '结束时间。和开始时间间隔不超过1年。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2024-06-01 00:00:00'."\n", + ], + 'nextToken' => [ + 'title' => '下一页token', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'maxResults' => [ + 'title' => '最大结果条数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'totalCount' => [ + 'title' => '总条数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'nextToken' => [ + 'title' => '下一页token，为null表示没有下一页', + 'description' => '', + 'type' => 'string', + 'example' => '2', + ], + 'maxResults' => [ + 'title' => '返回条数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'custom_value', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '记录自增Id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '320737507', + ], + 'fieldId' => [ + 'title' => '字段id，如自定义字段Id及标签id', + 'description' => '', + 'type' => 'string', + 'example' => '34dde3dfa5e3750151a7c4xxxx', + ], + 'gmtCreate' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1704950971000', + ], + 'gmtModified' => [ + 'title' => '更新时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1714669494000', + ], + 'identifier' => [ + 'title' => '自定义字段表关联值的唯一标识', + 'description' => '', + 'type' => 'string', + 'example' => '442d4a6a9980e841dc192a411080xxxx', + ], + 'isDeleted' => [ + 'title' => '是否删除(Y|N)', + 'description' => '', + 'type' => 'string', + 'example' => 'N', + ], + 'organizationId' => [ + 'title' => '企业id', + 'description' => '', + 'type' => 'string', + 'example' => '61db9af2148974246bexxxx', + ], + 'targetId' => [ + 'title' => '关联对象的资源id', + 'description' => '', + 'type' => 'string', + 'example' => '1ee00fcb1a18c2dc83dafdxxxx', + ], + 'targetType' => [ + 'title' => '关联对象的资源类型，如workitem space code', + 'description' => '', + 'type' => 'string', + 'example' => 'Workitem', + ], + 'type' => [ + 'title' => '自定义字段值类型', + 'description' => '', + 'type' => 'string', + 'example' => 'string', + ], + 'value' => [ + 'description' => '', + 'type' => 'string', + 'example' => '66', + ], + 'doubleValue' => [ + 'title' => 'double值', + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '66.6', + ], + 'longValue' => [ + 'title' => 'long值', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '66', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 100,\\n \\"nextToken\\": \\"2\\",\\n \\"maxResults\\": 10,\\n \\"result\\": [\\n {\\n \\"id\\": 320737507,\\n \\"fieldId\\": \\"34dde3dfa5e3750151a7c4xxxx\\",\\n \\"gmtCreate\\": 1704950971000,\\n \\"gmtModified\\": 1714669494000,\\n \\"identifier\\": \\"442d4a6a9980e841dc192a411080xxxx\\",\\n \\"isDeleted\\": \\"N\\",\\n \\"organizationId\\": \\"61db9af2148974246bexxxx\\",\\n \\"targetId\\": \\"1ee00fcb1a18c2dc83dafdxxxx\\",\\n \\"targetType\\": \\"Workitem\\",\\n \\"type\\": \\"string\\",\\n \\"value\\": \\"66\\",\\n \\"doubleValue\\": 66.6,\\n \\"longValue\\": 66\\n }\\n ]\\n}","type":"json"}]', + ], + 'UpdateOrganizationMember' => [ + 'summary' => '当前用户加入的企业列表', + 'path' => '/organization/{organizationId}/members/{accountId}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => false, + 'notSupportAutoTestReason' => '数据面 api 经安全评估统一不做处理，后续逐步安排下线', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accountId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '243721251830762xxx', + ], + ], + [ + 'name' => 'organizationMemberName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ApiGenericResult', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'member' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'accountId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '292035769476261xxx', + ], + 'organizationMemberName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidParam.NoPermission', + 'errorMessage' => 'param value is not permission.', + ], + ], + [ + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F7B85D1B-D1C2-140F-A039-341859F130B9\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"member\\": {\\n \\"accountId\\": \\"292035769476261xxx\\",\\n \\"organizationMemberName\\": \\"名字1\\"\\n },\\n \\"success\\": true\\n}","type":"json"}]', + ], + 'ListOrganizationMembers' => [ + 'summary' => '获取企业成员列表', + 'path' => '/organization/{organizationId}/members', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '66c0c9fffeb86b450c199fcd', + ], + ], + [ + 'name' => 'organizationMemberName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'provider', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Dingtalk', + ], + ], + [ + 'name' => 'externUid', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1236666', + ], + ], + [ + 'name' => 'state', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '""', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '200', + 'minimum' => '1', + 'example' => '20', + ], + ], + [ + 'name' => 'joinTimeFrom', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1631845101798', + ], + ], + [ + 'name' => 'joinTimeTo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1631845101798', + ], + ], + [ + 'name' => 'containsExternInfo', + 'in' => 'query', + 'schema' => [ + 'title' => '返回信息中是否包含第三方信息，默认不包含。', + 'description' => '返回信息中是否包含第三方信息，默认不包含。', + 'type' => 'boolean', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => 'error info', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'nextToken' => [ + 'title' => '分页Token', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'totalCount' => [ + 'title' => '总数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '15', + ], + 'members' => [ + 'title' => '成员列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'accountId' => [ + 'title' => '阿里云用户ID', + 'description' => '', + 'type' => 'string', + 'example' => '123456677888', + ], + 'birthday' => [ + 'title' => '生日', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1631845101798', + ], + 'deptLists' => [ + 'title' => '部门名称列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '8fc0c9ff039711dd64acd000'."\n", + ], + ], + 'email' => [ + 'title' => '邮箱', + 'description' => '', + 'type' => 'string', + 'example' => '(敏感字段，暂不返回)', + ], + 'hiredDate' => [ + 'title' => '入职时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1631845101798', + ], + 'identities' => [ + 'title' => '第三方信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'externUid' => [ + 'title' => '第三方系统的用户Id', + 'description' => '', + 'type' => 'string', + 'example' => '1236666', + ], + 'provider' => [ + 'title' => '第三方系统', + 'description' => '', + 'type' => 'string', + 'example' => 'Dingtalk', + ], + ], + ], + 'joinTime' => [ + 'title' => '加入云效企业时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1631845101798', + ], + 'lastVisitTime' => [ + 'title' => '最近一次访问时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1631845101798', + ], + 'mobile' => [ + 'title' => '手机号', + 'description' => '', + 'type' => 'string', + 'example' => '(敏感字段，暂不返回)', + ], + 'organizationMemberName' => [ + 'title' => '企业成员名', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'organizationRoleName' => [ + 'title' => '企业角色名字', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'organizationRoleId' => [ + 'title' => '企业角色Id', + 'description' => '', + 'type' => 'string', + 'example' => '8fc0c9ff039711dd64acd000', + ], + 'state' => [ + 'title' => '用户状态', + 'description' => '', + 'type' => 'string', + 'example' => 'normal', + ], + 'jobNumber' => [ + 'description' => '', + 'type' => 'string', + 'example' => '373***', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidParam.NoPermission', + 'errorMessage' => 'No Permission.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F\\",\\n \\"errorMessage\\": \\"error info\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"null\\",\\n \\"nextToken\\": \\"\\\\\\"\\\\\\"\\",\\n \\"totalCount\\": 15,\\n \\"members\\": [\\n {\\n \\"accountId\\": \\"123456677888\\",\\n \\"birthday\\": 1631845101798,\\n \\"deptLists\\": [\\n \\"测试部门\\"\\n ],\\n \\"email\\": \\"[email protected]\\",\\n \\"hiredDate\\": 1631845101798,\\n \\"identities\\": {\\n \\"externUid\\": \\"1236666\\",\\n \\"provider\\": \\"Dingtalk\\"\\n },\\n \\"joinTime\\": 1631845101798,\\n \\"lastVisitTime\\": 1631845101798,\\n \\"mobile\\": \\"1390000****\\",\\n \\"organizationMemberName\\": \\"名字1\\",\\n \\"organizationRoleName\\": \\"管理员\\",\\n \\"organizationRoleId\\": \\"8fc0c9ff039711dd64acd000\\",\\n \\"state\\": \\"normal\\",\\n \\"jobNumber\\": \\"373***\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListOrganizationMembersResponse>\\n <requestId>FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F</requestId>\\n <errorMessage>error info</errorMessage>\\n <success>true</success>\\n <errorCode>null</errorCode>\\n <nextToken>\\"\\"</nextToken>\\n <totalCount>15</totalCount>\\n <members>\\n <accountId>123456677888</accountId>\\n <birthday>1631845101798</birthday>\\n <deptLists>测试部门</deptLists>\\n <email>[email protected]</email>\\n <hiredDate>1631845101798</hiredDate>\\n <identities>\\n <externUid>1236666</externUid>\\n <provider>Dingtalk</provider>\\n </identities>\\n <joinTime>1631845101798</joinTime>\\n <lastVisitTime>1631845101798</lastVisitTime>\\n <mobile>1390000****</mobile>\\n <organizationMemberName>名字1</organizationMemberName>\\n <organizationRoleName>管理员</organizationRoleName>\\n <organizationRoleId>8fc0c9ff039711dd64acd000</organizationRoleId>\\n <state>normal</state>\\n </members>\\n</ListOrganizationMembersResponse>","errorExample":""}]', + 'title' => 'ListOrganizationMembers', + ], + 'GetOrganizationMember' => [ + 'summary' => '获取企业成员', + 'path' => '/organization/{organizationId}/members/{accountId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '66c0c9fffeb86b450c199fcd', + ], + ], + [ + 'name' => 'accountId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '123456677888', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'HC93CE1A-8D7A-13A9-8306-7465DE2E5C0F', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => 'error info', + ], + 'member' => [ + 'title' => '成员', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'accountId' => [ + 'title' => '阿里云用户PK', + 'description' => '', + 'type' => 'string', + 'example' => '123456677888', + ], + 'birthday' => [ + 'title' => '生日', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1631845101798', + ], + 'deptLists' => [ + 'title' => '部门名称列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + 'email' => [ + 'title' => '邮箱', + 'description' => '', + 'type' => 'string', + 'example' => '(敏感字段，暂不返回)', + ], + 'hiredDate' => [ + 'title' => '入职时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1631845101798', + ], + 'identities' => [ + 'title' => '第三方信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'externUid' => [ + 'title' => '第三方系统的用户 id', + 'description' => '', + 'type' => 'string', + 'example' => '1236666', + ], + 'provider' => [ + 'title' => '第三方系统', + 'description' => '', + 'type' => 'string', + 'example' => 'Dingtalk', + ], + ], + ], + 'joinTime' => [ + 'title' => '加入云效企业时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1631845101798', + ], + 'lastVisitTime' => [ + 'title' => '最近一次访问时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1631845101798', + ], + 'mobile' => [ + 'title' => '手机号', + 'description' => '', + 'type' => 'string', + 'example' => '(敏感字段，暂不返回)', + ], + 'organizationMemberName' => [ + 'title' => '企业成员名', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'organizationRoleName' => [ + 'title' => '企业角色名字', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'jobNumber' => [ + 'description' => '', + 'type' => 'string', + 'example' => '373***', + ], + 'organizationRoleId' => [ + 'title' => '企业角色Id', + 'description' => '', + 'type' => 'string', + 'example' => '8fc0c9ff039711dd64acd000', + ], + 'state' => [ + 'title' => '用户状态', + 'description' => '', + 'type' => 'string', + 'example' => 'normal', + ], + ], + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"HC93CE1A-8D7A-13A9-8306-7465DE2E5C0F\\",\\n \\"errorMessage\\": \\"error info\\",\\n \\"member\\": {\\n \\"accountId\\": \\"123456677888\\",\\n \\"birthday\\": 1631845101798,\\n \\"deptLists\\": [\\n \\"测试部门\\"\\n ],\\n \\"email\\": \\"[email protected]\\",\\n \\"hiredDate\\": 1631845101798,\\n \\"identities\\": {\\n \\"externUid\\": \\"1236666\\",\\n \\"provider\\": \\"Dingtalk\\"\\n },\\n \\"joinTime\\": 1631845101798,\\n \\"lastVisitTime\\": 1631845101798,\\n \\"mobile\\": \\"1390000****\\",\\n \\"organizationMemberName\\": \\"名字1\\",\\n \\"organizationRoleName\\": \\"管理员\\",\\n \\"jobNumber\\": \\"373***\\",\\n \\"organizationRoleId\\": \\"8fc0c9ff039711dd64acd000\\",\\n \\"state\\": \\"normal\\"\\n },\\n \\"errorCode\\": \\"null\\",\\n \\"success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetOrganizationMemberResponse>\\n <requestId>HC93CE1A-8D7A-13A9-8306-7465DE2E5C0F</requestId>\\n <errorMessage>error info</errorMessage>\\n <member>\\n <accountId>123456677888</accountId>\\n <birthday>1631845101798</birthday>\\n <deptLists>测试部门</deptLists>\\n <email>[email protected]</email>\\n <hiredDate>1631845101798</hiredDate>\\n <identities>\\n <externUid>1236666</externUid>\\n <provider>Dingtalk</provider>\\n </identities>\\n <joinTime>1631845101798</joinTime>\\n <lastVisitTime>1631845101798</lastVisitTime>\\n <mobile>1390000****</mobile>\\n <organizationMemberName>名字1</organizationMemberName>\\n <organizationRoleName>管理员</organizationRoleName>\\n <organizationRoleId>8fc0c9ff039711dd64acd000</organizationRoleId>\\n <state>normal</state>\\n </member>\\n <errorCode>null</errorCode>\\n <success>true</success>\\n</GetOrganizationMemberResponse>","errorExample":""}]', + 'title' => 'GetOrganizationMember', + ], + 'ListJoinedOrganizations' => [ + 'summary' => '当前用户加入的企业列表', + 'path' => '/users/joinedOrgs', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ApiGenericResult<List<OrganizationVO>>', + 'description' => 'ApiGenericResult<List<OrganizationVO>>', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '11D0EE6E-5803-5D4C-A652-E672BE1F3D8E', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '”“', + ], + 'organizations' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'string', + 'example' => '65f25d0fa54c216dcf6b1dbd'."\n", + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'isOrgAdmin' => [ + 'type' => 'boolean', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"11D0EE6E-5803-5D4C-A652-E672BE1F3D8F\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"organizations\\": [\\n {\\n \\"id\\": \\"65f25d0fa54c216dcf6b1dbd\\",\\n \\"name\\": \\"云效测试企业\\",\\n \\"isOrgAdmin\\": true\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetApplication' => [ + 'summary' => '查找应用详情', + 'path' => '/appstack/apps/{appName}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + '应用', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => false, + 'notSupportAutoTestReason' => '数据面 api 经安全评估统一不做处理，后续逐步安排下线', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'appName', + 'in' => 'path', + 'schema' => [ + 'title' => '应用名', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'testApp', + ], + ], + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => '企业标识，也称企业id', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '66c0c9fffeb86b450c199fcd', + ], + ], + ], + 'responses' => [ + 200 => [ + 'description' => '已按名称查找到应用详情', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '应用名', + 'description' => '', + 'type' => 'string', + 'example' => 'testApp', + ], + 'gmtCreate' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'string', + 'example' => '2024-01-01T00:00:00.000+00:00', + ], + 'creatorAccountId' => [ + 'title' => '创建者阿里云UID', + 'description' => '', + 'type' => 'string', + 'example' => '1332695887xxxxxx', + ], + 'description' => [ + 'title' => '应用描述', + 'description' => '', + 'type' => 'string', + 'example' => '应用描述', + ], + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F', + ], + 'appTemplateName' => [ + 'title' => '应用模版名称', + 'type' => 'string', + 'example' => '应用模版名称A', + ], + 'appTemplateDisplayName' => [ + 'title' => '应用模版展示名称', + 'type' => 'string', + 'example' => '应用模版展示名称A', + ], + ], + ], + ], + 404 => [ + 'description' => '未查找到应用详情', + ], + 500 => [ + 'description' => '服务端内部异常', + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"name\\": \\"testApp\\",\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00.000+00:00\\",\\n \\"creatorAccountId\\": \\"1332695887xxxxxx\\",\\n \\"description\\": \\"应用描述\\",\\n \\"requestId\\": \\"FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F\\",\\n \\"appTemplateName\\": \\"应用模版名称A\\",\\n \\"appTemplateDisplayName\\": \\"应用模版展示名称A\\"\\n}","type":"json"}]', + ], + 'UpdateApplication' => [ + 'summary' => '更新应用', + 'path' => '/appstack/apps/{appName}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + '应用', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => '企业标识，也称企业id', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '66c0c9fffeb86b450c199fcd', + ], + ], + [ + 'name' => 'appName', + 'in' => 'path', + 'schema' => [ + 'title' => '应用名', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'testApp', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ownerAccountId' => [ + 'title' => '拥有者阿里云UID', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '1332695887xxxxxx', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'description' => '更新成功', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'creatorAccountId' => [ + 'title' => '创建者阿里云UID', + 'description' => '', + 'type' => 'string', + 'example' => '1332695887xxxxxx', + ], + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F', + ], + 'name' => [ + 'title' => '应用名', + 'description' => '', + 'type' => 'string', + 'example' => 'testApp', + ], + 'gmtCreate' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'string', + 'example' => '2024-01-01T00:00:00.000+00:00', + ], + 'description' => [ + 'title' => '应用描述', + 'description' => '', + 'type' => 'string', + 'example' => '应用描述', + ], + ], + ], + ], + 404 => [ + 'description' => '未查找到指定的应用', + ], + 500 => [ + 'description' => '服务端内部异常', + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"creatorAccountId\\": \\"1332695887xxxxxx\\",\\n \\"requestId\\": \\"FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F\\",\\n \\"name\\": \\"testApp\\",\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00.000+00:00\\",\\n \\"description\\": \\"应用描述\\"\\n}","type":"json"}]', + ], + 'ListApplications' => [ + 'summary' => '分页查找应用详情', + 'path' => '/appstack/apps:search', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + '应用', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'pagination', + 'in' => 'query', + 'schema' => [ + 'title' => '分页模式参数，目前只支持键集分页 keyset 模式', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'keyset', + ], + ], + [ + 'name' => 'perPage', + 'in' => 'query', + 'schema' => [ + 'title' => '分页尺寸参数，决定一页最多返回多少对象', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'orderBy', + 'in' => 'query', + 'schema' => [ + 'title' => '分页排序属性，决定根据何种属性进行记录排序；推荐在实现严格遍历时，使用 id 属性', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'asc', + ], + ], + [ + 'name' => 'sort', + 'in' => 'query', + 'schema' => [ + 'title' => '分页排序升降序，asc 为升序，desc 为降序；推荐在实现严格遍历时，使用升序', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'id', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '键集分页 token，获取第一页数据时无需传入，否则需要传入前一页查询结果中的 nextToken 字段', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'vxc2341gfssad12', + ], + ], + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => '企业标识，也称企业id', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '66c0c9fffeb86b450c199fcd', + ], + ], + ], + 'responses' => [ + 200 => [ + 'description' => '分页查找完成（包括未查找到对象的情况）', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'nextToken' => [ + 'title' => '键集分页 token', + 'description' => '', + 'type' => 'string', + 'example' => 'vxc2341gfssad12', + ], + 'data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'creatorAccountId' => [ + 'title' => '创建者阿里云UID', + 'description' => '', + 'type' => 'string', + 'example' => '1332695887xxxxxx', + ], + 'name' => [ + 'title' => '应用名', + 'description' => '', + 'type' => 'string', + 'example' => 'testApp', + ], + 'gmtCreate' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'string', + 'example' => '2024-01-01T00:00:00.000+00:00', + ], + 'description' => [ + 'title' => '应用描述', + 'description' => '', + 'type' => 'string', + 'example' => '应用描述', + ], + ], + ], + ], + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F', + ], + ], + ], + ], + 500 => [ + 'description' => '服务端内部异常', + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"nextToken\\": \\"vxc2341gfssad12\\",\\n \\"data\\": [\\n {\\n \\"creatorAccountId\\": \\"1332695887xxxxxx\\",\\n \\"name\\": \\"testApp\\",\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00.000+00:00\\",\\n \\"description\\": \\"应用描述\\"\\n }\\n ],\\n \\"requestId\\": \\"FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F\\"\\n}","type":"json"}]', + ], + 'ListApplicationMembers' => [ + 'summary' => '查找应用成员列表', + 'path' => '/appstack/apps/{appName}/members', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + '应用', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'appName', + 'in' => 'path', + 'schema' => [ + 'title' => '应用名', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'testApp', + ], + ], + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => '企业标识，也称企业id', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '66c0c9fffeb86b450c199fcd', + ], + ], + ], + 'responses' => [ + 200 => [ + 'description' => '分页查找完成（包括未查找到对象的情况）', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'total' => [ + 'title' => '列表总数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'current' => [ + 'title' => '当前所在分页', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'pageSize' => [ + 'title' => '分页规模', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'pages' => [ + 'title' => '总页数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'records' => [ + 'title' => '成员列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '成员id，类型为User时为成员的阿里云UID', + 'description' => '', + 'type' => 'string', + 'example' => '1332695887xxxxxx', + ], + 'type' => [ + 'title' => '成员类型，目前只支持User', + 'description' => '', + 'type' => 'string', + 'example' => 'User', + ], + 'displayName' => [ + 'title' => '成员显示名', + 'description' => '', + 'type' => 'string', + 'example' => '成员1', + ], + 'description' => [ + 'title' => '成员描述', + 'description' => '', + 'type' => 'string', + 'example' => '成语描述', + ], + 'avatar' => [ + 'title' => '头像', + 'description' => '', + 'type' => 'string', + 'example' => 'http://', + ], + 'roleList' => [ + 'title' => '成员的角色列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '角色名', + 'description' => '', + 'type' => 'string', + 'example' => 'developer', + ], + 'displayName' => [ + 'title' => '角色显示名', + 'description' => '', + 'type' => 'string', + 'example' => '开发者', + ], + ], + ], + ], + ], + ], + ], + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F', + ], + ], + ], + ], + 500 => [ + 'description' => '服务端内部异常', + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 100,\\n \\"current\\": 1,\\n \\"pageSize\\": 10,\\n \\"pages\\": 10,\\n \\"records\\": [\\n {\\n \\"id\\": \\"1332695887xxxxxx\\",\\n \\"type\\": \\"User\\",\\n \\"displayName\\": \\"成员1\\",\\n \\"description\\": \\"成语描述\\",\\n \\"avatar\\": \\"http://\\",\\n \\"roleList\\": [\\n {\\n \\"name\\": \\"developer\\",\\n \\"displayName\\": \\"开发者\\"\\n }\\n ]\\n }\\n ],\\n \\"requestId\\": \\"FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F\\"\\n}","type":"json"}]', + ], + 'CreateAppMembers' => [ + 'summary' => '添加应用成员', + 'path' => '/appstack/apps/{appName}/members', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + '应用', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => '企业标识，也称企业id', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '66c0c9fffeb86b450c199fcd', + ], + ], + [ + 'name' => 'appName', + 'in' => 'path', + 'schema' => [ + 'title' => '应用名', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'testApp', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'roleNames' => [ + 'title' => '添加成员的角色列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'developer', + ], + 'required' => false, + 'docRequired' => true, + ], + 'playerList' => [ + 'title' => '添加的成员列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '成员id，类型为User时为成员的阿里云UID', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '1332695887xxxxxx', + ], + 'type' => [ + 'title' => '成员类型，目前只支持User', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'User', + 'default' => 'User', + ], + ], + 'required' => false, + ], + 'required' => false, + 'docRequired' => true, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'description' => '添加应用成员成功', + 'schema' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F', + ], + ], + 403 => [ + 'description' => '没权限设置拥有者', + ], + [ + 'description' => '角色未找到', + ], + 500 => [ + 'description' => '服务端内部异常', + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"\\"FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F\\"","type":"json"}]', + ], + 'UpdateAppMember' => [ + 'summary' => '更新应用成员', + 'path' => '/appstack/apps/{appName}/members', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + '应用', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => '企业标识，也称企业id', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '66c0c9fffeb86b450c199fcd', + ], + ], + [ + 'name' => 'appName', + 'in' => 'path', + 'schema' => [ + 'title' => '应用名', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'testApp', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'roleNames' => [ + 'title' => '更新成员的角色列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'developer', + ], + 'required' => false, + ], + 'player' => [ + 'title' => '更新的成员', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '成员id，类型为User时为成员的阿里云UID', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '1332695887xxxxxx', + ], + 'type' => [ + 'title' => '成员类型，目前只支持User', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'User', + 'default' => 'User', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'description' => '更新应用成员角色成功', + 'schema' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F', + ], + ], + 404 => [ + 'description' => '应用角色未找到', + ], + 500 => [ + 'description' => '服务端内部异常', + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"\\"FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F\\"","type":"json"}]', + ], + 'DeleteAppMember' => [ + 'summary' => '删除应用成员', + 'path' => '/appstack/apps/{appName}/members', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + '应用', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => '企业标识，也称企业id', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '66c0c9fffeb86b450c199fcd', + ], + ], + [ + 'name' => 'appName', + 'in' => 'path', + 'schema' => [ + 'title' => '应用名', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'testApp', + ], + ], + [ + 'name' => 'subjectType', + 'in' => 'query', + 'schema' => [ + 'title' => '成员类型，目前只支持User', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'User', + ], + ], + [ + 'name' => 'subjectId', + 'in' => 'query', + 'schema' => [ + 'title' => '成员id，类型为User时为成员的阿里云UID', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '1332695887xxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'description' => '删除应用成员成功', + 'schema' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '', + 'type' => 'string', + 'example' => 'FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F', + ], + ], + 500 => [ + 'description' => '服务端内部异常', + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"\\"FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F\\"","type":"json"}]', + ], + 'GetReleaseStagePipelineRun' => [ + 'summary' => '获取研发阶段流水线运行实例', + 'path' => '/appstack/apps/{appName}/releaseWorkflows/{releaseWorkflowSn}/releaseStages/{releaseStageSn}/executions/{executionNumber}:getPipelineRun', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'autoTest' => false, + 'notSupportAutoTestReason' => '数据面 api 经安全评估统一不做处理，后续逐步安排下线', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => '企业标识，也称企业id', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '66c0c9fffeb86b450c199fcd', + ], + ], + [ + 'name' => 'appName', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testApp', + ], + ], + [ + 'name' => 'releaseWorkflowSn', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ce51b31b996246ecaf8747368383****', + ], + ], + [ + 'name' => 'releaseStageSn', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'e173f3c11db5445eb426ca33c922****', + ], + ], + [ + 'name' => 'executionNumber', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'GetPipelineRunResponse', + 'description' => 'GetPipelineRunResponse', + 'type' => 'object', + 'properties' => [ + 'pipelineRun' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'creatorAccountId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1111111111', + ], + 'createTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1586863220000', + ], + 'updateTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1586863220000', + ], + 'modifierAccountId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '11111111111', + ], + 'pipelineId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'pipelineRunId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'triggerMode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'stageGroup' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'Group', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + 'stages' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'stageInfo' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'startTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1586863220000', + ], + 'endTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1586863220000', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'jobs' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '21212', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'startTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1586863220000', + ], + 'endTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1586863220000', + ], + 'status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'params' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{}', + ], + 'actions' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'PassPipelineValidate', + ], + 'disable' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'params' => [ + 'description' => '', + 'type' => 'any', + 'example' => '{}', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'sources' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Codeup', + ], + 'sign' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'assaaaaaasasasa', + ], + 'data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'branch' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'master', + ], + 'commit' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{}', + ], + 'repo' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'http://codeup.aliyun.com/a.git', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"pipelineRun\\": {\\n \\"creatorAccountId\\": \\"1111111111\\",\\n \\"createTime\\": 1586863220000,\\n \\"updateTime\\": 1586863220000,\\n \\"modifierAccountId\\": \\"11111111111\\",\\n \\"pipelineId\\": 1234,\\n \\"pipelineRunId\\": 1,\\n \\"status\\": \\"SUCCESS\\",\\n \\"triggerMode\\": 1,\\n \\"stageGroup\\": [\\n [\\n \\"阶段名称\\"\\n ]\\n ],\\n \\"stages\\": [\\n {\\n \\"name\\": \\"Java构建\\",\\n \\"stageInfo\\": {\\n \\"startTime\\": 1586863220000,\\n \\"endTime\\": 1586863220000,\\n \\"name\\": \\"Java构建\\",\\n \\"status\\": \\"RUNNING\\",\\n \\"jobs\\": [\\n {\\n \\"id\\": 21212,\\n \\"name\\": \\"Java构建\\",\\n \\"startTime\\": 1586863220000,\\n \\"endTime\\": 1586863220000,\\n \\"status\\": \\"RUNNING\\",\\n \\"params\\": \\"{}\\",\\n \\"actions\\": [\\n {\\n \\"type\\": \\"PassPipelineValidate\\",\\n \\"disable\\": true,\\n \\"params\\": \\"{}\\"\\n }\\n ]\\n }\\n ]\\n }\\n }\\n ],\\n \\"sources\\": [\\n {\\n \\"type\\": \\"Codeup\\",\\n \\"sign\\": \\"assaaaaaasasasa\\",\\n \\"data\\": {\\n \\"branch\\": \\"master\\",\\n \\"commit\\": \\"{}\\",\\n \\"repo\\": \\"http://codeup.aliyun.com/a.git\\"\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ExecuteChangeRequestReleaseStage' => [ + 'summary' => '执行研发阶段流水线', + 'path' => '/appstack/apps/{appName}/releaseWorkflows/{releaseWorkflowSn}/releaseStages/{releaseStageSn}:execute', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'autoTest' => false, + 'notSupportAutoTestReason' => '数据面 api 经安全评估统一不做处理，后续逐步安排下线', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => '企业标识，也称企业id', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '66c0c9fffeb86b450c199fcd', + ], + ], + [ + 'name' => 'appName', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testApp', + ], + ], + [ + 'name' => 'releaseWorkflowSn', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ce51b31b996246ecaf8747368383****', + ], + ], + [ + 'name' => 'releaseStageSn', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'e173f3c11db5445eb426ca33c922****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'params' => [ + 'description' => '', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'any', + 'description' => '', + 'example' => '', + ], + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ExecutePipelineResult', + 'description' => 'ExecutePipelineResult', + 'type' => 'object', + 'properties' => [ + 'object' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'pipelineId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3259***', + ], + 'pipelineRunId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"object\\": 1,\\n \\"pipelineId\\": 0,\\n \\"pipelineRunId\\": 1\\n}","type":"json"}]', + ], + 'CancelExecutionReleaseStage' => [ + 'summary' => '取消执行研发阶段流水线', + 'path' => '/appstack/apps/{appName}/releaseWorkflows/{releaseWorkflowSn}/releaseStages/{releaseStageSn}/executions/{executionNumber}:cancel', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'autoTest' => false, + 'notSupportAutoTestReason' => '数据面 api 经安全评估统一不做处理，后续逐步安排下线', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => '企业标识，也称企业id', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '66c0c9fffeb86b450c19****', + ], + ], + [ + 'name' => 'appName', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'app-name', + ], + ], + [ + 'name' => 'releaseWorkflowSn', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ce51b31b996246ecaf8747368383****', + ], + ], + [ + 'name' => 'releaseStageSn', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'e173f3c11db5445eb426ca33c922****', + ], + ], + [ + 'name' => 'executionNumber', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'CancelExecutionResponse', + 'description' => 'CancelExecutionResponse', + 'type' => 'object', + 'properties' => [ + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"success\\": true\\n}","type":"json"}]', + ], + 'ListAllReleaseWorkflows' => [ + 'summary' => '查找应用下所有的研发流程', + 'path' => '/appstack/apps/{appName}/releaseWorkflows', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => '企业标识，也称企业id', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '66c0c9fffeb86b450c199fcd', + ], + ], + [ + 'name' => 'appName', + 'in' => 'path', + 'schema' => [ + 'title' => '应用名', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testApp', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'List<ReleaseWorkflow>', + 'description' => 'List<ReleaseWorkflow>', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'appName' => [ + 'title' => '应用名', + 'description' => '', + 'type' => 'string', + 'example' => 'testApp', + ], + 'sn' => [ + 'title' => '唯一标识sn', + 'description' => '', + 'type' => 'string', + 'example' => 'ce51b31b996246ecaf874736838360b2', + ], + 'name' => [ + 'title' => '名称', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'order' => [ + 'title' => '排序', + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'releaseStages' => [ + 'title' => '研发阶段', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'appName' => [ + 'title' => '应用名', + 'description' => '', + 'type' => 'string', + 'example' => 'testApp', + ], + 'name' => [ + 'title' => '阶段名', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'sn' => [ + 'title' => '阶段sn', + 'description' => '', + 'type' => 'string', + 'example' => '5aa8cc67e75e41bf9dddeb708775bcc3', + ], + 'releaseWorkflowSn' => [ + 'title' => '所属的研发流程sn', + 'description' => '', + 'type' => 'string', + 'example' => 'ce51b31b996246ecaf874736838360b2', + ], + 'order' => [ + 'title' => '阶段顺序', + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'variableGroups' => [ + 'title' => '变量组列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '变量组名称', + 'description' => '', + 'type' => 'string', + 'example' => 'dev', + ], + 'displayName' => [ + 'title' => '变量组显示名', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'type' => [ + 'title' => '变量组类型', + 'description' => '', + 'type' => 'string', + 'example' => 'APP', + 'enum' => [ + 'GLOBAL', + 'APP', + ], + ], + ], + ], + ], + ], + ], + ], + 'note' => [ + 'title' => '公告', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"[\\n {\\n \\"appName\\": \\"testApp\\",\\n \\"sn\\": \\"ce51b31b996246ecaf874736838360b2\\",\\n \\"name\\": \\"标准研发流程\\",\\n \\"order\\": \\"1\\",\\n \\"releaseStages\\": [\\n {\\n \\"appName\\": \\"testApp\\",\\n \\"name\\": \\"开发阶段\\",\\n \\"sn\\": \\"5aa8cc67e75e41bf9dddeb708775bcc3\\",\\n \\"releaseWorkflowSn\\": \\"ce51b31b996246ecaf874736838360b2\\",\\n \\"order\\": \\"1\\",\\n \\"variableGroups\\": [\\n {\\n \\"name\\": \\"dev\\",\\n \\"displayName\\": \\"开发环境变量组\\",\\n \\"type\\": \\"APP\\"\\n }\\n ]\\n }\\n ],\\n \\"note\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n]","type":"json"}]', + ], + 'ListAppReleaseStageExecutions' => [ + 'summary' => '批量查询研发阶段执行记录', + 'path' => '/appstack/apps/{appName}/releaseWorkflows/{releaseWorkflowSn}/releaseStages/{releaseStageSn}/executions', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => '企业标识，也称企业id', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '66c0c9fffeb86b450c199fcd', + ], + ], + [ + 'name' => 'appName', + 'in' => 'path', + 'schema' => [ + 'title' => '应用名', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testApp', + ], + ], + [ + 'name' => 'releaseWorkflowSn', + 'in' => 'path', + 'schema' => [ + 'title' => '研发流程sn', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '340beb481a334fd49b006816382f0c11', + ], + ], + [ + 'name' => 'releaseStageSn', + 'in' => 'path', + 'schema' => [ + 'title' => '研发阶段sn', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'e173f3c11db5445eb426ca33c92207c8', + ], + ], + [ + 'name' => 'pagination', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'keyset' => 'keyset', + ], + 'example' => 'keyset', + ], + ], + [ + 'name' => 'perPage', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'orderBy', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'id' => 'id', + 'gmtCreate' => 'gmtCreate', + ], + 'example' => 'gmtCreate', + ], + ], + [ + 'name' => 'sort', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'asc' => 'asc', + 'desc' => 'desc', + ], + 'example' => 'desc', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '""', + ], + ], + [ + 'name' => 'page', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PageList<ReleaseStageInstanceVO>', + 'description' => 'PageList<ReleaseStageInstanceVO>', + 'type' => 'object', + 'properties' => [ + 'nextToken' => [ + 'title' => '采用键值分页时存在该字段，用于传给分页接口，迭代获取下一页数据', + 'description' => '', + 'type' => 'string', + 'example' => 'vxc2341gfssad12', + ], + 'data' => [ + 'title' => '分页结果数据', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'number' => [ + 'title' => '流水线执行编号', + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'state' => [ + 'title' => '流水线执行状态', + 'description' => '', + 'type' => 'string', + 'example' => 'SUCCESS', + 'enum' => [ + 'RUNNING', + 'SUCCESS', + 'FAILED', + 'CANCELED', + 'UNKNOWN', + ], + ], + 'triggerMode' => [ + 'title' => '流水线执行触发方式', + 'description' => '', + 'type' => 'string', + 'example' => 'MANUAL', + ], + 'startTime' => [ + 'title' => '流水线执行开始时间', + 'description' => '', + 'type' => 'string', + 'example' => '2024-06-25T07:25:54.000+00:00', + ], + 'endTime' => [ + 'title' => '流水线执行结束时间', + 'description' => '', + 'type' => 'string', + 'example' => '2024-06-25T07:26:18.000+00:00', + ], + ], + ], + ], + 'total' => [ + 'title' => '页码分页时存在该字段，表示结果总数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'current' => [ + 'title' => '页码分页时存在该字段，表示当前页', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'perPage' => [ + 'title' => '页码分页时存在该字段，表示每页大小', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'pages' => [ + 'title' => '页码分页时存在该字段，表示总页数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"nextToken\\": \\"vxc2341gfssad12\\",\\n \\"data\\": [\\n {\\n \\"number\\": \\"1\\",\\n \\"state\\": \\"SUCCESS\\",\\n \\"triggerMode\\": \\"MANUAL\\",\\n \\"startTime\\": \\"2024-06-25T07:25:54.000+00:00\\",\\n \\"endTime\\": \\"2024-06-25T07:26:18.000+00:00\\"\\n }\\n ],\\n \\"total\\": 2,\\n \\"current\\": 1,\\n \\"perPage\\": 20,\\n \\"pages\\": 1\\n}","type":"json"}]', + ], + 'ListAppReleaseStageExecutionIntegratedMetadata' => [ + 'summary' => '查询研发阶段执行记录集成变更信息', + 'path' => '/appstack/apps/{appName}/releaseWorkflows/{releaseWorkflowSn}/releaseStages/{releaseStageSn}/executions/{executionNumber}/integratedMetadata', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => '企业标识，也称企业id', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '66c0c9fffeb86b450c199fcd', + ], + ], + [ + 'name' => 'appName', + 'in' => 'path', + 'schema' => [ + 'title' => '应用名', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testApp', + ], + ], + [ + 'name' => 'releaseWorkflowSn', + 'in' => 'path', + 'schema' => [ + 'title' => '研发流程sn', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ce51b31b996246ecaf874736838360b2', + ], + ], + [ + 'name' => 'releaseStageSn', + 'in' => 'path', + 'schema' => [ + 'title' => '研发阶段sn', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'e173f3c11db5445eb426ca33c92207c8', + ], + ], + [ + 'name' => 'executionNumber', + 'in' => 'path', + 'schema' => [ + 'title' => '研发阶段的执行记录编号', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'List<ReleaseStageInstanceIntegratedMetadataVO>', + 'description' => 'List<ReleaseStageInstanceIntegratedMetadataVO>', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'releaseBranch' => [ + 'title' => '发布分支', + 'description' => '', + 'type' => 'string', + 'example' => 'release/20240625-152603220321211_release_3252057_1', + ], + 'releaseRevision' => [ + 'title' => '发布分支git版本', + 'description' => '', + 'type' => 'string', + 'example' => 'a66cfa8c6869b96bb7d111ba2144c9c764d556b7', + ], + 'repoUrl' => [ + 'title' => '代码仓库地址', + 'description' => '', + 'type' => 'string', + 'example' => 'https://codeup.aliyun.com/60d54f3daccf2bbd6659f3ad/auto-test.git', + ], + 'repoType' => [ + 'title' => '代码仓库类型', + 'description' => '', + 'type' => 'string', + 'example' => 'CODEUP', + ], + 'changeRequests' => [ + 'title' => '变更请求', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'sn' => [ + 'title' => '变更请求编号', + 'description' => '', + 'type' => 'string', + 'example' => 'fcd37726a6f84c60b7eb9c5856007c2f', + ], + 'name' => [ + 'title' => '变更请求名称', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'branchName' => [ + 'title' => '变更请求分支', + 'description' => '', + 'type' => 'string', + 'example' => 'feature/20240625', + ], + 'commitId' => [ + 'title' => '变更请求commitId', + 'description' => '', + 'type' => 'string', + 'example' => 'a66cfa8c6869b96bb7d111ba2144c9c764d556b7', + ], + 'ownerAccountId' => [ + 'title' => '变更请求拥有者的阿里云pk', + 'description' => '', + 'type' => 'string', + 'example' => '262579140573491041', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"[\\n {\\n \\"releaseBranch\\": \\"release/20240625-152603220321211_release_3252057_1\\",\\n \\"releaseRevision\\": \\"a66cfa8c6869b96bb7d111ba2144c9c764d556b7\\",\\n \\"repoUrl\\": \\"https://codeup.aliyun.com/60d54f3daccf2bbd6659f3ad/auto-test.git\\",\\n \\"repoType\\": \\"CODEUP\\",\\n \\"changeRequests\\": [\\n {\\n \\"sn\\": \\"fcd37726a6f84c60b7eb9c5856007c2f\\",\\n \\"name\\": \\"变更名称\\",\\n \\"branchName\\": \\"feature/20240625\\",\\n \\"commitId\\": \\"a66cfa8c6869b96bb7d111ba2144c9c764d556b7\\",\\n \\"ownerAccountId\\": \\"262579140573491041\\"\\n }\\n ]\\n }\\n]","type":"json"}]', + ], + 'RefuseReleaseStagePipelineValidate' => [ + 'summary' => '拒绝人工卡点', + 'path' => '/appstack/apps/{appName}/releaseWorkflows/{releaseWorkflowSn}/releaseStages/{releaseStageSn}/executions/{executionNumber}:refusePipelineValidate', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'autoTest' => false, + 'notSupportAutoTestReason' => '数据面 api 经安全评估统一不做处理，后续逐步安排下线', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => '企业标识，也称企业id', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '66c0c9fffeb86b450c19****', + ], + ], + [ + 'name' => 'appName', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testApp', + ], + ], + [ + 'name' => 'releaseWorkflowSn', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ce51b31b996246ecaf8747368383****', + ], + ], + [ + 'name' => 'releaseStageSn', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'e173f3c11db5445eb426ca33c922****', + ], + ], + [ + 'name' => 'executionNumber', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'jobId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '226241***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RefusePipelineValidateResponse', + 'description' => 'RefusePipelineValidateResponse', + 'type' => 'object', + 'properties' => [ + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"success\\": true\\n}","type":"json"}]', + ], + 'PassReleaseStagePipelineValidate' => [ + 'summary' => '通过人工卡点', + 'path' => '/appstack/apps/{appName}/releaseWorkflows/{releaseWorkflowSn}/releaseStages/{releaseStageSn}/executions/{executionNumber}:passPipelineValidate', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'autoTest' => false, + 'notSupportAutoTestReason' => '数据面 api 经安全评估统一不做处理，后续逐步安排下线', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => '企业标识，也称企业id', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '66c0c9fffeb86b450c199***', + ], + ], + [ + 'name' => 'appName', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testApp', + ], + ], + [ + 'name' => 'releaseWorkflowSn', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ce51b31b996246ecaf8747368383****', + ], + ], + [ + 'name' => 'releaseStageSn', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'e173f3c11db5445eb426ca33c922****', + ], + ], + [ + 'name' => 'executionNumber', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'jobId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '226241***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PassPipelineValidateResponse', + 'description' => 'PassPipelineValidateResponse', + 'type' => 'object', + 'properties' => [ + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"success\\": true\\n}","type":"json"}]', + ], + 'CreateChangeRequest' => [ + 'summary' => '创建变更', + 'path' => '/appstack/apps/{appName}/changeRequests', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'autoTest' => false, + 'notSupportAutoTestReason' => '数据面 api 经安全评估统一不做处理，后续逐步安排下线', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => '企业标识，也称企业id', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '66c0c9fffeb86b450c199fcd', + ], + ], + [ + 'name' => 'appName', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'app-name', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'title' => [ + 'title' => '标题', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + 'ownerId' => [ + 'title' => 'ownerId', + 'type' => 'string', + 'required' => true, + ], + 'ownerAccountId' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1332695887xxxxxx', + ], + 'appCodeRepoSn' => [ + 'title' => '应用代码库唯一标识', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'sn123', + ], + 'branchName' => [ + 'title' => '分支名称', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'hotfix/20240524', + ], + 'autoDeleteBranchWhenEnd' => [ + 'title' => '变更结束后是否自动删除分支', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + 'createBranch' => [ + 'title' => '是否创建新分支', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ChangeRequestVO', + 'description' => 'ChangeRequestVO', + 'type' => 'object', + 'properties' => [ + 'sn' => [ + 'title' => '唯一标识符', + 'description' => '', + 'type' => 'string', + 'example' => 'ce51b31b996246ecaf874736838360b2', + ], + 'appName' => [ + 'title' => '应用名', + 'description' => '', + 'type' => 'string', + 'example' => 'app-name', + ], + 'state' => [ + 'title' => '状态', + 'description' => '', + 'type' => 'string', + 'example' => 'DEVELOPING', + ], + 'name' => [ + 'title' => '变更名称', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'type' => [ + 'title' => '变更状态', + 'description' => '', + 'type' => 'string', + 'example' => 'APP', + ], + 'appCodeRepoSn' => [ + 'title' => '代码仓库唯一标识', + 'description' => '', + 'type' => 'string', + 'example' => 'sn123', + ], + 'branch' => [ + 'title' => '变更代码分支', + 'description' => '', + 'type' => 'string', + 'example' => 'hotfix/20240524', + ], + 'ownerId' => [ + 'title' => '拥有者云效id', + 'description' => '', + 'type' => 'string', + 'example' => 'owner-id-123', + ], + 'ownerAccountId' => [ + 'title' => '拥有者的阿里云账号pk', + 'description' => '', + 'type' => 'string', + 'example' => 'account-id-123', + ], + 'originBranch' => [ + 'title' => '代码分支源分支', + 'description' => '', + 'type' => 'string', + 'example' => 'master', + ], + 'originBranchRevisionSha' => [ + 'title' => '代码分支源分支版本', + 'description' => '', + 'type' => 'string', + 'example' => 'revision-123', + ], + 'creatorId' => [ + 'title' => '创建者者云效id', + 'description' => '', + 'type' => 'string', + 'example' => 'create-id-123'."\n", + ], + 'creatorAccountId' => [ + 'title' => '创建者的阿里云账号pk', + 'description' => '', + 'type' => 'string', + 'example' => 'create-account-123', + ], + 'gmtCreate' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'string', + 'example' => '2024-01-01 00:00:00', + ], + 'gmtModified' => [ + 'title' => '修改时间', + 'description' => '', + 'type' => 'string', + 'example' => '2024-01-01 00:00:00', + ], + 'autoDeleteBranchWhenEnd' => [ + 'title' => '结束后是否自动删除分支', + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"sn\\": \\"ce51b31b996246ecaf874736838360b2\\",\\n \\"appName\\": \\"app-name\\",\\n \\"state\\": \\"DEVELOPING\\",\\n \\"name\\": \\"变更名称\\",\\n \\"type\\": \\"APP\\",\\n \\"appCodeRepoSn\\": \\"sn123\\",\\n \\"branch\\": \\"hotfix/20240524\\",\\n \\"ownerId\\": \\"owner-id-123\\",\\n \\"ownerAccountId\\": \\"account-id-123\\",\\n \\"originBranch\\": \\"master\\",\\n \\"originBranchRevisionSha\\": \\"revision-123\\",\\n \\"creatorId\\": \\"create-id-123\\\\n\\",\\n \\"creatorAccountId\\": \\"create-account-123\\",\\n \\"gmtCreate\\": \\"2024-01-01 00:00:00\\",\\n \\"gmtModified\\": \\"2024-01-01 00:00:00\\",\\n \\"autoDeleteBranchWhenEnd\\": false\\n}","type":"json"}]', + ], + 'ListChangeRequests' => [ + 'summary' => '查询变更列表', + 'path' => '/appstack/apps/{appName}/changeRequests', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'autoTest' => false, + 'notSupportAutoTestReason' => '数据面 api 经安全评估统一不做处理，后续逐步安排下线', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => '企业标识，也称企业id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '66c0c9fffeb86b450c199fcd', + ], + ], + [ + 'name' => 'appName', + 'in' => 'path', + 'schema' => [ + 'title' => '应用名', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'app-name', + ], + ], + [ + 'name' => 'pagination', + 'in' => 'query', + 'schema' => [ + 'title' => '分页模式参数，目前只支持键集分页 keyset 模式', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'keyset' => 'keyset', + ], + 'example' => 'keyset', + 'default' => 'keyset', + ], + ], + [ + 'name' => 'perPage', + 'in' => 'query', + 'schema' => [ + 'title' => '分页尺寸参数，决定一页最多返回多少对象', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'orderBy', + 'in' => 'query', + 'schema' => [ + 'title' => '分页排序属性，决定根据何种属性进行记录排序；推荐在实现严格遍历时，使用 id 属性', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'id' => 'id', + ], + 'example' => 'id', + 'default' => 'desc', + ], + ], + [ + 'name' => 'sort', + 'in' => 'query', + 'schema' => [ + 'title' => '分页排序升降序，asc 为升序，desc 为降序；推荐在实现严格遍历时，使用升序', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'asc' => 'asc', + 'desc' => 'desc', + ], + 'example' => 'desc', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'title' => '键集分页 token，获取第一页数据时无需传入，否则需要传入前一页查询结果中的 nextToken 字段', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '4dc150725770510122396e2476', + ], + ], + [ + 'name' => 'stateList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '按状态进行搜索', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'DEVELOPING' => 'DEVELOPING', + 'RELEASED' => 'RELEASED', + 'CLOSED' => 'CLOSED', + 'INTEGRATING' => 'INTEGRATING', + ], + 'example' => 'DEVELOPING', + ], + 'required' => false, + ], + ], + [ + 'name' => 'ownerIdList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '按ownerId进行搜索', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'eycodj8dshsmf6ss65s', + ], + 'required' => false, + ], + ], + [ + 'name' => 'appNameList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '按应用名称进行搜索', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'app-name', + ], + 'required' => false, + ], + ], + [ + 'name' => 'displayNameKeyword', + 'in' => 'query', + 'schema' => [ + 'title' => '按展示名进行模糊搜索的关键字', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'change1', + ], + ], + [ + 'name' => 'page', + 'in' => 'query', + 'schema' => [ + 'title' => '页面分页时使用，用于获取下一页内容', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PageList<ChangeRequestVO>', + 'description' => 'PageList<ChangeRequestVO>', + 'type' => 'object', + 'properties' => [ + 'nextToken' => [ + 'title' => '采用键值分页时存在该字段，用于传给分页接口，迭代获取下一页数据', + 'description' => '', + 'type' => 'string', + 'example' => 'eb13ac6049d3d78159d60f84af', + ], + 'data' => [ + 'title' => '分页结果数据', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'any', + 'example' => '{"sn":"sn_bbe378996538","appName":"app-name","state":"RELEASED","name":"name_7699a487e82c","type":"APP","appCodeRepoSn":"appCodeRepoSn_f46c1f3f2d3e","branch":"branch_8b3bcdcb8086","ownerId":"ownerId_2ec0c96eb7e2","ownerAccountId":"ownerAccountId_93a92d951cfe","originBranch":"master","originBranchRevisionSha":"originBranchRevisionSha_8fc026946097","creatorId":"creatorId_53660e01024f","creatorAccountId":"creatorAccountId_480afbff2edc","gmtCreate":"2024-07-09 11:19:54","gmtModified":"2024-07-09 11:19:54","autoDeleteBranchWhenEnd":false}', + ], + ], + 'total' => [ + 'title' => '页码分页时存在该字段，表示结果总数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'current' => [ + 'title' => '页码分页时存在该字段，表示当前页', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'perPage' => [ + 'title' => '页码分页时存在该字段，表示每页大小', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'pages' => [ + 'title' => '页码分页时存在该字段，表示总页数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"nextToken\\": \\"eb13ac6049d3d78159d60f84af\\",\\n \\"data\\": [\\n \\"{\\\\\\"sn\\\\\\":\\\\\\"sn_bbe378996538\\\\\\",\\\\\\"appName\\\\\\":\\\\\\"app-name\\\\\\",\\\\\\"state\\\\\\":\\\\\\"RELEASED\\\\\\",\\\\\\"name\\\\\\":\\\\\\"name_7699a487e82c\\\\\\",\\\\\\"type\\\\\\":\\\\\\"APP\\\\\\",\\\\\\"appCodeRepoSn\\\\\\":\\\\\\"appCodeRepoSn_f46c1f3f2d3e\\\\\\",\\\\\\"branch\\\\\\":\\\\\\"branch_8b3bcdcb8086\\\\\\",\\\\\\"ownerId\\\\\\":\\\\\\"ownerId_2ec0c96eb7e2\\\\\\",\\\\\\"ownerAccountId\\\\\\":\\\\\\"ownerAccountId_93a92d951cfe\\\\\\",\\\\\\"originBranch\\\\\\":\\\\\\"master\\\\\\",\\\\\\"originBranchRevisionSha\\\\\\":\\\\\\"originBranchRevisionSha_8fc026946097\\\\\\",\\\\\\"creatorId\\\\\\":\\\\\\"creatorId_53660e01024f\\\\\\",\\\\\\"creatorAccountId\\\\\\":\\\\\\"creatorAccountId_480afbff2edc\\\\\\",\\\\\\"gmtCreate\\\\\\":\\\\\\"2024-07-09 11:19:54\\\\\\",\\\\\\"gmtModified\\\\\\":\\\\\\"2024-07-09 11:19:54\\\\\\",\\\\\\"autoDeleteBranchWhenEnd\\\\\\":false}\\"\\n ],\\n \\"total\\": 100,\\n \\"current\\": 1,\\n \\"perPage\\": 20,\\n \\"pages\\": 5\\n}","type":"json"}]', + ], + 'ListChangeRequestWorkflowExecutions' => [ + 'summary' => '查询变更研发流程运行记录', + 'path' => '/appstack/apps/{appName}/changeRequests/{sn}/executions', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'autoTest' => false, + 'notSupportAutoTestReason' => '数据面 api 经安全评估统一不做处理，后续逐步安排下线', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => '企业标识，也称企业id', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '66c0c9fffeb86b450c199fcd', + ], + ], + [ + 'name' => 'appName', + 'in' => 'path', + 'schema' => [ + 'title' => '应用名', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'test-app', + ], + ], + [ + 'name' => 'sn', + 'in' => 'path', + 'schema' => [ + 'title' => '变更唯一标识', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ce51b31b996246ecaf874736838360b2', + ], + ], + [ + 'name' => 'perPage', + 'in' => 'query', + 'schema' => [ + 'title' => '分页尺寸参数，决定一页最多返回多少对象', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'page', + 'in' => 'query', + 'schema' => [ + 'title' => '页面分页时使用，用于获取下一页内容，默认第1页', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'orderBy', + 'in' => 'query', + 'schema' => [ + 'title' => '分页排序属性，决定根据何种属性进行记录排序；推荐在实现严格遍历时，使用 id 属性', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'id' => 'id', + ], + 'example' => 'id', + 'default' => 'id', + ], + ], + [ + 'name' => 'sort', + 'in' => 'query', + 'schema' => [ + 'title' => '分页排序升降序，asc 为升序，desc 为降序；推荐在实现严格遍历时，使用升序', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'asc' => 'asc', + 'desc' => 'desc', + ], + 'example' => 'desc', + 'default' => 'desc', + ], + ], + [ + 'name' => 'releaseWorkflowSn', + 'in' => 'query', + 'schema' => [ + 'title' => '研发流程唯一标识', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ce51b31b996246ecaf874736838360b2', + ], + ], + [ + 'name' => 'releaseStageSn', + 'in' => 'query', + 'schema' => [ + 'title' => '研发流程阶段唯一标识', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'e173f3c11db5445eb426ca33c92207c8', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Pagination<ChangeRequestExecutionVO>', + 'description' => 'Pagination<ChangeRequestExecutionVO>', + 'type' => 'object', + 'properties' => [ + 'total' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'current' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'pageSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'pages' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'records' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'any', + 'example' => '{"commit":{"id":"9ab34fe4c056"},"state":"RUNNING","runNumber":"123"}', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 200,\\n \\"current\\": 1,\\n \\"pageSize\\": 20,\\n \\"pages\\": 10,\\n \\"records\\": [\\n \\"{\\\\\\"commit\\\\\\":{\\\\\\"id\\\\\\":\\\\\\"9ab34fe4c056\\\\\\"},\\\\\\"state\\\\\\":\\\\\\"RUNNING\\\\\\",\\\\\\"runNumber\\\\\\":\\\\\\"123\\\\\\"}\\"\\n ]\\n}","type":"json"}]', + ], + 'ListUserDrawRecordByPk' => [ + 'summary' => '测试DrawService', + 'path' => '/listUserDrawRecords', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'aliyunPk', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1789095186553536', + ], + ], + [ + 'name' => 'drawGroup', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'task_group_0000', + ], + ], + [ + 'name' => 'drawPoolName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'developer-award-draw-pool_123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'uccId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'dsadsadasd', + ], + 'drawGroup' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'dsadsadsadas', + ], + 'drawPoolName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'dasdsadasdas', + ], + 'taskGroupId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'aliyunPk' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1401072305438324', + ], + 'gmtCreate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1545726028000', + ], + 'drawResult' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2', + ], + ], + ], + ], + 'requestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '200', + ], + 'message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'None', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": [\\n {\\n \\"uccId\\": \\"dsadsadasd\\",\\n \\"drawGroup\\": \\"dsadsadsadas\\",\\n \\"drawPoolName\\": \\"dasdsadasdas\\",\\n \\"taskGroupId\\": \\"null\\",\\n \\"aliyunPk\\": \\"1401072305438324\\",\\n \\"gmtCreate\\": \\"1545726028000\\",\\n \\"drawResult\\": \\"2\\"\\n }\\n ],\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"success\\": true,\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"None\\"\\n}","type":"json"}]', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'devops.cn-hangzhou.aliyuncs.com', + ], + ], +]; |