diff options
| author | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
|---|---|---|
| committer | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
| commit | 1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch) | |
| tree | 5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/en_us/devops/2021-06-25 | |
| parent | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff) | |
| download | afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip | |
update APIs 20260712
Diffstat (limited to 'data/en_us/devops/2021-06-25')
| -rw-r--r-- | data/en_us/devops/2021-06-25/api-docs.php | 61517 |
1 files changed, 19860 insertions, 41657 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 index 4716c31..148ae17 100644 --- a/data/en_us/devops/2021-06-25/api-docs.php +++ b/data/en_us/devops/2021-06-25/api-docs.php @@ -1,607 +1,255 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'ROA', - 'product' => 'devops', - 'version' => '2021-06-25', - ], + 'info' => ['style' => 'ROA', 'product' => 'devops', 'version' => '2021-06-25'], 'directories' => [ [ - 'id' => 164546, - 'title' => 'Code Management', - 'type' => 'directory', 'children' => [ [ - 'id' => 172780, - 'title' => 'File', + 'children' => ['CreateFile', 'DeleteFile', 'UpdateFile', 'GetFileBlobs', 'ListRepositoryTree'], 'type' => 'directory', - 'children' => [ - 'CreateFile', - 'DeleteFile', - 'UpdateFile', - 'GetFileBlobs', - 'ListRepositoryTree', - ], + 'title' => 'File', ], [ - 'id' => 164547, - 'title' => 'Submission', + 'children' => ['GetFileLastCommit', 'GetRepositoryCommit', 'ListRepositoryCommits', 'ListRepositoryCommitDiff', 'CreateCommitWithMultipleFiles'], 'type' => 'directory', - 'children' => [ - 'GetFileLastCommit', - 'GetRepositoryCommit', - 'ListRepositoryCommits', - 'ListRepositoryCommitDiff', - 'CreateCommitWithMultipleFiles', - ], + 'title' => 'Submission', ], [ - 'id' => 164551, - 'title' => 'Members', + 'children' => ['AddRepositoryMember', 'AddGroupMember', 'DeleteRepositoryMember', 'DeleteGroupMember', 'UpdateRepositoryMember', 'UpdateGroupMember', 'ListRepositoryMemberWithInherited', 'GetProjectMember', 'ListGroupMember'], 'type' => 'directory', - 'children' => [ - 'AddRepositoryMember', - 'AddGroupMember', - 'DeleteRepositoryMember', - 'DeleteGroupMember', - 'UpdateRepositoryMember', - 'UpdateGroupMember', - 'ListRepositoryMemberWithInherited', - 'GetProjectMember', - 'ListGroupMember', - ], + 'title' => 'Members', ], [ - 'id' => 164554, - 'title' => 'Warehouse', + 'children' => ['CreateRepository', 'DeleteRepository', 'UpdateRepository', 'TriggerRepositoryMirrorSync', 'TransferRepository', 'ListRepositories', 'GetRepository'], 'type' => 'directory', - 'children' => [ - 'CreateRepository', - 'DeleteRepository', - 'UpdateRepository', - 'TriggerRepositoryMirrorSync', - 'TransferRepository', - 'ListRepositories', - 'GetRepository', - ], + 'title' => 'Warehouse', ], [ - 'id' => 171910, - 'title' => 'Branch', + 'children' => ['CreateBranch', 'CreateProtectdBranch', 'DeleteBranch', 'DeleteProtectedBranch', 'UpdateProtectedBranches', 'GetBranchInfo', 'ListRepositoryBranches', 'ListProtectedBranches'], 'type' => 'directory', - 'children' => [ - 'CreateBranch', - 'CreateProtectdBranch', - 'DeleteBranch', - 'DeleteProtectedBranch', - 'UpdateProtectedBranches', - 'GetBranchInfo', - 'ListRepositoryBranches', - 'ListProtectedBranches', - ], + 'title' => 'Branch', ], [ - 'id' => 185321, + 'children' => ['GetMergeRequest', 'ListMergeRequests', 'CreateMergeRequest', 'UpdateMergeRequest', 'UpdateMergeRequestPersonnel', 'MergeMergeRequest', 'ReviewMergeRequest', 'CloseMergeRequest', 'ReopenMergeRequest', 'ListMergeRequestPatchSets', 'GetMergeRequestChangeTree', 'ListMergeRequestFilesReads', 'ListMergeRequestComments', 'CreateComment'], + 'type' => 'directory', 'title' => 'Merge Request', + ], + [ + 'children' => ['GetCompareDetail'], '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', + 'children' => ['CreateCommitStatus', 'ListCommitStatuses'], 'type' => 'directory', - 'children' => [ - 'CreateCommitStatus', - 'ListCommitStatuses', - ], + 'title' => 'Submit Status', ], [ - 'id' => 189204, - 'title' => 'Check Run', + 'children' => ['CreateCheckRun', 'UpdateCheckRun', 'GetCheckRun', 'ListCheckRuns'], 'type' => 'directory', - 'children' => [ - 'CreateCheckRun', - 'UpdateCheckRun', - 'GetCheckRun', - 'ListCheckRuns', - ], + 'title' => 'Check Run', ], [ - 'id' => 177752, - 'title' => 'Label', + 'children' => ['CreateTag', 'DeleteTag', 'GetRepositoryTag', 'ListRepositoryTags'], 'type' => 'directory', - 'children' => [ - 'CreateTag', - 'DeleteTag', - 'GetRepositoryTag', - 'ListRepositoryTags', - ], + 'title' => 'Label', ], [ - 'id' => 188973, - 'title' => 'Class Label', + 'children' => ['CreateProjectLabel', 'UpdateProjectLabel', 'DeleteProjectLabel', 'ListProjectLabels', 'ListMergeRequestLabels', 'LinkMergeRequestLabel'], 'type' => 'directory', - 'children' => [ - 'CreateProjectLabel', - 'UpdateProjectLabel', - 'DeleteProjectLabel', - 'ListProjectLabels', - 'ListMergeRequestLabels', - 'LinkMergeRequestLabel', - ], + 'title' => 'Class Label', ], [ - 'id' => 164559, - 'title' => 'Webhook', + 'children' => ['AddWebhook', 'DeleteRepositoryWebhook', 'ListRepositoryWebhook'], 'type' => 'directory', - 'children' => [ - 'AddWebhook', - 'DeleteRepositoryWebhook', - 'ListRepositoryWebhook', - ], + 'title' => 'Webhook', ], [ - 'id' => 176819, - 'title' => 'Code Group', + 'children' => ['CreateRepositoryGroup', 'DeleteRepositoryGroup', 'UpdateGroup', 'GetGroupDetail', 'GetGroupByPath', 'ListRepositoryGroups', 'ListGroupRepositories'], 'type' => 'directory', - 'children' => [ - 'CreateRepositoryGroup', - 'DeleteRepositoryGroup', - 'UpdateGroup', - 'GetGroupDetail', - 'GetGroupByPath', - 'ListRepositoryGroups', - 'ListGroupRepositories', - ], + 'title' => 'Code Group', ], [ - 'id' => 178460, - 'title' => 'Push Review', + 'children' => ['UpdatePushReviewOnOff'], 'type' => 'directory', - 'children' => [ - 'UpdatePushReviewOnOff', - ], + 'title' => 'Push Review', ], [ - 'id' => 186377, - 'title' => 'Push Rules', + 'children' => ['CreatePushRule', 'UpdatePushRule', 'DeletePushRule', 'ListPushRules'], 'type' => 'directory', - 'children' => [ - 'CreatePushRule', - 'UpdatePushRule', - 'DeletePushRule', - 'ListPushRules', - ], + 'title' => 'Push Rules', ], [ - 'id' => 177915, - 'title' => 'Deployment Key', + 'children' => ['CreateDeployKey', 'EnableDeployKey'], 'type' => 'directory', - 'children' => [ - 'CreateDeployKey', - 'EnableDeployKey', - ], + 'title' => 'Deployment Key', ], [ - 'id' => 183443, - 'title' => 'SSH Key', + 'children' => ['CreateUserKey', 'DeleteUserKey', 'ListUserKeys'], 'type' => 'directory', - 'children' => [ - 'CreateUserKey', - 'DeleteUserKey', - 'ListUserKeys', - ], + 'title' => 'SSH Key', ], [ - 'id' => 178455, - 'title' => 'Code Search', + 'children' => ['ListSearchSourceCode', 'ListSearchRepository', 'ListSearchCommit', 'GetSearchCodePreview'], 'type' => 'directory', - 'children' => [ - 'ListSearchSourceCode', - 'ListSearchRepository', - 'ListSearchCommit', - 'GetSearchCodePreview', - ], + 'title' => 'Code Search', ], [ - 'id' => 164549, - 'title' => 'Enterprise Information', + 'children' => ['GetCodeupOrganization', 'ListOrganizations'], 'type' => 'directory', - 'children' => [ - 'GetCodeupOrganization', - 'ListOrganizations', - ], + 'title' => 'Enterprise Information', ], [ - 'id' => 177750, - 'title' => 'User', + 'children' => ['GetUserInfo'], 'type' => 'directory', - 'children' => [ - 'GetUserInfo', - ], + 'title' => 'User', ], [ - 'id' => 184606, - 'title' => 'Audit', + 'children' => ['ListUserResources'], 'type' => 'directory', - 'children' => [ - 'ListUserResources', - ], + 'title' => 'Audit', ], [ - 'id' => 167604, - 'title' => 'Authentication', + 'children' => ['CreateOAuthToken'], 'type' => 'directory', - 'children' => [ - 'CreateOAuthToken', - ], + 'title' => 'Authentication', ], ], + 'type' => 'directory', + 'title' => 'Code Management', ], [ - 'id' => 129795, - 'title' => 'assembly line', - 'type' => 'directory', 'children' => [ [ - 'id' => 184754, - 'title' => 'Service Connection', + 'children' => ['CreateServiceConnection', 'CreateServiceAuth', 'CreateServiceCredential', 'ListServiceCredentials', 'ListServiceAuths', 'ListServiceConnections'], 'type' => 'directory', - 'children' => [ - 'CreateServiceConnection', - 'CreateServiceAuth', - 'CreateServiceCredential', - 'ListServiceCredentials', - 'ListServiceAuths', - 'ListServiceConnections', - ], + 'title' => 'Service Connection', ], [ - 'id' => 169998, - 'title' => 'Host Deployment', + 'children' => ['StopVMDeployOrder', 'SkipVMDeployMachine', 'RetryVMDeployMachine', 'ResumeVMDeployOrder', 'GetVMDeployOrder', 'LogVMDeployMachine'], 'type' => 'directory', - 'children' => [ - 'StopVMDeployOrder', - 'SkipVMDeployMachine', - 'RetryVMDeployMachine', - 'ResumeVMDeployOrder', - 'GetVMDeployOrder', - 'LogVMDeployMachine', - ], + 'title' => 'Host Deployment', ], [ - 'id' => 169999, - 'title' => 'pipeline grouping', + 'children' => ['CreatePipelineGroup', 'DeletePipelineGroup', 'JoinPipelineGroup', 'UpdatePipelineGroup', 'GetPipelineGroup', 'ListPipelineGroupPipelines', 'ListPipelineGroups'], 'type' => 'directory', - 'children' => [ - 'CreatePipelineGroup', - 'DeletePipelineGroup', - 'JoinPipelineGroup', - 'UpdatePipelineGroup', - 'GetPipelineGroup', - 'ListPipelineGroupPipelines', - 'ListPipelineGroups', - ], + 'title' => 'pipeline grouping', ], [ - 'id' => 129796, - 'title' => 'Label', + 'children' => ['CreateSshKey', 'ResetSshKey'], 'type' => 'directory', - 'children' => [ - 'CreateFlowTag', - 'CreateFlowTagGroup', - 'DeleteFlowTagGroup', - 'DeleteFlowTag', - 'UpdateFlowTag', - 'UpdateFlowTagGroup', - 'GetFlowTagGroup', - 'ListFlowTagGroups', - ], - ], - [ - 'id' => 129805, 'title' => 'Other', - 'type' => 'directory', - 'children' => [ - 'CreateSshKey', - 'ResetSshKey', - ], ], [ - 'id' => 129809, - 'title' => 'Members', + 'children' => ['CreateHostGroup', 'DeleteHostGroup', 'UpdateHostGroup', 'GetHostGroup', 'ListHostGroups'], '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', + 'children' => ['CreateVariableGroup', 'DeleteVariableGroup', 'UpdateVariableGroup', 'GetVariableGroup', 'ListVariableGroups'], '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', - ], + 'title' => 'Variable Group', ], ], + 'type' => 'directory', + 'title' => 'assembly line', ], [ - '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', + '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', ], + 'type' => 'directory', + 'title' => 'Work item', + ], + [ + 'children' => ['CreateProject', 'CreateSprint', 'DeleteProject', 'UpdateProjectMember', 'UpdateProjectField', 'GetProjectInfo', 'ListProjectMembers', 'GetSprintInfo', 'ListProjects', 'ListProjectTemplates', 'ListSprints'], + 'type' => 'directory', + 'title' => 'Project', ], ], + 'type' => 'directory', + 'title' => 'Project Management (Projex)', ], [ - 'id' => 183317, - 'title' => 'Test Management', - 'type' => 'directory', 'children' => [ [ - 'id' => 183318, - 'title' => 'Test Case Library', + 'children' => ['CreateTestCase', 'UpdateTestCase', 'ListTestCaseFields', 'GetTestcaseList'], 'type' => 'directory', - 'children' => [ - 'CreateTestCase', - 'UpdateTestCase', - 'ListTestCaseFields', - 'GetTestcaseList', - ], + 'title' => 'Test Case Library', ], [ - 'id' => 183322, - 'title' => 'Test Plan', + 'children' => ['UpdateTestResult', 'GetTestResultList'], 'type' => 'directory', - 'children' => [ - 'UpdateTestResult', - 'GetTestResultList', - ], + 'title' => 'Test Plan', ], ], + 'type' => 'directory', + 'title' => 'Test Management', ], [ - 'id' => 192620, - 'title' => 'Performance Insights', + 'children' => ['ExportWorkitemActivity', 'ExportInsightWorkitemVersion', 'ExportInsightWorkitemStatusJoinWorkitemDefectExtra', 'ExportInsightWorkitemStatus', 'ExportInsightWorkTime', 'ExportInsightTagRef', 'ExportInsightSprint', 'ExportInsightSpaceRef', 'ExportInsightSpace', 'ExportInsightField', 'ExportInsightExpectedWorkTime', 'ExportInsightCustomValue'], 'type' => 'directory', - 'children' => [ - 'ExportWorkitemActivity', - 'ExportInsightWorkitemVersion', - 'ExportInsightWorkitemStatusJoinWorkitemDefectExtra', - 'ExportInsightWorkitemStatus', - 'ExportInsightWorkTime', - 'ExportInsightTagRef', - 'ExportInsightSprint', - 'ExportInsightSpaceRef', - 'ExportInsightSpace', - 'ExportInsightField', - 'ExportInsightExpectedWorkTime', - 'ExportInsightCustomValue', - ], + 'title' => 'Performance Insights', ], [ - 'id' => 129762, - 'title' => 'Enterprises and members', + 'children' => ['UpdateOrganizationMember', 'ListOrganizationMembers', 'GetOrganizationMember', 'ListJoinedOrganizations'], 'type' => 'directory', - 'children' => [ - 'UpdateOrganizationMember', - 'ListOrganizationMembers', - 'GetOrganizationMember', - 'ListJoinedOrganizations', - ], + 'title' => 'Enterprises and members', ], [ - 'id' => 188636, - 'title' => 'Application Delivery', - 'type' => 'directory', 'children' => [ [ - 'id' => 188637, - 'title' => 'Application', + 'children' => ['GetApplication', 'UpdateApplication', 'ListApplications'], 'type' => 'directory', - 'children' => [ - 'GetApplication', - 'UpdateApplication', - 'ListApplications', - ], + 'title' => 'Application', ], [ - 'id' => 193448, - 'title' => 'Application Member', + 'children' => ['ListApplicationMembers', 'CreateAppMembers', 'UpdateAppMember', 'DeleteAppMember'], 'type' => 'directory', - 'children' => [ - 'ListApplicationMembers', - 'CreateAppMembers', - 'UpdateAppMember', - 'DeleteAppMember', - ], + 'title' => 'Application Member', ], [ - 'id' => 193449, - 'title' => 'Application R & D Process', + 'children' => ['GetReleaseStagePipelineRun', 'ExecuteChangeRequestReleaseStage', 'CancelExecutionReleaseStage', 'ListAllReleaseWorkflows', 'ListAppReleaseStageExecutions', 'ListAppReleaseStageExecutionIntegratedMetadata', 'RefuseReleaseStagePipelineValidate', 'PassReleaseStagePipelineValidate'], 'type' => 'directory', - 'children' => [ - 'GetReleaseStagePipelineRun', - 'ExecuteChangeRequestReleaseStage', - 'CancelExecutionReleaseStage', - 'ListAllReleaseWorkflows', - 'ListAppReleaseStageExecutions', - 'ListAppReleaseStageExecutionIntegratedMetadata', - 'RefuseReleaseStagePipelineValidate', - 'PassReleaseStagePipelineValidate', - ], + 'title' => 'Application development process', ], [ - 'id' => 193927, - 'title' => 'Change', + 'children' => ['CreateChangeRequest', 'ListChangeRequests', 'ListChangeRequestWorkflowExecutions'], 'type' => 'directory', - 'children' => [ - 'CreateChangeRequest', - 'ListChangeRequests', - 'ListChangeRequestWorkflowExecutions', - ], + 'title' => 'Change', ], ], + 'type' => 'directory', + 'title' => 'Application Delivery', ], [ - 'id' => 196435, - 'title' => 'Other', - 'type' => 'directory', 'children' => [ - 'ListUserDrawRecordByPk', + 'AddPipelineRelations', 'CreateFlowTag', 'CreateFlowTagGroup', 'CreatePipeline', 'CreateResourceMember', 'DeleteFlowTag', 'DeleteFlowTagGroup', 'DeletePipeline', 'DeletePipelineRelations', 'DeleteResourceMember', 'GetFlowTagGroup', 'GetPipeline', 'GetPipelineArtifactUrl', 'GetPipelineEmasArtifactUrl', 'GetPipelineRun', 'GetPipelineScanReportUrl', 'ListFlowTagGroups', 'ListPipelineJobHistorys', 'ListPipelineJobs', 'ListPipelineRelations', + 'ListPipelineRuns', 'ListPipelines', 'ListResourceMembers', 'ListUserDrawRecordByPk', 'LogPipelineJobRun', 'PassPipelineValidate', 'RefusePipelineValidate', 'RetryPipelineJobRun', 'SkipPipelineJobRun', 'StartPipelineRun', 'StopPipelineJobRun', 'StopPipelineRun', 'UpdateFlowTag', 'UpdateFlowTagGroup', 'UpdatePipeline', 'UpdatePipelineBaseInfo', 'UpdateResourceMember', ], + 'title' => 'Others', + 'type' => 'directory', ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'CreateFile' => [ - 'summary' => '创建文件', - 'path' => '/repository/{repositoryId}/files', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'AddGroupMember' => [ + 'summary' => 'Adds one or more members to a group.', + 'path' => '/repository/groups/{groupId}/members/create', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], @@ -609,74 +257,38 @@ [ 'name' => 'organizationId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '60de7a6852743a5162b5f957', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The organization ID. You can find the organization ID in your organization\'s URL on Alibaba Cloud DevOps. For example, https\\://devops.aliyun.com/organization/{organizationId}.', 'type' => 'string', 'required' => true, 'example' => '60de7a6852743a5162b5f957'], ], [ 'name' => 'accessToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'f0b1e61db5961df5975a93f9129d2513', - ], + 'schema' => ['description' => 'The personal access token. This parameter is optional if you authenticate using an Alibaba Cloud AccessKey pair or Security Token Service (STS) credentials.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], ], [ - 'name' => 'repositoryId', + 'name' => 'groupId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '2080972', - ], + 'schema' => ['description' => 'The ID of the group.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '22901', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', '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' => '', - ], + 'aliyunPks' => ['description' => 'The Alibaba Cloud account ID of the group member. To add multiple members, separate the IDs with commas (,).', 'type' => 'string', 'required' => true, 'example' => '18745637472884', 'title' => ''], + 'accessLevel' => ['description' => 'The access level of the member. Valid values:'."\n" + ."\n" + .'- `20`: reporter'."\n" + ."\n" + .'- `30`: developer'."\n" + ."\n" + .'- `40`: maintainer', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '30', 'title' => ''], ], 'required' => true, + 'title' => '', + 'example' => '', ], ], ], @@ -684,224 +296,153 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Response schema', '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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'errorCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => 'Openapi.RequestError', 'title' => ''], + 'success' => ['description' => 'Indicates if the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'result' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'filePath' => [ - 'description' => '', - 'type' => 'string', - 'example' => '/src/main/test.java', - ], - 'branchName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'master', - ], + 'description' => 'A list of result objects, one for each member added.', + 'type' => 'array', + 'items' => [ + 'description' => 'Details of an added member.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The Codeup user ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', 'title' => ''], + 'name' => ['description' => 'The name of the user.', 'type' => 'string', 'example' => 'codeup', 'title' => ''], + 'username' => ['description' => 'The username of the user.', 'type' => 'string', 'example' => 'test-codeup', 'title' => ''], + 'state' => ['description' => 'The state of the user. Valid values: `active` and `blocked`.', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'avatarUrl' => ['description' => 'The URL of the user\'s avatar.', 'type' => 'string', 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', 'title' => ''], + 'email' => ['description' => 'The email address of the user.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + 'accessLevel' => ['description' => 'The access level of the member. Valid values:'."\n" + ."\n" + .'- `20`: reporter'."\n" + ."\n" + .'- `30`: developer'."\n" + ."\n" + .'- `40`: maintainer', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'sourceId' => ['description' => 'The ID of the group to which the member was added.', 'type' => 'integer', 'format' => 'int64', 'example' => '223241', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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', + '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\\": \\"username@example.com\\",\\n \\"accessLevel\\": 30,\\n \\"sourceId\\": 223241\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Add group members ', + 'changeSet' => [ + ['createdAt' => '2023-07-24T06:14:53.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddGroupMember'], + ], ], + 'ramActions' => [], + ], + 'AddPipelineRelations' => [ + 'summary' => 'Adds relations to a pipeline.', + 'path' => '/organization/{organizationId}/{pipelineId}/pipelineRelations', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + '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' => '2709413', - ], + 'schema' => ['description' => 'The ID of the organization. You can obtain this ID from the URL of your organization in Alibaba Cloud DevOps, for example, `https://devops.aliyun.com/organization/{OrgId}`.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx', 'title' => ''], ], [ - 'name' => 'branchName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'master', - ], + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the pipeline. You can obtain this ID from the pipeline URL, for example, `https://flow.aliyun.com/pipelines/{PipelineId}/current`.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '11'], ], [ - 'name' => 'filePath', + 'name' => 'relObjectType', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The type of the related resource. The only value currently supported is `VARIABLE_GROUP`, which represents a variable group.', 'type' => 'string', 'required' => true, - 'example' => 'src/main/test.java', + 'enum' => ['VARIABLE_GROUP', 'OOS_APP_ID'], + 'title' => '', + 'example' => 'VARIABLE_GROUP', ], ], [ - 'name' => 'commitMessage', + 'name' => 'relObjectIds', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], + 'schema' => ['description' => 'The IDs of the related resources. This parameter currently accepts only the IDs of variable groups. To specify multiple IDs, separate them with a comma.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '11,22'], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The data returned.', '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', - ], - ], - ], + 'requestId' => ['description' => 'The unique ID of the request. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', 'title' => ''], + 'errorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'errorCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'success' => ['description' => 'Indicates whether the API call succeeded. Returns `true` on success and `false` on failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => 'The user that is invoking the API service is not a registered user.'], + ], 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.', - ], + ['errorCode' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], ], ], - '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', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true\\n}","type":"json"}]', + 'title' => 'Add Pipeline Association', + 'changeSet' => [ + ['createdAt' => '2023-08-31T14:28:57.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddPipelineRelations'], + ], ], + 'ramActions' => [], + ], + 'AddRepositoryMember' => [ + 'summary' => 'Add members to a code repository, using the Alibaba Cloud account ID (aliyunPk) as the identity. You can batch add members by specifying multiple Alibaba Cloud account IDs separated by commas (aliyunPks).', + 'path' => '/repository/{repositoryId}/members', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], @@ -909,1179 +450,495 @@ [ '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", - ], + 'schema' => ['title' => '', 'description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, for example: https://devops.aliyun.com/organization/【OrganizationId】 ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '60de7a6852743a5162b5f957'."\n"], ], [ 'name' => 'repositoryId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2813489', - ], + 'schema' => ['title' => '', 'description' => 'Code repository ID ', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '2464454', 'isFileTransferUrl' => false], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'Request input parameter ', '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' => '', - ], + 'aliyunPks' => ['title' => '', 'description' => 'Alibaba Cloud IDs of users to be added as code repository members. Multiple IDs are supported and must be separated by commas (",") ', 'type' => 'string', 'required' => true, 'example' => '18745637472884'], + 'accessLevel' => ['title' => '', 'description' => 'Member permission ', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '30'], ], - 'required' => false, + 'required' => true, + 'example' => '', ], ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Personal access token. '."\n" + .'This field is not required when using Alibaba Cloud AccessKey ID and AccessKey Secret (AK+SK) or Security Token Service (STS) temporary authorization. '."\n", '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' => 'C2F153F6-BB43-50C4-9F4F-40593203E19A', - ], - 'errorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => '""', - ], - 'errorCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SYSTEM_UNKNOWN_ERROR', - ], - 'success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'errorMessage' => ['title' => '', 'description' => 'error message ', 'type' => 'string', 'example' => '""'], + 'requestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '4D6AF7CC-B43B-5454-86AB-023D25E44868'], + 'errorCode' => ['title' => '', 'description' => 'error code ', 'type' => 'string', 'example' => 'Invalid.IdNotFound'], + 'success' => ['title' => '', 'description' => 'Request status', 'type' => 'boolean', 'example' => 'true'], 'result' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'branchName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'master', - ], - 'filePath' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'src/main/update.txt', - ], + 'title' => '', + 'description' => 'Return Result', + 'type' => 'array', + 'items' => [ + 'description' => 'Result object', + 'type' => 'object', + 'properties' => [ + 'email' => ['title' => '', 'description' => 'Mailbox', 'type' => 'string', 'example' => 'username@example.com'], + 'avatarUrl' => ['title' => '', 'description' => 'Profile picture URL', 'type' => 'string', 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100'], + 'state' => ['title' => '', 'description' => 'Status '."\n" + .'Valid values: active / blocked', 'type' => 'string', 'example' => 'active'], + 'accessLevel' => ['title' => '', 'description' => 'Permission Type '."\n" + .'- 20 – Viewer '."\n" + .'- 30 – Developer '."\n" + .'- 40 – Administrator', 'type' => 'integer', 'format' => 'int32', 'example' => '40'], + 'id' => ['title' => '', 'description' => 'Codeup user ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'], + ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - '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.', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"requestId\\": \\"4D6AF7CC-B43B-5454-86AB-023D25E44868\\",\\n \\"errorCode\\": \\"Invalid.IdNotFound\\",\\n \\"success\\": true,\\n \\"result\\": [\\n {\\n \\"email\\": \\"username@example.com\\",\\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}","type":"json"}]', + 'title' => 'Add code repository member ', + 'changeSet' => [ + ['createdAt' => '2023-07-24T06:14:53.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-01-03T02:17:32.000Z', 'description' => 'Request parameters changed, Error codes changed'], + ['createdAt' => '2022-11-21T13:16:40.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ], + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddRepositoryMember'], ], ], - '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', - ], + 'AddWebhook' => [ + 'summary' => 'Create a code repository Webhook.', + 'path' => '/repository/{repositoryId}/webhooks/create', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '60de7a6852743a5162b5f957', - ], + 'schema' => ['description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access URL, for example: https://devops.aliyun.com/organization/【OrganizationId】', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '60de7a6852743a5162b5f957', 'title' => ''], ], [ 'name' => 'accessToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'f0b1e61db5961df5975a93f9129d2513', - ], + 'schema' => ['description' => 'Personal access token. '."\n" + .'This field is not required if you use Alibaba Cloud AccessKey ID and AccessKey Secret or Security Token Service (STS) temporary authorization.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], ], [ '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', - ], + 'schema' => ['description' => 'Code repository ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '2835387', 'isFileTransferUrl' => false, 'title' => ''], ], [ - 'name' => 'ref', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'Request body', + 'type' => 'object', + 'properties' => [ + 'url' => ['title' => 'hook url', 'description' => 'Webhook Link URL', 'type' => 'string', 'required' => true, 'example' => 'https://xxxxx'], + 'pushEvents' => ['title' => '', 'description' => 'Indicates whether to subscribe to branch push events. '."\n" + .'Valid values: true / false', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'mergeRequestsEvents' => ['title' => '', 'description' => 'Indicates whether to subscribe to merge request events. '."\n" + .'Valid values: true / false', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'tagPushEvents' => ['title' => '', 'description' => 'Indicates whether to subscribe to tag push events. '."\n" + .'Valid values: true / false', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'noteEvents' => ['title' => '', 'description' => 'Whether to subscribe to comment management events '."\n" + .'Valid values: true / false', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'enableSslVerification' => ['title' => '', 'description' => 'Use SSL authentication '."\n" + .'Valid values: true / false', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'description' => ['title' => '', 'description' => 'Webhook description', 'type' => 'string', 'required' => false, 'example' => '线下测试'], + 'secretToken' => ['title' => '', 'description' => 'Token used to authenticate identity, custom-defined by the User', 'type' => 'string', 'required' => false, 'example' => 'xxxx'], + ], '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', + 'title' => '', + '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' => 'F590C9D8-E908-5B6C-95AC-56B7E8011FFA', - ], - 'errorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => '”“', - ], - 'errorCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SYSTEM_UNKNOWN_ERROR', - ], - 'success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'errorMessage' => ['description' => 'Error message', 'type' => 'string', 'example' => '“”', 'title' => ''], + 'requestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '6177543A-8D54-5736-A93B-E0195A1512CB', 'title' => ''], + 'errorCode' => ['description' => 'Error code', 'type' => 'string', 'example' => 'SYSTEM_NOT_FOUND_ERROR', 'title' => ''], + 'success' => ['description' => 'Indicates whether the invocation succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'result' => [ - 'description' => '', + 'description' => 'Result.', 'type' => 'object', 'properties' => [ - 'content' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxxx', - ], - 'totalLines' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '65535', - ], - 'size' => [ - 'type' => 'integer', - 'format' => 'int64', - ], + 'pushEvents' => ['description' => 'Whether to subscribe to branch push events. '."\n" + .'Valid values: true / false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'repositoryId' => ['description' => 'Code repository ID', 'type' => 'integer', 'format' => 'int64', 'example' => '2835387', 'title' => ''], + 'createdAt' => ['description' => 'Creation Time', 'type' => 'string', 'example' => '2022-03-12 12:00:00', 'title' => ''], + 'url' => ['description' => 'Webhook URL', 'type' => 'string', 'example' => 'https://xxxxx', 'title' => ''], + 'tagPushEvents' => ['description' => 'Whether to subscribe to tag push events. '."\n" + .'Valid values: true / false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'lastTestResult' => ['description' => 'Last execution result '."\n" + .'Valid values: ok / error / "" (empty string)', 'type' => 'string', 'example' => 'ok', 'title' => ''], + 'description' => ['description' => 'Description', 'type' => 'string', 'example' => '线下测试', 'title' => ''], + 'mergeRequestsEvents' => ['description' => 'Whether to subscribe to merge request events. '."\n" + .'Valid values: true / false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'secretToken' => ['description' => 'Token used for authentication, defined by the user.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'noteEvents' => ['description' => 'Whether to subscribe to comment events. '."\n" + .'Valid values: true / false', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'id' => ['description' => 'UUID of the webhook', 'type' => 'integer', 'format' => 'int64', 'example' => '30815', 'title' => ''], + 'enableSslVerification' => ['description' => 'Whether to use SSL authentication. '."\n" + .'Valid values: true / false', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], '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.', - ], + 500 => [ + ['errorCode' => 'SystemError.UnKnownError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''], ], ], - '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', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Create a Code Repository Webhook', + 'changeSet' => [ + ['createdAt' => '2022-11-21T13:16:40.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-03-18T06:00:13.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-03-18T06:00:13.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddWebhook'], + ], ], + ], + 'CancelExecutionReleaseStage' => [ + 'summary' => 'Cancels a specific execution of a release stage.', + 'path' => '/appstack/apps/{appName}/releaseWorkflows/{releaseWorkflowSn}/releaseStages/{releaseStageSn}/executions/{executionNumber}:cancel', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'update', 'autoTest' => false, 'notSupportAutoTestReason' => '数据面 api 经安全评估统一不做处理,后续逐步安排下线', 'tenantRelevance' => 'tenant'], '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', - ], + 'schema' => ['description' => 'The organization ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '66c0c9fffeb86b450c19****', 'title' => ''], ], [ - 'name' => 'repositoryId', + 'name' => 'appName', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '2851516', - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'example' => 'app-name', 'title' => ''], ], [ - 'name' => 'path', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'module', - ], + 'name' => 'releaseWorkflowSn', + 'in' => 'path', + 'schema' => ['description' => 'The serial number of the release workflow.', 'type' => 'string', 'required' => true, 'example' => 'ce51b31b996246ecaf8747368383****', 'title' => ''], ], [ - 'name' => 'refName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'master / tag1.0 / sjjfssa', - ], + 'name' => 'releaseStageSn', + 'in' => 'path', + 'schema' => ['description' => 'The serial number of the release stage.', 'type' => 'string', 'required' => true, 'example' => 'e173f3c11db5445eb426ca33c922****', 'title' => ''], ], [ - 'name' => 'type', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'RECURSIVE', - ], + 'name' => 'executionNumber', + 'in' => 'path', + 'schema' => ['description' => 'The execution number of the release stage.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => 'CancelExecutionResponse', + 'description' => 'The response body.', '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', - ], - ], - ], - ], + 'success' => ['description' => 'Indicates whether the request was successful. A value of `true` indicates success and a value of `false` indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - '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.', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"success\\": true\\n}","type":"json"}]', + 'title' => 'Cancel the execution of a development-phase pipeline', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelExecutionReleaseStage'], ], ], - '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"}]', + 'ramActions' => [], ], - 'GetFileLastCommit' => [ - 'summary' => '获取文件上一次提交信息', - 'path' => '/repository/{repositoryId}/files/lastCommit', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CloseMergeRequest' => [ + 'summary' => 'Closes a specified merge request.', + 'path' => '/api/v4/projects/{repositoryId}/merge_requests/{localId}/close', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', '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', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The ID of the organization. You can find this ID in the URL of your organization page on Alibaba Cloud DevOps, for example: `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ - 'name' => 'sha', + 'name' => 'accessToken', 'in' => 'query', - 'schema' => [ - 'title' => '分支名称、标签名称或Commit ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'master', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The personal access token. Not required if you authenticate with an Alibaba Cloud AccessKey pair or Security Token Service (STS).', 'type' => 'string', 'required' => false, 'example' => '0cf2c8458ac44d9481aab2dd6ec10596v3'."\n"], ], [ - 'name' => 'filePath', - 'in' => 'query', - 'schema' => [ - 'title' => '文件路径', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'src/main/test.java', - ], + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the repository.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2369234', 'title' => ''], ], [ - 'name' => 'showSignature', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'name' => 'localId', + 'in' => 'path', + 'schema' => ['description' => 'The local ID of the merge request, which is its number within the repository.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of Response', + 'title' => 'Schema of Response', + 'description' => 'The response body.', '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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'HC93CE1A-8D7A-13A9-8306-7465DE2E5C0F'], + 'errorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => 'InvalidParam.NoPermission', 'title' => ''], + 'errorCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request succeeded. Valid values are `true` and `false`.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'result' => [ - 'title' => '响应结果', - 'description' => '', + 'description' => 'The data returned by the operation.', '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' => 'username@example.com', - ], - 'id' => [ - 'title' => 'Commit ID', - 'description' => '', - 'type' => 'string', - 'example' => 'ff4fb5ac6d1f44f452654336d2dba468ae6c8d04 ', - ], - 'committerEmail' => [ - 'title' => '提交者邮箱', - 'description' => '', - 'type' => 'string', - 'example' => 'username@example.com', - ], - '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', - ], - ], - ], + 'result' => ['description' => 'Indicates if the merge request was closed successfully.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'SystemError.UnKnownError', - 'errorMessage' => 'An error occurred while processing your request.', - ], + '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"}]', + 'title' => 'Shut Down Merge Request', + 'description' => 'This API is available only if your organization is using the new version of merge requests. You can verify this on the merge request page for your organization.', + 'changeSet' => [], + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CloseMergeRequest'], ], ], - '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\\": \\"username@example.com\\",\\n \\"id\\": \\"ff4fb5ac6d1f44f452654336d2dba468ae6c8d04 \\",\\n \\"committerEmail\\": \\"username@example.com\\",\\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>yunxiao-codeup@aliyun.com</AuthorEmail>\\n <Id>201</Id>\\n <CommitterEmail>yunxiao-codeup@aliyun.com</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', - ], + 'CreateAppMembers' => [ + 'summary' => 'Adds members to an application.', + 'path' => '/appstack/apps/{appName}/members', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'tags' => ['应用'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '60de7a6852743a5162b5f957', - ], + 'schema' => ['description' => 'The organization ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '66c0c9fffeb86b450c199fcd', 'title' => ''], ], [ - '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', + 'name' => 'appName', 'in' => 'path', - 'schema' => [ - 'title' => 'The commit hash or name of a repository branch or tag', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'master', - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'testApp', 'title' => ''], ], [ - 'name' => 'showSignature', - 'in' => 'query', - 'schema' => [ - 'title' => '展示签名', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], - ], - ], - 'responses' => [ - 200 => [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ + 'description' => 'The request body.', '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', + 'roleNames' => [ + 'title' => '', + 'description' => 'The roles to assign to the new members.', + 'type' => 'array', + 'items' => [ + 'description' => 'The role name.', + 'enumValueTitles' => ['owner' => 'owner', 'tester' => 'tester', 'admin' => 'administrator', 'developer' => 'developer', 'operator' => 'operator'], + 'type' => 'string', + 'example' => 'developer', + 'required' => false, + 'title' => '', + ], + 'required' => false, + 'docRequired' => true, + 'example' => '', ], - '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' => 'username@example.com', - ], - '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' => 'username@example.com'."\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' => 'username@example.com', - ], - ], - ], - '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' => 'username@example.com', - ], - ], - ], - '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', + 'playerList' => [ + 'title' => '', + 'description' => 'The members to add.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The member ID. If the member type is `User`, this ID is the member\'s Alibaba Cloud UID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '1332695887xxxxxx', 'title' => ''], + 'type' => ['description' => 'The member type. Currently, only `User` is supported.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'User', 'default' => 'User', 'title' => ''], ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], + 'required' => false, + 'docRequired' => true, + 'example' => '', ], ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], - '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.', - ], + 'responses' => [ + 200 => [ + 'description' => '添加应用成员成功', + 'schema' => ['description' => 'The request ID. Use this unique ID to troubleshoot the request.', 'type' => 'string', 'example' => 'FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F', 'title' => ''], ], + 403 => ['description' => '没权限设置拥有者'], + ['description' => '角色未找到'], + 500 => ['description' => '服务端内部异常'], ], - '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\\": \\"username@example.com\\",\\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\\": \\"username@example.com\\\\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\\": \\"username@example.com\\"\\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\\": \\"username@example.com\\"\\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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"\\"FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F\\"","type":"json"}]', + 'title' => 'Create Application Members', + 'changeSet' => [], + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAppMembers'], + ], ], + ], + 'CreateBranch' => [ + 'summary' => 'Create a code repository branch.', + 'path' => '/repository/{repositoryId}/branches', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + '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', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, such as https://devops.aliyun.com/organization/【OrganizationId】 ', 'type' => 'string', 'required' => true, 'example' => '60de7a6852743a5162b5f957'], ], [ 'name' => 'accessToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'f0b1e61db5961df5975a93f9129d2513', - ], + 'schema' => ['description' => 'Personal access token. '."\n" + .'This field is not required if you use Alibaba Cloud AccessKey ID and AccessKey Secret or Security Token Service (STS) temporary authorization.', 'type' => 'string', 'required' => false, 'example' => '0cf2c8458ac44d9481aab2dd6ec10596v3'."\n", 'title' => ''], ], [ 'name' => 'repositoryId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '2334743', - ], + 'schema' => ['description' => 'Code repository ID', 'type' => 'string', 'required' => true, 'example' => '2334815', 'title' => ''], ], [ - 'name' => 'refName', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'Request body', + 'type' => 'object', + 'properties' => [ + 'branchName' => ['description' => 'Branch name', 'type' => 'string', 'required' => true, 'example' => 'createBranch', 'title' => ''], + 'ref' => ['description' => 'Source branch, indicating the branch from which a new branch is created.', 'type' => 'string', 'required' => true, 'example' => 'master', 'title' => ''], + ], 'required' => true, + 'title' => '', '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 => [ @@ -2090,533 +947,308 @@ '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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID ', 'type' => 'string', 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9'], + 'errorMessage' => ['description' => 'Error message ', 'type' => 'string', 'example' => '""', 'title' => ''], + 'errorCode' => ['description' => 'Error code ', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'success' => ['description' => 'Indicates whether the invocation succeeded ', 'type' => 'boolean', 'example' => 'true', 'title' => ''], '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' => 'username@example.com', - ], - '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' => 'username@example.com', - ], - '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' => 'username@example.com', - ], - ], - ], - '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' => 'username@example.com', - ], - ], - ], - 'signature' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'gpgKeyId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '”“', - ], - 'verificationStatus' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'verified', - ], + 'description' => 'Return Result', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'Branch Name', 'type' => 'string', 'example' => 'createBranch', 'title' => ''], + 'protected' => ['description' => 'Is protected branch', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'commit' => [ + 'description' => 'Latest commit information of the branch', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'Commit ID ', 'type' => 'string', 'example' => 'ff4fb5ac6d1f44f452654336d2dba468ae6c8d04', 'title' => ''], + 'shortId' => ['description' => 'Short commit ID', 'type' => 'string', 'example' => 'ff4fb5ac', 'title' => ''], + 'title' => ['description' => 'Commit title, which is the first line of the commit content ', 'type' => 'string', 'example' => '创建代码库分支', 'title' => ''], + 'authorName' => ['description' => 'Author Name', 'type' => 'string', 'example' => '阿里云云效', 'title' => ''], + 'authorEmail' => ['description' => 'Author mailbox', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + 'createdAt' => ['description' => 'Creation Time', 'type' => 'string', 'example' => '2022-03-18 10:00:00', 'title' => ''], + 'message' => ['description' => 'Commit content ', 'type' => 'string', 'example' => 'create branch', 'title' => ''], + 'authoredDate' => ['description' => 'Author submitted time', 'type' => 'string', 'example' => '2022-03-18 09:00:00', 'title' => ''], + 'committedDate' => ['description' => 'Submitted At by committer', 'type' => 'string', 'example' => '2022-03-18 10:00:00', 'title' => ''], + 'committerEmail' => ['description' => 'Committer\'s mailbox ', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + 'committerName' => ['description' => 'Committer\'s name ', 'type' => 'string', 'example' => '阿里云云效committer', 'title' => ''], + 'parentIds' => [ + 'description' => 'List of parent commit IDs', + 'type' => 'array', + 'items' => ['description' => 'Parent commit ID ', 'type' => 'string', 'example' => '34d2c47c7ce46a5c4639c5ffe208a66dda975a05', 'title' => ''], + 'title' => '', + 'example' => '', ], ], - 'commentsCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], '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.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => '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.', 'description' => ''], ], ], - '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\\": \\"username@example.com\\",\\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\\": \\"username@example.com\\",\\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\\": \\"username@example.com\\"\\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\\": \\"username@example.com\\"\\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', + '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\\": \\"username@example.com\\",\\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\\": \\"username@example.com\\",\\n \\"committerName\\": \\"阿里云云效committer\\",\\n \\"parentIds\\": [\\n \\"34d2c47c7ce46a5c4639c5ffe208a66dda975a05\\"\\n ]\\n }\\n }\\n}","type":"json"}]', + 'title' => 'Create branch ', + 'changeSet' => [], + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateBranch'], + ], ], + ], + 'CreateChangeRequest' => [ + 'summary' => 'Create an application deployment.', + 'path' => '/appstack/apps/{appName}/changeRequests', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'create', 'autoTest' => false, 'notSupportAutoTestReason' => '数据面 api 经安全评估统一不做处理,后续逐步安排下线', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '60de7a6852743a5162b5f957', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The organization ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '66c0c9fffeb86b450c199fcd', 'title' => ''], ], [ - 'name' => 'accessToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'accessToken', - 'example' => 'f0b1e61db5961df5975a93f9129d2513', - 'required' => false, - 'type' => 'string', - ], - ], - [ - 'name' => 'repositoryId', + 'name' => 'appName', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'example' => '2464454', - 'format' => 'int64', - 'required' => true, - 'type' => 'integer', - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'example' => 'app-name', 'title' => ''], ], [ - 'name' => 'sha', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'example' => 'master', - 'required' => true, - 'type' => 'string', - ], - ], - [ - 'name' => 'contextLine', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'example' => '3', - 'format' => 'int32', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'title' => ['description' => 'The title of the change request.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '变更标题'], + 'ownerId' => ['title' => 'ownerId', 'type' => 'string', 'required' => true, 'description' => '', 'example' => ''], + 'ownerAccountId' => ['description' => 'The owner\'s Alibaba Cloud account ID.', 'type' => 'string', 'required' => false, 'example' => '1332695887xxxxxx', 'title' => ''], + 'appCodeRepoSn' => ['description' => 'The ID of the application code repository.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'sn123'], + 'branchName' => ['description' => 'The branch name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'hotfix/20240524'], + 'autoDeleteBranchWhenEnd' => ['description' => 'Specifies whether to automatically delete the branch upon completion of the change.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'title' => '', 'example' => 'false'], + 'createBranch' => ['description' => 'Specifies whether to create a new branch.', 'type' => 'boolean', 'default' => 'false', 'title' => '', 'required' => false, 'example' => 'false'], + ], 'required' => false, - 'type' => 'integer', + 'title' => '', + 'example' => '', ], ], ], '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' => 'ChangeRequestVO', + 'description' => 'The change request object.', + 'type' => 'object', + 'properties' => [ + 'sn' => ['description' => 'The unique identifier of the change request.', 'type' => 'string', 'title' => '', 'example' => 'ce51b31b996246ecaf874736838360b2'], + 'appName' => ['description' => 'The application name.', 'type' => 'string', 'title' => '', 'example' => 'app-name'], + 'state' => ['description' => 'The state of the change request.', 'type' => 'string', 'title' => '', 'example' => 'DEVELOPING'], + 'name' => ['description' => 'The name of the change request.', 'type' => 'string', 'title' => '', 'example' => '变更名称'], + 'type' => ['description' => 'The type of the change request.', 'type' => 'string', 'title' => '', 'example' => 'APP'], + 'appCodeRepoSn' => ['description' => 'The unique identifier of the code repository.', 'type' => 'string', 'title' => '', 'example' => 'sn123'], + 'branch' => ['description' => 'The branch for the change.', 'type' => 'string', 'title' => '', 'example' => 'hotfix/20240524'], + 'ownerId' => ['description' => 'The Alibaba Cloud DevOps ID of the owner.', 'type' => 'string', 'title' => '', 'example' => 'owner-id-123'], + 'ownerAccountId' => ['description' => 'The Alibaba Cloud account ID of the owner.', 'type' => 'string', 'title' => '', 'example' => 'account-id-123'], + 'originBranch' => ['description' => 'The source branch from which the change branch was created.', 'type' => 'string', 'title' => '', 'example' => 'master'], + 'originBranchRevisionSha' => ['description' => 'The SHA hash of the source branch revision.', 'type' => 'string', 'title' => '', 'example' => 'revision-123'], + 'creatorId' => ['description' => 'The Alibaba Cloud DevOps ID of the creator.', 'type' => 'string', 'title' => '', 'example' => 'create-id-123'."\n"], + 'creatorAccountId' => ['description' => 'The Alibaba Cloud account ID of the creator.', 'type' => 'string', 'title' => '', 'example' => 'create-account-123'], + 'gmtCreate' => ['description' => 'The time when the change request was created.', 'type' => 'string', 'title' => '', 'example' => '2024-01-01 00:00:00'], + 'gmtModified' => ['description' => 'The time when the change request was last modified.', 'type' => 'string', 'title' => '', 'example' => '2024-01-01 00:00:00'], + 'autoDeleteBranchWhenEnd' => ['description' => 'Indicates whether the branch is automatically deleted after the change is complete.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], ], - 'title' => 'Schema of Response', - 'type' => 'object', + '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 \\"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', + '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"}]', + 'title' => 'Create Application Change ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateChangeRequest'], + ], ], + 'ramActions' => [], + ], + 'CreateCheckRun' => [ + 'summary' => 'Creates a check run record only.', + 'path' => '/api/v4/projects/check_runs/create_check_run', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'query', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The organization ID. You can get the organization ID from the URL in Alibaba Cloud DevOps. Example: https\\://devops.aliyun.com/organization/{OrganizationId}', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ 'name' => 'accessToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'f0b1e61db5961df5975a93f9129d2513', - ], + 'schema' => ['description' => 'The personal access token. This parameter is optional if you use an AccessKey or STS temporary authorization for authentication.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], ], [ 'name' => 'repositoryIdentity', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], + 'schema' => ['description' => 'The ID or full path of the repository.', 'type' => 'string', 'required' => true, 'example' => '2835387 或 codeup/codeup-demo'."\n", 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'branch' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'master', - ], - 'commitMessage' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The name of the check run.'."\n" + ."\n" + .'> The name must be unique for a given repository, commit ID, and author. The maximum length is 50 characters.', 'type' => 'string', 'required' => true, 'example' => 'my-check-ci', 'title' => ''], + 'headSha' => ['description' => 'The commit SHA.'."\n" + ."\n" + .'> This commit must be at the head of a branch that is the source of a merge request.', 'type' => 'string', 'required' => true, 'example' => '40f4ccfe019cdd4a62d4acb0c57130106fc7e1be', 'title' => ''], + 'status' => ['description' => 'The status of the check run. Valid values:'."\n" + ."\n" + .'- `queued`: Queued'."\n" + ."\n" + .'- `in_progress`: In progress'."\n" + ."\n" + .'- `completed`: Completed', 'type' => 'string', 'required' => false, 'example' => 'completed', 'title' => ''], + 'conclusion' => ['description' => 'The conclusion of the check run. Valid values:'."\n" + ."\n" + .'- `cancelled`: Cancelled'."\n" + ."\n" + .'- `failure`: Failure'."\n" + ."\n" + .'- `neutral`: Neutral. This is a success state.'."\n" + ."\n" + .'- `success`: Success'."\n" + ."\n" + .'- `skipped`: Skipped. This is a success state.'."\n" + ."\n" + .'- `timed_out`: Timed out', 'type' => 'string', 'required' => false, 'example' => 'success', 'title' => ''], + 'startedAt' => ['description' => 'The time the check run started.'."\n" + ."\n" + .'> The time must be in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Example: 2023-03-15T08:00:00Z.', 'type' => 'string', 'required' => false, 'example' => '2023-03-15T08:00:00Z', 'title' => ''], + 'completedAt' => ['description' => 'The time the check run completed.'."\n" + ."\n" + .'> The time must be in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Example: 2023-03-15T08:00:00Z.', 'type' => 'string', 'required' => false, 'example' => '2023-03-15T08:00:00Z', 'title' => ''], + 'externalId' => ['description' => 'The ID from an external system.'."\n" + ."\n" + .'> An external system refers to your own check system. Use this field to store an identifier from that system. The platform stores this value as a string and does not interpret it.', 'type' => 'string', 'required' => false, 'example' => '42', 'title' => ''], + 'detailsUrl' => ['description' => 'The URL to a page on an external system with full details about the check run. The platform provides a link to this URL.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], + 'output' => [ + 'description' => 'The display information for the check run.', + 'type' => 'object', + 'properties' => [ + 'title' => ['description' => 'The title of the UI module. This is different from the check run \'name\'.', 'type' => 'string', 'required' => true, 'example' => 'Mighty Readme report', 'title' => ''], + 'summary' => ['description' => 'A summary of the check run.'."\n" + ."\n" + .'> Supports Markdown. The maximum length is 65,535 characters (64 KB).', 'type' => 'string', 'required' => true, 'example' => '摘要信息内容', 'title' => ''], + 'text' => ['description' => 'The details of the check run.'."\n" + ."\n" + .'> Supports Markdown. The maximum length is 65,535 characters (64 KB).', 'type' => 'string', 'required' => false, 'example' => '详情信息内容', 'title' => ''], + 'images' => [ + 'description' => 'An array of image objects.'."\n" + ."\n" + .'> Images in this array are displayed in the output module of the check run.', + 'type' => 'array', + 'items' => [ + 'description' => 'An image object.', + 'type' => 'object', + 'properties' => [ + 'alt' => ['description' => 'The alternative text for the image.', 'type' => 'string', 'required' => true, 'example' => 'test-image-alt', 'title' => ''], + 'imageUrl' => ['description' => 'The URL of the image. The URL must be publicly accessible for the image to be displayed.', 'type' => 'string', 'required' => true, 'example' => 'xxx', 'title' => ''], + 'caption' => ['description' => 'A short description of the image.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], 'required' => false, - 'example' => 'auto', + 'title' => '', + 'example' => '', ], - 'actions' => [ - 'description' => '', + 'annotations' => [ + 'description' => 'A list of annotations.'."\n" + ."\n" + .'> If your external system produces code quality check results, you can provide them here. The results are displayed as annotations on the relevant code.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'An annotation object.', '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', - ], + 'path' => ['description' => 'The path of the file to which the annotation applies.', 'type' => 'string', 'required' => true, 'example' => 'demo/test.txt', 'title' => ''], + 'startLine' => ['description' => 'The starting line of the annotation.'."\n" + ."\n" + .'> The line number starts from 1. The annotation is not displayed if the line number is invalid for the specified file.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], + 'endLine' => ['description' => 'The ending line of the annotation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2', 'title' => ''], + 'startColumn' => ['description' => 'The starting column of the annotation.'."\n" + ."\n" + .'> This field is valid only when `startLine` is the same as `endLine`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3', 'title' => ''], + 'endColumn' => ['description' => 'The ending column of the annotation.'."\n" + ."\n" + .'> This field is valid only when `startLine` is the same as `endLine`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5', 'title' => ''], + 'annotationLevel' => ['description' => 'The severity level of the annotation. Valid values:'."\n" + ."\n" + .'- `notice`: Notice'."\n" + ."\n" + .'- `warning`: Warning'."\n" + ."\n" + .'- `failure`: Failure', 'type' => 'string', 'required' => true, 'example' => 'notice', 'title' => ''], + 'message' => ['description' => 'A short, descriptive message for the annotation.', 'type' => 'string', 'required' => true, 'example' => '回写检查注释的简要描述信息', 'title' => ''], + 'title' => ['description' => 'The title of the annotation.', 'type' => 'string', 'required' => false, 'example' => '检查注释的标题', 'title' => ''], + 'rawDetails' => ['description' => 'Detailed information for the annotation. The maximum size is 64 KB.', 'type' => 'string', 'required' => false, 'example' => '详情信息内容', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], - 'required' => true, + 'required' => false, + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -2624,458 +1256,250 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response schema.', '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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'errorCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'errorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => '""', 'title' => ''], 'result' => [ - 'description' => '', + 'description' => 'The result of the request.', 'type' => 'object', 'properties' => [ - 'id' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'de02b625ba8488f92eb204bcb3773a40c1b4ddac', - ], - 'shortId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'de02b625', - ], - 'title' => [ - 'description' => '', - 'type' => 'string', + 'id' => ['description' => 'The unique ID of the check run.', 'type' => 'integer', 'format' => 'int64', 'example' => '524836', 'title' => ''], + 'createdAt' => ['description' => 'The creation time of the check run.', 'type' => 'string', 'example' => '2022-01-14T21:08:26+08:00', 'title' => ''], + 'updatedAt' => ['description' => 'The update time of the check run.', 'type' => 'string', 'example' => '2022-01-14T21:08:26+08:00', 'title' => ''], + 'startedAt' => ['description' => 'The start time of the check run.', 'type' => 'string', 'example' => '2023-03-15T08:00:00Z', 'title' => ''], + 'completedAt' => ['description' => 'The completion time of the check run.', 'type' => 'string', 'example' => '2023-03-15T08:00:00Z', 'title' => ''], + 'externalId' => ['description' => 'The external ID for the check run.', 'type' => 'string', 'example' => '42', 'title' => ''], + 'name' => ['description' => 'The name of the check run.', 'type' => 'string', 'example' => 'my-check-ci'."\n", 'title' => ''], + 'headSha' => ['description' => 'The commit ID.', 'type' => 'string', 'example' => '40f4ccfe019cdd4a62d4acb0c57130106fc7e1be', 'title' => ''], + 'status' => ['description' => 'The current status of the check run.'."\n" + ."\n" + .'- `queued`: Queued'."\n" + ."\n" + .'- `in_progress`: In progress'."\n" + ."\n" + .'- `completed`: Completed', 'type' => 'string', 'example' => 'completed', 'title' => ''], + 'conclusion' => ['description' => 'The conclusion of the check run.'."\n" + ."\n" + .'- `cancelled`: Cancelled'."\n" + ."\n" + .'- `failure`: Failure'."\n" + ."\n" + .'- `neutral`: Neutral (treated as a success)'."\n" + ."\n" + .'- `success`: Success'."\n" + ."\n" + .'- `skipped`: Skipped (treated as a success)'."\n" + ."\n" + .'- `timed_out`: Timed out', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'detailsUrl' => ['description' => 'A user-defined URL that links to details on an external system. The platform only provides a redirect to this URL.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'checkSuite' => [ + 'description' => 'The check suite to which the check run belongs.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The unique ID of the check suite.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + ], + 'title' => '', 'example' => '', ], - 'message' => [ - 'description' => '', - 'type' => 'string', + 'writer' => [ + 'description' => 'Brief information about the writer.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The writer\'s Alibaba Cloud account ID.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'type' => ['description' => 'The type of the writer.'."\n" + ."\n" + .'- `User`: A user.', 'type' => 'string', 'example' => 'User', 'title' => ''], + 'name' => ['description' => 'The name of the writer.', 'type' => 'string', 'example' => 'test-codeup', 'title' => ''], + 'slug' => ['description' => 'The slug for the writer.', 'type' => 'string', 'example' => 'test-codeup', 'title' => ''], + 'logoUrl' => ['description' => 'The writer\'s avatar URL.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + ], + 'title' => '', 'example' => '', ], - 'authorName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test-codeup', - ], - 'authorEmail' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'username@example.com', - ], - 'authoredDate' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2022-03-18 15:00:00', - ], - 'committerName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'committer-codeup', - ], - 'committerEmail' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'username@example.com', - ], - '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' => '', + 'output' => [ + 'description' => 'Contains the output to be displayed in the user interface.', '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' => 'username@example.com', - ], - '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' => '""', + 'title' => ['description' => 'The title of the output. This is different from the check run `name`.', 'type' => 'string', 'example' => 'Mighty Readme report'."\n", 'title' => ''], + 'summary' => ['description' => 'A summary of the check run.'."\n" + ."\n" + .'> Supports Markdown. The maximum length is 65,535 characters (64 KB).', 'type' => 'string', 'example' => '摘要信息内容'."\n", 'title' => ''], + 'text' => ['description' => 'The details of the check run.'."\n" + ."\n" + .'> Supports Markdown. The maximum length is 65,535 characters (64 KB).', 'type' => 'string', 'example' => '详情信息内容'."\n", 'title' => ''], + 'images' => [ + 'description' => 'A list of image objects.'."\n" + ."\n" + .'> Use this field to display images in the check run output.', + 'type' => 'array', + 'items' => [ + 'description' => 'An image object.', + 'type' => 'object', + 'properties' => [ + 'alt' => ['description' => 'The alt text for the image.', 'type' => 'string', 'example' => 'test-image-alt', 'title' => ''], + 'imageUrl' => ['description' => 'The URL of the image. This URL must be publicly accessible; otherwise, the image will not be displayed.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'caption' => ['description' => 'A short description of the image.', 'type' => 'string', 'example' => 'test', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + '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' => 'username@example.com', - ], - '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' => '""', - ], + 'annotations' => [ + 'description' => 'A list of check annotations.'."\n" + ."\n" + .'> Use this field to display code quality results from third-party systems as annotations on the check run.', + 'type' => 'array', + 'items' => [ + 'description' => 'A check annotation object.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The unique ID of the check annotation.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'path' => ['description' => 'The path of the file to which the annotation applies.', 'type' => 'string', 'example' => 'demo/test.txt', 'title' => ''], + 'startLine' => ['description' => 'The start line of the annotation.'."\n" + ."\n" + .'> Line numbering starts at 1. The annotation will not be displayed if the line number is invalid for the specified file.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'endLine' => ['description' => 'The end line of the annotation.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'startColumn' => ['description' => 'The start column of the annotation.'."\n" + ."\n" + .'> This field is valid only when `startLine` and `endLine` are the same.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'endColumn' => ['description' => 'The end column of the annotation.'."\n" + ."\n" + .'> This field is valid only when `startLine` and `endLine` are the same.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], + 'annotationLevel' => ['description' => 'The severity level of the annotation.'."\n" + ."\n" + .'- `notice`: Notice'."\n" + ."\n" + .'- `warning`: Warning'."\n" + ."\n" + .'- `failure`: Failure', 'type' => 'string', 'example' => 'notice', 'title' => ''], + 'message' => ['description' => 'A short message about the annotation.', 'type' => 'string', 'example' => '回写检查注释的简要描述信息'."\n", 'title' => ''], + 'title' => ['description' => 'The title of the annotation.', 'type' => 'string', 'example' => '检查注释的标题', 'title' => ''], + 'rawDetails' => ['description' => 'The raw details of the annotation, with a maximum size of 64 KB.', 'type' => 'string', 'example' => '详情信息', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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"}]', + 'title' => 'Add Execution History', + 'changeSet' => [], + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCheckRun'], + ], ], - '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\\": \\"username@example.com\\",\\n \\"authoredDate\\": \\"2022-03-18 15:00:00\\",\\n \\"committerName\\": \\"committer-codeup\\",\\n \\"committerEmail\\": \\"username@example.com\\",\\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\\": \\"username@example.com\\",\\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\\": \\"username@example.com\\",\\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', - ], + 'CreateComment' => [ + 'summary' => 'You can add overall and inline comments to a merge request. As a best practice, limit comment threads to a maximum of three levels.', + 'path' => '/api/v4/projects/code_reviews/comments/create_comment', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '214317', + 'abilityTreeNodes' => ['FEATURErdcI7YZMH'], + ], '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, - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The ID of the organization. You can find this ID in the URL for your organization in Alibaba Cloud DevOps. The URL is in the format `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ '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' => 'username@example.com', - ], - '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', - ], - ], - ], - ], - ], - ], + 'schema' => ['description' => 'The personal access token. This parameter is not required if you use an AccessKey pair or a Security Token Service (STS) token for authentication.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], ], - ], - '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\\": \\"username@example.com\\",\\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>yunxiao@aliyun.com</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', + 'name' => 'repositoryIdentity', 'in' => 'query', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '60de7a6852743a5162b5f957', - ], + 'schema' => ['description' => 'The ID or full path of the repository.', 'type' => 'string', 'required' => true, 'example' => '2835387 或 codeup/codeup-demo', 'title' => ''], ], [ - 'name' => 'accessToken', + 'name' => 'localId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'f0b1e61db5961df5975a93f9129d2513', - ], - ], - [ - 'name' => 'groupId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '22901', - ], + 'schema' => ['description' => 'The sequential ID of the merge request within the repository.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], [ '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, + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'content' => ['description' => 'The comment content.', 'type' => 'string', 'required' => true, 'example' => '评论内容', 'title' => ''], + 'commentType' => ['description' => 'The comment type. Valid values:'."\n" + ."\n" + .'- `GLOBAL_COMMENT`: A comment on the entire merge request.'."\n" + ."\n" + .'- `INLINE_COMMENT`: A comment on a specific line of a file.', 'type' => 'string', 'required' => true, 'example' => 'GLOBAL_COMMENT', 'title' => ''], + 'parentCommentBizId' => ['description' => 'The business ID of the parent comment.', 'type' => 'string', 'required' => false, 'example' => '2666ac1ac53841b0ba1b042e383279cc', 'title' => ''], + 'resolved' => ['description' => 'Indicates whether the comment is resolved.'."\n" + ."\n" + .'><notice>'."\n" + ."\n" + .'This parameter is required when creating a root comment (when `parentCommentBizId` is empty).'."\n" + ."\n" + .'></notice>', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'filePath' => ['description' => 'The file path.'."\n" + ."\n" + .'> This parameter is required if `commentType` is `INLINE_COMMENT`.', 'type' => 'string', 'required' => false, 'example' => '/src/main/test.java', 'title' => ''], + 'lineNumber' => ['description' => 'The line number in the file for an inline comment.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'patchSetBizId' => ['description' => 'The ID of the patch set associated with the merge request.'."\n" + .'><notice>This parameter is required if `commentType` is `INLINE_COMMENT`.></notice>', 'type' => 'string', 'required' => false, 'example' => 'b7d8386be17c4ca68a07140db4836257', 'title' => ''], + 'draft' => ['description' => 'Indicates whether the comment is a draft.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'fromPachSetBizId' => ['description' => 'The ID of the source patch set for comparison.'."\n" + .'><notice>This parameter is required if `commentType` is `INLINE_COMMENT`.></notice>'."\n" + ."\n" + .'><notice>'."\n" + ."\n" + .'This value is required when you create a comment of the INLINE\\_COMMENT type.'."\n" + ."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'b7d8386be17c4ca68a07140db4836257', 'title' => ''], + 'toPatchSetBizId' => ['description' => 'The ID of the target patch set for comparison.'."\n" + .'><notice>This parameter is required if `commentType` is `INLINE_COMMENT`.></notice>'."\n" + ."\n" + .'><notice>'."\n" + ."\n" + .'This value is required if you create a comment of the INLINE\\_COMMENT type.'."\n" + ."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => '543cd42cbfc0447b920a670e9897b6f7', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -3083,175 +1507,160 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response body.', '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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'."\n"], + 'success' => ['description' => 'Specifies whether the request was successful. `true` indicates success, and `false` indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'errorCode' => ['description' => 'The error code returned when the request fails.', 'type' => 'string', 'example' => 'Openapi.RequestError', 'title' => ''], + 'errorMessage' => ['description' => 'The error message returned when the request fails.', 'type' => 'string', 'example' => '""', 'title' => ''], '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' => 'username@example.com', - ], - 'accessLevel' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'sourceId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '223241', - ], + 'description' => 'The data returned for the request.', + 'type' => 'object', + 'properties' => [ + 'commentBizId' => ['description' => 'The unique business ID of the comment.', 'type' => 'string', 'example' => '5c399e3685e542a28db16d93e9f82abb', 'title' => ''], + 'commentType' => ['description' => 'The type of the comment. Valid values:'."\n" + ."\n" + .'- `GLOBAL_COMMENT`: A global comment.'."\n" + ."\n" + .'- `INLINE_COMMENT`: An inline comment.', 'type' => 'string', 'example' => 'GLOBAL_COMMENT', 'title' => ''], + 'state' => ['description' => 'The status of the comment. Valid values:'."\n" + ."\n" + .'- `DRAFT`: The comment is a draft.'."\n" + ."\n" + .'- `OPENED`: The comment is published.', 'type' => 'string', 'example' => 'OPENED', 'title' => ''], + 'resolved' => ['description' => 'Indicates whether the comment has been resolved.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'deleted' => ['description' => 'Indicates whether the comment has been deleted.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'commentTime' => ['description' => 'The time when the comment was created.', 'type' => 'string', 'example' => '2022-03-18 14:24:54'."\n", 'title' => ''], + 'lastEditTime' => ['description' => 'The time when the comment was last edited.', 'type' => 'string', 'example' => '2022-03-18 14:24:54'."\n", 'title' => ''], + 'content' => ['description' => 'The content of the comment.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'author' => [ + 'description' => 'The comment\'s author.', + 'type' => 'object', + 'properties' => [ + 'aliyunPk' => ['description' => 'The Alibaba Cloud account ID of the author.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'name' => ['description' => 'The author\'s name.', 'type' => 'string', 'example' => 'test-codeup', 'title' => ''], + 'username' => ['description' => 'The author\'s username.', 'type' => 'string', 'example' => 'test-codeup', 'title' => ''], + 'state' => ['description' => 'The state of the user. Valid values:'."\n" + ."\n" + .'- `active`: The user is active.'."\n" + ."\n" + .'- `blocked`: The user is blocked or inactive.', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'avatarUrl' => ['description' => 'The user\'s avatar URL.', 'type' => 'string', 'example' => '头像地址'."\n" + ."\n" + .'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', 'title' => ''], + 'email' => ['description' => 'The user\'s email address.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + 'id' => ['description' => 'The user\'s primary key ID. This is an internal identifier and has no business significance.', 'type' => 'integer', 'format' => 'int64', 'example' => '19927', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'relatedPatchSet' => [ + 'description' => 'The associated patch set.', + 'type' => 'object', + 'properties' => [ + 'patchSetNo' => ['description' => 'The patch set number.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'patchSetBizId' => ['description' => 'The unique business ID of the patch set.', 'type' => 'string', 'example' => '513fcfd81a9142d2bb0db4f72c0aa15b', 'title' => ''], + 'patchSetName' => ['description' => 'The patch set\'s name.', 'type' => 'string', 'example' => '版本1', 'title' => ''], + 'commitId' => ['description' => 'The commit ID associated with the patch set.', 'type' => 'string', 'example' => '1a072f5367c21f9de3464b8c0ee8546e47764d2d', 'title' => ''], + 'shortId' => ['description' => 'The short commit ID.', 'type' => 'string', 'example' => '1a072f53', 'title' => ''], + 'relatedMergeItemType' => ['description' => 'The associated merge type. Valid values:'."\n" + ."\n" + .'- `MERGE_SOURCE`: The merge source.'."\n" + ."\n" + .'- `MERGE_TARGET`: The merge target.', 'type' => 'string', 'example' => 'MERGE_SOURCE', 'title' => ''], + 'createdAt' => ['description' => 'The creation time of the patch set.', 'type' => 'string', 'example' => '2022-03-18 14:24:54'."\n", 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'lineNumber' => ['description' => 'The line number in the file where the comment is located. This field is returned only for inline comments.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'filePath' => ['description' => 'The path of the file to which the comment applies. This field is returned only when `commentType` is `INLINE_COMMENT`.', 'type' => 'string', 'example' => 'src/main/update.txt', 'title' => ''], + 'parentCommentBizId' => ['description' => 'The business ID of the parent comment.', 'type' => 'string', 'example' => '4c5dcec6a8dc41e69c369737dadc1841', 'title' => ''], + 'rootCommentBizId' => ['description' => 'The business ID of the root comment.', 'type' => 'string', 'example' => 'dcf2b23cebfc418f98dbd35e423d9fd3', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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\\": \\"username@example.com\\",\\n \\"accessLevel\\": 30,\\n \\"sourceId\\": 223241\\n }\\n ]\\n}","type":"json"}]', - ], - 'DeleteRepositoryMember' => [ - 'summary' => '删除代码库成员', - 'path' => '/repository/{repositoryId}/members/delete/{aliyunPk}', - 'methods' => [ - 'post', + '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\\": \\"username@example.com\\",\\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"}]', + 'title' => 'Create a merge request comment', + 'changeSet' => [ + ['createdAt' => '2025-02-20T12:24:46.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateComment'], + ], ], + ], + 'CreateCommitStatus' => [ + 'summary' => 'Adds a commit status record for a specified commit.', + 'path' => '/api/v4/projects/repository/commit_statuses/create_commit_status', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'query', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '632bbfdf419338aaa2b1360a', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The organization ID. You can find the organization ID in your Alibaba Cloud DevOps URL, for example, https\\://devops.aliyun.com/organization/{OrganizationId}.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ 'name' => 'accessToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'f0b1e61db5961df5975a93f9129d2513'."\n", - ], + 'schema' => ['description' => 'The personal access token.'."\n" + .'This parameter is not required if you use an Alibaba Cloud AccessKey pair or a Security Token Service (STS) temporary token for authentication.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], ], [ - 'name' => 'repositoryId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '2080398', - ], + 'name' => 'repositoryIdentity', + 'in' => 'query', + 'schema' => ['description' => 'The ID or full path of the repository.', 'type' => 'string', 'required' => true, 'example' => '2080972', 'title' => ''], ], [ - 'name' => 'aliyunPk', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1789095186553536', - ], + 'name' => 'sha', + 'in' => 'query', + 'schema' => ['description' => 'The commit SHA.', 'type' => 'string', 'required' => true, 'example' => 'e0c1a1299a2656bfc155650bbd2df5e628fa1f4c', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'memberType' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'USERS', - ], + 'state' => ['description' => 'The state of the commit status. The API returns an error if you provide any value other than the following:'."\n" + ."\n" + .'- error'."\n" + ."\n" + .'- failure'."\n" + ."\n" + .'- pending'."\n" + ."\n" + .'- success', 'type' => 'string', 'required' => true, 'example' => 'success', 'title' => ''], + 'description' => ['description' => 'A short description of the commit status. The description cannot exceed 3,000 characters.', 'type' => 'string', 'required' => false, 'example' => '提交状态描述内容', 'title' => ''], + 'targetUrl' => ['description' => 'A URL to associate with this status. The UI links to this URL, which typically points to a third-party system.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], + 'context' => ['description' => 'A string identifier to differentiate statuses from different systems. The UI displays it as a title. The default value is "default". The maximum length is 50 characters, and the value is case-insensitive.'."\n" + ."\n" + .'> This parameter is crucial for configuring quality gates and merge request integrations. Do not change it unless you are testing or debugging.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -3259,176 +1668,146 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response body.', '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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '020F71F3-F063-5B8B-8978-2B01833216BB'], + 'success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''], 'result' => [ - 'description' => '', + 'description' => 'The returned data.', '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', + 'id' => ['description' => 'The unique ID of the commit status record. This ID has no business significance.', 'type' => 'integer', 'format' => 'int64', 'example' => '30815', 'title' => ''], + 'sha' => ['description' => 'The commit SHA.', 'type' => 'string', 'example' => 'c0ca103441b9fa7f369be8d24a6f20db44dfddf7', 'title' => ''], + 'context' => ['description' => 'A string identifier to differentiate statuses from different systems. The UI displays it as a title. The default value is "default". The maximum length is 50 characters, and the value is case-insensitive.', 'type' => 'string', 'example' => 'default', 'title' => ''], + 'state' => ['description' => 'The state of the commit status.'."\n" + ."\n" + .'- error'."\n" + ."\n" + .'- failure'."\n" + ."\n" + .'- pending'."\n" + ."\n" + .'- success', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'targetUrl' => ['description' => 'A URL to associate with this status. The UI links to this URL, which typically points to a third-party system.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'description' => ['description' => 'A short description of the commit status. The description cannot exceed 3,000 characters.', 'type' => 'string', 'example' => '提交状态描述内容', 'title' => ''], + 'creator' => [ + 'description' => 'Information about the user or application that created the commit status.', + 'type' => 'object', + 'properties' => [ + 'aliyunPk' => ['description' => 'The Alibaba Cloud account ID. This field is empty if "type" is "Bot".', 'type' => 'integer', 'format' => 'int64', 'example' => '204485087002425236', 'title' => ''], + 'login' => ['description' => 'If "type" is "User", this is the username. If "type" is "Bot", this is the application name.', 'type' => 'string', 'example' => 'codeup', 'title' => ''], + 'avatarUrl' => ['description' => 'The creator\'s avatar URL.', 'type' => 'string', 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', 'title' => ''], + 'type' => ['description' => 'The type of creator.'."\n" + ."\n" + .'- "User": A regular user.'."\n" + ."\n" + .'- "Bot": An application.', 'type' => 'string', 'example' => 'User', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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\\": \\"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"}]', + 'title' => 'Add commit status record ', + 'description' => 'A repository cannot have more than 1,000 commit status records for the same combination of commit SHA and context. The API returns an error if you exceed this limit.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCommitStatus'], ], ], - '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"}]', + 'ramActions' => [], ], - 'DeleteGroupMember' => [ - 'summary' => '删除组成员', - 'path' => '/repository/groups/{groupId}/members/remove/aliyun_pk', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateCommitWithMultipleFiles' => [ + 'summary' => 'Use this API to commit changes to multiple files, a common development scenario.', + 'path' => '/api/v4/projects/repository/commits/files', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'query', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '6082a9b0c7972588ac363793', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The ID of the organization. You can obtain this ID from the Alibaba Cloud DevOps URL, for example, `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ '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', - ], + 'schema' => ['description' => 'The personal access token. This parameter is not required if you use an Alibaba Cloud AccessKey pair or STS temporary credentials for authentication.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], ], [ - 'name' => 'aliyunPk', + 'name' => 'repositoryIdentity', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1789095186553536', - ], + 'schema' => ['description' => 'The ID or full path of the repository.', 'type' => 'string', 'required' => true, 'example' => '2835387 或 codeup/codeup-demo', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'memberType' => [ - 'description' => '', - 'type' => 'string', + 'branch' => ['description' => 'The name of the branch.', 'type' => 'string', 'required' => true, 'example' => 'master', 'title' => ''], + 'commitMessage' => ['description' => 'The commit message.', 'type' => 'string', 'required' => false, 'example' => 'auto', 'title' => ''], + 'actions' => [ + 'description' => 'An array of objects, where each object defines a file operation.', + 'type' => 'array', + 'items' => [ + 'description' => 'An object that defines a file operation.', + 'type' => 'object', + 'properties' => [ + 'action' => ['description' => 'The type of action to perform. Valid values:'."\n" + ."\n" + .'- `create`: Create a new file.'."\n" + ."\n" + .'- `delete`: Delete a file.'."\n" + ."\n" + .'- `move`: Move or rename a file.'."\n" + ."\n" + .'- `update`: Update a file.', 'type' => 'string', 'required' => false, 'example' => 'create', 'title' => ''], + 'filePath' => ['description' => 'The full file path.', 'type' => 'string', 'required' => false, 'example' => 'src/test.java', 'title' => ''], + 'previousPath' => ['description' => 'The original file path. This parameter is required for `move` actions.', 'type' => 'string', 'required' => false, 'example' => 'src/main/test.java', 'title' => ''], + 'content' => ['description' => 'The content of the file.'."\n" + ."\n" + .'><notice>'."\n" + ."\n" + .'For an `update` action, this content replaces the existing content of the file.'."\n" + ."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => true, - 'example' => 'USERS', + 'title' => '', + 'example' => '', ], ], - 'required' => true, + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -3436,220 +1815,143 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response schema.', '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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'A7586FEB-E48D-5579-983F-74981FBFF627'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'errorMsg' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'error', 'title' => ''], 'result' => [ - 'description' => '', + 'description' => 'Details of the created commit.'."\n" + ."\n" + .'> The result contains commit information.', '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', + 'id' => ['description' => 'The commit ID.', 'type' => 'string', 'example' => 'de02b625ba8488f92eb204bcb3773a40c1b4ddac', 'title' => ''], + 'shortId' => ['description' => 'The short commit ID.', 'type' => 'string', 'example' => 'de02b625', 'title' => ''], + 'title' => ['description' => 'The commit title. This is the first line of the commit message.', 'type' => 'string', 'example' => '提交标题', 'title' => ''], + 'message' => ['description' => 'The commit message.', 'type' => 'string', 'example' => '具体的提交内容', 'title' => ''], + 'authorName' => ['description' => 'The name of the author.', 'type' => 'string', 'example' => 'test-codeup', 'title' => ''], + 'authorEmail' => ['description' => 'The email address of the author.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + 'authoredDate' => ['description' => 'The authored date.', 'type' => 'string', 'example' => '2022-03-18 15:00:00', 'title' => ''], + 'committerName' => ['description' => 'The name of the committer.', 'type' => 'string', 'example' => 'committer-codeup', 'title' => ''], + 'committerEmail' => ['description' => 'The email address of the committer.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + 'committedDate' => ['description' => 'The committed date.', 'type' => 'string', 'example' => '2022-03-18 16:00:00', 'title' => ''], + 'parentIds' => [ + 'description' => 'A list of parent commit IDs.', + 'type' => 'array', + 'items' => ['description' => 'The ID of a parent commit.', 'type' => 'string', 'example' => 'ff4fb5ac6d1f44f452654336d2dba468ae6c8d04 ', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'memberType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'USERS', + 'createdAt' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2022-03-18 14:24:54', 'title' => ''], + 'author' => [ + 'description' => 'Information about the author.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The Codeup ID of the author.', 'type' => 'integer', 'format' => 'int64', 'example' => '19927', 'title' => ''], + 'aliyunPk' => ['description' => 'The Alibaba Cloud account ID of the author.', 'type' => 'string', 'example' => '1234567890', 'title' => ''], + 'name' => ['description' => 'The name of the author.', 'type' => 'string', 'example' => 'test-codeup', 'title' => ''], + 'username' => ['description' => 'The username of the author.', 'type' => 'string', 'example' => 'test-codeup', 'title' => ''], + 'email' => ['description' => 'The email address of the author.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + 'state' => ['description' => 'The status of the author. Valid values:'."\n" + ."\n" + .'- `active`: The user is active.'."\n" + ."\n" + .'- `blocked`: The user is blocked or unavailable.', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'avatarUrl' => ['description' => 'The avatar URL of the author.', 'type' => 'string', 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c4ef67f1bea827c4/w/100/h/100', 'title' => ''], + 'websiteUrl' => ['description' => 'The website URL of the author.', 'type' => 'string', 'example' => '""', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'sourceId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2080398', + 'committer' => [ + 'description' => 'Information about the committer.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The Codeup ID of the committer.', 'type' => 'integer', 'format' => 'int64', 'example' => '24661', 'title' => ''], + 'aliyunPk' => ['description' => 'The Alibaba Cloud account ID of the committer.', 'type' => 'string', 'example' => '1234567890', 'title' => ''], + 'name' => ['description' => 'The name of the committer.', 'type' => 'string', 'example' => 'committer-codeup', 'title' => ''], + 'username' => ['description' => 'The username of the committer.', 'type' => 'string', 'example' => 'committer-codeup', 'title' => ''], + 'email' => ['description' => 'The email address of the committer.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + 'state' => ['description' => 'The status of the committer. Valid values:'."\n" + ."\n" + .'- `active`: The user is active.'."\n" + ."\n" + .'- `blocked`: The user is blocked or unavailable.', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'avatarUrl' => ['description' => 'The avatar URL of the committer.', 'type' => 'string', 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', 'title' => ''], + 'websiteUrl' => ['description' => 'The website URL of the committer.', 'type' => 'string', 'example' => '""', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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\\": \\"username@example.com\\",\\n \\"authoredDate\\": \\"2022-03-18 15:00:00\\",\\n \\"committerName\\": \\"committer-codeup\\",\\n \\"committerEmail\\": \\"username@example.com\\",\\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\\": \\"username@example.com\\",\\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\\": \\"username@example.com\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"websiteUrl\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n }\\n}","type":"json"}]', + 'title' => 'Submit changes to multiple files', + 'changeSet' => [], + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCommitWithMultipleFiles'], + ], ], - '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', - ], + 'CreateDeployKey' => [ + 'summary' => 'Creates a new deploy key in a repository.', + 'path' => '/repository/{repositoryId}/keys/create', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + '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' => 'organizationId', + 'in' => 'query', + 'schema' => ['title' => 'A short description of struct', 'description' => 'The ID of the organization. You can find this ID in your Alibaba Cloud DevOps URL, which is formatted as `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'required' => true, 'example' => '60de7a6852743a5162b5f957'], ], [ - 'name' => 'aliyunPk', + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => ['description' => 'The personal access token. This parameter is optional when authorizing with an AccessKey pair or Security Token Service (STS).', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], + ], + [ + 'name' => 'repositoryId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1232456789123467', - ], + 'schema' => ['description' => 'The ID of the repository.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2813489', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', '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, - ], + 'title' => ['description' => 'The title of the deploy key.', 'type' => 'string', 'required' => true, 'example' => '测试密钥', 'title' => ''], + 'key' => ['description' => 'The content of the deploy key.'."\n" + .'><notice>A deploy key cannot be the same as an SSH key. For more information, see https\\://help.aliyun.com/document\\_detail/153709.html.></notice>', 'type' => 'string', 'required' => true, 'example' => '""', 'title' => ''], ], - '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', + 'title' => '', + 'example' => '', ], ], ], @@ -3657,131 +1959,60 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', '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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorCode' => ['description' => 'The error code returned on a failed request.', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'errorMessage' => ['description' => 'The error message returned on a failed request.', 'type' => 'string', 'example' => '”“', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'result' => [ - 'description' => '', + 'description' => 'The data returned for a successful request.', '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' => 'test@alibaba.com', - ], - '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', - ], + 'id' => ['description' => 'The ID of the deploy key.', 'type' => 'integer', 'format' => 'int64', 'example' => '502385', 'title' => ''], + 'title' => ['description' => 'The title of the deploy key.', 'type' => 'string', 'example' => '测试密钥', 'title' => ''], + 'key' => ['description' => 'The content of the deploy key.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'fingerprint' => ['description' => 'The fingerprint of the deploy key.', 'type' => 'string', 'example' => 'xx:xx:xx:xx', 'title' => ''], + 'createdAt' => ['description' => 'The creation time of the deploy key.', 'type' => 'string', 'example' => '2022-03-18 14:24:54', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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\\": \\"test@alibaba.com\\",\\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>test@alibaba.com</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', + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => '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.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + '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"}]', + 'title' => 'Create Deployment Key', + 'changeSet' => [], + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDeployKey'], + ], ], + ], + 'CreateFile' => [ + 'summary' => 'Create a file in the code repository.', + 'path' => '/repository/{repositoryId}/files', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], @@ -3789,68 +2020,37 @@ [ 'name' => 'organizationId', 'in' => 'query', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '632bbfdf419338aaa2b1360a', - ], + 'schema' => ['description' => 'Organization identity, also known as organization ID, in string format. You can obtain it from the Alibaba Cloud DevOps access link, such as https://devops.aliyun.com/organization/【OrganizationId】.', 'type' => 'string', 'required' => true, 'example' => '60de7a6852743a5162b5f957', 'title' => ''], ], [ 'name' => 'accessToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'f0b1e61db5961df5975a93f9129d2513', - ], + 'schema' => ['description' => 'Personal access token. '."\n" + .'This field is not required if you use an Alibaba Cloud AccessKey pair (AK+SK) or temporary authorization through Security Token Service (STS).', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], ], [ - 'name' => 'groupId', + 'name' => 'repositoryId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '22901', - ], - ], - [ - 'name' => 'aliyunPk', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1789095186553536', - ], + 'schema' => ['description' => 'Code repository ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2080972', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Request Body', 'type' => 'object', 'properties' => [ - 'accessLevel' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '30', - ], - 'memberType' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'USERS', - ], + 'filePath' => ['description' => 'File Path', 'type' => 'string', 'required' => true, 'example' => '/src/main/test.java', 'title' => ''], + 'branchName' => ['description' => 'Branch where the file resides', 'type' => 'string', 'required' => true, 'example' => 'master', 'title' => ''], + 'encoding' => ['description' => 'Codec. '."\n" + .'Optional: text or base64. Default value is text.', 'type' => 'string', 'required' => false, 'example' => 'text', 'title' => ''], + 'content' => ['description' => 'File content', 'type' => 'string', 'required' => true, 'example' => '文件内容', 'title' => ''], + 'commitMessage' => ['description' => 'Commit message when creating the file', 'type' => 'string', 'required' => true, 'example' => '创建xxx文件', 'title' => ''], ], 'required' => true, + 'title' => '', + 'example' => '', ], ], ], @@ -3861,1010 +2061,352 @@ '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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => 'F8053E32-9623-511F-8B46-F0E5FD206524'], + 'errorMessage' => ['description' => 'Error message', 'type' => 'string', 'example' => '”“', 'title' => ''], + 'errorCode' => ['description' => 'Error code', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'success' => ['description' => 'Indicates whether the invocation succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'result' => [ - 'description' => '', + 'description' => 'Return Result', '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' => 'username@example.com', - ], - 'accessLevel' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'memberType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'USERS', - ], - 'sourceId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '223241', - ], + 'filePath' => ['description' => 'File Path', 'type' => 'string', 'example' => '/src/main/test.java', 'title' => ''], + 'branchName' => ['description' => 'Branch Name', 'type' => 'string', 'example' => 'master', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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"}]', + 'title' => 'Create File', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateFile'], + ], ], - '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\\": \\"username@example.com\\",\\n \\"accessLevel\\": 30,\\n \\"memberType\\": \\"USERS\\",\\n \\"sourceId\\": 223241\\n }\\n}","type":"json"}]', + 'ramActions' => [], ], - 'ListRepositoryMemberWithInherited' => [ - 'summary' => '查询代码库成员列表', - 'path' => '/repository/{repositoryId}/members/list', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateFlowTag' => [ + 'summary' => 'Create a tag.', + 'path' => '/organization/{organizationId}/flow/tags', + 'methods' => ['post'], + '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' => 'organizationId', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, such as https://devops.aliyun.com/organization/【OrganizationId】.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ - 'name' => 'repositoryId', - 'in' => 'path', - 'schema' => [ - 'title' => '仓库Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '', - 'isFileTransferUrl' => false, - ], + 'name' => 'name', + 'in' => 'query', + 'schema' => ['description' => 'Tag Name, with a maximum length of 20 characters.', 'type' => 'string', 'required' => true, 'example' => '标签名称', 'maxLength' => 20, 'title' => ''], ], [ - 'name' => 'organizationId', + 'name' => 'color', 'in' => 'query', 'schema' => [ - 'title' => '企业Id', - 'description' => '', + 'description' => '- \\#1F9AEF Blue '."\n" + .'- \\#E63A3A Red '."\n" + .'- \\#FA8C15 Yellow '."\n" + .'- \\#15AD31 Green '."\n" + .'- \\#7978E5 Purple '."\n" + .'- \\#8C8C8C Gray', 'type' => 'string', 'required' => true, - 'docRequired' => true, - 'example' => '', + 'example' => '#1F9AEF', + 'enum' => ['#1F9AEF', '#E63A3A', '#FA8C15', '#15AD31', '#7978E5', '#8C8C8C'], + 'title' => '', ], ], + [ + 'name' => 'flowTagGroupId', + 'in' => 'query', + 'schema' => ['description' => 'Tag categorization ID. A value of 0 indicates uncategorized.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '111', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', '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' => '', - ], - ], - ], - ], - ], - ], + 'requestId' => ['title' => '', 'description' => 'Request ID. Each request has a unique value, which facilitates troubleshooting later.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['title' => '', 'description' => 'error message', 'type' => 'string', 'example' => '”“'], + 'success' => ['title' => '', 'description' => 'true if the API call succeeded; false if the API call failed.', 'type' => 'boolean', 'example' => 'true 接口调用成功,false 接口调用失败'], + 'errorCode' => ['title' => '', 'description' => 'error code', 'type' => 'string', 'example' => '”“'], + 'id' => ['description' => 'Tag ID', 'type' => 'integer', 'format' => 'int64', 'example' => '111', 'title' => ''], ], + '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\\": \\"yunxiao-codeup@aliyun.com\\",\\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>yunxiao-test@aliyun.com</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', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidCluster.NotFound', 'errorMessage' => 'No cluster is available to generate the workspace.', 'description' => 'No cluster is available to generate the workspace.'], + ['errorCode' => 'InvalidCodeUrl.NotSupportSVN', 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', 'description' => 'The parameter codeUrl is invalid. SVN is not supported.'], + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidResource.NotFound', 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', 'description' => 'No resource is found. You cannot create the workspace. Please try again later.'], + ['errorCode' => 'InvalidResourceRole.NotFoun', 'errorMessage' => 'The member role is invalid.', 'description' => 'The member role is invalid.'], + ['errorCode' => 'InvalidResourceRole.NotFound', 'errorMessage' => 'The member role is invalid.', 'description' => ''], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => 'The user that is invoking the API service is not a registered user.'], + ['errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', 'errorMessage' => 'Resource owner cannot be deleted.', 'description' => 'The resource owner cannot be deleted.'], + ['errorCode' => 'InvalidUser.ResourceMemberNotExists', 'errorMessage' => 'The resource member does not exist.', 'description' => 'The resource member does not exist.'], + ['errorCode' => 'InvalidUser.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization.', 'description' => 'The user is not in the organization.'], + ], + 403 => [ + ['errorCode' => 'Forbidden.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidIdentifier.NotFound', 'errorMessage' => 'space id is error or not exist.', 'description' => ''], + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], + ['errorCode' => 'InvalidPipeline.NotFound', 'errorMessage' => 'The pipeline is not found.', 'description' => 'The pipeline does not exist.'], + ['errorCode' => 'InvalidPipelineRun.NotFound', 'errorMessage' => 'The pipeline execution instance is not found.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'InvalidWorkspace.NotFound', 'errorMessage' => 'The workspace is not found.', 'description' => '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"}]', + 'title' => 'Create a tag', + 'changeSet' => [ + ['createdAt' => '2021-12-15T03:07:17.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateFlowTag'], + ], ], + ], + 'CreateFlowTagGroup' => [ + 'summary' => 'Create tag categorization.', + 'path' => '/organization/{organizationId}/flow/tagGroups', + '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' => '企业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', - ], + 'schema' => ['title' => '', 'description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, such as https://devops.aliyun.com/organization/【OrganizationId】.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ - 'name' => 'aliyunPk', - 'in' => 'path', - 'schema' => [ - 'title' => '用户阿里云PK', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1232456789123467', - ], + 'name' => 'name', + 'in' => 'query', + 'schema' => ['description' => 'Tag categorization name. It must be unique and contain at most 20 characters.', 'type' => 'string', 'required' => true, 'example' => '标签分类名称', 'maxLength' => 20, 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', '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', - ], - ], - ], + 'requestId' => ['title' => '', 'description' => 'Request ID. Each request has a unique value, which facilitates troubleshooting later.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => '”“'], + 'success' => ['title' => '', 'description' => 'true if the API call succeeded; false if the API call failed.', 'type' => 'boolean', 'example' => 'true 接口调用成功,false 接口调用失败'], + 'errorCode' => ['title' => '', 'description' => 'Error code', 'type' => 'string', 'example' => '”“'], + 'id' => ['title' => '', 'description' => 'Tag categorization ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1223'], ], + 'example' => '', ], ], ], - '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\\": \\"username@example.com\\"\\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', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidCluster.NotFound', 'errorMessage' => 'No cluster is available to generate the workspace.', 'description' => 'No cluster is available to generate the workspace.'], + ['errorCode' => 'InvalidCodeUrl.NotSupportSVN', 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', 'description' => 'The parameter codeUrl is invalid. SVN is not supported.'], + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidResource.NotFound', 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', 'description' => 'No resource is found. You cannot create the workspace. Please try again later.'], + ['errorCode' => 'InvalidResourceRole.NotFoun', 'errorMessage' => 'The member role is invalid.', 'description' => 'The member role is invalid.'], + ['errorCode' => 'InvalidResourceRole.NotFound', 'errorMessage' => 'The member role is invalid.', 'description' => ''], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => 'The user that is invoking the API service is not a registered user.'], + ['errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', 'errorMessage' => 'Resource owner cannot be deleted.', 'description' => 'The resource owner cannot be deleted.'], + ['errorCode' => 'InvalidUser.ResourceMemberNotExists', 'errorMessage' => 'The resource member does not exist.', 'description' => 'The resource member does not exist.'], + ['errorCode' => 'InvalidUser.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization.', 'description' => '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.', 'description' => 'The workspace status is invalid. You can only operate workspaces with the SUCCESS status.'], + ['errorCode' => 'InvalidWorkspaceTemplate.NotFound', 'errorMessage' => 'The parameter workspaceTemplate is not found.', 'description' => 'The parameter workspaceTemplate is not found.'], + ], + 403 => [ + ['errorCode' => 'Forbidden.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], + ['errorCode' => 'InvalidPipeline.NotFound', 'errorMessage' => 'The pipeline is not found.', 'description' => 'The pipeline does not exist.'], + ['errorCode' => 'InvalidPipelineRun.NotFound', 'errorMessage' => 'The pipeline execution instance is not found.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'InvalidWorkspace.NotFound', 'errorMessage' => 'The workspace is not found.', 'description' => '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"}]', + 'title' => 'Create tag categorization', + 'changeSet' => [ + ['createdAt' => '2021-12-15T03:07:17.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateFlowTagGroup'], + ], ], + 'ramActions' => [], + ], + 'CreateHostGroup' => [ + 'summary' => 'You can create a host group.', + 'path' => '/organization/{organizationId}/hostGroups', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'organizationId', - 'in' => 'query', + 'in' => 'path', + 'schema' => ['description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access URL, for example: https://devops.aliyun.com/organization/【OrganizationId】', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx', 'title' => ''], + ], + [ + 'name' => 'type', + 'in' => 'formData', 'schema' => [ - 'title' => 'A short description of struct', - 'description' => '', + 'description' => 'Host group type. Only ECS is supported for now.', 'type' => 'string', 'required' => true, - 'example' => '632bbfdf419338aaa2b1360a', + 'example' => 'ECS', + 'enum' => ['ECS'], + 'title' => '', ], ], [ - 'name' => 'accessToken', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'f0b1e61db5961df5975a93f9129d2513'."\n", - ], + 'name' => 'envId', + 'in' => 'formData', + 'schema' => ['description' => 'Environment ID', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ - 'name' => 'groupId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '22901', - ], + 'name' => 'name', + 'in' => 'formData', + 'schema' => ['description' => 'Host group name', 'type' => 'string', 'required' => true, 'example' => '主机组', 'title' => ''], ], - ], - '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' => 'username@example.com', - ], - 'accessLevel' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'memberType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'USERS', - ], - 'sourceId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '223241', - ], - ], - ], - ], - ], - ], + [ + 'name' => 'serviceConnectionId', + 'in' => 'formData', + 'schema' => ['description' => 'Service connection ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123', 'title' => ''], ], - ], - '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\\": \\"username@example.com\\",\\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' => [], + 'name' => 'tagIds', + 'in' => 'formData', + 'schema' => ['description' => 'Tag IDs, separated by commas if multiple', 'type' => 'string', 'required' => false, 'example' => '12,234', 'title' => ''], ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ [ - 'name' => 'accessToken', - 'in' => 'query', + 'name' => 'ecsType', + 'in' => 'formData', 'schema' => [ - 'description' => '', + 'description' => 'ECS type. Only ECS_ALIYUN is supported for now.', 'type' => 'string', 'required' => false, - 'example' => 'f0b1e61db5961df5975a93f9129d2513', + 'example' => 'ECS_ALIYUN', + 'enum' => ['ECS_ALIYUN'], + 'title' => '', ], ], [ - 'name' => 'sync', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'name' => 'ecsLabelKey', + 'in' => 'formData', + 'schema' => ['description' => 'ECS label key', 'type' => 'string', 'required' => false, 'example' => 'ecs', 'title' => ''], ], [ - 'name' => 'createParentPath', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'name' => 'ecsLabelValue', + 'in' => 'formData', + 'schema' => ['description' => 'ECS label value', 'type' => 'string', 'required' => false, 'example' => 'ecs', 'title' => ''], ], [ - 'name' => 'organizationId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '60de7a6852743a5162b5f957', - ], + 'name' => 'aliyunRegion', + 'in' => 'formData', + 'schema' => ['description' => 'Alibaba Cloud region', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ - '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, - ], + 'name' => 'machineInfos', + 'in' => 'formData', + 'schema' => ['description' => 'aliyunRegionId: the Alibaba Cloud region where the machine is located; machineSn: the serial number of the machine; instanceName: hostname; ip: host IP address', 'type' => 'string', 'required' => false, 'example' => '[{"aliyunRegionId":"cn-beijing","machineSn":"i-sssssss","instanceName":"ceshi","ip":"120.0.0.0"}]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', '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', - ], - ], - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID. Each request has a unique value, which facilitates troubleshooting later.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['description' => 'error message', 'type' => 'string', 'example' => '""', 'title' => ''], + 'errorCode' => ['description' => 'error code', 'type' => 'string', 'example' => '""', 'title' => ''], + 'success' => ['description' => 'true indicates the invocation succeeded; false indicates the invocation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'hostGroupId' => ['description' => 'Host group ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], ], + 'example' => '', ], ], ], - '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', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => '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.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"hostGroupId\\": 123\\n}","type":"json"}]', + 'title' => 'Create a host group', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateHostGroup'], + ], ], + 'ramActions' => [], + ], + 'CreateMergeRequest' => [ + 'summary' => 'Create a merge request.', + 'path' => '/api/v4/projects/{repositoryId}/merge_requests', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], @@ -4872,50 +2414,46 @@ [ 'name' => 'organizationId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '6082a9b0c7972588ac363793', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The organization ID. You can find this ID in the URL for your Alibaba Cloud DevOps organization, for example, `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'required' => true, 'example' => '6270e731cfea268afc21ccac'], ], [ 'name' => 'accessToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'f0b1e61db5961df5975a93f9129d2513', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The personal access token. This parameter is not required if you authenticate by using an Alibaba Cloud AccessKey pair or Security Token Service (STS).', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513'], ], [ 'name' => 'repositoryId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '2464454', - ], + 'schema' => ['description' => 'The repository ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2369234', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'reason' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, + 'sourceProjectId' => ['description' => 'The ID of the source repository.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2369234', 'title' => ''], + 'sourceBranch' => ['description' => 'The name of the source branch.', 'type' => 'string', 'required' => true, 'example' => 'sourceBranch', 'title' => ''], + 'targetProjectId' => ['description' => 'The ID of the target repository.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2369234', 'title' => ''], + 'targetBranch' => ['description' => 'The name of the target branch.', 'type' => 'string', 'required' => true, 'example' => 'targetBranch', 'title' => ''], + 'title' => ['description' => 'The title of the merge request.', 'type' => 'string', 'required' => true, 'example' => '测试合并请求的标题', 'title' => ''], + 'createFrom' => ['description' => 'The source of the request. The value must be `WEB`.', 'type' => 'string', 'required' => true, 'example' => 'WEB', 'title' => ''], + 'description' => ['description' => 'The description of the merge request.', 'type' => 'string', 'required' => false, 'example' => '测试合并请求', 'title' => ''], + 'reviewerIds' => [ + 'description' => 'The Alibaba Cloud account IDs of the reviewers.', + 'type' => 'array', + 'items' => ['description' => 'The Alibaba Cloud account ID.', 'type' => 'string', 'required' => false, 'example' => '1234567890', 'title' => ''], + 'required' => false, + 'title' => '', 'example' => '', ], + 'workItemIds' => ['description' => 'A comma-separated string of work item IDs to associate with the merge request.', 'type' => 'string', 'required' => false, 'example' => '722200214032b6b31e6f1434ab', 'title' => ''], ], 'required' => true, + 'title' => '', + 'example' => '', ], ], ], @@ -4923,1493 +2461,566 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response schema.', '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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9'], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'result' => [ - 'description' => '', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'mrBizId' => ['description' => 'The unique business ID of the merge request.', 'type' => 'string', 'example' => 'bca90244c4b749e0b109df52ac0eb570', 'title' => ''], + 'projectId' => ['description' => 'The ID of the repository.', 'type' => 'integer', 'format' => 'int64', 'example' => '2369234', 'title' => ''], + 'localId' => ['description' => 'The local ID of the merge request. This ID is unique within the repository.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'createTime' => ['description' => 'The time the merge request was created.', 'type' => 'string', 'example' => '2023-06-02T03:41:22Z', 'title' => ''], + 'updateTime' => ['description' => 'The time the merge request was last updated.', 'type' => 'string', 'example' => '2023-06-02T03:41:22Z', 'title' => ''], + 'mrType' => ['description' => 'The type of the merge request. The value is always `CODE_REVIEW`.', 'type' => 'string', 'example' => 'CODE_REVIEW', 'title' => ''], + 'sourceProjectId' => ['description' => 'The ID of the repository that contains the source branch.', 'type' => 'integer', 'format' => 'int64', 'example' => '2369234', 'title' => ''], + 'sourceBranch' => ['description' => 'The name of the source branch.', 'type' => 'string', 'example' => 'sourceBranch', 'title' => ''], + 'targetProjectId' => ['description' => 'The ID of the repository that contains the target branch.', 'type' => 'integer', 'format' => 'int64', 'example' => '2369234', 'title' => ''], + 'targetBranch' => ['description' => 'The name of the target branch.', 'type' => 'string', 'example' => 'targetBranch', 'title' => ''], + 'title' => ['description' => 'The title of the merge request.', 'type' => 'string', 'example' => '测试合并请求的标题', 'title' => ''], + 'description' => ['description' => 'The description of the merge request.', 'type' => 'string', 'example' => '测试合并请求', 'title' => ''], + 'reviewers' => [ + 'description' => 'A list of reviewers.', + 'type' => 'array', + 'items' => [ + 'description' => 'Information about a reviewer.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The Codeup user ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '7905', 'title' => ''], + 'name' => ['description' => 'The name of the user.', 'type' => 'string', 'example' => 'codeup', 'title' => ''], + 'username' => ['description' => 'The enterprise username.', 'type' => 'string', 'example' => 'root-codeup', 'title' => ''], + 'state' => ['description' => 'The state of the user. Valid values:'."\n" + ."\n" + .'- `active`: The user is active.'."\n" + ."\n" + .'- `blocked`: The user is blocked or inactive.', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'avatarUrl' => ['description' => 'The URL of the reviewer\'s avatar.', 'type' => 'string', 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', 'title' => ''], + 'email' => ['description' => 'The email address of the user.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + 'hasReviewed' => ['description' => 'Indicates whether the reviewer has completed their review.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'reviewOpinionStatus' => ['description' => 'The review status. Valid values:'."\n" + ."\n" + .'- `PASS`: Approved.'."\n" + ."\n" + .'- `NOT_PASS`: Changes requested.', 'type' => 'string', 'example' => 'PASS', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'author' => [ + 'description' => 'Information about the author.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The Codeup user ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '19230', 'title' => ''], + 'name' => ['description' => 'The name of the user.', 'type' => 'string', 'example' => 'test-codeup', 'title' => ''], + 'username' => ['description' => 'The login name of the user.', 'type' => 'string', 'example' => 'test-codeup-nickname', 'title' => ''], + 'state' => ['description' => 'The state of the user. Valid values:'."\n" + ."\n" + .'- `active`: The user is active.'."\n" + ."\n" + .'- `blocked`: The user is blocked or inactive.', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'avatarUrl' => ['description' => 'The URL of the author\'s avatar.', 'type' => 'string', 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', 'title' => ''], + 'email' => ['description' => 'The email address of the author.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'subscribers' => [ + 'description' => 'A list of subscribers.', + 'type' => 'array', + 'items' => [ + 'description' => 'Information about a subscriber.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The Codeup user ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10092', 'title' => ''], + 'name' => ['description' => 'The name of the user.', 'type' => 'string', 'example' => 'test-codeup', 'title' => ''], + 'username' => ['description' => 'The login name of the user.', 'type' => 'string', 'example' => 'root-test-codeup', 'title' => ''], + 'state' => ['description' => 'The state of the user. Valid values:'."\n" + ."\n" + .'- `active`: The user is active.'."\n" + ."\n" + .'- `blocked`: The user is blocked or inactive.', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'avatarUrl' => ['description' => 'The URL of the subscriber\'s avatar.', 'type' => 'string', 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', 'title' => ''], + 'email' => ['description' => 'The email address of the subscriber.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'status' => ['description' => 'The status of the merge request. Valid values:'."\n" + ."\n" + .'- `UNDER_DEV`: In development.'."\n" + ."\n" + .'- `UNDER_REVIEW`: Under review.'."\n" + ."\n" + .'- `TO_BE_MERGED`: Ready to merge.'."\n" + ."\n" + .'- `CLOSED`: Closed.'."\n" + ."\n" + .'- `MERGED`: Merged.', 'type' => 'string', 'example' => 'UNDER_REVIEW', 'title' => ''], + 'createFrom' => ['description' => 'The creation source of the merge request. The value is `WEB`.', 'type' => 'string', 'example' => 'WEB', 'title' => ''], + 'ahead' => ['description' => 'The number of commits the source branch is ahead of the target branch.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'behind' => ['description' => 'The number of commits the source branch is behind the target branch.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'detailUrl' => ['description' => 'The URL of the merge request details page.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'webUrl' => ['description' => 'The web URL of the merge request.', 'type' => 'string', 'example' => 'https://codeup.aliyun.com/xxx/test/test'."\n", 'title' => ''], + 'allRequirementsPass' => ['description' => 'Indicates whether all requirements are met.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'supportMergeFastForwardOnly' => ['description' => 'Indicates whether a fast-forward-only merge is supported.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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\\": \\"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\\": \\"username@example.com\\",\\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\\": \\"username@example.com\\"\\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\\": \\"username@example.com\\"\\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"}]', + 'title' => 'Create a merge request ', + 'description' => 'Before calling this API, check the merge request page to ensure your organization is using the new merge request (MR) experience.', + 'changeSet' => [], + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMergeRequest'], ], ], - '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', - ], + 'CreateOAuthToken' => [ + 'summary' => 'Create an OAuthToken (This API is in internal testing and is not supported for use yet).', + 'path' => '/login/oauth/create', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + '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' => '', + 'description' => 'Request structure.', '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', - ], + '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' => '', 'description' => 'Authorization type: code, token', 'type' => 'string', 'required' => true, 'example' => 'code'], + 'scope' => ['title' => '', 'description' => 'Authorization scope'."\n" + ."\n" + .'Examples:'."\n" + .'- User-related: read:user'."\n" + .'- Repository-related: read:repo, write:repo'."\n" + .'- Repository merge request-related: repo:cr, read:repo:cr, write:repo:cr'."\n" + .'- Repository branch-related: repo:branch, read:repo:branch, write:repo:branch'."\n" + ."\n" + .'><notice>You can view more authorization scopes at '."\n" + .'https://account-devops.aliyun.com/settings/personalAccessToken></notice>', 'type' => 'string', 'required' => true, 'example' => 'read:repo'], + 'code' => ['title' => '', 'description' => 'Authorization code. Required when grantType=code.', 'type' => 'string', 'required' => false, 'example' => '86df532f74454e189740d100ac97f4b9'], + 'login' => ['title' => '', 'description' => 'The User\'s logon Account. Required when grant type is token.', 'type' => 'string', 'required' => false, 'example' => 'username'], ], 'required' => false, + 'title' => '', + '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' => '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', - ], + 'errorMessage' => ['title' => 'Id of the request', 'description' => 'Error message', 'type' => 'string', 'example' => '”“'], + 'requestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'C2F153F6-BB43-50C4-9F4F-40593203E19A', 'title' => ''], + 'errorCode' => ['description' => 'Error code', 'type' => 'string', 'example' => 'Openapi.RequestError', 'title' => ''], + 'success' => ['description' => 'true if the API call succeeded, false if the API call failed', 'type' => 'string', 'example' => 'true', 'title' => ''], 'result' => [ - 'description' => '', + 'description' => 'Return Result', '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' => 'git@codeup.aliyun.com: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', - ], + 'accessToken' => ['description' => 'Access token', 'type' => 'string', 'example' => '2aeb4cd012af879e54f0d37dfa526f51', 'title' => ''], + 'scope' => ['description' => 'Authorization scope', 'type' => 'string', 'example' => 'read:repo', 'title' => ''], + 'tokenType' => ['description' => 'Token type, static field: bearer', 'type' => 'string', 'example' => 'bearer', 'title' => ''], + 'id' => ['description' => 'id', 'type' => 'string', 'example' => '30815', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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 \\"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}","type":"json"}]', + 'title' => 'Create OAuthToken', + 'changeSet' => [], + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateOAuthToken'], ], ], - '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\\": \\"git@codeup.aliyun.com: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', - ], + 'CreatePipeline' => [ + 'summary' => 'Creates a pipeline based on a YAML definition.', + 'path' => '/organization/{organizationId}/pipelines', + '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', - ], + 'schema' => ['description' => 'The ID of the organization. You can find this ID in the organization URL in Alibaba Cloud DevOps, for example: `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx', 'title' => ''], ], [ - 'name' => 'account', - 'in' => 'query', - 'schema' => [ - 'title' => '远程同步库克隆账号', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test-account', - ], + 'name' => 'name', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the pipeline.', 'type' => 'string', 'required' => true, 'example' => '示例流水线', 'title' => ''], ], [ - 'name' => 'token', - 'in' => 'query', - 'schema' => [ - 'title' => '远程同步库克隆令牌', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'asd12e44827fe2444f952e931e51xxxx', - ], + 'name' => 'content', + 'in' => 'formData', + 'schema' => ['description' => 'The pipeline definition in YAML format. For syntax details, see https\\://help.aliyun.com/document\\_detail/2249317.html.', 'type' => 'string', 'required' => true, 'example' => 'sources: # sources 配置流水线源节点'."\n" + .' my_repo: # 流水线源唯一标识 id'."\n" + .' type: codeup # 流水线源类型'."\n" + .' name: 代码源名称 # 代码源的展示名称 '."\n" + .' endpoint: <your-codeup-repository-url> # 代码源的 url'."\n" + .' branch: master # 代码源的默认分支'."\n" + .' triggerEvents: push # 代码源监听事件'."\n" + .' certificate: # certificate 认证信息'."\n" + .' type: serviceConnection # 认证类型为服务连接'."\n" + .' serviceConnection: <your-service-connection-id> # 服务连接 id'."\n" + .'stages: # stages 配置流水线阶段'."\n" + .' build_stage: # 流水线阶段标识 id'."\n" + .' name: 构建阶段 # 流水线阶段的展示名称'."\n" + .' jobs: # jobs 配置流水线任务'."\n" + .' build_job: # 流水线任务标识 id'."\n" + .' name: 构建任务 # 流水线任务的展示名称'."\n" + .' runsOn: public/cn-beijing # 流水线任务运行的集群环境'."\n" + .' steps: # steps 配置流水线步骤'."\n" + .' build_step: # 流水线步骤标识 id'."\n" + .' step: JavaBuild # 选择执行步骤'."\n" + .' name: java构建 # 流水线执行步骤的展示名称'."\n" + .' with: # 步骤的参数'."\n" + .' run: |'."\n" + .' mvn -B clean package -Dmaven.test.skip=true -Dautoconfig.skip'."\n" + .' upload_step:'."\n" + .' step: ArtifactUpload'."\n" + .' name: 构建物上传'."\n" + .' with:'."\n" + .' uploadType: flowPublic'."\n" + .' artifact: default'."\n" + .' filePath:'."\n" + .' - target/'."\n" + .' - deploy.sh'."\n" + .' deploy_stage:'."\n" + .' name: 部署阶段'."\n" + .' jobs:'."\n" + .' deploy_job:'."\n" + .' name: 主机组部署任务'."\n" + .' component: VMDeploy # 选择执行组件'."\n" + .' with: # 执行组件的参数'."\n" + .' artifact: $[stages.build_stage.build_job.upload_step.artifacts.default]'."\n" + .' machineGroup: <your-machine-group-id>'."\n" + .' artifactDownloadPath: /home/admin/app/package.tgz'."\n" + .' executeUser: root'."\n" + .' run: |'."\n" + .' mkdir -p /home/admin/application/'."\n" + .' tar zxvf /home/admin/app/package.tgz -C /home/admin/application/'."\n" + .' sh /home/admin/application/deploy.sh restart', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response 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', - ], - ], - ], + 'success' => ['description' => '`true` if the request was successful; `false` otherwise.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'errorCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'pipelinId' => ['description' => 'The ID of the pipeline.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '11XXX'], + 'requestId' => ['description' => 'A unique identifier for the request, used for troubleshooting.', 'type' => 'string', 'title' => '', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'."\n"], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Openapi.RequestError', - 'errorMessage' => 'request error', - ], + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => 'The user that is invoking the API service is not a registered user.'], ], 403 => [ - [ - 'errorCode' => 'Operate.NoPermission', - 'errorMessage' => 'NoPermission', - ], + ['errorCode' => 'Forbidden.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], ], [ - [ - 'errorCode' => 'InvalidWorkspace.NotFound', - 'errorMessage' => 'The workspace is not found.', - ], + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], + ['errorCode' => 'InvalidPipeline.NotFound', 'errorMessage' => 'The pipeline is not found.', 'description' => 'The pipeline does not exist.'], + ['errorCode' => 'InvalidPipelineRun.NotFound', 'errorMessage' => 'The pipeline execution instance is not found.', 'description' => 'The pipeline execution instance 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', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"success\\": true,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"pipelinId\\": 0,\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\\\n\\"\\n}","type":"json"}]', + 'title' => 'Create Pipeline ', + 'changeSet' => [], + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePipeline'], + ], ], + ], + 'CreatePipelineGroup' => [ + 'summary' => 'Create a pipeline group.', + 'path' => '/organization/{organizationId}/pipelineGroups', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => [], + 'produces' => [], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + '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' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'f0b1e61db5961df5975a93f9129d2513', - ], - ], - [ - 'name' => 'repositoryId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], + 'in' => 'path', + 'schema' => ['description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, such as https://devops.aliyun.com/organization/【OrganizationId】', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx', 'title' => ''], ], [ - 'name' => 'groupId', + 'name' => 'name', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], + 'schema' => ['description' => 'Pipeline group name, unique within the organization', 'type' => 'string', 'required' => true, 'example' => '流水线分组名称', 'maxLength' => 40, 'title' => ''], ], ], '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', - ], - 'errorCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Openapi.RequestError', - ], - 'errorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => '”“', - ], - 'success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'result' => [ - 'description' => '', + 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID. Each request has a unique value, which facilitates troubleshooting later.'."\n" + ."\n", 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['description' => 'error message', 'type' => 'string', 'example' => '""', 'title' => ''], + 'success' => ['description' => 'true indicates that the API call succeeded; false indicates that the API call failed.'."\n" + ."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'errorCode' => ['description' => 'error code', 'type' => 'string', 'example' => '""', 'title' => ''], + 'pipelineGroup' => [ + 'description' => 'Pipeline group', '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', - ], + 'id' => ['description' => 'Pipeline group ID', 'type' => 'integer', 'format' => 'int64', 'example' => '111', 'title' => ''], + 'name' => ['description' => 'Pipeline group name', 'type' => 'string', 'example' => '流水线分组名称', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], - ], - ], - ], - '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', - ], + ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], ], [ - 'name' => 'archived', - 'in' => 'query', - 'schema' => [ - 'title' => '是否列出归档项目', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'minAccessLevel', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], + ['errorCode' => 'InvalidUser.UserNotInCurrentOrganization', 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', 'description' => ''], ], ], - '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' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"pipelineGroup\\": {\\n \\"id\\": 111,\\n \\"name\\": \\"流水线分组名称\\"\\n }\\n}","type":"json"}]', + 'title' => 'Create a pipeline group', + 'changeSet' => [], + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePipelineGroup'], ], ], - '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', - ], + 'CreateProject' => [ + 'summary' => 'You can create a project.', + 'path' => '/organization/{organizationId}/projects/createProject', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => [], + 'produces' => [], + 'operationType' => 'write', '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', - ], + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'Organization identifier, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access URL, for example: https://devops.aliyun.com/organization/【OrganizationId】 ', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ - 'name' => 'identity', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '代码库ID或路径', - 'description' => '', - 'type' => 'string', + 'description' => 'Request body ', + 'type' => 'object', + 'properties' => [ + 'templateIdentifier' => ['description' => 'Project template ID, which can be obtained from the frontend project template list page. Frontend API: https://devops.aliyun.com/projex/api/workspace/template/setting/corp/listSpaceTemplatesForCreate?category=Project&_input_charset=utf-8. Example value: identifier: "704eaxxxx5efede61xxx5" ', 'type' => 'string', 'required' => true, 'example' => '704eaxxxx5efede61xxx5', 'title' => ''], + 'name' => ['description' => 'Project name ', 'type' => 'string', 'required' => true, 'example' => 'name', 'title' => ''], + 'scope' => ['description' => 'Public: public '."\n" + .'Private: private ', 'type' => 'string', 'required' => true, 'example' => 'public', 'title' => ''], + 'customCode' => ['description' => 'Project code, consisting of four to six uppercase letters, unique within the organization ', 'type' => 'string', 'required' => true, 'example' => 'ABCD', 'title' => ''], + ], 'required' => true, - 'example' => '100', + 'title' => '', + 'example' => '', ], ], ], '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' => '', + 'requestId' => ['title' => '', 'description' => 'Request ID. Each request has a unique value to facilitate troubleshooting.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMsg' => ['title' => '', 'description' => 'Error message ', 'type' => 'string', 'example' => 'error'], + 'errorCode' => ['title' => '', 'description' => 'error code', 'type' => 'string', 'example' => 'Openapi.RequestError'], + 'success' => ['title' => '', 'description' => 'true or false', 'type' => 'boolean', 'example' => 'true'], + 'project' => [ + 'title' => '', + 'description' => 'project information', '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' => 'git@codeup.aliyun.com: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', - ], + 'categoryIdentifier' => ['title' => '', 'description' => 'Category ID, which is Project here ', 'type' => 'string', 'example' => 'Project'], + 'creator' => ['title' => '', 'description' => 'Alibaba Cloud account ID of the Creator', 'type' => 'string', 'example' => '19xx7043xxxxxxx914'], + 'customCode' => ['title' => '', 'description' => 'Project code consisting of four to six uppercase letters, unique within the enterprise ', 'type' => 'string', 'example' => 'OJAY'], + 'description' => ['title' => '', 'description' => 'Description ', 'type' => 'string', 'example' => '该项目用来跟进测试需求。'], + 'gmtCreate' => ['title' => '', 'description' => 'UNIX timestamp of the creation time, in milliseconds ', 'type' => 'integer', 'format' => 'int64', 'example' => '1623916393000'], + 'gmtModified' => ['title' => '', 'description' => 'UNIX timestamp of the Updated At time, in milliseconds', 'type' => 'integer', 'format' => 'int64', 'example' => '1623916393000'], + 'icon' => ['title' => '', 'description' => 'icon ', 'type' => 'string', 'example' => 'https://xxxxxx.png'], + 'identifier' => ['title' => '', 'description' => 'Unique Identifier of the project', 'type' => 'string', 'example' => 'e8bxxxxxxxxxxxxxxxx23'], + 'logicalStatus' => ['title' => '', 'description' => 'Project status ', 'type' => 'string', 'example' => 'NORMAL'], + 'modifier' => ['title' => '', 'description' => 'Alibaba Cloud account ID of the Updated By user', 'type' => 'string', 'example' => '19xx7043xxxxxxx914'], + 'name' => ['title' => '', 'description' => 'Project name', 'type' => 'string', 'example' => 'demo示例项目'], + 'organizationIdentifier' => ['title' => '', 'description' => 'Enterprise ID ', 'type' => 'string', 'example' => '5e70xxxxxxcd000xxxxe96'], + 'scope' => ['title' => '', 'description' => 'Visible To ', 'type' => 'string', 'example' => 'public'], + 'statusIdentifier' => ['title' => '', 'description' => 'Status ID ', 'type' => 'string', 'example' => '8a40xxxxxxxxxxxxx64'], + 'statusStageIdentifier' => ['title' => '', 'description' => 'status stage', 'type' => 'string', 'example' => '1'], + 'typeIdentifier' => ['title' => '', 'description' => 'Space category ID ', 'type' => 'string', 'example' => 'CustomProject'], ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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\\": \\"git@codeup.aliyun.com: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>git@codeup.aliyun.com: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', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Openapi.RequestError', 'errorMessage' => 'request error', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'Operate.NoPermission', 'errorMessage' => 'NoPermission', 'description' => 'You are not authorized to perform this operation.'], + ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Create Project ', + 'changeSet' => [ + ['createdAt' => '2022-01-06T13:27:07.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateProject'], + ], ], + 'ramActions' => [], + ], + 'CreateProjectLabel' => [ + 'summary' => 'Creates a label for a repository.', + 'path' => '/api/v4/projects/labels', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'query', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '60de7a6852743a5162b5f957', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The organization ID. You can find this ID in the URL of your Alibaba Cloud DevOps page, for example: https\\://devops.aliyun.com/organization/{organizationId}.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ 'name' => 'accessToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '0cf2c8458ac44d9481aab2dd6ec10596v3'."\n", - ], + 'schema' => ['description' => 'The personal access token. This parameter is not required if you use an Alibaba Cloud AK/SK or STS temporary authorization for authentication.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], ], [ - 'name' => 'repositoryId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2334815', - ], + 'name' => 'repositoryIdentity', + 'in' => 'query', + 'schema' => ['description' => 'The repository ID or full path.', 'type' => 'string', 'required' => true, 'example' => '2835387 或 codeup/codeup-demo'."\n", 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'branchName' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'createBranch', - ], - 'ref' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'master', - ], + 'name' => ['description' => 'The name of the label.', 'type' => 'string', 'required' => true, 'example' => '新特性', 'title' => ''], + 'color' => ['description' => 'The color of the label in hexadecimal format.', 'type' => 'string', 'required' => true, 'example' => '#006AD4', 'title' => ''], + 'description' => ['description' => 'The description of the label.', 'type' => 'string', 'required' => false, 'example' => '新的特性或需求', 'title' => ''], ], - 'required' => true, + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -6417,155 +3028,53 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', '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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The unique request ID. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => 'A7586FEB-E48D-5579-983F-74981FBFF627'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'errorCode' => ['description' => 'The error code for a failed request.', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'errorMessage' => ['description' => 'The error message for a failed request.', 'type' => 'string', 'example' => '""', 'title' => ''], 'result' => [ - 'description' => '', + 'description' => 'Details of the created label.', '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' => 'username@example.com', - ], - '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' => 'username@example.com', - ], - 'committerName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'parentIds' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '34d2c47c7ce46a5c4639c5ffe208a66dda975a05', - ], - ], - ], - ], + 'id' => ['description' => 'The unique ID of the label.', 'type' => 'string', 'example' => 'b5b5738b94954bc6aa5a293316ed1d24', 'title' => ''], + 'name' => ['description' => 'The name of the label.', 'type' => 'string', 'example' => '新特性', 'title' => ''], + 'color' => ['description' => 'The color of the label in hexadecimal format.', 'type' => 'string', 'example' => '#006AD4', 'title' => ''], + 'description' => ['description' => 'The description of the label.', 'type' => 'string', 'example' => '新的特性或需求'."\n", 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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\\": \\"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"}]', + 'title' => 'Create Category', + 'changeSet' => [], + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateProjectLabel'], ], ], - '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\\": \\"username@example.com\\",\\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\\": \\"username@example.com\\",\\n \\"committerName\\": \\"阿里云云效committer\\",\\n \\"parentIds\\": [\\n \\"34d2c47c7ce46a5c4639c5ffe208a66dda975a05\\"\\n ]\\n }\\n }\\n}","type":"json"}]', ], 'CreateProtectdBranch' => [ - 'summary' => '创建保护分支', + 'summary' => 'Create a protected branch.', 'path' => '/repository/{repositoryId}/protect_branches', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], @@ -6573,290 +3082,178 @@ [ 'name' => 'organizationId', 'in' => 'query', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '60de7a6852743a5162b5f957', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The unique ID of the organization. You can find this ID in your browser\'s URL after logging in to the Alibaba Cloud DevOps platform: https\\://devops.aliyun.com/organization/{organizationId}.', 'type' => 'string', 'required' => true, 'example' => '60de7a6852743a5162b5f957'], ], [ 'name' => 'accessToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'f0b1e61db5961df5975a93f9129d2513', - ], + 'schema' => ['description' => 'The personal access token. This parameter is not required if you use an Alibaba Cloud AccessKey pair or a Security Token Service (STS) temporary credential for authentication.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], ], [ 'name' => 'repositoryId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '2813891', - ], + 'schema' => ['description' => 'The ID of the repository.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2813891', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '--', - ], - 'branch' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'protectBranch', - ], + 'id' => ['description' => 'The ID of the protected branch rule.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '--', 'title' => ''], + 'branch' => ['description' => 'The name of the protected branch.', 'type' => 'string', 'required' => true, 'example' => 'protectBranch', 'title' => ''], 'allowPushRoles' => [ - 'description' => '', + 'description' => 'The IDs of roles allowed to push code.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '[40, 30]', - ], + 'items' => ['description' => '40: administrator<br>'."\n" + .'30: developer<br>', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '[40, 30]', 'title' => ''], 'required' => false, + 'title' => '', + 'example' => '', ], 'allowPushUserIds' => [ - 'description' => '', + 'description' => 'The IDs of users allowed to push code.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'items' => ['description' => 'An Alibaba Cloud account ID.', 'type' => 'string', 'required' => false, 'example' => '2344667212345561', 'title' => ''], 'required' => false, + 'title' => '', + 'example' => '', ], 'allowMergeRoles' => [ - 'description' => '', + 'description' => 'The IDs of roles allowed to merge code.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '[40, 30]', - ], + 'items' => ['description' => '40: administrator<br>'."\n" + .'30: developer<br>', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '[40, 30]', 'title' => ''], 'required' => true, + 'title' => '', + 'example' => '', ], 'allowMergeUserIds' => [ - 'description' => '', + 'description' => 'The IDs of users allowed to merge code.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'items' => ['description' => 'An Alibaba Cloud account ID.', 'type' => 'string', 'required' => false, 'example' => '123345678912345', 'title' => ''], 'required' => false, + 'title' => '', + 'example' => '', ], 'mergeRequestSetting' => [ - 'description' => '', + 'description' => 'The settings for code reviews before a merge.', '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', - ], + 'isRequired' => ['description' => 'Indicates whether to enable code review.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'mrMode' => ['description' => 'The review mode.'."\n" + ."\n" + .'- `general`: standard mode.'."\n" + ."\n" + .'- `codeowner`: Code Owner mode.', 'type' => 'string', 'required' => false, 'example' => 'general', 'title' => ''], + 'isAllowSelfApproval' => ['description' => 'Indicates whether the creator of a merge request can approve their own request.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'isRequireDiscussionProcessed' => ['description' => 'Indicates whether all comments must be resolved.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'isResetApprovalWhenNewPush' => ['description' => 'Indicates whether to reset the review status when a new commit is submitted.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'minimumApproval' => ['description' => 'The minimum number of reviewers who must approve the merge request.'."\n" + ."\n" + .'> This parameter is valid only in the standard mode.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], 'allowMergeRequestRoles' => [ - 'description' => '', + 'description' => 'The IDs of roles allowed to merge code.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '[40, 30]', - ], + 'items' => ['description' => '40: administrator (default)<br>'."\n" + .'30: developer<br>', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '[40, 30]', 'title' => ''], 'required' => false, + 'title' => '', + 'example' => '', ], 'defaultAssignees' => [ - 'description' => '', + 'description' => 'The default reviewers.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1234567891234567', - ], + 'items' => ['description' => 'An Alibaba Cloud account ID.', 'type' => 'string', 'required' => false, 'example' => '1234567891234567', 'title' => ''], 'required' => false, + 'title' => '', + 'example' => '', ], - 'whiteList' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '**.java', - ], + 'whiteList' => ['description' => 'File review whitelist'."\n" + .'><notice>Files on the whitelist are exempt from the "minimum approval count" limit and do not require a mandatory manual review.></notice>', 'type' => 'string', 'required' => false, 'example' => '**.java', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'testSettingDTO' => [ - 'description' => '', + 'description' => 'The settings for automated status checks before a merge.', 'type' => 'object', 'properties' => [ - 'isRequired' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'isRequired' => ['description' => 'Indicates whether to enable automated status checks.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], 'codeGuidelinesDetection' => [ - 'description' => '', + 'description' => 'The settings for code guideline scanning.', 'type' => 'object', 'properties' => [ - 'enabled' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test_code_guide_lines', - ], + 'enabled' => ['description' => 'Indicates whether to enable code guideline scanning.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'message' => ['description' => 'The description.', 'type' => 'string', 'required' => false, 'example' => 'test_code_guide_lines', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'sensitiveInfoDetection' => [ - 'description' => '', + 'description' => 'The settings for sensitive information detection.', 'type' => 'object', 'properties' => [ - 'enabled' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test_code_sensitive_info', - ], + 'enabled' => ['description' => 'Indicates whether to enable sensitive information detection.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'message' => ['description' => 'The description.', 'type' => 'string', 'required' => false, 'example' => 'test_code_sensitive_info', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'checkTaskQualityConfig' => [ - 'description' => '', + 'description' => 'The settings for code quality checks.', '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', - ], + 'enabled' => ['description' => 'Indicates whether to enable code quality checks.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'bizNo' => ['description' => 'The ID of the task.', 'type' => 'string', 'required' => false, 'example' => '123456', 'title' => ''], + 'taskName' => ['description' => 'The name of the task.', 'type' => 'string', 'required' => false, 'example' => 'bz-task-quality', 'title' => ''], + 'message' => ['description' => 'The information about the task.', 'type' => 'string', 'required' => false, 'example' => 'test_task_quality', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'checkConfig' => [ - 'description' => '', + 'description' => 'The settings for the merge request check pipeline.', 'type' => 'object', 'properties' => [ 'checkItems' => [ - 'description' => '', + 'description' => 'The configuration items.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'A configuration item.', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'isRequired' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'name' => ['description' => 'The name of the pipeline.', 'type' => 'string', 'required' => false, 'example' => '测试流水线', 'title' => ''], + 'isRequired' => ['description' => 'Indicates whether the check is required.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], 'required' => true, + 'title' => '', + 'example' => '', ], ], ], @@ -6864,452 +3261,274 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response schema.', '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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'C2F153F6-BB43-50C4-9F4F-40593203E19A'], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Openapi.RequestError', 'title' => ''], + 'success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'result' => [ - 'description' => '', + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5240', - ], - 'branch' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'protectBranch', - ], + 'id' => ['description' => 'The ID of the protected branch rule.', 'type' => 'integer', 'format' => 'int64', 'example' => '5240', 'title' => ''], + 'branch' => ['description' => 'The name of the protected branch.', 'type' => 'string', 'example' => 'protectBranch', 'title' => ''], 'allowPushRoles' => [ - 'description' => '', + 'description' => 'A list of role IDs allowed to push to the branch.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '40', - ], + 'items' => ['description' => '40: Maintainer<br>'."\n" + .'30: Developer<br>', 'type' => 'integer', 'format' => 'int32', 'example' => '40', 'title' => ''], + 'title' => '', + 'example' => '', ], 'allowPushUserIds' => [ - 'description' => '', + 'description' => 'A list of user IDs allowed to push to the branch.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '19238', - ], + 'items' => ['description' => 'The user ID in Codeup.', 'type' => 'integer', 'format' => 'int64', 'example' => '19238', 'title' => ''], + 'title' => '', + 'example' => '', ], 'allowMergeRoles' => [ - 'description' => '', + 'description' => 'A list of role IDs allowed to merge into the branch.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '40', - ], + 'items' => ['description' => '40: Maintainer<br>'."\n" + .'30: Developer<br>', 'type' => 'integer', 'format' => 'int32', 'example' => '40', 'title' => ''], + 'title' => '', + 'example' => '', ], 'allowMergeUserIds' => [ - 'description' => '', + 'description' => 'A list of user IDs allowed to merge into the branch.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '19238', - ], + 'items' => ['description' => 'The user ID in Codeup.', 'type' => 'integer', 'format' => 'int64', 'example' => '19238', 'title' => ''], + 'title' => '', + 'example' => '', ], 'mergeRequestSetting' => [ - 'description' => '', + 'description' => 'The settings for code review before merging.', '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', - ], + 'isRequired' => ['description' => 'Indicates whether a code review is required.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'mrMode' => ['description' => 'The review mode.'."\n" + ."\n" + .'- `general`: General mode.'."\n" + ."\n" + .'- `codeowner`: CodeOwner mode.', 'type' => 'string', 'example' => 'general', 'title' => ''], + 'isAllowSelfApproval' => ['description' => 'Indicates whether users can approve their own merge requests.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'isRequireDiscussionProcessed' => ['description' => 'Indicates whether all review comments must be resolved before merging.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'isResetApprovalWhenNewPush' => ['description' => 'Indicates whether all approvals are reset when new commits are pushed to the source branch.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'minimumApproval' => ['description' => 'The minimum number of approvals required for a code review.'."\n" + .'Note: This setting applies only in general mode.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'allowMergeRequestRoles' => [ - 'description' => '', + 'description' => 'A list of role IDs permitted to merge merge requests.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '40', - ], + 'items' => ['description' => '40: Maintainer (default)<br>'."\n" + .'30: Developer<br>', 'type' => 'integer', 'format' => 'int32', 'example' => '40', 'title' => ''], + 'title' => '', + 'example' => '', ], 'defaultAssignees' => [ - 'description' => '', + 'description' => 'The user IDs of default reviewers.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5f969843cd2214ba0e24327d', - ], - ], - 'whiteList' => [ - 'description' => '', - 'type' => 'string', - 'example' => '**.java', + 'items' => ['description' => 'The user ID in Alibaba Cloud DevOps.', 'type' => 'string', 'example' => '5f969843cd2214ba0e24327d', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'whiteList' => ['description' => 'The file whitelist for code review.'."\n" + .'Note: Whitelisted files are exempt from the minimum number of approvals and mandatory manual reviews.', 'type' => 'string', 'example' => '**.java', 'title' => ''], ], + 'title' => '', + 'example' => '', ], 'testSettingDTO' => [ - 'description' => '', + 'description' => 'The settings for automated status checks before merging.', 'type' => 'object', 'properties' => [ - 'isRequired' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], + 'isRequired' => ['description' => 'Indicates whether automated status checks are enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'codeGuidelinesDetection' => [ - 'description' => '', + 'description' => 'The settings for code guideline detection.', 'type' => 'object', 'properties' => [ - 'enabled' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test_code_guide_lines', - ], + 'enabled' => ['description' => 'Indicates whether code guideline detection is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'message' => ['description' => 'The message for this detection.', 'type' => 'string', 'example' => 'test_code_guide_lines', 'title' => ''], ], + 'title' => '', + 'example' => '', ], 'sensitiveInfoDetection' => [ - 'description' => '', + 'description' => 'The settings for sensitive information detection.', 'type' => 'object', 'properties' => [ - 'enabled' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test_code_sensitive_info', - ], + 'enabled' => ['description' => 'Indicates whether sensitive information detection is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'message' => ['description' => 'The message for this detection.', 'type' => 'string', 'example' => 'test_code_sensitive_info', 'title' => ''], ], + 'title' => '', + 'example' => '', ], 'checkTaskQualityConfig' => [ - 'description' => '', + 'description' => 'The settings for the code quality check.', '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', - ], + 'enabled' => ['description' => 'Indicates whether the code quality check is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'bizNo' => ['description' => 'The serial number of the task.', 'type' => 'string', 'example' => '123456', 'title' => ''], + 'taskName' => ['description' => 'The name of the task.', 'type' => 'string', 'example' => 'biz-task-quality', 'title' => ''], + 'message' => ['description' => 'The message for the task.', 'type' => 'string', 'example' => 'test_task_quality', 'title' => ''], ], + 'title' => '', + 'example' => '', ], 'checkConfig' => [ - 'description' => '', + 'description' => 'Configuration for the merge request quality gate pipeline.', 'type' => 'object', 'properties' => [ 'checkItems' => [ - 'description' => '', + 'description' => 'The configuration items.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'A configuration item.', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'isRequired' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], + 'name' => ['description' => 'The name of the pipeline.', 'type' => 'string', 'example' => '测试流水线', 'title' => ''], + 'isRequired' => ['description' => 'Specifies whether this check is a required gate.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], '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.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => '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.', 'description' => ''], ], ], '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', + 'title' => 'Creation of protected branch', + 'changeSet' => [ + ['createdAt' => '2023-06-05T11:04:31.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-01-10T09:24:45.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateProtectdBranch'], + ], ], + ], + 'CreatePushRule' => [ + 'summary' => 'Create a push rule.', + 'path' => '/api/v4/projects/{repositoryId}/push_rule', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'query', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '619b80042f595dbd1b9b0de2', - ], + 'schema' => ['description' => 'The organization ID. You can get this ID from your Alibaba Cloud DevOps URL, for example: `https://devops.aliyun.com/organization/{OrganizationId}`.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx', 'title' => ''], ], [ 'name' => 'accessToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'f0b1e61db5961df5975a93f9129d2513', - ], + 'schema' => ['description' => 'The personal access token. This parameter is not required if you authenticate by using an Alibaba Cloud AccessKey pair or STS temporary authorization.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], ], [ 'name' => 'repositoryId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '2185366', - ], + 'schema' => ['description' => 'The repository ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '187687', 'title' => ''], ], [ - 'name' => 'branchName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'deleteBranch', - ], - ], - ], - 'responses' => [ - 200 => [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The request body.', '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', + 'ruleInfos' => [ + 'description' => 'A list of rule objects.', + 'type' => 'array', + 'items' => [ + 'description' => 'A rule object.', + 'type' => 'object', + 'properties' => [ + 'checkerName' => ['description' => 'The name of the rule. Valid values:'."\n" + ."\n" + .'- `CommitMessageChecker`: A commit message rule.'."\n" + ."\n" + .'- `CommitAuthorEmailChecker`: A commit author email rule.'."\n" + ."\n" + .'- `CommitAuthorChecker`: A commit author rule.'."\n" + ."\n" + .'- `CommitCommitterChecker`: A commit committer rule.'."\n" + ."\n" + .'- `ForcePushChecker`: A rule that disallows force pushes.'."\n" + ."\n" + .'- `CommitFilesChecker`: A commit file restriction rule.', 'type' => 'string', 'required' => false, 'example' => 'CommitMessageChecker', 'title' => ''], + 'extraMessage' => ['description' => 'The behavior of this parameter varies based on the value of `checkerName`.'."\n" + ."\n" + .'- For the `CommitMessageChecker` rule, provide a regular expression to validate commit messages.'."\n" + ."\n" + .'- For the `CommitAuthorEmailChecker` rule, provide a regular expression to validate author email addresses.'."\n" + ."\n" + .'- For the `ForcePushChecker` rule, provide the value `"disabled"` to disallow force pushes.'."\n" + ."\n" + .'- For the `CommitAuthorChecker` rule, provide the value `"on"` to enable the check. Omit this parameter if the check is not required.'."\n" + ."\n" + .'- For the `CommitCommitterChecker` rule, provide the value `"on"` to enable the check. Omit this parameter if the check is not required.', 'type' => 'string', 'required' => false, 'example' => 'user@example.com', 'title' => ''], + 'checkerType' => ['description' => 'Specifies the enforcement level for a code ownership check. This parameter is valid only for `CommitAuthorChecker` and `CommitCommitterChecker`. Valid values:'."\n" + ."\n" + .'- `warn`: Displays a warning but allows the push.'."\n" + ."\n" + .'- `block`: Blocks the push and returns an error.', 'type' => 'string', 'required' => false, 'example' => 'warn', 'title' => ''], + 'fileRuleRegexes' => [ + 'description' => 'An array of regular expressions to restrict file paths. This parameter is used only when `checkerName` is `CommitFilesChecker`.', + 'type' => 'array', + 'items' => ['description' => 'A regular expression to restrict file paths.', 'type' => 'string', 'required' => false, 'example' => '\\.java$', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => true, + 'title' => '', + 'example' => '', ], ], - ], - ], - ], - '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', + 'title' => '', + 'example' => '', ], ], ], @@ -7317,710 +3536,309 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response schema.', '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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'result' => [ - 'description' => '', + 'description' => 'The result.', 'type' => 'object', 'properties' => [ - 'result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'id' => ['description' => 'The push rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '2077', 'title' => ''], + 'ruleInfos' => [ + 'description' => 'The list of rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'Information about a single rule.', + 'type' => 'object', + 'properties' => [ + 'checkerName' => ['description' => 'The rule name. Valid values:'."\n" + ."\n" + .'- `CommitMessageChecker`: commit message rule'."\n" + ."\n" + .'- `CommitAuthorEmailChecker`: commit author email rule'."\n" + ."\n" + .'- `CommitAuthorChecker`: commit author check'."\n" + ."\n" + .'- `CommitCommitterChecker`: committer check'."\n" + ."\n" + .'- `ForcePushChecker`: force push check'."\n" + ."\n" + .'- `CommitFilesChecker`: commit file limit rule', 'type' => 'string', 'example' => 'ForcePushChecker', 'title' => ''], + 'checkerType' => ['description' => 'The enforcement level. This parameter applies only to the commit author check and committer check rules. Valid values:'."\n" + ."\n" + .'- `warn`: Warns the user and allows the push.'."\n" + ."\n" + .'- `block`: Blocks the push.', 'type' => 'string', 'example' => 'warn', 'title' => ''], + 'extraMessage' => ['description' => 'Additional information about the rule. The value of this parameter depends on the value of `checkerName`:'."\n" + ."\n" + .'- For the commit message rule, this parameter contains the validation regular expression.'."\n" + ."\n" + .'- For the commit author email rule, this parameter contains the regular expression for the email address.'."\n" + ."\n" + .'- For the force push check, this parameter is set to `disabled`.'."\n" + ."\n" + .'- For the commit author check, the value is `on` if the check is enabled.'."\n" + ."\n" + .'- For the committer check, the value is `on` if the check is enabled.', 'type' => 'string', 'example' => 'disabled', 'title' => ''], + 'fileRuleRegexes' => [ + 'description' => 'An array of regular expressions for the commit file limit rule. Multiple expressions are supported.', + 'type' => 'array', + 'items' => ['description' => 'A regular expression used for restricting files.', 'type' => 'string', 'example' => '\\.java$'."\n", 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'gmtCreate' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2023-09-03T18:20:06+08:00', 'title' => ''], + 'gmtModified' => ['description' => 'The modification time.', 'type' => 'string', 'example' => '2023-09-03T18:20:06+08:00', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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\\": \\"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"}]', + 'title' => 'Create push rule ', + 'description' => 'You must have repository administrator permissions or higher.', + 'changeSet' => [], + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePushRule'], ], ], - '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', - ], + 'CreateRepository' => [ + 'summary' => 'Create or import a code repository. ', + 'path' => '/repository/create', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'organizationId', + 'name' => 'accessToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'f0b1e61db5961df5975a93f9129d2513', - ], + 'schema' => ['description' => 'Personal access token. '."\n" + .'This field is not required when using Alibaba Cloud AccessKey ID and AccessKey Secret (AK+SK) or Security Token Service (STS) temporary authorization.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], ], [ - 'name' => 'accessToken', + 'name' => 'sync', 'in' => 'query', - 'schema' => [ - 'title' => 'accessToken(选填),使用AK方式调用时无需填accessToken', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'f0b1e61db5961df5975a93f9129d2513', - ], + 'schema' => ['description' => 'Whether to execute repository Creation synchronously '."\n" + .'Valid values: true / false', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ - 'name' => 'repositoryId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '2835387', - ], + 'name' => 'createParentPath', + 'in' => 'query', + 'schema' => ['description' => 'Whether to create the parent folder. '."\n" + .'Valid values: true / false', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'id', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '19224', - ], + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => ['description' => 'Organization identifier, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps URL, for example: https://devops.aliyun.com/organization/【OrganizationId】', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '60de7a6852743a5162b5f957', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Request body', 'type' => 'object', 'properties' => [ - 'id' => [ - 'description' => '', + 'name' => ['title' => '', 'description' => 'Name of the repository', 'type' => 'string', 'required' => true, 'example' => 'Demo库'], + 'path' => ['title' => '', 'description' => 'Path of the repository', 'type' => 'string', 'required' => false, 'example' => 'Demo库(与name保持同层级,name与path的值可以不同,若带上了父路径,那么需要设置createParentPath字段为true,且父路径前面不加斜杠,如 parentPath/demo)'], + 'namespaceId' => ['title' => '', 'description' => 'ID of the parent path of the repository', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2022(需要保证当前用户在父路径下有创建代码库的权限;若需要创建父路径,那么namespaceId需要设置为企业的空间ID)'], + 'description' => ['title' => '', 'description' => 'Description of the repository', 'type' => 'string', 'required' => false, 'example' => '测试内容'], + 'visibilityLevel' => [ + 'description' => 'Visibility level of the code repository '."\n" + .'0 – private, visible only to repository members '."\n" + .'10 – internal to the enterprise, visible to enterprise members', 'type' => 'integer', - 'format' => 'int64', + 'format' => 'int32', 'required' => false, - 'example' => '19224', + 'enumValueTitles' => [], + 'example' => '0', + 'title' => '', ], - 'branch' => [ - 'description' => '', + 'importUrl' => ['title' => '', 'description' => 'URL of the repository to be imported (HTTP protocol), such as a GitHub repository URL', 'type' => 'string', 'required' => false, 'example' => 'https://github.com/a/b.git'], + 'importAccount' => ['title' => '', 'description' => 'Account used for import', 'type' => 'string', 'required' => false, 'example' => 'codeup-test'], + 'importToken' => ['title' => '', 'description' => 'Account token used during import', 'type' => 'string', 'required' => false, 'example' => 'xxxxx'], + 'importTokenEncrypted' => ['title' => '', 'description' => 'Transmission format of the importToken field, using plaintext or RSA encryption '."\n" + .'Valid values: text (plaintext) / rsa (RSA encryption)', 'type' => 'string', 'required' => false, 'example' => 'text'], + 'importDemoProject' => ['title' => '', 'description' => 'Whether to import a Sample project '."\n" + .'Valid values: true / false', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'avatarUrl' => ['title' => '', 'description' => 'URL of the repository profile picture', 'type' => 'string', 'required' => false, 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100'], + 'readmeType' => [ + 'title' => '', + 'description' => 'Type of automatically created README file: '."\n" + .'EMPTY – Create only README.md '."\n" + .'USER_GUIDE – Include beginner guidance', '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, + 'enumValueTitles' => ['USER_GUIDE' => '', 'EMPTY' => ''], + 'example' => 'USER_GUIDE', ], + 'importRepoType' => ['title' => '', 'description' => 'Type of repository to import: '."\n" + .'GIT – Git repository '."\n" + .'SVN – SVN repository', 'type' => 'string', 'required' => false, 'example' => 'GIT'], + 'initStandardService' => ['title' => '', 'description' => 'Initialize standard Intelligent service. '."\n" + .'Valid values: true / false', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'gitignoreType' => ['title' => '', 'description' => 'Type of gitignore template', 'type' => 'string', 'required' => false, 'example' => 'Java'], + 'isCryptoEnabled' => ['title' => '', 'description' => 'Whether encryption is enabled '."\n" + .'Valid values: true / false', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'localImportUrl' => ['title' => '', 'description' => 'Remote URL of the locally imported code repository', 'type' => 'string', 'required' => false, 'example' => '""'], ], 'required' => true, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Return Result ', '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', - ], + 'errorMessage' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => 'SYSTEM_UNAUTHORIZED_ERROR'], + 'requestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => 'F590C9D8-E908-5B6C-95AC-56B7E8011FFA'], + 'errorCode' => ['title' => '', 'description' => 'Error code', 'type' => 'string', 'example' => '401'], + 'success' => ['title' => '', 'description' => 'Indicates whether the invocation succeeded', 'type' => 'boolean', 'example' => 'true'], 'result' => [ - 'description' => '', + 'description' => 'Return detailed result '."\n", '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' => '', + 'id' => ['title' => 'id', 'description' => 'id', 'type' => 'integer', 'format' => 'int64', 'example' => '2959'], + 'description' => ['title' => '', 'description' => 'Description ', 'type' => 'string', 'example' => '线下测试'], + 'defaultBranch' => ['title' => '', 'description' => 'Default branch ', 'type' => 'string', 'example' => 'master'], + 'visibilityLevel' => ['title' => '', 'description' => 'Visibility. 0: private, 10: internal public', 'type' => 'string', 'example' => '0'], + 'sshUrlToRepo' => ['title' => '', 'description' => 'SSH URL ', 'type' => 'string', 'example' => '""'], + 'httpUrlToRepo' => ['title' => '', 'description' => 'HTTP URL ', 'type' => 'string', 'example' => '""'], + 'webUrl' => ['title' => 'web url', 'description' => 'web url', 'type' => 'string', 'example' => '""'], + 'name' => ['title' => '', 'description' => 'Name', 'type' => 'string', 'example' => 'codeupTest'], + 'nameWithNamespace' => ['title' => '', 'description' => 'Name (including parent path)', 'type' => 'string', 'example' => 'codeup-test-org / test-codeup'], + 'path' => ['title' => '', 'description' => 'path', 'type' => 'string', 'example' => 'test-codeup'], + 'pathWithNamespace' => ['title' => '', 'description' => 'Path (including parent path)', 'type' => 'string', 'example' => 'codeup-test-org/test-codeup'], + 'createdAt' => ['title' => '', 'description' => 'Creation Time', 'type' => 'string', 'example' => '2022-01-14T21:08:26+08:00'], + 'lastActivityAt' => ['title' => '', 'description' => 'Last activity time ', 'type' => 'string', 'example' => '2022-01-14T21:08:26+08:00'], + 'creatorId' => ['title' => '', 'description' => 'Creator ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '1233'], + 'namespace' => [ + 'title' => '', + 'description' => 'Parent path information', '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', - ], - ], - ], - ], - ], - ], + 'id' => ['title' => 'id', 'description' => 'id', 'type' => 'integer', 'format' => 'int64', 'example' => '3194'], + 'name' => ['title' => '', 'description' => 'Name ', 'type' => 'string', 'example' => 'codeup'], + 'path' => ['title' => '', 'description' => 'path ', 'type' => 'string', 'example' => 'codeup'], + 'ownerId' => ['title' => '', 'description' => 'Owner ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'createdAt' => ['title' => '', 'description' => 'Creation Time ', 'type' => 'string', 'example' => '2022-01-14T21:08:26+08:00'], + 'updatedAt' => ['title' => '', 'description' => 'Update Time', 'type' => 'string', 'example' => '2022-01-14T21:08:26+08:00'], + 'description' => ['title' => '', 'description' => 'Description ', 'type' => 'string', 'example' => 'codeup repo description'], + 'avatar' => ['title' => '', 'description' => 'Profile picture URL', 'type' => 'string', 'example' => '""'], + 'public' => ['title' => '', 'description' => 'Public visibility ', 'type' => 'boolean', 'example' => 'true'], + 'visibilityLevel' => ['title' => '', 'description' => 'Visibility. 0: private, 10: internally public ', 'type' => 'string', 'example' => '0'], ], + 'example' => '', ], + 'archived' => ['title' => '', 'description' => 'data archiving identity', 'type' => 'boolean', 'example' => 'false'], + 'avatar_url' => ['title' => '', 'description' => 'Code repository profile picture URL', 'type' => 'string', 'example' => '""'], + 'demoProject' => ['title' => '', 'description' => 'Demo repository identity ', 'type' => 'boolean', 'example' => 'false'], + 'Import_from_svn' => ['title' => '', 'description' => 'Import from SVN ', 'type' => 'boolean', 'example' => 'false'], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.AccessDenied', - 'errorMessage' => 'The user is not authorized to perform the operation.', - ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Create or import a code repository', + 'changeSet' => [ + ['createdAt' => '2022-07-27T11:20:41.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-03-18T06:00:14.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-03-18T06:00:14.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRepository'], ], ], - '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":""}]', + 'ramActions' => [], ], - 'GetBranchInfo' => [ - 'summary' => '查询单个分支', - 'path' => '/repository/{repositoryId}/branches/detail', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateRepositoryGroup' => [ + 'summary' => 'Create a code group.', + 'path' => '/repository/groups/create', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + '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' => '5fbe3118672533690be72b12', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The organization ID is a string that you can obtain from the Alibaba Cloud DevOps URL, such as `https://devops.aliyun.com/organization/{OrganizationId}`.', 'type' => 'string', 'required' => true, 'example' => '60de7a6852743a5162b5f957'], ], [ 'name' => 'accessToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'f0b1e61db5961df5975a93f9129d2513', - ], + 'schema' => ['description' => 'The personal access token. This parameter is not required if you authenticate using an Alibaba Cloud access key pair or Security Token Service (STS).', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], ], [ - 'name' => 'repositoryId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '2334743', - ], - ], - [ - 'name' => 'branchName', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The name of the repository group.', 'type' => 'string', 'required' => true, 'example' => 'test-create-group', 'title' => ''], + 'path' => ['description' => 'The path of the repository group.', 'type' => 'string', 'required' => true, 'example' => 'test-create-group', 'title' => ''], + 'visibilityLevel' => ['description' => 'The visibility level of the repository group.'."\n" + ."\n" + .'- `0`: private'."\n" + ."\n" + .'- `10`: internal', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', 'title' => ''], + 'parentId' => ['description' => 'The parent ID. If this parameter is omitted, the repository group is created at the root level.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '26842', 'title' => ''], + 'description' => ['description' => 'The description of the repository group.', 'type' => 'string', 'required' => false, 'example' => '描述信息的具体内容', 'title' => ''], + 'avatarUrl' => ['description' => 'The URL of the avatar for the repository group.', 'type' => 'string', 'required' => false, 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', 'title' => ''], + ], 'required' => true, - 'example' => 'master', + 'title' => '', + 'example' => '', ], ], ], @@ -8028,1958 +3846,416 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', '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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9'], + 'errorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'errorCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'result' => [ - 'description' => '', + 'description' => 'The details of the created repository group.', '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' => 'username@example.com', - ], - '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' => 'username@example.com', - ], - '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' => 'username@example.com', - ], - ], - ], - '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' => 'username@example.com', - ], - ], - ], - 'signature' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'gpgKeyId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '""', - ], - 'verificationStatus' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'verified', - ], - ], - ], - 'commentsCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - ], - ], + 'id' => ['description' => 'The ID of the repository group.', 'type' => 'integer', 'format' => 'int64', 'example' => '18685', 'title' => ''], + 'name' => ['description' => 'The name of the repository group.', 'type' => 'string', 'example' => 'test-create-group', 'title' => ''], + 'path' => ['description' => 'The path of the repository group.', 'type' => 'string', 'example' => 'test-create-group', 'title' => ''], + 'description' => ['description' => 'The description of the repository group.', 'type' => 'string', 'example' => '描述信息的具体内容', 'title' => ''], + 'avatarUrl' => ['description' => 'The avatar URL of the repository group.', 'type' => 'string', 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', 'title' => ''], + 'webUrl' => ['description' => 'The web URL of the repository group.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'pathWithNamespace' => ['description' => 'The full path of the repository group, including the namespace.', 'type' => 'string', 'example' => 'codeup-test-org/test-create-group', 'title' => ''], + 'nameWithNamespace' => ['description' => 'The full name of the repository group, including the namespace. The namespace and the group name are separated by a forward slash surrounded by spaces (` / `).', 'type' => 'string', 'example' => 'codeup-test-org / test-create-group (斜杠两侧有空格)', 'title' => ''], + 'type' => ['description' => 'The type of the resource. The value is always `Group`.', 'type' => 'string', 'example' => 'Group', 'title' => ''], + 'visibilityLevel' => ['description' => 'The visibility level of the repository group.'."\n" + ."\n" + .'- `0`: private'."\n" + ."\n" + .'- `10`: internal', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'parentId' => ['description' => 'The ID of the parent group.', 'type' => 'integer', 'format' => 'int64', 'example' => '26842', 'title' => ''], + 'ownerId' => ['description' => 'The ID of the user who owns the repository group.', 'type' => 'integer', 'format' => 'int64', 'example' => '19230', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], '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.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'Forbidden.UserNotAdminOrOwner', 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', 'description' => ''], ], ], - '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\\": \\"username@example.com\\",\\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\\": \\"username@example.com\\",\\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\\": \\"username@example.com\\"\\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\\": \\"username@example.com\\"\\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', + '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"}]', + 'title' => 'Create a code group ', + 'changeSet' => [], + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRepositoryGroup'], + ], ], + ], + 'CreateResourceMember' => [ + 'summary' => 'You can insert resource members.', + 'path' => '/organization/{organizationId}/{resourceType}/{resourceId}/members', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + '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', - ], + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'Organization identity, also known as organization ID, in string format. You can obtain it from the Alibaba Cloud DevOps access link, such as https://devops.aliyun.com/organization/【OrganizationId】.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ - 'name' => 'repositoryId', + 'name' => 'resourceType', 'in' => 'path', 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'Resource type: pipeline (pipeline) or hostGroup (host group)', + 'type' => 'string', 'required' => true, - 'example' => '2709413', - ], - ], - [ - 'name' => 'page', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', + 'docRequired' => true, + 'maximum' => '999999999999999', + 'minimum' => '1', + 'example' => 'pipeline', + 'enum' => ['pipeline', 'hostGroup'], ], ], [ - 'name' => 'pageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20', - ], + 'name' => 'accountId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Alibaba Cloud account ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1111111111111'], ], [ - 'name' => 'search', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Demo', - ], + 'name' => 'roleName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Role'."\n" + ."\n" + .'For deployment group (hostGroup):'."\n" + .'- user: member with usage permission '."\n" + .'- admin: administrator with edit permission '."\n" + .'- owner: owner with all permissions '."\n" + ."\n" + .'For pipeline:'."\n" + .'- owner: owner with all permissions '."\n" + .'- admin: View, Run, and Edit permissions '."\n" + .'- member: Run permission '."\n" + .'- viewer: View permission', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'admin'], ], [ - 'name' => 'sort', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'desc', - ], + 'name' => 'resourceId', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'Resource ID', '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' => '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' => 'username@example.com', - ], - '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' => 'username@example.com', - ], - 'committerName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'commit-codeup', - ], - 'parentIds' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'de02b625ba8488f92eb204bcb3773a40c1b4ddac', - ], - ], - ], - ], - ], - ], - ], + 'requestId' => ['title' => '', 'description' => 'The request ID. Each request has a unique value, which facilitates troubleshooting later.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['title' => '', 'description' => 'error message', 'type' => 'string', 'example' => '""'], + 'errorCode' => ['title' => '', 'description' => 'error code', 'type' => 'string', 'example' => '""'], + 'success' => ['title' => '', 'description' => 'true indicates that the API call succeeded. false indicates that the API call failed.', 'type' => 'boolean', 'example' => 'true'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => 'The user that is invoking the API service is not a registered user.'], + ['errorCode' => 'InvalidResourceRole.NotFoun', 'errorMessage' => 'The member role is invalid.', 'description' => 'The member role is invalid.'], + ], 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.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], ], ], - '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\\": \\"username@example.com\\",\\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\\": \\"username@example.com\\",\\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', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true\\n}","type":"json"}]', + 'title' => 'Insert resource members', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateResourceMember'], + ], ], + 'ramActions' => [], + ], + 'CreateServiceAuth' => [ + 'summary' => 'Creates a service authorization.', + 'path' => '/organization/{organizationId}/serviceAuths', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'organizationId', - 'in' => 'query', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '60de7a6852743a5162b5f957', - ], + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'The organization ID, also referred to as the enterprise ID. This is a string value that you can obtain from the China Cloud DevOps access URL, such as https:// devops.aliyun.com/organization/[OrgId].', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ - 'name' => 'accessToken', + 'name' => 'serviceAuthType', 'in' => 'query', 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'The service authorization type. Currently, only RAM is supported.', 'type' => 'string', - 'required' => false, - 'example' => 'f0b1e61db5961df5975a93f9129d2513'."\n", - ], - ], - [ - 'name' => 'repositoryId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', 'required' => true, - 'example' => '2813489', + 'example' => 'RAM (阿里云RAM类型)', + 'enum' => ['RAM'], ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => 'username@example.com', - ], - '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' => 'username@example.com', - ], - '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' => 'username@example.com', - ], - '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"]', - ], - ], - ], - ], - ], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'."\n"], + 'errorMessage' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => '""'], + 'errorCode' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => '”“'], + 'success' => ['title' => '', 'description' => 'Indicates whether the API call was successful. Valid values:'."\n" + .'- true: The call was successful.'."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true'], + 'id' => ['description' => 'The service authorization ID.', 'type' => 'string', 'example' => '1223', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => '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.UserNotInCurrentOrganization', - 'errorMessage' => 'The user is not 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.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], ], ], - '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\\": \\"username@example.com\\",\\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\\": \\"username@example.com\\",\\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\\": \\"username@example.com\\",\\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', + '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"}]', + 'title' => 'Create service authorization', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateServiceAuth'], + ], ], + 'ramActions' => [], + ], + 'CreateServiceConnection' => [ + 'summary' => 'Creates a service connection.', + 'path' => '/organization/{organizationId}/createServiceConnection', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURErdcCL5BE0'], ], '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', - ], + 'schema' => ['title' => '', 'description' => 'The organization identifier, also known as the organization ID. This is a string value that can be obtained from the China Cloud Effect (Yunxiao) access URL, such as https:// devops.aliyun.com/organization/【OrgId】.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ - 'name' => 'localId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], - ], - ], - 'responses' => [ - 200 => [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', + 'connectionType' => [ + 'title' => '', + 'description' => 'The type of the service connection.', 'type' => 'string', - 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9', - ], - 'errorMessage' => [ - 'description' => '', + 'required' => true, + 'example' => 'ecs 云服务器(ECS)'."\n" + .'ack 容器服务Kubernetes(ACK)'."\n" + .'oss 对象存储(OSS)'."\n" + .'edas 企业级分布式应用(EDAS)'."\n" + .'sae Serverless应用引擎(SAE)'."\n" + .'ros 资源编排服务(ROS)'."\n" + .'fc 阿里云函数计算(FC)'."\n" + .'emas 移动研发平台(EMAS)'."\n" + .'customGitlab 自建Gitlab'."\n" + .'git 通用Git'."\n" + .'gitlab Gitlab'."\n" + .'bitbucket Bitbucket'."\n" + .'docker_register_aliyun 容器镜像服务(ACR)'."\n" + .'ess 弹性伸缩(ESS)', + 'enum' => ['ecs', 'ack', 'oss', 'edas', 'sae', 'ros', 'fc', 'emas', 'customGitlab', 'git', 'gitlab', 'bitbucket', 'docker_register_aliyun', 'ess', 'Codeup'], + ], + 'connectionName' => ['title' => '', 'description' => 'The name of the service connection.', 'type' => 'string', 'required' => true, 'example' => 'ecs连接'], + 'serviceAuthId' => ['description' => 'The service authorization ID.', 'type' => 'integer', 'title' => '', 'format' => 'int64', 'required' => true, 'example' => '111'], + 'scope' => [ + 'title' => '', + 'description' => 'The visibility scope. Valid values: PERSON, GLOBAL, and CUSTOM.', 'type' => 'string', - 'example' => '""', + 'required' => true, + 'example' => 'PERSON (私有)'."\n" + .'GLOBAL (公开)'."\n" + .'CUSTOM (自定义)', + 'enum' => ['PERSONAL', 'GLOBAL', 'CUSTOM'], ], - 'errorCode' => [ - 'description' => '', + 'authType' => [ + 'description' => 'The service authorization type.', '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' => 'username@example.com', - ], - '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' => 'username@example.com', - ], - ], - ], - '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' => 'username@example.com', - ], - ], - ], - ], - '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', - ], - ], + 'required' => true, + 'example' => 'CREDENTIAL (服务证书)'."\n" + .'AUTHENTICATION (服务授权)', + 'enum' => ['CREDENTIAL', 'AUTHENTICATION'], + 'title' => '', ], ], - ], - ], - ], - '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\\": \\"username@example.com\\",\\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\\": \\"username@example.com\\"\\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\\": \\"username@example.com\\"\\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', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => 'username@example.com', - ], - ], - ], - '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' => 'username@example.com', - ], - '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' => 'username@example.com', - ], - ], - ], - ], - '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', - ], - ], - ], - ], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'."\n"], + 'errorMessage' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => '""'], + 'errorCode' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => '""'], + 'success' => ['title' => '', 'description' => 'Indicates whether the API call was successful. Valid values:'."\n" + .'- true: The API call was successful.'."\n" + .'- false: The API call failed.', 'type' => 'boolean', 'example' => 'true'], + 'id' => ['description' => 'The ID of the service connection.', 'type' => 'integer', 'format' => 'int64', 'example' => '19224', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => '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.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], + ], ], - '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\\": \\"username@example.com\\"\\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\\": \\"username@example.com\\",\\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\\": \\"username@example.com\\"\\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', + '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"}]', + 'title' => 'Create a service connection', + 'changeSet' => [ + ['createdAt' => '2025-03-12T13:37:33.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateServiceConnection'], + ], ], + 'ramActions' => [], + ], + 'CreateServiceCredential' => [ + 'summary' => 'Creates a username-and-password service credential.', + 'path' => '/organization/{organizationId}/serviceCredentials', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + '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', - ], + 'schema' => ['description' => 'The organization ID. You can get this ID from the URL of your organization page in Alibaba Cloud DevOps. For example: `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', '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' => '', + 'name' => ['description' => 'The service credential name.', 'type' => 'string', 'required' => true, 'example' => '张三的Git证书', 'maxLength' => 100, 'title' => ''], + 'type' => [ + 'description' => 'The service credential type. The default value is `USERNAME_PASSWORD`.', '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, + 'example' => 'USERNAME_PASSWORD (用户密码类型)', + 'default' => 'USERNAME_PASSWORD', + 'enum' => ['USERNAME_PASSWORD'], + 'title' => '', ], - 'workItemIds' => [ - 'description' => '', + 'scope' => [ + 'description' => 'The scope of the credential. For example, `PERSON`.', 'type' => 'string', 'required' => false, - 'example' => '722200214032b6b31e6f1434ab', + 'example' => 'PERSON (私有)', + 'default' => 'PERSON', + 'enum' => ['PERSON'], + 'title' => '', ], + 'username' => ['description' => 'The username.', 'type' => 'string', 'required' => true, 'example' => 'zhangsan', 'title' => ''], + 'password' => ['description' => 'The password.', 'type' => 'string', 'required' => true, 'example' => 'zhangsan', 'title' => ''], ], - 'required' => true, + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -9987,592 +4263,231 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response schema.', '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' => 'username@example.com', - ], - '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' => 'username@example.com', - ], - ], - ], - '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' => 'username@example.com', - ], - ], - ], - ], - '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', - ], - ], - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'success' => ['description' => 'Indicates if the request succeeded. `true` indicates success, and `false` indicates failure.', 'type' => 'boolean', 'default' => '默认值', 'title' => '', 'example' => 'true'], + 'id' => ['description' => 'The service credential ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '11222', 'title' => ''], ], + 'example' => '', ], ], ], - '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\\": \\"username@example.com\\",\\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\\": \\"username@example.com\\"\\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\\": \\"username@example.com\\"\\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', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => '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.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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"}]', + 'title' => 'Create a service certificate', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateServiceCredential'], + ], ], + 'ramActions' => [], + ], + 'CreateSprint' => [ + 'summary' => 'You can create an iteration for a project.', + 'path' => '/organization/{organizationId}/sprints/create', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => [], + 'produces' => [], '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', - ], + 'schema' => ['title' => '', 'description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access URL, such as https://devops.aliyun.com/organization/【OrganizationId】 ', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Request structure.', 'type' => 'object', 'properties' => [ - 'title' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'description' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, + 'name' => ['title' => '', 'description' => 'Iteration name', 'type' => 'string', 'required' => true, 'example' => '示例迭代'], + 'spaceIdentifier' => ['title' => '', 'description' => 'Project ID, which has the same meaning as projectId.', 'type' => 'string', 'required' => true, 'example' => 'asd345xxxxx9q9845xxxxx34'], + 'startDate' => ['title' => '', 'description' => 'Start Time', 'type' => 'string', 'required' => false, 'example' => '2021-12-01'], + 'endDate' => ['title' => '', 'description' => 'End Time', 'type' => 'string', 'required' => false, 'example' => '2021-12-02'], + 'staffIds' => [ + 'title' => '', + 'description' => 'List of owners', + 'type' => 'array', + 'items' => ['description' => 'Supports enterprise usernames, such as "Zhang San", or user aliyunPk.', 'type' => 'string', 'required' => true, 'example' => '19xx7043xxxxxxx914', 'title' => ''], + 'required' => true, 'example' => '', ], ], 'required' => false, + 'title' => '', + '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' => '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' => '', + 'requestId' => ['title' => '', 'description' => 'Request ID. Each request has a unique value to facilitate troubleshooting.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMsg' => ['title' => '', 'description' => 'Error Message ', 'type' => 'string', 'example' => 'error'], + 'errorCode' => ['title' => '', 'description' => 'Error Code ', 'type' => 'string', 'example' => 'Openapi.RequestError'], + 'success' => ['title' => '', 'description' => 'true or false', 'type' => 'boolean', 'example' => 'true'], + 'sprint' => [ + 'title' => '', + 'description' => 'Iteration information', 'type' => 'object', 'properties' => [ - 'result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'creator' => ['title' => '', 'description' => 'Alibaba Cloud account ID of the Creator', 'type' => 'string', 'example' => '19xx7043xxxxxxx914'], + 'description' => ['title' => '', 'description' => 'Description ', 'type' => 'string', 'example' => 'xxx'], + 'gmtCreate' => ['title' => '', 'description' => 'UNIX timestamp of the Creation Time, in milliseconds ', 'type' => 'integer', 'format' => 'int64', 'example' => '1623916393000'], + 'gmtModified' => ['title' => '', 'description' => 'UNIX timestamp of the Updated At time, in milliseconds', 'type' => 'integer', 'format' => 'int64', 'example' => '1623916393000'], + 'endDate' => ['title' => '', 'description' => 'UNIX timestamp of the End time, in milliseconds', 'type' => 'integer', 'format' => 'int64', 'example' => '1623916393000'], + 'startDate' => ['title' => '', 'description' => 'UNIX timestamp of the Start Time, in milliseconds ', 'type' => 'integer', 'format' => 'int64', 'example' => '1638403200000'], + 'identifier' => ['title' => '', 'description' => 'Unique Identifier of the iteration', 'type' => 'string', 'example' => 'e8bxxxxxxxxxxxxxxxx23'], + 'modifier' => ['title' => '', 'description' => 'Alibaba Cloud account ID of the Updated By user', 'type' => 'string', 'example' => '19xx7043xxxxxxx914'], + 'name' => ['title' => '', 'description' => 'Iteration Name ', 'type' => 'string', 'example' => 'demo示例项目'], + 'spaceIdentifier' => ['title' => '', 'description' => 'Project UUID ', 'type' => 'string', 'example' => '5e70xxxxxxcd000xxxxe96'], + 'scope' => ['title' => '', 'description' => 'Visible To: public or private', 'type' => 'string', 'example' => 'public'], + 'status' => ['title' => '', 'description' => 'Status '."\n" + ."\n" + .'Not Started: Todo '."\n" + ."\n" + .'In Progress: Doing '."\n" + ."\n" + .'Completed: Done ', 'type' => 'string', 'example' => 'TODO'], ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Openapi.RequestError', 'errorMessage' => 'request error', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'Operate.NoPermission', 'errorMessage' => 'NoPermission', 'description' => 'You are not authorized to perform this operation.'], + ], ], - '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', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Create Iteration ', + 'changeSet' => [ + ['createdAt' => '2022-01-06T13:27:07.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSprint'], + ], ], + 'ramActions' => [], + ], + 'CreateSshKey' => [ + 'summary' => 'You can create an enterprise public key.', + 'path' => '/organization/{organizationId}/sshKey', + '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, - ], + 'schema' => ['title' => '', 'description' => 'Enterprise identity, also known as enterprise ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, such as https://devops.aliyun.com/organization/【OrganizationId】', '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' => '', - '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' => '', + 'requestId' => ['title' => '', 'description' => 'Request ID. Each request has a unique value, which facilitates troubleshooting later.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => '""'], + 'errorCode' => ['title' => '', 'description' => 'Error code', 'type' => 'string', 'example' => '""'], + 'success' => ['title' => '', 'description' => 'true indicates the API call succeeded; false indicates the API call failed.', 'type' => 'boolean', 'example' => 'true'], + 'sshKey' => [ + 'title' => '', + 'description' => 'Enterprise public key', 'type' => 'object', 'properties' => [ - 'result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'publicKey' => ['title' => '', 'description' => 'Enterprise public key', 'type' => 'string', 'example' => 'assssssssssss'], + 'id' => ['title' => '', 'description' => 'Enterprise public key ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => '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.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"sshKey\\": {\\n \\"publicKey\\": \\"assssssssssss\\",\\n \\"id\\": 123\\n }\\n}","type":"json"}]', + 'title' => 'Create Enterprise Public Key', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSshKey'], + ], ], + 'ramActions' => [], + ], + 'CreateTag' => [ + 'summary' => 'Tag a code repository.', + 'path' => '/repository/{repositoryId}/tags/create', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], @@ -10580,75 +4495,33 @@ [ 'name' => 'organizationId', 'in' => 'query', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '60de7a6852743a5162b5f957', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The organization ID. You can find this ID in your Alibaba Cloud DevOps URL, for example: https\\://devops.aliyun.com/organization/{organizationId}.', '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", - ], + 'schema' => ['description' => 'The personal access token. This is not required when authenticating with an Alibaba Cloud AccessKey pair (AK/SK) or temporary credentials from the Security Token Service (STS).', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], ], [ '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', - ], + 'schema' => ['description' => 'The ID of the repository.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2080972', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', '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', - ], + 'tagName' => ['description' => 'The tag name.', 'type' => 'string', 'required' => true, 'example' => 'v1.0', 'title' => ''], + 'ref' => ['description' => 'The reference from which the tag is created. This can be a branch name, another tag, or a commit SHA.', 'type' => 'string', 'required' => true, 'example' => 'master', 'title' => ''], + 'message' => ['description' => 'The message for the tag.', 'type' => 'string', 'required' => false, 'example' => '描述信息', 'title' => ''], ], - 'required' => false, + 'required' => true, + 'title' => '', + 'example' => '', ], ], ], @@ -10656,167 +4529,171 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Response schema', '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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9'], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'result' => [ - 'description' => '', + 'description' => 'The details of the created tag.', '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', + 'id' => ['description' => 'The tag ID.', 'type' => 'string', 'example' => '0e3b6aa5eab2b086b59fde74766b28d4e5faab0d', 'title' => ''], + 'name' => ['description' => 'The tag name.', 'type' => 'string', 'example' => 'v1.0', 'title' => ''], + 'message' => ['description' => 'The tag message.', 'type' => 'string', 'example' => '描述内容', 'title' => ''], + 'commit' => [ + 'description' => 'Details of the commit that the tag points to.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The commit ID.', 'type' => 'string', 'example' => 'e0297d8fb0393c833a8531e7cc8832739e3cba6d', 'title' => ''], + 'shortId' => ['description' => 'The short commit ID.', 'type' => 'string', 'example' => 'e0297d8f', 'title' => ''], + 'title' => ['description' => 'The commit title, which is the first line of the commit message.', 'type' => 'string', 'example' => '提交标题'."\n", 'title' => ''], + 'message' => ['description' => 'The body of the commit message.', 'type' => 'string', 'example' => '具体的提交内容'."\n", 'title' => ''], + 'createdAt' => ['description' => 'The creation time of the commit.', 'type' => 'string', 'example' => '2022-03-18 10:00:00', 'title' => ''], + 'authorName' => ['description' => 'The author name.', 'type' => 'string', 'example' => '阿里云云效', 'title' => ''], + 'authorEmail' => ['description' => 'The author\'s email address.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + 'authoredDate' => ['description' => 'The time when the commit was authored.', 'type' => 'string', 'example' => '2022-03-18 10:00:00', 'title' => ''], + 'committerName' => ['description' => 'The committer name.', 'type' => 'string', 'example' => '阿里云云效committer', 'title' => ''], + 'committerEmail' => ['description' => 'The committer\'s email address.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + 'committedDate' => ['description' => 'The time when the commit was committed.', 'type' => 'string', 'example' => '2022-03-18 09:00:00', 'title' => ''], + 'parentIds' => [ + 'description' => 'The parent commit IDs.', + 'type' => 'array', + 'items' => ['description' => 'A parent commit ID.', 'type' => 'string', 'example' => '34d2c47c7ce46a5c4639c5ffe208a66dda975a05', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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', + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => '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.', 'description' => ''], + ], ], - 'schemes' => [ - 'https', + '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\\": \\"username@example.com\\",\\n \\"authoredDate\\": \\"2022-03-18 10:00:00\\",\\n \\"committerName\\": \\"阿里云云效committer\\",\\n \\"committerEmail\\": \\"username@example.com\\",\\n \\"committedDate\\": \\"2022-03-18 09:00:00\\",\\n \\"parentIds\\": [\\n \\"34d2c47c7ce46a5c4639c5ffe208a66dda975a05\\"\\n ]\\n }\\n }\\n}","type":"json"}]', + 'title' => 'Create Tag ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTag'], + ], ], + 'ramActions' => [], + ], + 'CreateTestCase' => [ + 'summary' => 'Create a test case in the use case library.', + 'path' => '/organization/{organizationId}/testhub/testcase', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'create'], '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', - ], + 'schema' => ['description' => 'Get the organization ID from the URL of your Alibaba Cloud DevOps page, for example: https\\://devops.aliyun.com/organization/{organizationId}.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'reviewOpinion' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PASS', - ], - 'reviewComment' => [ - 'description' => '', - 'type' => 'string', + 'subject' => ['description' => 'The title of the test case.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '测试工作项'], + 'assignedTo' => ['description' => 'The ID of the assignee.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '19xxxx31947xxxx'], + 'spaceIdentifier' => ['description' => 'The ID of the test case library.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'asd345xxxxx9q9845xxxxx34'], + 'directoryIdentifier' => ['description' => 'The ID of the directory.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'fdd395xxxxx9q9845xxxxx23'."\n"], + 'priority' => ['description' => 'The priority of the test case.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'ik3dexxxxxfdfds1xxxxx23'], + 'tags' => [ + 'title' => '', + 'description' => 'A list of tag IDs.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the tag.', 'type' => 'string', 'required' => false, 'example' => 'opwxsxxxxxf5434xxxxx12', 'title' => ''], 'required' => false, 'example' => '', ], - 'draftCommentIds' => [ - 'description' => '', + 'fieldValueList' => [ + 'title' => '', + 'description' => 'A list of custom fields.', 'type' => 'array', 'items' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'Call the `ListTestCaseAllFields` operation to identify which custom fields are required. A field is required if its `isRequired` parameter is `true`.', + 'type' => 'object', + 'properties' => [ + 'fieldIdentifier' => ['description' => 'The ID of the field.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '6aexxxxxa1d98c09c60xxxx16'], + 'value' => ['description' => 'The value of the field.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '77c7fb03c4186c8691d6...'], + ], 'required' => false, - 'example' => 'f0b1e61db5961df5975a93f9129d2513', + 'title' => '', + 'example' => '', ], 'required' => false, + 'example' => '', + ], + 'testcaseStepContentInfo' => [ + 'title' => '', + 'description' => 'Contains the details of the test case steps.', + 'type' => 'object', + 'properties' => [ + 'precondition' => ['description' => 'The precondition for the test case.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '前置条件内容'], + 'stepType' => [ + 'description' => 'The format of the test step. Supported values are `TABLE` and `TEXT`.', + 'enumValueTitles' => ['TABLE' => 'TABLE', 'TEXT' => 'TEXT'], + 'type' => 'string', + 'required' => true, + 'enum' => ['TEXT', 'TABLE'], + 'title' => '', + 'example' => 'TEXT', + ], + 'stepResultList' => [ + 'title' => '', + 'description' => 'A list of objects defining each test step and its expected result. If `stepType` is `TEXT`, only the first object is processed, and its content can be formatted. If `stepType` is `TABLE`, all objects are processed, but their content cannot be formatted.', + 'type' => 'array', + 'items' => [ + 'description' => 'The test step (`step`) and its expected result (`expected`).', + 'type' => 'object', + 'properties' => [ + 'step' => ['description' => 'The test step.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '测试第一步骤'], + 'expected' => ['description' => 'The expected result.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '测试第一步预期结果'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -10824,117 +4701,190 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response schema.', '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' => '', + 'requestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '18E50717-93A4-53BC-A30D-963F742A1CE6'], + 'errorMsg' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'error'], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'testcase' => [ + 'description' => 'The test case object.', 'type' => 'object', 'properties' => [ - 'result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'identifier' => ['description' => 'The ID of the test case.', 'type' => 'string', 'title' => '', 'example' => '5a73f81c834d013361d92bdcce'], + 'subject' => ['description' => 'The subject of the test case.', 'type' => 'string', 'title' => '', 'example' => '标题'], + 'assignedTo' => [ + 'title' => '', + 'description' => 'Information about the assignee.', + 'type' => 'object', + 'properties' => [ + 'assignIdentifier' => ['description' => 'The ID of the assignee.', 'type' => 'string', 'title' => '', 'example' => '134xxx343xxxxx'], + 'name' => ['description' => 'The name of the assignee.', 'type' => 'string', 'title' => '', 'example' => '人员名称'], + 'tbRoleId' => ['description' => 'The ID of the user role.', 'type' => 'string', 'title' => '', 'example' => '3c2253c22xxxxxxxx53a'], + ], + 'example' => '', + ], + 'spaceIdentifier' => ['description' => 'The ID of the test case library.', 'type' => 'string', 'title' => '', 'example' => 'a18571eba8fe9267cd8375fc06'], + 'spaceType' => ['description' => 'The type of the space. The value is always `TestRepo`.', 'type' => 'string', 'title' => '', 'example' => 'TestRepo'."\n" + ."\n"], + 'categoryIdentifier' => ['description' => 'The ID of the work item type. The value is typically `TestCase`.', 'type' => 'string', 'title' => '', 'example' => 'TestCase'."\n" + ."\n"], + 'creator' => [ + 'title' => '', + 'description' => 'Information about the creator.', + 'type' => 'object', + 'properties' => [ + 'createIdentifier' => ['description' => 'The ID of the creator.', 'type' => 'string', 'title' => '', 'example' => '134xxx343xxxxx'], + 'name' => ['description' => 'The name of the creator.', 'type' => 'string', 'title' => '', 'example' => '人员名称'], + ], + 'example' => '', + ], + 'modifier' => [ + 'title' => '', + 'description' => 'Information about the modifier.', + 'type' => 'object', + 'properties' => [ + 'modifyIdentifier' => ['description' => 'The ID of the modifier.', 'type' => 'string', 'title' => '', 'example' => '134xxx343xxxxx'], + 'name' => ['description' => 'The name of the modifier.', 'type' => 'string', 'title' => '', 'example' => '人员名称'], + ], + 'example' => '', + ], + 'directory' => [ + 'title' => '', + 'description' => 'Information about the directory.', + 'type' => 'object', + 'properties' => [ + 'directoryIdentifier' => ['description' => 'The ID of the directory.', 'type' => 'string', 'title' => '', 'example' => '0bc1150dcxxxxxxxx04c'], + 'name' => ['description' => 'The name of the directory.', 'type' => 'string', 'title' => '', 'example' => '全部目录'], + 'pathName' => [ + 'title' => '', + 'description' => 'The full directory path of the test case.', + 'type' => 'array', + 'items' => ['description' => 'The sequence of directories in the path.', 'type' => 'string', 'example' => '[一级目录,二级目录]', 'title' => ''], + 'example' => '', + ], + 'childIdentifier' => ['description' => 'The ID of the subdirectory.', 'type' => 'string', 'title' => '', 'example' => '0bc1150dcxxxxxxxx04c'], + ], + 'example' => '', + ], + 'detailInfo' => [ + 'title' => '', + 'description' => 'Details of the test case.', + 'type' => 'object', + 'properties' => [ + 'stepType' => ['description' => 'The type of the test step. Valid values: `TEXT`, `TABLE`.', 'type' => 'string', 'title' => '', 'example' => 'TEXT/TABLE'], + 'precondition' => [ + 'title' => '', + 'description' => 'The precondition object.', + 'type' => 'object', + 'properties' => [ + 'preIdentifier' => ['description' => 'The ID of the precondition.', 'type' => 'string', 'title' => '', 'example' => '59253164xxxxxxf2e98dbc7e27'], + 'preContent' => ['description' => 'The content of the precondition.', 'type' => 'string', 'title' => '', 'example' => '前置条件内容'], + 'preContentType' => ['description' => 'The format of the precondition\'s content, such as `RICHTEXT`.', 'type' => 'string', 'title' => '', 'example' => 'RICHTEXT'], + ], + 'example' => '', + ], + 'stepContent' => [ + 'title' => '', + 'description' => 'The test step object.', + 'type' => 'object', + 'properties' => [ + 'stepIdentifier' => ['description' => 'The ID of the test step.', 'type' => 'string', 'title' => '', 'example' => '59253164xxxxxxf2e98dbc7e27'], + 'stepContent' => ['description' => 'The content of the test step.', 'type' => 'string', 'title' => '', 'example' => '测试步骤内容'], + 'stepContentType' => ['description' => 'The format of the test step\'s content, such as `RICHTEXT`.', 'type' => 'string', 'title' => '', 'example' => 'RICHTEXT'], + ], + 'example' => '', + ], + 'expectedResult' => [ + 'title' => '', + 'description' => 'The expected result object.', + 'type' => 'object', + 'properties' => [ + 'expectIdentifier' => ['description' => 'The ID of the expected result.', 'type' => 'string', 'title' => '', 'example' => '59253164xxxxxxf2e98dbc7e27'], + 'expectContent' => ['description' => 'The content of the expected result.', 'type' => 'string', 'title' => '', 'example' => '预期结果'], + 'expectContentType' => ['description' => 'The format of the expected result\'s content, such as `RICHTEXT`.', 'type' => 'string', 'title' => '', 'example' => 'RICHTEXT'], + ], + 'example' => '', + ], + ], + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Openapi.RequestError', 'errorMessage' => 'request error', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'Operate.NoPermission', 'errorMessage' => 'NoPermission', 'description' => 'You are not authorized to perform this operation.'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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"}]', + 'title' => 'Creation of a test case ', + 'description' => 'When creating a test case in the use case library, you must use `aliyunPk` for user information.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTestCase'], + ], ], + 'ramActions' => [], + ], + 'CreateUserKey' => [ + 'summary' => 'Creates an SSH key for the current user.', + 'path' => '/api/v3/user/keys/create', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'query', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['description' => 'The organization ID. You can get this ID from your organization\'s URL in Alibaba Cloud DevOps, for example, https\\://devops.aliyun.com/organization/{organizationId}.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx', 'title' => ''], ], [ 'name' => 'accessToken', 'in' => 'query', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '0cf2c8458ac44d9481aab2dd6ec10596v3'."\n", - ], + 'schema' => ['description' => 'The personal access token. This parameter is not required when you authenticate by using an Alibaba Cloud AccessKey pair (AK/SK) or a Security Token Service (STS) temporary credential.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513'."\n", 'title' => ''], ], [ - 'name' => 'repositoryId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '2369234', - ], - ], - [ - 'name' => 'localId', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'publicKey' => ['description' => 'The content of the public key.', 'type' => 'string', 'required' => true, 'example' => 'xxx', 'title' => ''], + 'title' => ['description' => 'The title of the SSH key.', 'type' => 'string', 'required' => true, 'example' => 'SSH Title', 'title' => ''], + 'keyScope' => ['description' => 'The scope of the key. Valid values: ALL and READ.'."\n" + ."\n" + .'- ALL: Allows read and write operations, including clone, pull, and push.'."\n" + ."\n" + .'- READ: Allows read-only operations, such as clone and pull.', 'type' => 'string', 'required' => true, 'example' => 'ALL', 'title' => ''], + 'expireTime' => ['description' => 'The expiration time.', 'type' => 'string', 'required' => false, 'example' => '2022-03-12 12:00:00', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -10942,609 +4892,338 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response body.', '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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'result' => [ - 'description' => '', + 'description' => 'The result of the request.', 'type' => 'object', 'properties' => [ - 'result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'id' => ['description' => 'The primary key ID of the SSH key.', 'type' => 'integer', 'format' => 'int64', 'example' => '11072', 'title' => ''], + 'title' => ['description' => 'The title of the SSH key.', 'type' => 'string', 'example' => 'My Title', 'title' => ''], + 'publicKey' => ['description' => 'The content of the public key.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'fingerPrint' => ['description' => 'The fingerprint of the SSH key.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'keyScope' => ['description' => 'The scope of the SSH key. Valid values: ALL and READ.'."\n" + ."\n" + .'- ALL: Allows read and write operations, including clone, pull, and push.'."\n" + ."\n" + .'- READ: Allows read-only operations, such as clone and pull.', 'type' => 'string', 'example' => 'ALL', 'title' => ''], + 'createdAt' => ['description' => 'The time when the SSH key was created.', 'type' => 'string', 'example' => '2022-03-12 12:00:00', 'title' => ''], + 'expireTime' => ['description' => 'The expiration time of the SSH key.', 'type' => 'string', 'example' => '2022-03-12 12:00:00', 'title' => ''], + 'lastUsedTime' => ['description' => 'The time when the SSH key was last used.', 'type' => 'string', 'example' => '2022-03-12 12:00:00', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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"}]', + 'title' => 'Create a user SSH key ', + 'changeSet' => [], + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateUserKey'], + ], ], - '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', - ], + 'CreateVariableGroup' => [ + 'summary' => 'You can create a variable group.', + 'path' => '/organization/{organizationId}/variableGroups', + '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', - ], + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, such as https://devops.aliyun.com/organization/【OrganizationId】.', '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' => 'name', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Variable group name', 'type' => 'string', 'required' => true, 'example' => '变量组'], ], [ - 'name' => 'repositoryId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '2464454', - ], + 'name' => 'description', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Variable group description', 'type' => 'string', 'required' => false, 'example' => '变量组描述'], ], [ - 'name' => 'localId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'name' => 'variables', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'JSON string containing variable information: isEncrypted (whether encrypted), name (variable name), and value (variable value).', 'type' => 'string', 'required' => true, 'example' => '[{"isEncrypted":true,"name":"name1","value":"vaue1"}]'], ], ], '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', - ], - ], - ], + 'requestId' => ['title' => '', 'description' => 'Request ID. Each request has a unique value, which facilitates troubleshooting later.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => '”“'], + 'errorCode' => ['title' => '', 'description' => 'Error code', 'type' => 'string', 'example' => '”“'], + 'success' => ['title' => '', 'description' => 'true if the API call succeeded; false if the API call failed.', 'type' => 'boolean', 'example' => 'true'], + 'variableGroupId' => ['title' => '', 'description' => 'ID of the newly created variable group', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => '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.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"errorCode\\": \\"”“\\",\\n \\"success\\": true,\\n \\"variableGroupId\\": 1234\\n}","type":"json"}]', + 'title' => 'Create a variable group', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateVariableGroup'], + ], ], - '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"}]', + 'ramActions' => [], ], - 'ListMergeRequestPatchSets' => [ - 'summary' => '查询合并请求的版本列表', - 'path' => '/api/v4/projects/merge_requests/diffs/list_patchsets', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'CreateWorkitem' => [ + 'path' => '/organization/{organizationId}/workitems/create', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURErdc3GIDZJ'], ], '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' => '', - ], + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'Organization identifier, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access URL, for example: https://devops.aliyun.com/organization/【OrganizationId】 '."\n", 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ - 'name' => 'localId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '4', - ], - ], - ], - 'responses' => [ - 200 => [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Request structure. ', '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' => '', + 'subject' => ['title' => '', 'description' => 'Work item title ', 'type' => 'string', 'required' => true, 'example' => '测试工作项'], + 'description' => ['title' => '', 'description' => 'Work item content ', 'type' => 'string', 'required' => false, 'example' => '测试内容'], + 'descriptionFormat' => ['title' => '', 'description' => 'Content format. Supports RICHTEXT and MARKDOWN formats. The default is RICHTEXT.', 'type' => 'string', 'required' => false, 'example' => 'RICHTEXT'], + 'assignedTo' => ['title' => '', 'description' => 'The account ID of the work item owner, or the username within the enterprise', 'type' => 'string', 'required' => true, 'example' => '19xxxx31947xxxx'], + 'space' => ['title' => '', 'description' => 'Unique identifier of the project, equivalent to projectId', 'type' => 'string', 'required' => true, 'example' => 'asd345xxxxx9q9845xxxxx34'], + 'spaceIdentifier' => ['title' => '', 'description' => 'Same as the space field; UUID of the project ID ', 'type' => 'string', 'required' => true, 'example' => 'asd345xxxxx9q9845xxxxx34'], + 'spaceType' => ['title' => '', 'description' => 'Resource type ', 'type' => 'string', 'required' => true, 'example' => 'Project'], + 'category' => ['title' => '', 'description' => 'Type ID of the work item, such as the ID corresponding to Bug or Task', 'type' => 'string', 'required' => true, 'example' => 'Req'], + 'workitemType' => ['title' => '', 'description' => 'Work item subtype ID ', 'type' => 'string', 'required' => true, 'example' => '9uyxxxxxre573f561dxxn40'], + 'fieldValueList' => [ + 'title' => '', + 'description' => 'Custom Fields', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'You must first call the API to retrieve work item fields: ListWorkItemAllFields, to check which fields are required. Fields with isRequired set to true are required. '."\n" + .'【Priority】 is a custom field but is required.'."\n", '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', - ], + 'fieldIdentifier' => ['title' => '', 'description' => 'UUID of the field. This field is required for the Priority field.', 'type' => 'string', 'required' => false, 'example' => '6aexxxxxa1d98c09c60xxxx16'], + 'value' => ['title' => '', 'description' => 'Field Value to be written. This field is required for the Priority field.', 'type' => 'string', 'required' => false, 'example' => '77c7fb03c4186c8691d6...'], + 'workitemIdentifier' => ['title' => '', 'description' => 'UUID of the work item. Not currently used.', 'type' => 'string', 'required' => false, 'example' => 'null'], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => false, + 'example' => '', ], + 'sprint' => [ + 'title' => '', + 'description' => 'Iteration to associate ', + 'type' => 'array', + 'items' => ['description' => 'UUID of the iteration ', 'type' => 'string', 'required' => false, 'example' => '81be62xxxxxb63e291bdcxxxxa4', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'tracker' => [ + 'title' => '', + 'description' => 'Account ID of a carbon copy recipient', + 'type' => 'array', + 'items' => ['description' => 'Account ID of a carbon copy recipient', 'type' => 'string', 'required' => false, 'example' => '1561159309......', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'participant' => [ + 'title' => '', + 'description' => 'Account ID of a participant', + 'type' => 'array', + 'items' => ['description' => 'Account ID of a participant', 'type' => 'string', 'required' => false, 'example' => '1561159309......', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'verifier' => [ + 'title' => '', + 'description' => 'Account ID of a verifier', + 'type' => 'array', + 'items' => ['description' => 'Account ID of a verifier', 'type' => 'string', 'required' => false, 'example' => '1561159309......', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'parent' => ['title' => '', 'description' => 'UUID of the parent work item ', 'type' => 'string', 'required' => false, 'example' => '3a0c9cdd24ae1e1995b8...'], ], - ], - ], - ], - '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, + 'title' => '', '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' => '', + 'requestId' => ['title' => '', 'description' => 'Request ID. Each request has a unique value to facilitate troubleshooting.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMsg' => ['title' => '', 'description' => 'Error message ', 'type' => 'string', 'example' => 'error'], + 'errorCode' => ['title' => '', 'description' => 'error code', 'type' => 'string', 'example' => 'Openapi.RequestError'], + 'success' => ['title' => '', 'description' => 'true or false', 'type' => 'boolean', 'example' => 'true'], + 'workitem' => [ + 'title' => '', + 'description' => 'Work item information', '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', - ], - ], - ], - ], + 'identifier' => ['title' => '', 'description' => 'UUID of the work item', 'type' => 'string', 'example' => 'e8bxxxxxxxxxxxxxxxx23'], + 'subject' => ['title' => '', 'description' => 'Work Item Title', 'type' => 'string', 'example' => '测试工作项'], + 'document' => ['title' => '', 'description' => 'Work Item Content', 'type' => 'string', 'example' => 'html格式'], + 'assignedTo' => ['title' => '', 'description' => 'Alibaba Cloud accountId of the owner', 'type' => 'string', 'example' => '19xx7043xxxxxxx914'], + 'status' => ['title' => '', 'description' => 'Name of the status', 'type' => 'string', 'example' => '待处理'], + 'statusStageIdentifier' => ['title' => '', 'description' => 'Status stage ID', 'type' => 'string', 'example' => '100005'], + 'spaceIdentifier' => ['title' => '', 'description' => 'Project ID', 'type' => 'string', 'example' => 'e8b26xxxxx6e76aa20xxxxx23'], + 'spaceName' => ['title' => '', 'description' => 'Name of the project to which the work item belongs', 'type' => 'string', 'example' => '需求项目'], + 'spaceType' => ['title' => '', 'description' => 'Project Mode', 'type' => 'string', 'example' => 'Project'], + 'logicalStatus' => ['title' => '', 'description' => 'Logical status', 'type' => 'string', 'example' => 'NORMAL'], + 'categoryIdentifier' => ['title' => '', 'description' => 'Category ID of the Work Item', 'type' => 'string', 'example' => 'Req'], + 'parentIdentifier' => ['title' => '', 'description' => 'Parent Work Item ID', 'type' => 'string', 'example' => 'e8bxxxxxxxxxxxxxxxx24'], + 'workitemTypeIdentifier' => ['title' => '', 'description' => 'Work Item Type ID', 'type' => 'string', 'example' => '9uxxxxxxre573f5xxxxxx0'], + 'updateStatusAt' => ['title' => '', 'description' => 'Time when the status was updated', 'type' => 'integer', 'format' => 'int64', 'example' => '1640850328000'], + 'serialNumber' => ['title' => '', 'description' => 'Serial number', 'type' => 'string', 'example' => 'ABCD-1'], + 'gmtCreate' => ['title' => '', 'description' => 'UNIX timestamp of the Creation Time, in milliseconds', 'type' => 'integer', 'format' => 'int64', 'example' => '1640850318000'], + 'gmtModified' => ['title' => '', 'description' => 'UNIX timestamp of the modification time, in milliseconds', 'type' => 'integer', 'format' => 'int64', 'example' => '1640850318000'], + 'creator' => ['title' => '', 'description' => 'Alibaba Cloud account ID of the Creator', 'type' => 'string', 'example' => '19xx7043xxxxxxx914'], + 'modifier' => ['title' => '', 'description' => 'Alibaba Cloud account ID of the Updated By', 'type' => 'string', 'example' => '19xx7043xxxxxxx914'], + 'statusIdentifier' => ['title' => '', 'description' => 'UUID of the status', 'type' => 'string', 'example' => '28'], + 'sprintIdentifier' => ['title' => '', 'description' => 'UUID of the iteration', 'type' => 'string', 'example' => '75528f17703e92e5a568......'], + 'documentFormat' => ['description' => 'format of the Description content, either RICHTEXT or MARKDOWN', 'type' => 'string', 'example' => 'RICHTEXT', 'title' => ''], ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Openapi.RequestError', 'errorMessage' => 'request error', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'Operate.NoPermission', 'errorMessage' => 'NoPermission', 'description' => 'You are not authorized to perform this operation.'], + ], ], - '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', + 'title' => 'Creation of a work item ', + 'summary' => 'Create a work item.', + 'changeSet' => [ + ['createdAt' => '2024-04-19T13:00:42.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-12-05T14:50:20.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-02-24T08:23:15.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-02-24T08:23:15.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-02-24T08:23:15.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-02-24T08:23:15.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateWorkitem'], + ], ], + 'ramActions' => [], + '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\\": \\"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}","type":"json"}]', + ], + 'CreateWorkitemComment' => [ + 'summary' => 'Create a work item comment.', + 'path' => '/organization/{organizationId}/workitems/comment', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURErdc3GIDZJ'], ], 'parameters' => [ [ 'name' => 'organizationId', - 'in' => 'query', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '60de7a6852743a5162b5f957', - ], + 'in' => 'path', + 'schema' => ['description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, for example: https://devops.aliyun.com/organization/【OrganizationId】 ', 'type' => 'string', 'required' => true, 'example' => '60811b5eed6e867404f6xxxx', 'title' => ''], ], [ - 'name' => 'accessToken', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'Request body ', + 'type' => 'object', + 'properties' => [ + 'content' => ['title' => '', 'description' => 'Comment content ', 'type' => 'string', 'required' => true, 'example' => '有关于黑龙江地区旅店业室内广告屏出租'], + 'workitemIdentifier' => ['title' => '', 'description' => 'Work item ID, same as workItemId, which is the UUID of the work item ', 'type' => 'string', 'required' => true, 'example' => '1e9903d8b3f12xxxxxf9286ef5'], + 'formatType' => ['title' => '', 'description' => 'Currently supports either RICHTEXT or MARKDOWN ', 'type' => 'string', 'required' => true, 'example' => 'RICHTEXT/MARKDOWN'], + 'parentId' => ['description' => 'Parent folder ID. '."\n" + ."\n" + .'> Pass **0** for the root directory. ', 'type' => 'string', 'required' => false, 'example' => '26842', 'title' => ''], + ], 'required' => false, - 'example' => 'agp_4d57a6796b3626f52064ab1fba5384a5', - ], - ], - [ - 'name' => 'repositoryIdentity', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, + 'title' => '', '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 => [ @@ -11553,223 +5232,108 @@ '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' => 'username@example.com', - ], - ], - ], - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMsg' => ['description' => 'Error message ', 'type' => 'string', 'example' => 'error', 'title' => ''], + 'errorCode' => ['description' => '- When success is false, returns a business error code. '."\n" + .'- When success is true, returns an empty value. ', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'success' => ['description' => 'Indicates whether the invocation succeeded. ', 'type' => 'string', 'example' => 'true 接口调用成功,false 接口调用失败', 'title' => ''], + 'Comment' => [ + 'description' => 'Review note. Supports up to 512 bytes.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'UUID', 'type' => 'integer', 'format' => 'int64', 'example' => '26842'], + 'content' => ['title' => '', 'description' => 'Content ', 'type' => 'string', 'example' => '有关于黑龙江地区旅店业室内广告屏出租'], + 'user' => [ + 'description' => 'User-related information', + 'type' => 'object', + 'properties' => [ + 'account' => ['description' => 'Alibaba Cloud ID ', 'type' => 'string', 'example' => '13164xxxxx41068', 'title' => ''], + 'identifier' => ['description' => 'User identifier ', 'type' => 'string', 'example' => '1e9903d8bxxxxxxe9df9286ef5', 'title' => ''], + 'realName' => ['description' => 'Real name ', 'type' => 'string', 'example' => '王五', 'title' => ''], + 'nickName' => ['description' => 'nickname ', 'type' => 'string', 'example' => '王五', 'title' => ''], + 'avatar' => ['description' => 'Link to the profile picture ', 'type' => 'string', 'example' => 'https://xxxxx/thumbnail/112m7150e256dbba0d6456bafbb65c81f90d/w/200/h/200', 'title' => ''], + 'displayName' => ['description' => 'Display name ', 'type' => 'string', 'example' => '王五', 'title' => ''], + 'targetType' => ['description' => 'resource type ', 'type' => 'string', 'example' => 'workitem', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'targetType' => ['description' => 'resource type', 'type' => 'string', 'example' => 'workitem', 'title' => ''], + 'targetIdentifier' => ['description' => 'Resource ID, which is the project ID.', 'type' => 'string', 'example' => '79d523806bdxxxxx95612a5154', 'title' => ''], + 'parentId' => ['description' => 'Parent pipeline ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '26842', 'title' => ''], + 'createTime' => ['description' => 'Creation Time', 'type' => 'integer', 'format' => 'int64', 'example' => '1667202662000', 'title' => ''], + 'modifiedTime' => ['description' => 'Updated At', 'type' => 'integer', 'format' => 'int64', 'example' => '1637995553000', 'title' => ''], + 'isTop' => ['title' => '', 'description' => 'is pinned', 'type' => 'boolean', 'example' => 'true/false'], + 'topTime' => ['title' => '', 'description' => 'Time when pinned', 'type' => 'integer', 'format' => 'int64', 'example' => '1667202662000'], + 'formatType' => ['title' => '', 'description' => 'Comment Type', 'type' => 'string', 'example' => 'RICHTEXT/MARKDOWN '], ], + 'title' => '', + 'example' => '', ], ], + '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 \\"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\\": \\"username@example.com\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', - ], - 'ListMergeRequestComments' => [ - 'summary' => '查询合并请求评论列表', - 'path' => '/api/v4/projects/merge_requests/comments/list_comments', - 'methods' => [ - 'post', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Openapi.RequestError', 'errorMessage' => 'request error', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'Operate.NoPermission', 'errorMessage' => 'NoPermission', 'description' => 'You are not authorized to perform this operation.'], + ], ], - 'schemes' => [ - 'https', + 'title' => 'Create a work item comment ', + 'description' => 'Create a comment for a work item.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateWorkitemComment'], + ], ], + 'ramActions' => [], + '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"}]', + ], + 'CreateWorkitemEstimate' => [ + 'path' => '/organization/{organizationId}/workitems/estimate', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURErdc3GIDZJ'], ], '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', - ], + 'in' => 'path', + 'schema' => ['description' => 'Organization identifier, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, for example: https://devops.aliyun.com/organization/【OrganizationId】 ', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Request body ', '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', - ], + 'workitemIdentifier' => ['title' => '', 'description' => 'Work item ID, same as workitemId ', 'type' => 'string', 'required' => true, 'example' => '1e9903d8b3f1xxxxxf9286ef5'], + 'spentTime' => ['title' => '', 'description' => 'Spent effort, with a maximum value of 9999 ', 'type' => 'string', 'required' => true, 'example' => '21'], + 'type' => ['title' => '', 'description' => 'Effort type. Obtain valid values via the effort type retrieval API. The value is the identifier of each type. ', 'type' => 'string', 'required' => true, 'example' => '9144ef6b72d8exxxxx9e61a4d0'."\n"], + 'description' => ['title' => '', 'description' => 'Description ', 'type' => 'string', 'required' => false, 'example' => '描述信息'], + 'recordUserIdentifier' => ['title' => '', 'description' => 'Recorder, represented by the user\'s aliyunPk ', 'type' => 'string', 'required' => true, 'example' => '1316458xxxxx41068'], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -11780,625 +5344,124 @@ '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' => 'username@example.com', - ], - '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' => 'username@example.com'."\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' => 'username@example.com'."\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", - ], - ], - ], - ], - ], - ], - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMsg' => ['description' => 'Error message. ', 'type' => 'string', 'example' => 'error', 'title' => ''], + 'errorCode' => ['description' => '- When success is false, returns a business error code. '."\n" + .'- When success is true, returns an empty value. ', 'type' => 'string', 'example' => 'Openapi.RequestError', 'title' => ''], + 'success' => ['description' => 'true or false ', 'type' => 'boolean', 'example' => 'true 接口调用成功,false 接口调用失败', 'title' => ''], + 'WorkitemTimeEstimate' => [ + 'description' => 'Time estimate', + 'type' => 'object', + 'properties' => [ + 'identifier' => ['title' => '', 'description' => 'UUID of the time estimate', 'type' => 'string', 'example' => 'deafe5f33xxxxx6a259d8dafd'], + 'workitemIdentifier' => ['description' => 'Work item ID, UUID ', 'type' => 'string', 'example' => '1e9903d8b3f1xxxxxf9286ef5', 'title' => ''], + 'spentTime' => ['description' => 'Estimated work hours to be spent ', 'type' => 'integer', 'format' => 'int64', 'example' => '11', 'title' => ''], + 'type' => ['description' => 'Type of work hours ', 'type' => 'string', 'example' => '9144ef6b72d8exxxxx9e61a4d0', 'title' => ''], + 'description' => ['description' => 'Description ', 'type' => 'string', 'example' => '蜜雪冰城甜蜜蜜', 'title' => ''], + 'recordUser' => [ + 'description' => 'Information of the recording User', + 'type' => 'object', + 'properties' => [ + 'account' => [ + 'description' => 'Alibaba Cloud Account ', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => '1316458xxxxx41068', + 'title' => '', + ], + 'identifier' => ['description' => 'User ID', 'type' => 'string', 'example' => 'deafe5f33xxxxx6a259d8dafd', 'title' => ''], + 'realName' => ['description' => 'User name ', 'type' => 'string', 'example' => '王五', 'title' => ''], + 'nickName' => ['description' => 'User nickname', 'type' => 'string', 'example' => '王五', 'title' => ''], + 'avatar' => ['description' => 'Profile picture link ', 'type' => 'string', 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112m7150e256dbba0d6456bafbb65c81f90d/w/200/h/200', 'title' => ''], + 'stamp' => ['description' => 'Regular user or group ', 'type' => 'string', 'example' => 'null 代表普通用户', 'title' => ''], + 'nameEn' => ['description' => 'User name in pinyin ', 'type' => 'string', 'example' => 'wangwu', 'title' => ''], + 'gender' => ['description' => 'Gender', 'type' => 'string', 'example' => '保留字段', 'title' => ''], + 'mobile' => ['description' => 'Phone number ', 'type' => 'string', 'example' => '无效字段,保留', 'title' => ''], + 'email' => ['description' => 'Mailbox information ', 'type' => 'string', 'example' => 'xxxxxxcc@xxx.com', 'title' => ''], + 'nickNamePinyin' => ['description' => 'Pinyin of nickname', 'type' => 'string', 'example' => 'wangwu', 'title' => ''], + 'realNamePinyin' => ['description' => 'Real name in pinyin ', 'type' => 'string', 'example' => 'wangwu', 'title' => ''], + 'displayNickName' => ['description' => 'Display nickname ', 'type' => 'string', 'example' => 'wangwu', 'title' => ''], + 'displayRealName' => ['description' => 'Display real name ', 'type' => 'string', 'example' => 'wangwu', 'title' => ''], + 'displayName' => ['description' => 'Display name ', 'type' => 'string', 'example' => '王五', 'title' => ''], + 'dingTalkId' => ['description' => 'DingTalk ID', 'type' => 'string', 'example' => 'fdsad12xxx11'."\n", 'title' => ''], + 'tbRoleId' => ['description' => 'Role ID ', 'type' => 'string', 'example' => '9144ef6b72d8exxxxx9e61a4d0', 'title' => ''], + 'isDisabled' => ['description' => 'Indicates whether the user is disabled ', 'type' => 'boolean', 'example' => 'true/false', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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\\": \\"username@example.com\\",\\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\\": \\"username@example.com\\\\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\\": \\"username@example.com\\\\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', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Openapi.RequestError', 'errorMessage' => 'request error', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'Operate.NoPermission', 'errorMessage' => 'NoPermission', 'description' => 'You are not authorized to perform this operation.'], + ], ], - 'schemes' => [ - 'https', + 'title' => 'Create Work Item Estimated Effort API ', + 'summary' => 'Create an API to register the estimated hours for a work item.', + 'description' => 'Create an estimated hours API.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateWorkitemEstimate'], + ], ], + 'ramActions' => [], + '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\\": \\"xxxxxxcc@xxx.com\\",\\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"}]', + ], + 'CreateWorkitemRecord' => [ + 'summary' => 'Log actual working hours.', + 'path' => '/organization/{organizationId}/workitems/record', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '214317', - 'abilityTreeNodes' => [ - 'FEATURErdcI7YZMH', - ], + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURErdc3GIDZJ'], ], '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', - ], + 'in' => 'path', + 'schema' => ['description' => 'Organization identifier, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, for example: https://devops.aliyun.com/organization/【OrganizationId】 ', 'type' => 'string', 'required' => true, 'example' => '1e9903d8b3f1xxxxxf9286ef5', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Request body ', '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', - ], + 'workitemIdentifier' => ['title' => '', 'description' => 'Work item ID, that is, workitemId ', 'type' => 'string', 'required' => true, 'example' => '9144ef6b72d8exxxxx9e61a4d0'], + 'actualTime' => ['title' => '', 'description' => 'Actual work hours spent, with a maximum value of 9999 ', 'type' => 'string', 'required' => true, 'example' => '12'], + 'type' => ['title' => '', 'description' => 'Type, obtained from the API for retrieving work hour types ', 'type' => 'string', 'required' => true, 'example' => 'deafe5f33xxxxx6a259d8dafd'], + 'description' => ['title' => '', 'description' => 'Description ', 'type' => 'string', 'required' => false, 'example' => '测试内容'], + 'recordUserIdentifier' => ['title' => '', 'description' => 'Recorder, represented by the user\'s aliyunPk ', 'type' => 'string', 'required' => true, 'example' => '1316458xxxxx41068'], + 'gmtStart' => ['title' => '', 'description' => 'Start Time ', 'type' => 'string', 'required' => true, 'example' => '1667205617061'], + 'gmtEnd' => ['title' => '', 'description' => 'End Time; Start Time cannot be later than End Time ', 'type' => 'string', 'required' => true, 'example' => '1646323200000'], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -12409,663 +5472,174 @@ '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' => '', + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMsg' => ['description' => 'Error message. ', 'type' => 'string', 'example' => 'error', 'title' => ''], + 'errorCode' => ['description' => '- When success is false, returns a business error code. '."\n" + .'- When success is true, returns an empty value. ', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'success' => ['description' => 'true if the API call succeeded, false if the API call failed', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'WorkitemTime' => [ + 'description' => 'Working time', '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' => 'username@example.com', - ], - 'id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '19927', - ], - ], - ], - 'relatedPatchSet' => [ - 'description' => '', + 'identifier' => ['title' => '', 'description' => 'UUID of the working hours entry', 'type' => 'string', 'example' => 'deafe5f33xxxxx6a259d8dafd'], + 'workitemIdentifier' => ['title' => '', 'description' => 'Work item ID ', 'type' => 'string', 'example' => '9144ef6b72d8exxxxx9e61a4d0'], + 'actualTime' => ['description' => 'Actual working hours, in hours', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], + 'type' => ['description' => 'Type of work hours. You can obtain it by calling the API for retrieving work hour types. ', 'type' => 'string', 'example' => 'deafe5f33xxxxx6a259d8dafd', 'title' => ''], + 'description' => ['description' => 'Description ', 'type' => 'string', 'example' => '这是一段描述', 'title' => ''], + 'recordUser' => [ + 'description' => 'Information about the person who logged the hours', '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', + 'account' => ['description' => 'Alibaba Cloud account ', 'type' => 'string', 'example' => '1316458xxxxx41068', 'title' => ''], + 'identifier' => ['description' => 'User ID', 'type' => 'string', 'example' => 'deafe5f33xxxxx6a259d8dafd', 'title' => ''], + 'realName' => ['description' => 'User\'s real name', 'type' => 'string', 'example' => '王五', 'title' => ''], + 'nickName' => ['description' => 'User nickname', 'type' => 'string', 'example' => '王武', 'title' => ''], + 'avatar' => ['description' => 'Profile picture', 'type' => 'string', 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112m7150e256dbba0d6456bafbb65c81f90d/w/200/h/200', 'title' => ''], + 'stamp' => ['description' => 'Regular user or group', 'type' => 'string', 'example' => 'null标识普通用户', 'title' => ''], + 'nameEn' => ['description' => 'User\'s English name', 'type' => 'string', 'example' => 'wangwu', 'title' => ''], + 'gender' => ['description' => 'Gender', 'type' => 'string', 'example' => '保留字段', 'title' => ''], + 'mobile' => ['description' => 'Phone number', 'type' => 'string', 'example' => '保留字段', 'title' => ''], + 'email' => ['description' => 'Mailbox address ', 'type' => 'string', 'example' => 'xxx@xxx.com', 'title' => ''], + 'nickNamePinyin' => ['description' => 'Pinyin of nickname', 'type' => 'string', 'example' => 'wangwu'."\n", 'title' => ''], + 'realNamePinyin' => ['description' => 'Pinyin of real name', 'type' => 'string', 'example' => 'wangwu', 'title' => ''], + 'displayNickName' => ['description' => 'Display nickname ', 'type' => 'string', 'example' => '王五', 'title' => ''], + 'displayRealName' => ['description' => 'Displayed real name', 'type' => 'string', 'example' => '王五', 'title' => ''], + 'displayName' => ['description' => 'Display name', 'type' => 'string', 'example' => '王五', 'title' => ''], + 'dingTalkId' => ['description' => 'DingTalk ID', 'type' => 'string', 'example' => 'xx12322', 'title' => ''], + 'tbRoleId' => ['description' => 'Role ID ', 'type' => 'string', 'example' => '1e9903d8b3f1xxxxxf9286ef5', 'title' => ''], + 'isDisabled' => ['description' => 'Visibility status ', 'type' => 'boolean', 'example' => 'true/false', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'gmtStart' => ['description' => 'Start Time ', 'type' => 'integer', 'format' => 'int64', 'example' => '1667205617061', 'title' => ''], + 'gmtEnd' => ['description' => 'End Time ', 'type' => 'integer', 'format' => 'int64', 'example' => '1667205617089', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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\\": \\"username@example.com\\",\\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', - ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Openapi.RequestError', 'errorMessage' => 'request error', 'description' => ''], ], - [ - 'name' => 'maxDiffByte', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '24 * 1024 * 1024', - 'format' => 'int32', - 'required' => false, - 'type' => 'integer', - ], + 403 => [ + ['errorCode' => 'Operate.NoPermission', 'errorMessage' => 'NoPermission', 'description' => 'You are not authorized to perform this operation.'], ], ], - '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' => 'username@example.com', - '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' => 'username@example.com', - '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' => 'username@example.com', - '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' => 'username@example.com', - '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', - ], + 'title' => 'Log Actual Work Hours ', + 'description' => 'Log actual working hours.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateWorkitemRecord'], ], ], - '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\\": \\"username@example.com\\",\\n \\"authoredDate\\": \\"2023-01-03T15:41:26+08:00\\",\\n \\"createdAt\\": \\"2023-01-03T15:41:26+08:00\\",\\n \\"committerName\\": \\"云效CodeupCommitter\\",\\n \\"committerEmail\\": \\"username@example.com\\",\\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\\": \\"username@example.com\\",\\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\\": \\"username@example.com\\",\\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"}]', + 'ramActions' => [], + '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\\": \\"xxx@xxx.com\\",\\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"}]', ], - 'CreateCommitStatus' => [ - 'summary' => '创建提交状态记录', - 'path' => '/api/v4/projects/repository/commit_statuses/create_commit_status', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateWorkitemV2' => [ + 'summary' => 'Create work items for a project, such as requirements, defects, tasks, risks, and themes.', + 'path' => '/organization/{organizationId}/workitem', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => [], + 'produces' => [], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURErdc3GIDZJ'], ], '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', - ], + 'in' => 'path', + 'schema' => ['description' => 'The organization ID. You can find this ID in the URL of your organization on Alibaba Cloud DevOps, for example, `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'state' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'success', + 'subject' => ['description' => 'The title of the work item.', 'type' => 'string', 'required' => true, 'example' => '测试工作项', 'title' => ''], + 'description' => ['description' => 'The description. To upload an image, we recommend using images smaller than 1 MB. To insert an image, use the following format: \\<img src="data:image/png;base64,\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*****"/> where ****the asterisks (\\*\\*) represent the Base64-encoded image content, and `png` is the image format. Replace `png` with the actual image format.', 'type' => 'string', 'required' => false, 'example' => '测试内容', 'title' => ''], + 'assignedTo' => ['description' => 'The assignee ID.', 'type' => 'string', 'required' => true, 'example' => '19xxxx31947xxxx', 'title' => ''], + 'spaceIdentifier' => ['description' => 'The unique identifier of the project.', 'type' => 'string', 'required' => true, 'example' => 'asd345xxxxx9q9845xxxxx34', 'title' => ''], + 'category' => ['description' => 'The category of the work item. Valid values: `Req`, `Bug`, `Task`, and `Topic`.', 'type' => 'string', 'required' => true, 'example' => 'Req', 'title' => ''], + 'workitemTypeIdentifier' => ['description' => 'The ID of the work item type. Call the [Get Workitem Types API](https://help.aliyun.com/document_detail/460485.html) to get the available types for the project.', 'type' => 'string', 'required' => true, 'example' => '9uy29901re573f561d69jn40', 'title' => ''], + 'fieldValueList' => [ + 'description' => 'A list of field values. Call the [Get Workitem Fields List API](https://help.aliyun.com/document_detail/460486.html) to determine the available fields for the specified work item type.', + 'type' => 'array', + 'items' => [ + 'description' => 'A single field-value pair.', + 'type' => 'object', + 'properties' => [ + 'fieldIdentifier' => ['description' => 'The unique identifier of the field.', 'type' => 'string', 'required' => false, 'example' => '6aexxxxxa1d98c09c60xxxx16', 'title' => ''], + 'value' => ['description' => 'The field value.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'description' => [ - 'description' => '', - 'type' => 'string', + 'parentIdentifier' => ['description' => 'The parent work item ID.', 'type' => 'string', 'required' => false, 'example' => '11223331122', 'title' => ''], + 'versions' => [ + 'description' => 'A list of unique version identifiers.', + 'type' => 'array', + 'items' => ['description' => 'The unique identifier of the version.', 'type' => 'string', 'required' => false, 'example' => '[1111,1223]', 'title' => ''], 'required' => false, + 'title' => '', 'example' => '', ], - 'targetUrl' => [ - 'description' => '', - 'type' => 'string', + 'sprintIdentifier' => ['description' => 'The unique identifier of the sprint.', 'type' => 'string', 'required' => false, 'example' => '455532323455', 'title' => ''], + 'tags' => [ + 'description' => 'A list of unique tag identifiers.', + 'type' => 'array', + 'items' => ['description' => 'The unique identifier of the tag.', 'type' => 'string', 'required' => false, 'example' => '[1112,3344]', 'title' => ''], 'required' => false, - 'example' => 'xxx', + 'title' => '', + 'example' => '', ], - 'context' => [ - 'description' => '', - 'type' => 'string', + 'trackers' => [ + 'description' => 'A list of tracker account IDs.', + 'type' => 'array', + 'items' => ['description' => 'The tracker account ID.', 'type' => 'string', 'required' => false, 'example' => '1123344', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'participants' => [ + 'description' => 'A list of participant account IDs.', + 'type' => 'array', + 'items' => ['description' => 'The participant account ID.', 'type' => 'string', 'required' => false, 'example' => '1234454', 'title' => ''], 'required' => false, - 'example' => 'default', + 'title' => '', + 'example' => '', ], + 'verifier' => ['description' => 'The verifier\'s account ID.', 'type' => 'string', 'required' => false, 'example' => '1561159309......', 'title' => ''], ], 'required' => false, + 'docRequired' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -13073,542 +5647,142 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response schema', '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', - ], - ], - ], - ], - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The unique request ID. Use this ID for troubleshooting.', 'type' => 'string', 'example' => 'EAE03103-5497-58D1-9169-E524DDE8604C'], + 'errorCode' => ['description' => '- The error code returned if the request fails (when `success` is `false`).'."\n" + ."\n" + .'- An empty string is returned if the request succeeds (when `success` is `true`).', 'type' => 'string', 'example' => 'InvalidTagGroup.IdNotFound', 'title' => ''], + 'errorMessage' => ['description' => '- The error message returned if the request fails (when `success` is `false`).'."\n" + ."\n" + .'- An empty string is returned if the request succeeds (when `success` is `true`).', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'workitemIdentifier' => ['description' => 'The unique identifier of the work item.', 'type' => 'string', 'example' => '11234455454355', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Openapi.RequestError', 'errorMessage' => 'request error', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'Operate.NoPermission', 'errorMessage' => 'NoPermission', 'description' => 'You are not authorized to perform this operation.'], + ], ], - '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create Work Item (Requirement/Bug/Job) ', + 'description' => 'See the [Get work item field information](https://help.aliyun.com/document_detail/460486.html) and [Get work item types in a project](https://help.aliyun.com/document_detail/460485.html) APIs for details about which fields to complete.'."\n" + ."\n" + .'To upload an image to the description area, ensure its size does not exceed 5 MB. We recommend uploading images smaller than 1 MB. In the `description` field, insert the image using the following format:'."\n" + .'\\<img src="data:image/png;base64,\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*****"/>'."\n" + .'In this format, ****the string of asterisks represents the base64 encoding of the image content, and `png` is the image format. Replace `png` with the actual format of your image.', + 'responseParamsDescription' => 'workitemIdentifier is the work item ID returned upon successful creation.', + 'changeSet' => [ + ['createdAt' => '2023-09-10T02:07:37.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateWorkitemV2'], + ], ], + 'ramActions' => [], + '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"}]', + ], + 'DeleteAppMember' => [ + 'summary' => 'Deletes an app member.', + 'path' => '/appstack/apps/{appName}/members', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], + 'tags' => ['应用'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'query', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['description' => 'The organization ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '66c0c9fffeb86b450c199fcd', 'title' => ''], ], [ - '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' => 'appName', + 'in' => 'path', + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'testApp', 'title' => ''], ], [ - 'name' => 'page', + 'name' => 'subjectType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The member type. The only supported value is User.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'User', 'title' => ''], ], [ - 'name' => 'pageSize', + 'name' => 'subjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => 'The member ID. If the member type is User, this value is the member\'s Alibaba Cloud UID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '1332695887xxxxxx', 'title' => ''], ], ], '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', - ], - ], - ], - ], - ], - ], - ], - ], + 'description' => '删除应用成员成功', + 'schema' => ['description' => 'The unique ID of the request. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => 'FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F', 'title' => ''], ], + 500 => ['description' => '服务端内部异常'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"\\"FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F\\"","type":"json"}]', + 'title' => 'Delete an application member', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAppMember'], + ], ], - '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"}]', + 'ramActions' => [], ], - 'CreateCheckRun' => [ - 'summary' => '添加检查运行记录', - 'path' => '/api/v4/projects/check_runs/create_check_run', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DeleteBranch' => [ + 'summary' => 'Delete a code repository branch.', + 'path' => '/repository/{repositoryId}/branches/delete', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'query', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'Enterprise identity, also known as enterprise ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, such as https://devops.aliyun.com/organization/【OrganizationId】', 'type' => 'string', 'required' => true, 'example' => '619b80042f595dbd1b9b0de2'], ], [ 'name' => 'accessToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'f0b1e61db5961df5975a93f9129d2513', - ], + 'schema' => ['description' => 'Personal access token. '."\n" + .'This field is not required if you use an Alibaba Cloud AccessKey pair (AK+SK) or Security Token Service (STS) temporary authorization.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], ], [ - 'name' => 'repositoryIdentity', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => ['description' => 'Code repository ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2185366', 'title' => ''], ], [ - '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, - ], + 'name' => 'branchName', + 'in' => 'query', + 'schema' => ['description' => 'Branch name', 'type' => 'string', 'required' => true, 'example' => 'deleteBranch', 'title' => ''], ], ], 'responses' => [ @@ -13618,818 +5792,153 @@ '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' => '""', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => '6177543A-8D54-5736-A93B-E0195A1512CB'], + 'errorMessage' => ['description' => 'Error message', 'type' => 'string', 'example' => '""', 'title' => ''], + 'errorCode' => ['description' => 'Error code', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'success' => ['description' => 'Indicates whether the invocation succeeded', 'type' => 'string', 'example' => 'true', 'title' => ''], 'result' => [ - 'description' => '', + 'description' => 'Return Result', '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' => '', - ], - ], - ], - ], + 'branchName' => ['description' => 'Name of the deleted branch', 'type' => 'string', 'example' => 'deleteBranch', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + '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', + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => '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.', 'description' => ''], + ], ], - 'schemes' => [ - 'https', + '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"}]', + 'title' => 'Delete Branch', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteBranch'], + ], ], + 'ramActions' => [], + ], + 'DeleteFile' => [ + 'summary' => 'Delete a specified file in the code repository.', + 'path' => '/repository/{repositoryId}/files/delete', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'query', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '60de7a6852743a5162b5f957', - ], + 'schema' => ['description' => 'Organization identity, also known as organization ID, in string format. You can obtain it from the Alibaba Cloud DevOps access link, for example: https://devops.aliyun.com/organization/【OrganizationId】', 'type' => 'string', 'required' => true, 'example' => '60de7a6852743a5162b5f957', 'title' => ''], ], [ 'name' => 'accessToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'f0b1e61db5961df5975a93f9129d2513', - ], + 'schema' => ['description' => 'Personal access token. '."\n" + .'You do not need to pass this field if you use an Alibaba Cloud AccessKey pair (AK+SK) or temporary authorization via Security Token Service (STS).', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], ], [ - 'name' => 'repositoryIdentity', + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => ['description' => 'Code repository ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2709413', 'title' => ''], + ], + [ + 'name' => 'branchName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], + 'schema' => ['description' => 'Branch Name', 'type' => 'string', 'required' => true, 'example' => 'master', 'title' => ''], ], [ - 'name' => 'checkRunId', + 'name' => 'filePath', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '2', - ], + 'schema' => ['description' => 'File Path', 'type' => 'string', 'required' => true, 'example' => 'src/main/test.java', 'title' => ''], ], [ - '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, - ], + 'name' => 'commitMessage', + 'in' => 'query', + 'schema' => ['description' => 'Commit message when deleting the file', 'type' => 'string', 'required' => true, 'example' => '删除当前文件', 'title' => ''], ], ], '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', - ], - 'success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'errorCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SYSTEM_UNKNOWN_ERROR', - ], - 'errorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => '""', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => '7EFAD5FB-2296-5D52-BC60-FCC992A40767'], + 'errorMessage' => ['description' => 'Error message', 'type' => 'string', 'example' => '""', 'title' => ''], + 'errorCode' => ['description' => 'Error code', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'success' => ['description' => 'Indicates whether the invocation succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'result' => [ - 'description' => '', + 'description' => 'Return Result', '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' => '', - ], - ], - ], - ], + 'filePath' => ['description' => 'File Path', 'type' => 'string', 'example' => 'src/main/delete.java', 'title' => ''], + 'branchName' => ['description' => 'Branch Name', 'type' => 'string', 'example' => 'master', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + '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', + '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.', 'description' => ''], + ['errorCode' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], + ], ], - 'schemes' => [ - 'https', + '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"}]', + 'title' => 'Delete File', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteFile'], + ], ], + 'ramActions' => [], + ], + 'DeleteFlowTag' => [ + 'summary' => 'Remove tags.', + 'path' => '/organization/{organizationId}/flow/tags/{id}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + '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' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'f0b1e61db5961df5975a93f9129d2513', - ], - ], - [ - 'name' => 'repositoryIdentity', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, such as https://devops.aliyun.com/organization/【OrganizationId】.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ - 'name' => 'checkRunId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'name' => 'id', + 'in' => 'path', + 'schema' => ['description' => 'Tag ID', 'type' => 'string', 'required' => true, 'example' => '1111', 'title' => ''], ], ], 'responses' => [ @@ -14439,339 +5948,77 @@ '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' => '', - ], - ], - ], - ], - ], - ], + 'requestId' => ['title' => '', 'description' => 'Request ID. Each request has a unique value, which facilitates troubleshooting later.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => '”“'], + 'success' => ['title' => '', 'description' => 'true if the API call succeeded, false if the API call failed.', 'type' => 'boolean', 'example' => 'true 接口调用成功,false 接口调用失败'], + 'errorCode' => ['title' => '', 'description' => 'Error code', 'type' => 'string', 'example' => '”“'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidCluster.NotFound', 'errorMessage' => 'No cluster is available to generate the workspace.', 'description' => 'No cluster is available to generate the workspace.'], + ['errorCode' => 'InvalidCodeUrl.NotSupportSVN', 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', 'description' => 'The parameter codeUrl is invalid. SVN is not supported.'], + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidResource.NotFound', 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', 'description' => 'No resource is found. You cannot create the workspace. Please try again later.'], + ['errorCode' => 'InvalidResourceRole.NotFoun', 'errorMessage' => 'The member role is invalid.', 'description' => 'The member role is invalid.'], + ['errorCode' => 'InvalidResourceRole.NotFound', 'errorMessage' => 'The member role is invalid.', 'description' => ''], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => 'The user that is invoking the API service is not a registered user.'], + ['errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', 'errorMessage' => 'Resource owner cannot be deleted.', 'description' => 'The resource owner cannot be deleted.'], + ['errorCode' => 'InvalidUser.ResourceMemberNotExists', 'errorMessage' => 'The resource member does not exist.', 'description' => 'The resource member does not exist.'], + ['errorCode' => 'InvalidUser.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization.', 'description' => 'The user is not in the organization.'], + ], + 403 => [ + ['errorCode' => 'Forbidden.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidIdentifier.NotFound', 'errorMessage' => 'space id is error or not exist.', 'description' => ''], + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], + ['errorCode' => 'InvalidPipeline.NotFound', 'errorMessage' => 'The pipeline is not found.', 'description' => 'The pipeline does not exist.'], + ['errorCode' => 'InvalidPipelineRun.NotFound', 'errorMessage' => 'The pipeline execution instance is not found.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'InvalidWorkspace.NotFound', 'errorMessage' => 'The workspace is not found.', 'description' => 'The workspace is not found.'], + ], ], - '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', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\"\\n}","type":"json"}]', + 'title' => 'Remove tags', + 'description' => 'Users with all tag management permissions can delete all tags or only the tags they created.', + 'changeSet' => [ + ['createdAt' => '2021-12-15T03:07:17.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteFlowTag'], + ], ], + 'ramActions' => [], + ], + 'DeleteFlowTagGroup' => [ + 'summary' => 'Remove tag categorization.', + 'path' => '/organization/{organizationId}/flow/tagGroups/{id}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + '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' => [ - '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', - ], + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, such as https://devops.aliyun.com/organization/【OrganizationId】.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ - 'name' => 'pageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20', - ], + 'name' => 'id', + 'in' => 'path', + 'schema' => ['description' => 'Tag categorization ID', 'type' => 'string', 'required' => true, 'example' => '111', 'title' => ''], ], ], 'responses' => [ @@ -14781,277 +6028,67 @@ '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' => '', - ], - ], - ], - ], - ], - ], - ], + 'requestId' => ['title' => '', 'description' => 'Request ID. Each request has a unique value, which facilitates troubleshooting later.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => '”“'], + 'success' => ['title' => '', 'description' => 'true if the API call succeeded; false if the API call failed.', 'type' => 'boolean', 'example' => 'true 接口调用成功,false 接口调用失败'], + 'errorCode' => ['title' => '', 'description' => 'Error code', 'type' => 'string', 'example' => '”“'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidCluster.NotFound', 'errorMessage' => 'No cluster is available to generate the workspace.', 'description' => 'No cluster is available to generate the workspace.'], + ['errorCode' => 'InvalidCodeUrl.NotSupportSVN', 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', 'description' => 'The parameter codeUrl is invalid. SVN is not supported.'], + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidResource.NotFound', 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', 'description' => 'No resource is found. You cannot create the workspace. Please try again later.'], + ['errorCode' => 'InvalidResourceRole.NotFoun', 'errorMessage' => 'The member role is invalid.', 'description' => 'The member role is invalid.'], + ['errorCode' => 'InvalidResourceRole.NotFound', 'errorMessage' => 'The member role is invalid.', 'description' => ''], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => 'The user that is invoking the API service is not a registered user.'], + ['errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', 'errorMessage' => 'Resource owner cannot be deleted.', 'description' => 'The resource owner cannot be deleted.'], + ['errorCode' => 'InvalidUser.ResourceMemberNotExists', 'errorMessage' => 'The resource member does not exist.', 'description' => 'The resource member does not exist.'], + ['errorCode' => 'InvalidUser.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization.', 'description' => '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.', 'description' => 'The workspace status is invalid. You can only operate workspaces with the SUCCESS status.'], + ['errorCode' => 'InvalidWorkspaceTemplate.NotFound', 'errorMessage' => 'The parameter workspaceTemplate is not found.', 'description' => 'The parameter workspaceTemplate is not found.'], + ], + 403 => [ + ['errorCode' => 'Forbidden.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], + ['errorCode' => 'InvalidPipeline.NotFound', 'errorMessage' => 'The pipeline is not found.', 'description' => 'The pipeline does not exist.'], + ['errorCode' => 'InvalidPipelineRun.NotFound', 'errorMessage' => 'The pipeline execution instance is not found.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'InvalidWorkspace.NotFound', 'errorMessage' => 'The workspace is not found.', 'description' => 'The workspace is not found.'], + ], ], - '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', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\"\\n}","type":"json"}]', + 'title' => 'Remove tag categorization', + 'changeSet' => [ + ['createdAt' => '2021-12-15T03:07:17.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteFlowTagGroup'], + ], ], + 'ramActions' => [], + ], + 'DeleteGroupMember' => [ + 'summary' => 'Deletes a member from a specified code group by Alibaba Cloud account ID.', + 'path' => '/repository/groups/{groupId}/members/remove/aliyun_pk', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], @@ -15059,1192 +6096,531 @@ [ 'name' => 'organizationId', 'in' => 'query', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '60de7a6852743a5162b5f957', - ], + 'schema' => ['title' => '', 'description' => 'The enterprise identifier, also known as the enterprise ID, in string format. You can obtain it from the China Yunxiao access URL, such as https://devops.aliyun.com/organization/[OrganizationId].', 'type' => 'string', 'required' => true, 'example' => '6082a9b0c7972588ac363793'], ], [ 'name' => 'accessToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'f0b1e61db5961df5975a93f9129d2513', - ], + 'schema' => ['description' => 'The personal access token. This field is not required if you use an Alibaba Cloud AK/SK pair or STS temporary authorization.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], ], [ - 'name' => 'repositoryId', + 'name' => 'groupId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '2080972', - ], + 'schema' => ['description' => 'The primary key ID of the code group.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '34410', 'title' => ''], + ], + [ + 'name' => 'aliyunPk', + 'in' => 'query', + 'schema' => ['description' => 'The Alibaba Cloud account ID of the group member.', 'type' => 'string', 'required' => true, 'example' => '1789095186553536', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', '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' => '', - ], + 'memberType' => ['description' => 'The member type. Set this to the default value: USERS.', 'type' => 'string', 'required' => true, 'example' => 'USERS', 'title' => ''], ], 'required' => true, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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', - ], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '4D6AF7CC-B43B-5454-86AB-023D25E44868'], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'success' => ['description' => 'Indicates whether the call is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'result' => [ - 'description' => '', + 'description' => 'The returned result.', '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' => 'username@example.com', - ], - 'authoredDate' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2022-03-18 10:00:00', - ], - 'committerName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'committerEmail' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'username@example.com', - ], - 'committedDate' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2022-03-18 09:00:00', - ], - 'parentIds' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '34d2c47c7ce46a5c4639c5ffe208a66dda975a05', - ], - ], - ], - ], + 'id' => ['description' => 'The Codeup user ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '524836', 'title' => ''], + 'name' => ['description' => 'The username.', 'type' => 'string', 'example' => 'codeup', 'title' => ''], + 'username' => ['description' => 'The nickname.', 'type' => 'string', 'example' => 'test-codeup', 'title' => ''], + 'state' => ['description' => 'The status. Valid values:'."\n" + .'- active: active'."\n" + .'- blocked: blocked.', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'avatarUrl' => ['description' => 'The avatar URL.', 'type' => 'string', 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', 'title' => ''], + 'accessLevel' => ['description' => 'The permission type. Valid values:'."\n" + .'- 20: Viewer. '."\n" + .'- 30: Developer.'."\n" + .'- 40: Administrator.', 'type' => 'integer', 'format' => 'int32', 'example' => '40', 'title' => ''], + 'memberType' => ['description' => 'The member type. Default value: USERS.', 'type' => 'string', 'example' => 'USERS', 'title' => ''], + 'sourceId' => ['description' => 'The associated ID, which refers to the repository or code group ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '2080398', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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\\": \\"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"}]', + 'title' => 'Delete a group member', + 'changeSet' => [ + ['createdAt' => '2023-07-24T06:14:51.000Z', 'description' => 'Response parameters changed'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteGroupMember'], + ], ], - '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\\": \\"username@example.com\\",\\n \\"authoredDate\\": \\"2022-03-18 10:00:00\\",\\n \\"committerName\\": \\"阿里云云效committer\\",\\n \\"committerEmail\\": \\"username@example.com\\",\\n \\"committedDate\\": \\"2022-03-18 09:00:00\\",\\n \\"parentIds\\": [\\n \\"34d2c47c7ce46a5c4639c5ffe208a66dda975a05\\"\\n ]\\n }\\n }\\n}","type":"json"}]', + 'ramActions' => [], ], - 'DeleteTag' => [ - 'summary' => '删除标签', - 'path' => '/repository/{repositoryId}/tags/delete', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteHostGroup' => [ + 'summary' => 'You can delete a host group.', + 'path' => '/organization/{organizationId}/hostGroups/{id}', + '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', - ], + 'schema' => ['title' => '', 'description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, for example: https://devops.aliyun.com/organization/【OrganizationId】', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ - 'name' => 'tagName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'v1.0', - ], + 'name' => 'id', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'Host group ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11222'], ], ], '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', - ], - ], - ], + 'requestId' => ['title' => '', 'description' => 'The request ID. Each request has a unique value, which facilitates troubleshooting later.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => '""'], + 'errorCode' => ['title' => '', 'description' => 'Error code', 'type' => 'string', 'example' => '""'], + 'success' => ['title' => '', 'description' => 'true if the API call succeeded, false if the API call failed.', 'type' => 'boolean', 'example' => 'true'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => '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.UserNotInCurrentOrganization', - 'errorMessage' => 'The user is not 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.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], + ['errorCode' => 'InvalidPipeline.NotFound', 'errorMessage' => 'The pipeline is not found.', 'description' => 'The pipeline does not exist.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true\\n}","type":"json"}]', + 'title' => 'Delete a host group', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteHostGroup'], + ], ], - '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"}]', + 'ramActions' => [], ], - 'GetRepositoryTag' => [ - 'summary' => '查询单个标签', - 'path' => '/repository/{repositoryId}/tag/info', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeletePipeline' => [ + 'summary' => 'You can delete a pipeline.', + 'path' => '/organization/{organizationId}/pipelines/{pipelineId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'organizationId', - 'in' => 'query', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '60de7a6852743a5162b5f957', - ], + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'The enterprise identity, also known as the enterprise ID, is a string that can be obtained from the Alibaba Cloud DevOps access link, such as https://devops.aliyun.com/organization/【OrganizationId】.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ - 'name' => 'accessToken', - 'in' => 'query', + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'The pipeline ID, which can be obtained from the pipeline link, such as https://flow.aliyun.com/pipelines/【PipelineId】/current.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '999999999999999', 'minimum' => '1', 'example' => '123'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '', 'description' => 'The request ID. Each request has a unique value, which facilitates troubleshooting later.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['title' => '', 'description' => 'error message', 'type' => 'string', 'example' => '""'], + 'errorCode' => ['title' => '', 'description' => 'error code', 'type' => 'string', 'example' => '""'], + 'success' => ['title' => '', 'description' => 'true if the API call succeeded; false if the API call failed.', 'type' => 'boolean', 'example' => 'true'], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'f0b1e61db5961df5975a93f9129d2513', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => '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.', 'description' => ''], + ], [ - 'name' => 'repositoryId', + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], + ['errorCode' => 'InvalidPipeline.NotFound', 'errorMessage' => 'The pipeline is not found.', 'description' => 'The pipeline does not exist.'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true\\n}","type":"json"}]', + 'title' => 'Delete a pipeline', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePipeline'], + ], + ], + 'ramActions' => [], + ], + 'DeletePipelineGroup' => [ + 'summary' => 'Delete a pipeline group.', + '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' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '2369234', - ], + 'schema' => ['description' => 'The enterprise identity, also known as the enterprise ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, for example: https://devops.aliyun.com/organization/【OrganizationId】', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx', 'title' => ''], ], [ - 'name' => 'tagName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'tag v1.0', - ], + 'name' => 'groupId', + 'in' => 'path', + 'schema' => ['description' => 'The pipeline group ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '111', 'title' => ''], ], ], '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' => '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' => 'username@example.com', - ], - 'authoredDate' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2022-03-18 08:00:00', - ], - 'committerName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'committerEmail' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'username@example.com', - ], - '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', - ], - ], - ], - ], - ], - ], - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID. Each request has a unique value, which facilitates troubleshooting later.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['description' => 'error message', 'type' => 'string', 'example' => '""', 'title' => ''], + 'success' => ['description' => 'true if the API call succeeded, false if the API call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'errorCode' => ['description' => 'error code', 'type' => 'string', 'example' => '""', 'title' => ''], ], + 'example' => '', ], ], ], '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.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], + ['errorCode' => 'InvalidUser.UserNotInCurrentOrganization', 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', + 'title' => 'Delete a pipeline group', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePipelineGroup'], + ], ], - '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\\": \\"username@example.com\\",\\n \\"authoredDate\\": \\"2022-03-18 08:00:00\\",\\n \\"committerName\\": \\"阿里云云效Committer\\",\\n \\"committerEmail\\": \\"username@example.com\\",\\n \\"committedDate\\": \\"2022-03-18 09:00:00\\",\\n \\"signature\\": {\\n \\"gpgKeyId\\": \\"\\\\\\"\\\\\\"\\",\\n \\"verificationStatus\\": \\"verified\\"\\n }\\n }\\n }\\n}","type":"json"}]', + 'ramActions' => [], ], - 'ListRepositoryTags' => [ - 'summary' => '查询标签列表', - 'path' => '/repository/{repositoryId}/tag/list', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeletePipelineRelations' => [ + 'summary' => 'Delete Pipeline Relations', + 'path' => '/organization/{organizationId}/{pipelineId}/pipelineRelations', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', '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', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the organization, also known as the enterprise ID. It is a string that can be obtained from the China DevOps URL, for example, https:// devops.aliyun.com/organization/[OrgId].', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ - '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' => 'pipelineId', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'The ID of the pipeline. You can obtain it from the pipeline URL, for example, https://flow.aliyun.com/pipelines/[PipelineId]/current.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11'], ], [ - 'name' => 'sort', + 'name' => 'relObjectType', 'in' => 'query', 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'The type of the associated resource. Only VARIABLE_GROUP is supported.', 'type' => 'string', - 'required' => false, - 'example' => 'updated_desc', + 'required' => true, + 'enum' => ['VARIABLE_GROUP', 'OSS_APP_ID'], + 'example' => 'VARIABLE_GROUP', ], ], [ - 'name' => 'search', + 'name' => 'relObjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Demo', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the associated resource. Only variable group IDs are supported.', 'type' => 'string', 'required' => true, 'example' => '11'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response parameters.', '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' => 'username@example.com', - ], - 'authoredDate' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2022-03-18 10:00:00', - ], - 'committerName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'committerEmail' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'username@example.com', - ], - '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', - ], - ], - ], - ], - ], - ], - ], - ], + 'requestId' => ['title' => '', 'description' => 'The request ID. Each request has a unique ID for troubleshooting.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => '""'], + 'errorCode' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => '""'], + 'success' => ['title' => '', 'description' => 'Indicates whether the API call is successful. Valid values: true and false.', 'type' => 'boolean', 'example' => 'true'], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => '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.UserNotInCurrentOrganization', - 'errorMessage' => 'The user is not 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.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], ], ], - '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\\": \\"username@example.com\\",\\n \\"authoredDate\\": \\"2022-03-18 10:00:00\\",\\n \\"committerName\\": \\"阿里云云效Committer\\",\\n \\"committerEmail\\": \\"username@example.com\\",\\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', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true\\n}","type":"json"}]', + 'title' => 'Delete Pipeline Relations', + 'changeSet' => [ + ['createdAt' => '2023-08-31T14:28:54.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePipelineRelations'], + ], ], + 'ramActions' => [], + ], + 'DeleteProject' => [ + 'summary' => 'You can delete a project.', + 'path' => '/organization/{organizationId}/projects/delete', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + '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' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'f0b1e61db5961df5975a93f9129d2513', - ], + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'Organization identifier, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, for example: https://devops.aliyun.com/organization/【OrganizationId】', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ - 'name' => 'repositoryIdentity', + 'name' => 'identifier', '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, - ], + 'schema' => ['description' => 'Project ID, equivalent to the spaceIdentifier and projectId fields', 'type' => 'string', 'required' => true, 'example' => '7fb72727f32143574f7a...', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'Data returned by the API', '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' => '', - ], - ], - ], + 'requestId' => ['title' => '', 'description' => 'Request ID. Each request has a unique value, which facilitates troubleshooting later.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMsg' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => 'error'], + 'errorCode' => ['title' => '', 'description' => 'Error code', 'type' => 'string', 'example' => 'Openapi.RequestError'], + 'success' => ['title' => '', 'description' => 'true if the API request succeeded, false if it failed', 'type' => 'boolean', 'example' => 'true'], + 'result' => ['title' => '', 'description' => 'true if the deletion succeeded, false if it failed', 'type' => 'boolean', 'example' => 'true'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Openapi.RequestError', 'errorMessage' => 'request error', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'Operate.NoPermission', 'errorMessage' => 'NoPermission', 'description' => 'You are not authorized to perform this operation.'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"result\\": true\\n}","type":"json"}]', + 'title' => 'Delete a project', + 'changeSet' => [ + ['createdAt' => '2022-02-24T08:23:15.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-01-06T13:27:07.000Z', 'description' => 'OpenAPI offline'], ], - '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"}]', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteProject'], + ], + ], + 'ramActions' => [], ], - 'UpdateProjectLabel' => [ - 'summary' => '更新代码库Label', + 'DeleteProjectLabel' => [ + 'summary' => 'Deletes a repository label.', 'path' => '/api/v4/projects/labels/{labelId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'query', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The organization ID. This ID is part of the URL used to access Alibaba Cloud DevOps. For example, in `https://devops.aliyun.com/organization/{organizationId}`, the organization ID is `{organizationId}`.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ 'name' => 'accessToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'f0b1e61db5961df5975a93f9129d2513', - ], + 'schema' => ['description' => 'The personal access token. This parameter is not required if you use an Alibaba Cloud AccessKey pair or Security Token Service (STS) for authentication.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], ], [ 'name' => 'labelId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '54e2699e538b4ba985177d6eb4d16cee', - ], + 'schema' => ['description' => 'The unique identifier of the label.', 'type' => 'string', 'required' => true, 'example' => '54e2699e538b4ba985177d6eb4d16cee', 'title' => ''], ], [ '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, - ], + 'schema' => ['description' => 'The ID or full path of the repository.', 'type' => 'string', 'required' => true, 'example' => '2835387 或 codeup/codeup-demo', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Response schema.', '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' => '""', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'success' => ['description' => 'Indicates if the request succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'errorCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'errorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => '""', 'title' => ''], 'result' => [ - 'description' => '', + 'description' => 'The operation result.', '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' => '', - ], + 'result' => ['description' => 'Indicates if the deletion succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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"}]', + 'title' => 'Delete Label', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteProjectLabel'], + ], ], - '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"}]', + 'ramActions' => [], ], - 'DeleteProjectLabel' => [ - 'summary' => '删除代码库Label', - 'path' => '/api/v4/projects/labels/{labelId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'DeleteProtectedBranch' => [ + 'summary' => 'Delete a protected branch in a code repository.', + 'path' => '/repository/{repositoryId}/protect_branches/{protectedBranchId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'query', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, for example: https://devops.aliyun.com/organization/【OrganizationId】', 'type' => 'string', 'required' => true, 'example' => '611b75680fc7bf0dbe1dce55'], ], [ 'name' => 'accessToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'f0b1e61db5961df5975a93f9129d2513', - ], + 'schema' => ['description' => 'Personal access token. '."\n" + .'This field is not required if you use an Alibaba Cloud AccessKey pair (AK+SK) or temporary authorization via Security Token Service (STS).', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], ], [ - 'name' => 'labelId', + 'name' => 'repositoryId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '54e2699e538b4ba985177d6eb4d16cee', - ], + 'schema' => ['description' => 'Code repository ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2813489', 'title' => ''], ], [ - 'name' => 'repositoryIdentity', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], + 'name' => 'protectedBranchId', + 'in' => 'path', + 'schema' => ['description' => 'Protected branch rule ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '5326', 'title' => ''], ], ], 'responses' => [ @@ -16254,310 +6630,160 @@ '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' => '""', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => '1F4F342D-493A-5B2C-B133-BA78B30FF834'], + 'errorMessage' => ['description' => 'error message', 'type' => 'string', 'example' => '”“', 'title' => ''], + 'errorCode' => ['description' => 'error code', 'type' => 'string', 'example' => 'Openapi.RequestError', 'title' => ''], + 'success' => ['description' => 'Indicates whether the invocation succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'result' => [ - 'description' => '', + 'description' => 'Return Result', 'type' => 'object', 'properties' => [ - 'result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'result' => ['description' => 'Indicates whether the deletion succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + '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 \\"result\\": true\\n }\\n}","type":"json"}]', - ], - 'ListProjectLabels' => [ - 'summary' => '查询代码库Label列表', - 'path' => '/api/v4/projects/labels', - 'methods' => [ - 'get', + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'Forbidden.UserNotAdminOrOwner', 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', 'description' => ''], + ], ], - 'schemes' => [ - 'https', + '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"}]', + 'title' => 'Delete Protected Branch', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteProtectedBranch'], + ], ], + 'ramActions' => [], + ], + 'DeletePushRule' => [ + 'summary' => 'Deletes a specified push rule.', + 'path' => '/api/v4/projects/{repositoryId}/push_rule/{pushRuleId}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'query', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['description' => 'The organization ID. You can obtain it from the URL in your browser\'s address bar after you log on to Alibaba Cloud DevOps. The URL has the format `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'required' => true, 'example' => '60d54f3daccf2bbd6659f3ad', 'title' => ''], ], [ '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', - ], + 'schema' => ['description' => 'The personal access token. This parameter is not required if you use an Alibaba Cloud AccessKey pair (AccessKey ID and AccessKey secret) or Security Token Service (STS) for authentication.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], ], [ - 'name' => 'sort', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'desc', - ], + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => ['description' => 'The repository ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2813489', 'title' => ''], ], [ - 'name' => 'withCounts', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'name' => 'pushRuleId', + 'in' => 'path', + 'schema' => ['description' => 'The push rule ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2077', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The schema of the 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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'InvalidParam.NotFound', 'title' => ''], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '”“', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'string', 'example' => 'true', 'title' => ''], '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', - ], - ], + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'result' => ['description' => 'Indicates whether the push rule was successfully deleted.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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"}]', + 'title' => 'Delete Push Rule', + 'description' => 'You must have repository administrator permissions or higher to perform this operation.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePushRule'], + ], ], - '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"}]', + 'ramActions' => [], ], - 'ListMergeRequestLabels' => [ - 'summary' => '查询合并请求Label列表', - 'path' => '/api/v4/projects/merge_requests/labels', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'DeleteRepository' => [ + 'summary' => 'Delete a code repository. (To ensure compliance, you must specify the reason for deletion.)', + 'path' => '/repository/{repositoryId}/remove', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'query', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '60de7a6852743a5162b5f957', - ], + 'schema' => ['description' => 'Organization identity, also known as organization ID, in string format. You can obtain it from the Alibaba Cloud DevOps access link, for example: https://devops.aliyun.com/organization/【OrganizationId】', 'type' => 'string', 'required' => true, 'example' => '6082a9b0c7972588ac363793', 'title' => ''], ], [ 'name' => 'accessToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'f0b1e61db5961df5975a93f9129d2513'."\n", - ], + 'schema' => ['description' => 'Personal access token. '."\n" + .'You do not need to provide this field if you use an Alibaba Cloud AccessKey pair (AK+SK) or Security Token Service (STS) temporary authorization.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], ], [ - 'name' => 'repositoryIdentity', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => ['description' => 'Code repository ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2464454', 'title' => ''], ], [ - 'name' => 'localId', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'Request body', + 'type' => 'object', + 'properties' => [ + 'reason' => ['description' => 'Reason for deleting the code repository (Required)', 'type' => 'string', 'required' => true, 'example' => '代码库废弃且不再使用', 'title' => ''], + ], 'required' => true, - 'example' => '1', + 'title' => '', + 'example' => '', ], ], ], @@ -16568,154 +6794,84 @@ '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' => '""', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => 'A7586FEB-E48D-5579-983F-74981FBFF627'], + 'errorMessage' => ['description' => 'Error message', 'type' => 'string', 'example' => '”“', 'title' => ''], + 'errorCode' => ['description' => 'Error code', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'success' => ['description' => 'Indicates whether the invocation succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], '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', - ], - ], + 'description' => 'Return Result', + 'type' => 'object', + 'properties' => [ + 'result' => ['description' => 'Indicates whether the deletion succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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', + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => '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.', 'description' => ''], + ], ], - 'schemes' => [ - 'https', + '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"}]', + 'title' => 'Delete Code Repository', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRepository'], + ], ], + 'ramActions' => [], + ], + 'DeleteRepositoryGroup' => [ + 'summary' => 'Deletes the specified code group.', + 'path' => '/repository/groups/{groupId}/remove', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'query', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The ID of the organization. You can find this ID in your browser\'s URL after logging in to the Alibaba Cloud DevOps console. The URL follows this format: https\\://devops.aliyun.com/organization/{organizationId}.', 'type' => 'string', 'required' => true, 'example' => '624666bd54d036291ae13a36'], ], [ 'name' => 'accessToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'f0b1e61db5961df5975a93f9129d2513', - ], + 'schema' => ['description' => 'The personal access token. This parameter is not required if you use an Alibaba Cloud AccessKey pair or a Security Token Service (STS) token for authentication.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], ], [ - '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' => 'groupId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the code group.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '22901', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'labelIds' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'f2bf0e0b4ce34a348b2d971c69a1d11f', - ], - 'required' => true, - ], + 'reason' => ['description' => 'The reason for deleting the code group. This parameter is required.', 'type' => 'string', 'required' => true, 'example' => '代码组废弃且不再使用', 'title' => ''], ], - 'required' => false, + 'required' => true, + 'title' => '', + 'example' => '', ], ], ], @@ -16723,71 +6879,56 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response structure.', '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' => '""', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '30F2DA15-2877-5FC9-BC71-F7F394717907'], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'result' => [ - 'description' => '', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'result' => ['description' => 'Indicates whether the deletion was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + '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 \\"result\\": true\\n }\\n}","type":"json"}]', - ], - 'AddWebhook' => [ - 'summary' => '添加代码库Webhook', - 'path' => '/repository/{repositoryId}/webhooks/create', - 'methods' => [ - 'post', + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => '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.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + '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"}]', + 'title' => 'Delete Code Group', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRepositoryGroup'], + ], ], + 'ramActions' => [], + ], + 'DeleteRepositoryMember' => [ + 'summary' => 'Deletes a member from a repository by using their Alibaba Cloud account ID.', + 'path' => '/repository/{repositoryId}/members/delete/{aliyunPk}', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], @@ -16795,237 +6936,100 @@ [ 'name' => 'organizationId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '60de7a6852743a5162b5f957', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The ID of the organization. Find this ID in your organization\'s URL, which follows this format: `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'required' => true, 'example' => '632bbfdf419338aaa2b1360a'], ], [ 'name' => 'accessToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'f0b1e61db5961df5975a93f9129d2513', - ], + 'schema' => ['description' => 'The personal access token. This parameter is not required if you authenticate by using an AccessKey pair or a Security Token Service (STS) token.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513'."\n", 'title' => ''], ], [ 'name' => 'repositoryId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '2835387', - 'isFileTransferUrl' => false, - ], + 'schema' => ['description' => 'The ID of the repository.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2080398', 'title' => ''], + ], + [ + 'name' => 'aliyunPk', + 'in' => 'path', + 'schema' => ['description' => 'The Alibaba Cloud account ID.', 'type' => 'string', 'required' => true, 'example' => '1789095186553536', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', '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', - ], + 'memberType' => ['description' => 'The member type. Valid values: `TEAMS` (department) and `USERS` (user).', 'type' => 'string', 'required' => false, 'example' => 'USERS', 'title' => ''], ], - 'required' => true, + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of Response', + 'title' => 'Schema of Response', + 'description' => 'The response data.', '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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0E1BCF81-51E6-59D4-8D55-FF945111127A'], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Openapi.RequestError', 'title' => ''], + 'success' => ['description' => '`true` if the request was successful; `false` otherwise.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'result' => [ - 'description' => '', + 'description' => 'An object that contains the details of the removed member.', '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', - ], + 'id' => ['description' => 'The primary key. This value has no business significance.', 'type' => 'integer', 'format' => 'int64', 'example' => '30815', 'title' => ''], + 'createAt' => ['description' => 'The time when the member was created.', 'type' => 'string', 'example' => '2022-03-12 12:00:00', 'title' => ''], + 'updateAt' => ['description' => 'The time when the membership was last updated.', 'type' => 'string', 'example' => '2022-03-12 12:00:00', 'title' => ''], + 'sourceId' => ['description' => 'The ID of the source, which can be the ID of a repository or a repository group.', 'type' => 'integer', 'format' => 'int64', 'example' => '2080398', 'title' => ''], + 'sourceType' => ['description' => 'The type of the source. Valid values: `Project` and `Namespace`.', 'type' => 'string', 'example' => 'Project', 'title' => ''], + 'userId' => ['description' => 'The Codeup user ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '19280', 'title' => ''], + 'accessLevel' => ['description' => 'The access level. Valid values: `20` (viewer), `30` (developer), and `40` (administrator).', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'SystemError.UnKnownError', - 'errorMessage' => 'An error occurred while processing your request.', - ], + 403 => [ + ['errorCode' => 'Forbidden.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => '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.', 'description' => ''], + ], + ], + '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"}]', + 'title' => 'Delete Code Repository Member', + 'changeSet' => [ + ['createdAt' => '2023-07-24T06:14:52.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRepositoryMember'], ], ], - '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":""}]', + 'ramActions' => [], ], 'DeleteRepositoryWebhook' => [ - 'summary' => '删除代码库Webhook', + 'summary' => 'Deletes a webhook from a code repository.', 'path' => '/repository/{repositoryId}/hooks/{hookId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], @@ -17033,1173 +7037,480 @@ [ 'name' => 'organizationId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '60de7a6852743a5162b5f957', - ], + 'schema' => ['description' => 'The organization ID. You can find this ID in your organization\'s URL on the Alibaba Cloud DevOps platform. The URL is formatted as https\\://devops.aliyun.com/organization/{organizationId}.', 'type' => 'string', 'required' => true, 'example' => '60de7a6852743a5162b5f957', 'title' => ''], ], [ 'name' => 'accessToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'f0b1e61db5961df5975a93f9129d2513'."\n", - ], + 'schema' => ['description' => 'The personal access token. This parameter is not required when authenticating with an AccessKey or STS temporary authorization.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513'."\n", 'title' => ''], ], [ 'name' => 'repositoryId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '2369234', - ], + 'schema' => ['description' => 'The ID of the repository.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2369234', 'title' => ''], ], [ 'name' => 'hookId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '524836', - ], + 'schema' => ['description' => 'The ID of the webhook.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '524836', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', '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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9'], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'result' => [ - 'description' => '', + 'description' => 'The result object.', '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', - ], + 'id' => ['description' => 'The unique ID of the webhook.', 'type' => 'integer', 'format' => 'int64', 'example' => '524836', 'title' => ''], + 'url' => ['description' => 'The webhook URL.', 'type' => 'string', 'example' => 'https://xxxxx', 'title' => ''], + 'createdAt' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2022-03-18 14:24:54', 'title' => ''], + 'projectId' => ['description' => 'The ID of the code repository.', 'type' => 'integer', 'format' => 'int64', 'example' => '2369234', 'title' => ''], + 'pushEvents' => ['description' => 'Indicates whether push events trigger this webhook. Valid values: `true` and `false`.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'issuesEvents' => ['description' => 'Indicates whether issue events trigger this webhook. Valid values: `true` and `false`.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'mergeRequestsEvents' => ['description' => 'Indicates whether merge request events trigger this webhook. Valid values: `true` and `false`.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'tagPushEvents' => ['description' => 'Indicates whether tag push events trigger this webhook. Valid values: `true` and `false`.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'buildEvents' => ['description' => 'Indicates whether build events trigger this webhook. Valid values: `true` and `false`.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'noteEvents' => ['description' => 'Indicates whether note events trigger this webhook. Valid values: `true` and `false`.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'enableSslVerification' => ['description' => 'Indicates whether SSL verification is enabled. Valid values: `true` and `false`.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'lastTestResult' => ['description' => 'The result of the last test execution. Valid values: `ok`, `error`, and `""` (empty string).', 'type' => 'string', 'example' => '""', 'title' => ''], + 'description' => ['description' => 'The webhook description.', 'type' => 'string', 'example' => 'Webhook描述内容', 'title' => ''], + 'secretToken' => ['description' => 'The user-defined token for authentication.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'type' => ['description' => 'The webhook type. Valid values: `ProjectHook` (project webhook) and `OrganizationHook` (organization webhook).', 'type' => 'string', 'example' => 'ProjectHook', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], '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.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => '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.', 'description' => ''], ], ], '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', + 'title' => 'Delete a code repository Webhook ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRepositoryWebhook'], + ], ], + 'ramActions' => [], + ], + 'DeleteResourceMember' => [ + 'summary' => 'You can delete a resource member.', + 'path' => '/organization/{organizationId}/{resourceType}/{resourceId}/members/{accountId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'operationType' => 'write', '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' => '', - ], + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'Organization identity, also known as organization ID, in string format. You can obtain it from the Alibaba Cloud DevOps access link, such as https://devops.aliyun.com/organization/【OrganizationId】.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ - 'name' => 'repositoryId', + 'name' => 'resourceType', 'in' => 'path', 'schema' => [ - 'title' => '代码仓库Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => '- Resource type'."\n" + ."\n" + .' pipeline: Pipeline'."\n" + ."\n" + .' hostGroup: Deployment group', + 'type' => 'string', 'required' => true, 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '', - 'isFileTransferUrl' => false, + 'maximum' => '999999999999999', + 'minimum' => '1', + 'example' => 'pipeline', + 'enum' => ['pipeline', 'hostGroup'], ], ], [ - 'name' => 'page', - 'in' => 'query', - 'schema' => [ - 'title' => '页码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '1', - 'default' => '1', - ], + 'name' => 'resourceId', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'Resource ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123'], ], [ - 'name' => 'pageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '每页数据量', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '100', - 'minimum' => '0', - 'example' => '10', - 'default' => '20', - ], + 'name' => 'accountId', + 'in' => 'path', + 'schema' => ['description' => 'Alibaba Cloud account ID', 'type' => 'string', 'required' => true, 'example' => '2211221', 'title' => ''], ], ], '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', - ], - ], - ], - ], + 'requestId' => ['title' => '', 'description' => 'The request ID. Each request has a unique value, which facilitates troubleshooting later.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => '""'], + 'errorCode' => ['title' => '', 'description' => 'Error code', 'type' => 'string', 'example' => '""'], + 'success' => ['title' => '', 'description' => 'true if the API call succeeded; false if the API call failed.', 'type' => 'boolean', 'example' => 'true'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'SystemError.UnKnownError', - 'errorMessage' => 'An error occurred while processing your request.', - ], + 400 => [ + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => 'The user that is invoking the API service is not a registered user.'], + ['errorCode' => 'InvalidUser.ResourceMemberNotExists', 'errorMessage' => 'The resource member does not exist.', 'description' => 'The resource member does not exist.'], + ['errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', 'errorMessage' => 'Resource owner cannot be deleted.', 'description' => 'The 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.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], ], ], - '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', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true\\n}","type":"json"}]', + 'title' => 'Delete a resource member', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteResourceMember'], + ], ], + 'ramActions' => [], + ], + 'DeleteTag' => [ + 'summary' => 'Deletes a tag from a repository.', + 'path' => '/repository/{repositoryId}/tags/delete', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + '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', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The organization ID. Find this ID in your browser\'s URL when you access your organization in Alibaba Cloud DevOps: `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'required' => true, 'example' => '609633ffd40eb063bac8165a'], ], [ 'name' => 'accessToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'f0b1e61db5961df5975a93f9129d2513', - ], + 'schema' => ['description' => 'The personal access token. This parameter is not required for authentication with an AccessKey pair or Security Token Service (STS).', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], ], [ - '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, - ], + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => ['description' => 'The repository ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2289464', 'title' => ''], + ], + [ + 'name' => 'tagName', + 'in' => 'query', + 'schema' => ['description' => 'The tag name.', 'type' => 'string', 'required' => true, 'example' => 'v1.0', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', '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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '60945D4F-CF6D-5CFF-89ED-1D1F6657032C'], + 'errorMessage' => ['description' => 'The error message returned when the request fails.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'errorCode' => ['description' => 'The error code returned when the request fails.', 'type' => 'string', 'example' => 'Openapi.RequestError', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'result' => [ - 'description' => '', + 'description' => 'The result of the operation.', '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', - ], + 'tagName' => ['description' => 'The name of the deleted tag.', 'type' => 'string', 'example' => 'v1.0', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], '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.', - ], + ['errorCode' => 'Forbidden.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => '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.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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"}]', + 'title' => 'Remove Tag', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTag'], + ], ], - '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"}]', + 'ramActions' => [], ], - 'DeleteRepositoryGroup' => [ - 'summary' => '删除代码组', - 'path' => '/repository/groups/{groupId}/remove', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteUserKey' => [ + 'summary' => 'Deletes a specified ssh key for the current user.', + 'path' => '/api/v3/user/keys/{keyId}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'query', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '624666bd54d036291ae13a36', - ], + 'schema' => ['description' => 'The ID of the organization. You can find the organization ID in the URL of the organization page on Alibaba Cloud DevOps. For example, in `https://devops.aliyun.com/organization/{organizationId}`, `{organizationId}` is the organization ID.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx', 'title' => ''], ], [ 'name' => 'accessToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'f0b1e61db5961df5975a93f9129d2513', - ], + 'schema' => ['description' => 'The personal access token. This parameter is not required if you use an AccessKey pair or STS temporary authorization for authentication.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], ], [ - 'name' => 'groupId', + 'name' => 'keyId', '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, - ], + 'schema' => ['description' => 'The unique ID of the ssh key.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '50998', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response body.', '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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'result' => [ - 'description' => '', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'id' => ['description' => 'The unique ID of the ssh key.', 'type' => 'integer', 'format' => 'int64', 'example' => '50998', 'title' => ''], + 'createdAt' => ['description' => 'The creation time of the ssh key.', 'type' => 'string', 'example' => '2022-03-18 14:24:54', 'title' => ''], + 'updatedAt' => ['description' => 'The last update time of the ssh key.', 'type' => 'string', 'example' => '2022-03-18 14:24:54', 'title' => ''], + 'title' => ['description' => 'The title of the ssh key.', 'type' => 'string', 'example' => '密钥标题', 'title' => ''], + 'fingerPrint' => ['description' => 'The key\'s fingerprint.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'shaContext' => ['description' => 'The SHA-1 hash of the public key context.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'publicKey' => ['description' => 'The public key.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'context' => ['description' => 'The context of the public key.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'expireTime' => ['description' => 'The expiration time of the key.', 'type' => 'string', 'example' => '2022-03-18 14:24:54'."\n", 'title' => ''], + 'lastUsedTime' => ['description' => 'When the key was last used.', 'type' => 'string', 'example' => '2022-03-18 14:24:54'."\n", 'title' => ''], + 'keyScope' => ['description' => 'The key scope. Valid values: `ALL` and `READ`.'."\n" + ."\n" + .'- `ALL`: Allows read and write operations, such as `clone`, `pull`, and `push`.'."\n" + ."\n" + .'- `READ`: Allows only read operations, such as `clone` and `pull`.', 'type' => 'string', 'example' => 'ALL', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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\\": \\"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"}]', + 'title' => 'Delete the specified Secure Shell key ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteUserKey'], ], ], - '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"}]', + 'ramActions' => [], ], - 'UpdateGroup' => [ - 'summary' => '更新单个代码组信息', - 'path' => '/groups/modify', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteVariableGroup' => [ + 'summary' => 'You can delete a variable group.', + 'path' => '/organization/{organizationId}/variableGroups/{id}', + 'methods' => ['delete'], + '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', - ], + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, for example: https://devops.aliyun.com/organization/【OrganizationId】', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ - '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, - ], + 'name' => 'id', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'Variable group ID', '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', - ], - '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', - ], - ], - ], + 'requestId' => ['title' => '', 'description' => 'Request ID. Each request has a unique value, which facilitates troubleshooting later.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => '”“'], + 'errorCode' => ['title' => '', 'description' => 'Error code', 'type' => 'string', 'example' => '”“'], + 'success' => ['title' => '', 'description' => 'true indicates the API call succeeded; false indicates the API call failed.', 'type' => 'boolean', 'example' => 'true'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => 'The user that is invoking the API service is not a registered user.'], + ], 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.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"errorCode\\": \\"”“\\",\\n \\"success\\": true\\n}","type":"json"}]', + 'title' => 'Delete a variable group', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteVariableGroup'], + ], ], - '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"}]', + 'ramActions' => [], ], - 'GetGroupDetail' => [ - 'summary' => '查询代码组信息', - 'path' => '/repository/groups/get_detail', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteWorkitem' => [ + 'summary' => 'Delete a work item.', + 'path' => '/organization/{organizationId}/workitem/delete', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'operationType' => 'write', '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', - ], + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'Organization ID', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ - 'name' => 'groupId', + 'name' => 'identifier', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '36612', - ], + 'schema' => ['title' => '', 'description' => 'Work item ID, equivalent to workitemIdentifier, workitemId, or UUID of the work item', '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' => '', - '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', - ], - ], - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMsg' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => 'error'], + 'errorCode' => ['title' => '', 'description' => 'Error status code', 'type' => 'string', 'example' => 'InvalidTagGroup.IdNotFound'], + 'success' => ['title' => 'true/false', 'description' => 'true/false', 'type' => 'boolean', 'example' => 'true'], + 'deleteFlag' => ['title' => '', 'description' => 'Indicates whether the deletion succeeded.', 'type' => 'boolean', 'example' => 'true/false'], ], + 'example' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Openapi.RequestError', 'errorMessage' => 'request error', 'description' => ''], + ], 403 => [ - [ - 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', - 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', - ], + ['errorCode' => 'Operate.NoPermission', 'errorMessage' => 'NoPermission', 'description' => 'You are not authorized to perform this operation.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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"}]', + 'title' => 'Delete a work item', + 'description' => 'To delete a work item, you must specify its properties.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteWorkitem'], + ], ], - '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"}]', + 'ramActions' => [], ], - 'GetGroupByPath' => [ - 'summary' => '根据路径查询代码组', - 'path' => '/api/4/groups/find_by_path', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'DeleteWorkitemAllComment' => [ + 'path' => '/organization/{organizationId}/workitems/deleteAllComment', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURErdc3GIDZJ'], ], 'parameters' => [ [ 'name' => 'organizationId', - 'in' => 'query', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '60de7a6852743a5162b5f957', - ], + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'Enterprise ID', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ - 'name' => 'identity', + 'name' => 'identifier', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '60de7a6852743a5162b5f957/test-group', - ], + 'schema' => ['title' => '', 'description' => 'Work item ID, equivalent to workitemId or workitemIdentifier; the UUID of the work item', 'type' => 'string', 'required' => true, 'example' => 'deafe5f33xxxxx6a259d8dafd'], ], ], 'responses' => [ @@ -18209,695 +7520,311 @@ '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', - ], - ], - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'A7586FEB-E48D-5579-983F-74981FBFF627'], + 'errorMsg' => ['description' => 'Error message', 'type' => 'string', 'example' => 'error', 'title' => ''], + 'errorCode' => ['description' => '- When success is false, returns the business error code. '."\n" + .'- When success is true, returns an empty value.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'success' => ['description' => 'true indicates the API call succeeded; false indicates the API call failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'deleteFlag' => ['description' => 'true indicates the deletion succeeded; false indicates the deletion failed.', 'type' => 'boolean', 'example' => 'true/false', 'title' => ''], ], + 'example' => '', ], ], ], - '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', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Openapi.RequestError', 'errorMessage' => 'request error', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'Operate.NoPermission', 'errorMessage' => 'NoPermission', 'description' => 'You are not authorized to perform this operation.'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'Delete all comments of the current work item', + 'summary' => 'Delete all comments of the current work item.', + 'description' => 'Delete all comments of the current work item.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteWorkitemAllComment'], + ], ], + 'ramActions' => [], + '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"}]', + ], + 'DeleteWorkitemComment' => [ + 'summary' => 'Delete a single comment under a work item.', + 'path' => '/organization/{organizationId}/workitems/deleteComent', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'organizationId', - 'in' => 'query', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '60de7a6852743a5162b5f957', - ], + 'in' => 'path', + 'schema' => ['description' => 'Organization identifier, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, for example: https://devops.aliyun.com/organization/【OrganizationId】', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx', 'title' => ''], ], [ - 'name' => 'accessToken', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'Request body', + 'type' => 'object', + 'properties' => [ + 'identifier' => ['description' => 'Unique identifier of the work item, equivalent to workitemId or workitemIdentifier.', 'type' => 'string', 'required' => true, 'example' => 'e8b2xxxxxx2abdxxxxxxxx23', 'title' => ''], + 'commentId' => ['description' => 'Comment ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12xx34', 'title' => ''], + ], 'required' => false, - 'example' => 'f0b1e61db5961df5975a93f9129d2513', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'parentId', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '26842', + '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' => 'Error message', 'type' => 'string', 'example' => 'error', 'title' => ''], + 'errorCode' => ['description' => '- When success is false, returns a business error code. '."\n" + .'- When success is true, returns an empty value.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'success' => ['description' => 'true indicates that the API call succeeded; false indicates that the API call failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'deleteFlag' => ['title' => '', 'description' => 'Indicates whether the deletion succeeded.', 'type' => 'boolean', 'example' => 'true/false'], + ], + 'example' => '', ], ], - [ - 'name' => 'page', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Openapi.RequestError', 'errorMessage' => 'request error', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'Operate.NoPermission', 'errorMessage' => 'NoPermission', 'description' => 'You are not authorized to perform this operation.'], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"success\\",\\n \\"success\\": \\"true\\",\\n \\"deleteFlag\\": true\\n}","type":"json"}]', + 'title' => 'Delete the current comment of the current work item', + 'description' => 'Delete a single comment under a work item.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteWorkitemComment'], + ], + ], + 'ramActions' => [], + ], + 'EnableDeployKey' => [ + 'summary' => 'Enables an existing deploy key in a repository.', + 'path' => '/repository/{repositoryId}/keys/{keyId}/enable', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'pageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'search', + 'name' => 'organizationId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Demo', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The organization ID. You can obtain this ID from your organization\'s URL in Alibaba Cloud DevOps: `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'required' => true, 'example' => '60de7a6852743a5162b5f957'], ], [ - 'name' => 'orderBy', + 'name' => 'accessToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'updated_at', - ], + 'schema' => ['description' => 'The personal access token. This parameter is optional if you use an Alibaba Cloud AccessKey pair (AK/SK) or an STS token.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], ], [ - 'name' => 'sort', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'desc', - ], + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => ['description' => 'The repository ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2709413', 'title' => ''], ], [ - 'name' => 'includePersonal', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'name' => 'keyId', + 'in' => 'path', + 'schema' => ['description' => 'The deploy key ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '50998', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', '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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'A unique identifier for the request.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => 'Openapi.RequestError', 'title' => ''], + 'errorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'success' => ['description' => 'Indicates if the request succeeded. `true` indicates success; `false` indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], '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', - ], - ], + 'description' => 'The result of the operation.', + 'type' => 'object', + 'properties' => [ + 'result' => ['description' => 'Indicates whether the deploy key was enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], '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.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => '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.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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"}]', + 'title' => 'Enable Deployment Key', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableDeployKey'], + ], ], - '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"}]', + 'ramActions' => [], ], - 'ListGroupRepositories' => [ - 'summary' => '查询代码组下的库列表', - 'path' => '/repository/groups/{groupId}/projects', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ExecuteChangeRequestReleaseStage' => [ + 'summary' => 'Executes a release stage pipeline.', + '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' => [], + 'systemTags' => ['operationType' => 'create', 'autoTest' => false, 'notSupportAutoTestReason' => '数据面 api 经安全评估统一不做处理,后续逐步安排下线', 'tenantRelevance' => 'tenant'], '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', - ], + 'schema' => ['description' => 'The organization ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '66c0c9fffeb86b450c199fcd', 'title' => ''], ], [ - 'name' => 'groupId', + 'name' => 'appName', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '35117', - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'example' => 'testApp', 'title' => ''], ], [ - 'name' => 'page', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'name' => 'releaseWorkflowSn', + 'in' => 'path', + 'schema' => ['description' => 'The unique ID for the release workflow.', 'type' => 'string', 'required' => true, 'example' => 'ce51b31b996246ecaf8747368383****', 'title' => ''], ], [ - 'name' => 'pageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + 'name' => 'releaseStageSn', + 'in' => 'path', + 'schema' => ['description' => 'The unique ID for the release stage.', 'type' => 'string', 'required' => true, 'example' => 'e173f3c11db5445eb426ca33c922****', 'title' => ''], ], [ - 'name' => 'search', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'params' => [ + 'description' => 'Parameters for the pipeline run.', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['description' => 'The pipeline source, specified as a branch name.<br>'."\n" + .'FLOW\\_INST\\_RUNNING\\_COMMENT: The run comment.<br>', 'type' => 'any', 'example' => '"spring-boot": "master",'."\n" + .'"FLOW_INST_RUNNING_COMMENT": "运行备注"', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], 'required' => false, - 'example' => 'Demo', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => 'ExecutePipelineResult', + 'description' => 'ExecutePipelineResult', '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', - ], - ], - ], - ], + 'object' => ['description' => 'The pipeline run ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'pipelineId' => ['description' => 'The pipeline ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '3259***', 'title' => ''], + 'pipelineRunId' => ['description' => 'The pipeline run ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"object\\": 1,\\n \\"pipelineId\\": 0,\\n \\"pipelineRunId\\": 1\\n}","type":"json"}]', + 'title' => 'Execute a pipeline in the development phase', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExecuteChangeRequestReleaseStage'], + ], ], - '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"}]', + 'ramActions' => [], ], - 'UpdatePushReviewOnOff' => [ - 'summary' => '推送评审模式开关', - 'path' => '/repository/{repositoryId}/settings/trunk_mode', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ExportInsightCustomValue' => [ + 'summary' => 'Retrieves data from the `custom_value` table for a specific enterprise in R&D Intelligence.', + 'path' => '/organization/{organizationId}/data/customValues', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'list'], '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', - ], + 'schema' => ['description' => 'The organization ID. This ID is part of the URL when you access Alibaba Cloud DevOps, for example, `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'required' => true, 'example' => '61db9af2148974246bexxxx'."\n", 'title' => ''], ], [ - 'name' => 'trunkMode', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'startTime' => ['description' => 'The start time for the query. The time range between `startTime` and `endTime` cannot exceed one year.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '2024-05-01 00:00:00'."\n"], + 'endTime' => ['description' => 'The end time for the query. The time range between `startTime` and `endTime` cannot exceed one year.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '2024-06-01 00:00:00'."\n"], + 'nextToken' => ['description' => 'The token to retrieve the next page of results.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '1'], + 'maxResults' => ['description' => 'The maximum number of results to return. The maximum value is 10,000.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '10'], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -18905,158 +7832,91 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', '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', - ], + 'totalCount' => ['description' => 'The total count of entries that match the query.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'], + 'nextToken' => ['description' => 'The token to retrieve the next page of results. A `null` value indicates that there are no more results.', 'type' => 'string', 'title' => '', 'example' => '2'], + 'maxResults' => ['description' => 'The number of entries returned in the current response.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], 'result' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'description' => 'The returned results.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of a single custom value record.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The auto-incrementing ID of the record.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '320737507'], + 'fieldId' => ['description' => 'The ID of the field, such as the ID of a custom field or a tag.', 'type' => 'string', 'title' => '', 'example' => '34dde3dfa5e3750151a7c4xxxx'], + 'gmtCreate' => ['description' => 'The creation time of the record, in Unix timestamp format (milliseconds).', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1704950971000'], + 'gmtModified' => ['description' => 'The last modification time of the record, in Unix timestamp format (milliseconds).', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1714669494000'], + 'identifier' => ['description' => 'The unique identifier for the associated value in the custom field table.', 'type' => 'string', 'title' => '', 'example' => '442d4a6a9980e841dc192a411080xxxx'], + 'isDeleted' => ['description' => 'Specifies whether the record is deleted. Valid values: `Y` and `N`.', 'type' => 'string', 'title' => '', 'example' => 'N'], + 'organizationId' => ['description' => 'The organization ID.', 'type' => 'string', 'title' => '', 'example' => '61db9af2148974246bexxxx'], + 'targetId' => ['description' => 'The resource ID of the associated object.', 'type' => 'string', 'title' => '', 'example' => '1ee00fcb1a18c2dc83dafdxxxx'], + 'targetType' => ['description' => 'The resource type of the associated object, such as `Workitem`, `space`, or `code`.', 'type' => 'string', 'title' => '', 'example' => 'Workitem'], + 'type' => ['description' => 'The value type of the custom field.', 'type' => 'string', 'title' => '', 'example' => 'string'], + 'value' => ['description' => 'The value of the custom field, in string format.', 'type' => 'string', 'example' => '66', 'title' => ''], + 'doubleValue' => ['description' => 'The value of the custom field, in double format.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '66.6'], + 'longValue' => ['description' => 'The value of the custom field, in long format.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '66'], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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"}]', + 'title' => 'Export CustomValue', + 'description' => 'The Insight data export API is for Advanced Edition customers only. To learn more about the features of Alibaba Cloud DevOps Advanced Edition, visit <https://help.aliyun.com/document_detail/173288.html>.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExportInsightCustomValue'], + ], ], - '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"}]', + 'ramActions' => [], ], - 'CreatePushRule' => [ - 'summary' => '创建推送规则', - 'path' => '/api/v4/projects/{repositoryId}/push_rule', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ExportInsightExpectedWorkTime' => [ + 'summary' => 'Retrieves data from the expected_work_time table in Insight for a specified organization.', + 'path' => '/organization/{organizationId}/data/expectedWorkTimes', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'list'], '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', - ], + 'schema' => ['description' => 'The organization ID. You can obtain this ID from the URL when you access Alibaba Cloud DevOps, for example: `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'required' => true, 'example' => '61db9af2148974246bexxxx'."\n", 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', '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' => 'user@example.com', - ], - '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, - ], + 'startTime' => ['description' => 'The start time for the query. The time range between the start and end times cannot exceed one year.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '2024-05-01 00:00:00'."\n"], + 'endTime' => ['description' => 'The end time for the query. The time range between the start and end times cannot exceed one year.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '2024-06-01 00:00:00'."\n"], + 'nextToken' => ['description' => 'The token used to retrieve the next page of results.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '1'], + 'maxResults' => ['description' => 'The maximum number of results to return. The maximum value is 10,000.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '10'], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -19064,214 +7924,90 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response body.', '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', - ], + 'totalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'], + 'nextToken' => ['description' => 'The token for the next page of results. A `null` value indicates that there are no more pages.', 'type' => 'string', 'title' => '', 'example' => '2'], + 'maxResults' => ['description' => 'The number of entries returned in this response.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], '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', - ], + 'description' => 'The array of result objects.', + 'type' => 'array', + 'items' => [ + 'description' => 'An object that contains the details of an expected work time record.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The auto-incrementing ID of the record.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '26281535'], + 'gmtCreate' => ['description' => 'The creation time, in milliseconds, as a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1714976497000'], + 'gmtModified' => ['description' => 'The modification time, in milliseconds, as a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1714976520000'], + 'identifier' => ['description' => 'The unique identifier for the expected work time entry.', 'type' => 'string', 'title' => '', 'example' => 'bd4ddc7b0ea0ef2ab52699xxxx'], + 'isDeleted' => ['description' => 'Specifies if the entry is deleted. Valid values: Y (Yes), N (No).', 'type' => 'string', 'title' => '', 'example' => 'N'."\n"], + 'organizationId' => ['description' => 'The organization ID. This ID serves as the tenant ID for data isolation.', 'type' => 'string', 'title' => '', 'example' => '61db9af2148974246be6xxxx'], + 'projectId' => ['description' => 'The ID of the project.', 'type' => 'string', 'title' => '', 'example' => '6c4687b0179e1d458fedf1xxxx'], + 'recorderId' => ['description' => 'The ID of the user who recorded the expected work time.', 'type' => 'string', 'title' => '', 'example' => '63466a385dc8531eebd7xxxx'], + 'source' => ['description' => 'The source of the work time entry.', 'type' => 'string', 'title' => '', 'example' => 'projex'], + 'type' => ['description' => 'The category of the work time.', 'type' => 'string', 'title' => '', 'example' => '产品'], + 'value' => ['description' => 'The duration of the expected work time.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '180'], + 'workitemId' => ['description' => 'The ID of the associated work item.', 'type' => 'string', 'title' => '', 'example' => 'de7c6fd3bd4b53f4d9e279xxxx'], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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"}]', + 'title' => 'Export ExpectedWorkTime', + 'description' => 'This Insight data export API is available only to Advanced Edition customers. To learn more about Alibaba Cloud DevOps Advanced Edition, visit <https://help.aliyun.com/document_detail/173288.html>.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExportInsightExpectedWorkTime'], + ], ], - '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"}]', + 'ramActions' => [], ], - 'UpdatePushRule' => [ - 'summary' => '更新推送规则', - 'path' => '/api/v4/projects/{repositoryId}/push_rule/{pushRuleId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'ExportInsightField' => [ + 'summary' => 'Retrieves an organization\'s field data from DevOps Insights.', + 'path' => '/organization/{organizationId}/data/fields', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'list'], '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', - ], + 'schema' => ['description' => 'The organization ID. You can find it in the URL for Alibaba Cloud DevOps, such as https\\://devops.aliyun.com/organization/#{organizationId}.', 'type' => 'string', 'required' => true, 'example' => '61db9af2148974246bexxxx'."\n", 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', '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, - ], + 'startTime' => ['description' => 'The duration between the start time and end time cannot exceed one year.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '2024-05-01 00:00:00'."\n"], + 'endTime' => ['description' => 'The duration between the start time and end time cannot exceed one year.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '2024-06-01 00:00:00'."\n"], + 'nextToken' => ['description' => 'The pagination token.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '1'], + 'maxResults' => ['description' => 'The maximum number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '10'], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -19279,159 +8015,94 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response body.', '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', - ], + 'totalCount' => ['description' => 'The total count of fields.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'], + 'nextToken' => ['description' => 'The next page token. If the value is `null`, there are no more pages.', 'type' => 'string', 'title' => '', 'example' => '2'], + 'maxResults' => ['description' => 'The maximum results to return per page.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], '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', - ], + 'description' => 'An array of field objects.', + 'type' => 'array', + 'items' => [ + 'description' => 'A field object.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The auto-incrementing ID of the field.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '666666'], + 'fieldId' => ['description' => 'The field ID, such as a custom field ID or tag ID.', 'type' => 'string', 'title' => '', 'example' => '9798551'], + 'fieldName' => ['description' => 'The field name.', 'type' => 'string', 'title' => '', 'example' => '多选字段'], + 'gmtCreate' => ['description' => 'The creation time, as a millisecond Unix timestamp.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1713752162000'], + 'gmtModified' => ['description' => 'The update time, as a millisecond Unix timestamp.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1714977502000'], + 'identifier' => ['description' => 'Deprecated.', 'type' => 'string', 'title' => '', 'example' => 'field-444153'], + 'isDeleted' => ['description' => 'Whether the field is deleted (Y for Yes, N for No).', 'type' => 'string', 'title' => '', 'example' => 'N'], + 'isSystem' => ['description' => 'Whether this is a system field (Y for Yes, N for No).', 'type' => 'string', 'title' => '', 'example' => 'N'], + 'optionValue' => ['description' => 'A JSON array of optional values for the field, provided as a string. This is typically used for enumeration types.', 'type' => 'string', 'title' => '', 'example' => '"[\\"是\\"]"'], + 'organizationId' => ['description' => 'The organization ID.', 'type' => 'string', 'title' => '', 'example' => '61db9af2148974246bexxxx'], + 'targetId' => ['description' => 'The ID of the target object to which the field applies, such as a project ID or organization ID.', 'type' => 'string', 'title' => '', 'example' => '61db9af2148974246bexxxx'], + 'targetType' => ['description' => 'The type of the target object. For example, `project` or `organization`.', 'type' => 'string', 'title' => '', 'example' => 'organization'], + 'type' => ['description' => 'The data type of the field, such as `tag`, `enumeration`, `text`, or `number`.', 'type' => 'string', 'title' => '', 'example' => 'string'], + 'position' => ['description' => 'The field order.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '150'], + 'scope' => ['description' => 'The field scope. Valid values are `space` (project), `global` (organization-wide), and `system` (system-defined).', 'type' => 'string', 'title' => '', 'example' => 'global'], + 'source' => ['description' => 'The source system of the field, such as `projex` or `teambition`.', 'type' => 'string', 'title' => '', 'example' => 'projex'], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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"}]', + 'title' => 'Export Field ', + 'description' => 'The performance insights data export API is available only in the Alibaba Cloud DevOps Advanced edition. For more information about the Advanced edition, see <https://help.aliyun.com/document_detail/173288.html>.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExportInsightField'], + ], ], - '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"}]', + 'ramActions' => [], ], - 'DeletePushRule' => [ - 'summary' => '删除推送规则', - 'path' => '/api/v4/projects/{repositoryId}/push_rule/{pushRuleId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'ExportInsightSpace' => [ + 'summary' => 'Retrieves data from the space table in DevOps Insights for a specified enterprise.', + 'path' => '/organization/{organizationId}/data/spaces', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + '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' => '2813489', - ], + 'schema' => ['description' => 'The organization ID. You can find this ID in the URL of your organization\'s Alibaba Cloud DevOps page. For example: https\\://devops.aliyun.com/organization/#{organizationId}.', 'type' => 'string', 'required' => true, 'example' => '61db9af2148974246bexxxx'."\n", 'title' => ''], ], [ - 'name' => 'pushRuleId', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '2077', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'startTime' => ['description' => 'The start time for the query. The period between the start and end times must not exceed one year.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '2024-05-01 00:00:00'."\n"], + 'endTime' => ['description' => 'The end time for the query. The period between the start and end times must not exceed one year.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '2024-06-01 00:00:00'."\n"], + 'nextToken' => ['description' => 'The token to retrieve the next page of results. The response includes this token when more results are available.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '1'], + 'maxResults' => ['description' => 'The maximum number of results to return per page.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '10'], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -19439,105 +8110,92 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response schema.', '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', - ], + 'totalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'], + 'nextToken' => ['description' => 'The token to retrieve the next page of results. A value of `null` indicates that no more results are available.', 'type' => 'string', 'title' => '', 'example' => '2'], + 'maxResults' => ['description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], 'result' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'description' => 'An array of space objects.', + 'type' => 'array', + 'items' => [ + 'description' => 'A space object.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The auto-incrementing ID of the record.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '11034222'], + 'gmtCreate' => ['description' => 'The time the record was created, as a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1706510424000'], + 'gmtModified' => ['description' => 'The time the record was last modified, as a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1706511201000'], + 'identifier' => ['description' => 'The unique identifier of the space.', 'type' => 'string', 'title' => '', 'example' => '83a2861bbb43b270a04b42xxxx'], + 'isDeleted' => ['description' => 'Specifies whether the space is deleted. Valid values are `Y` and `N`.', 'type' => 'string', 'title' => '', 'example' => 'N'], + 'organizationId' => ['description' => 'The organization ID.', 'type' => 'string', 'title' => '', 'example' => '61db9af2148974246be6xxxx'], + 'description' => ['description' => 'The space description.', 'type' => 'string', 'title' => '', 'example' => '项目描述'], + 'name' => ['description' => 'The space name.', 'type' => 'string', 'title' => '', 'example' => '研发项目'], + 'type' => ['description' => 'The space type, such as `Enterprise`, `Project`, or `Product`.', 'type' => 'string', 'title' => '', 'example' => 'Project'], + 'category' => ['description' => 'The space template category, such as `Agile Development` or `Classic Project`.', 'type' => 'string', 'title' => '', 'example' => 'Project'], + 'source' => ['description' => 'The source of the space.', 'type' => 'string', 'title' => '', 'example' => 'projex'], + 'status' => ['description' => 'The space status.', 'type' => 'string', 'title' => '', 'example' => '未开始'], + 'stage' => ['description' => 'The stage of the space.', 'type' => 'string', 'title' => '', 'example' => '10'], + 'customCode' => ['title' => 'Custom code ', 'description' => 'The custom code.', 'type' => 'string', 'example' => 'ABCD'], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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"}]', + 'title' => 'Export Space', + 'description' => 'The Project Insights data export API is an exclusive feature of the Alibaba Cloud DevOps Enterprise Edition. For more details, visit <https://help.aliyun.com/document_detail/173288.html>.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExportInsightSpace'], + ], ], - '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"}]', + 'ramActions' => [], ], - 'ListPushRules' => [ - 'summary' => '查询推送规则列表', - 'path' => '/api/v4/projects/{repositoryId}/push_rule/push_rules/list', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ExportInsightSpaceRef' => [ + 'summary' => 'Exports data from the space_ref table in DevOps Insight for a specified organization.', + 'path' => '/organization/{organizationId}/data/spaceRefs', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ 'name' => 'organizationId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '60d54f3daccf2bbd6659f3ad', - ], + 'in' => 'path', + 'schema' => ['description' => 'The ID of the organization. You can find this ID in your Alibaba Cloud DevOps URL, for example: https\\://devops.aliyun.com/organization/#{organizationId}.', 'type' => 'string', 'required' => true, 'example' => '61db9af2148974246bexxxx', 'title' => ''], ], [ - 'name' => 'accessToken', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The container for the request parameters.', + 'type' => 'object', + 'properties' => [ + 'startTime' => ['description' => 'The start time for the query. The duration between startTime and endTime cannot exceed one year.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '2024-05-01 00:00:00'."\n"], + 'endTime' => ['description' => 'The end time for the query.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '2024-06-01 00:00:00'."\n"], + 'nextToken' => ['description' => 'The nextToken value returned from a previous request, used for pagination.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '1'], + 'maxResults' => ['description' => 'The maximum number of results to return.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '10'], + ], 'required' => false, - 'example' => 'f0b1e61db5961df5975a93f9129d2513', - ], - ], - [ - 'name' => 'repositoryId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '889910', + 'title' => '', + 'example' => '', ], ], ], @@ -19548,181 +8206,86 @@ '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', - ], + 'totalCount' => ['description' => 'The total number of results that match the query.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'], + 'nextToken' => ['description' => 'The token for retrieving the next page of results. If the value is not null, pass it in a subsequent request to get the next page.', 'type' => 'string', 'title' => '', 'example' => '2'], + 'maxResults' => ['description' => 'The number of results returned on the current page.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], 'result' => [ - 'description' => '', + 'description' => 'The list of results for the current page.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'A space\\_ref object.', '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', - ], - ], + 'id' => ['description' => 'The auto-incrementing ID of the record.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '356525'], + 'gmtCreate' => ['description' => 'The time when the record was created, as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1704267849000'], + 'gmtModified' => ['description' => 'The time when the record was last modified, as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1704267849000'], + 'identifier' => ['description' => 'The unique identifier of the record.', 'type' => 'string', 'title' => '', 'example' => '49565'], + 'isDeleted' => ['description' => 'Indicates whether the record is deleted. Valid values: \'Y\' and \'N\'.', 'type' => 'string', 'title' => '', 'example' => 'N'], + 'organizationId' => ['description' => 'The ID of the organization.', 'type' => 'string', 'title' => '', 'example' => '61db9af2148974246bexxxx'], + 'creatorId' => ['description' => 'The ID of the user who created the record.', 'type' => 'string', 'title' => '', 'example' => '65659358c319d2a0f912xxxx'], + 'modifierId' => ['description' => 'The ID of the user who last modified the record.', 'type' => 'string', 'title' => '', 'example' => '65659358c319d2a0f912xxxx'], + 'fromId' => ['description' => 'The ID of the source space.', 'type' => 'string', 'title' => '', 'example' => '7bc2be989727d0d4c9801fxxxx'], + 'toId' => ['description' => 'The ID of the target space.', 'type' => 'string', 'title' => '', 'example' => '732026500a48d7a74f8b43xxxx'], + 'type' => ['description' => 'The type of association. For example, \'ASSOCIATED\' indicates that a program is associated with a project.', 'type' => 'string', 'title' => '', 'example' => 'ASSOCIATED'], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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"}]', + 'title' => 'Export SpaceRef', + 'description' => 'This API is available only for advanced edition customers. To learn more about the features of the Alibaba Cloud DevOps advanced edition, visit <https://help.aliyun.com/document_detail/173288.html>', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExportInsightSpaceRef'], + ], ], - '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"}]', + 'ramActions' => [], ], - 'CreateDeployKey' => [ - 'summary' => '创建部署密钥', - 'path' => '/repository/{repositoryId}/keys/create', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ExportInsightSprint' => [ + 'summary' => 'Fetches sprint table data for a specific enterprise from Insights.', + 'path' => '/organization/{organizationId}/data/sprints', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'list'], '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', - ], + 'schema' => ['description' => 'The organization ID. You can find this ID in the URL for your Alibaba Cloud DevOps organization, for example, https\\://devops.aliyun.com/organization/#{organizationId}.', 'type' => 'string', 'required' => true, 'example' => '61db9af2148974246bexxxx', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'title' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - 'key' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '""', - ], + 'startTime' => ['description' => 'The start of the time range. The time range cannot exceed one year.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '2024-05-01 00:00:00'."\n"], + 'endTime' => ['description' => 'The end of the time range.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '2024-06-01 00:00:00'."\n"], + 'nextToken' => ['description' => 'The token to retrieve the next page of results.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '1'], + 'maxResults' => ['description' => 'The maximum number of results to return.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '10'], ], - 'required' => true, + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -19730,149 +8293,93 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', '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', - ], + 'totalCount' => ['description' => 'The total count of items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'], + 'nextToken' => ['description' => 'The token for retrieving the next page of results. A null value indicates that there are no more results.', 'type' => 'string', 'title' => '', 'example' => '2'], + 'maxResults' => ['description' => 'The maximum number of items returned.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], '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', - ], + 'description' => 'An array of sprint objects.', + 'type' => 'array', + 'items' => [ + 'description' => 'A sprint object.', + 'type' => 'object', + 'properties' => [ + 'gmtCreate' => ['description' => 'The creation time, as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1710989643000'], + 'id' => ['description' => 'The auto-incrementing ID of the sprint.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '18471761'], + 'gmtModified' => ['description' => 'The last update time, as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1711936113000'], + 'identifier' => ['description' => 'The unique identifier of the sprint.', 'type' => 'string', 'title' => '', 'example' => 'e4895cadc86632f34dfaa7xxxx'], + 'isDeleted' => ['description' => 'Indicates if the sprint is deleted. Valid values: Y and N.', 'type' => 'string', 'title' => '', 'example' => 'N'], + 'organizationId' => ['description' => 'The organization ID.', 'type' => 'string', 'title' => '', 'example' => '61db9af2148974246bexxxx'], + 'gmtEnd' => ['description' => 'The planned end time of the sprint, as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1711728000000'], + 'gmtStart' => ['description' => 'The planned start time of the sprint, as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1711936113000'], + 'actualStart' => ['description' => 'The actual start time of the sprint, as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1711936113000'], + 'actualEnd' => ['description' => 'The actual end time of the sprint, as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1711936113000'], + 'name' => ['description' => 'The sprint name.', 'type' => 'string', 'title' => '', 'example' => '迭代0601'], + 'source' => ['description' => 'The source of the sprint data.', 'type' => 'string', 'title' => '', 'example' => 'projex'], + 'projectId' => ['description' => 'The project ID.', 'type' => 'string', 'title' => '', 'example' => '385e7e5a4be6791f0a5185xxxx'], + 'workTimeCapacity' => ['description' => 'The estimated work time capacity, in hours.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '60.0'], + 'status' => ['description' => 'The sprint status. Valid values: 10 (Pending), 50 (In Progress), and 100 (Completed/Closed).', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '50'], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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 \\"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"}]', + 'title' => 'Export Sprint', + 'description' => 'The Insights data export API is exclusive to Advanced Edition customers. To learn more about Alibaba Cloud DevOps Advanced Edition features, see <https://help.aliyun.com/document_detail/173288.html>.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExportInsightSprint'], ], ], - '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"}]', + 'ramActions' => [], ], - 'EnableDeployKey' => [ - 'summary' => '启用部署密钥', - 'path' => '/repository/{repositoryId}/keys/{keyId}/enable', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ExportInsightTagRef' => [ + 'summary' => 'Exports the tag_ref table data from Performance Insight for a specified enterprise.', + 'path' => '/organization/{organizationId}/data/tagRefs', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'list'], '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', - ], + 'schema' => ['description' => 'The enterprise ID. You can find this ID in the URL of your Alibaba Cloud DevOps organization: `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'required' => true, 'example' => '61db9af2148974246bexxxx', 'title' => ''], ], [ - 'name' => 'keyId', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '50998', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'startTime' => ['description' => 'The start of the time range to query. The interval between the start time and end time cannot exceed one year.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '2024-05-01 00:00:00'."\n"], + 'endTime' => ['description' => 'The end of the time range to query. The interval between the start time and end time cannot exceed one year.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '2024-06-01 00:00:00'."\n"], + 'nextToken' => ['description' => 'The token to retrieve the next page of results.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '1'], + 'maxResults' => ['description' => 'The maximum number of results to return per page. The maximum value is 10,000.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '10'], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -19880,142 +8387,88 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', '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', - ], + 'totalCount' => ['description' => 'The total count of matching entries.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'], + 'nextToken' => ['description' => 'The token to retrieve the next page of results. A null value indicates that all results have been returned.', 'type' => 'string', 'title' => '', 'example' => '2'], + 'maxResults' => ['description' => 'The number of entries returned in the current response.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], 'result' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'description' => 'An array of tag reference objects.', + 'type' => 'array', + 'items' => [ + 'description' => 'An object that contains the details of a tag reference.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The auto-increment ID of the record.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '41317426'], + 'gmtCreate' => ['description' => 'The creation time of the record, as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1696660187000'], + 'gmtModified' => ['description' => 'The time the record was last updated, as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1696660187000'], + 'identifier' => ['description' => 'The unique identifier of the record.', 'type' => 'string', 'title' => '', 'example' => '8545272'], + 'isDeleted' => ['description' => 'Indicates whether the record is deleted. Valid values: Y and N.', 'type' => 'string', 'title' => '', 'example' => 'N'], + 'organizationId' => ['description' => 'The enterprise ID.', 'type' => 'string', 'title' => '', 'example' => '61db9af2148974246bexxxx'], + 'name' => ['description' => 'The tag name.', 'type' => 'string', 'title' => '', 'example' => '1'], + 'tagId' => ['description' => 'The unique identifier of the tag.', 'type' => 'string', 'title' => '', 'example' => '19e0bc5348ccbe6c0d00fbxxxx'], + 'targetId' => ['description' => 'The resource ID of the tagged resource.', 'type' => 'string', 'title' => '', 'example' => 'bde89961b5a4acc8cf54eaxxxx'], + 'targetType' => ['description' => 'The resource type of the tagged resource. Examples: Workitem, Space, and Code.', 'type' => 'string', 'title' => '', 'example' => 'Workitem'], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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 \\"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"}]', + 'title' => 'Export TagRef', + 'description' => 'The Performance Insight data export API is exclusive to Advanced Edition subscribers. To learn more about the features of Alibaba Cloud DevOps Advanced Edition, see [https://www.alibabacloud.com/help/en/doc-detail/173288.html](https://help.aliyun.com/document_detail/173288.html).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExportInsightTagRef'], ], ], - '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"}]', + 'ramActions' => [], ], - 'CreateUserKey' => [ - 'summary' => '创建SSH Key密钥', - 'path' => '/api/v3/user/keys/create', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ExportInsightWorkTime' => [ + 'summary' => 'Retrieve data for a specific enterprise from the `workitem_time` table in Insight.', + 'path' => '/organization/{organizationId}/data/workTimes', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'list'], '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", - ], + 'in' => 'path', + 'schema' => ['description' => 'The organization ID. You can find this ID in the URL you use to access Alibaba Cloud DevOps. For example: `https://devops.aliyun.com/organization/#{organizationId}`.', 'type' => 'string', 'required' => true, 'example' => '61db9af2148974246bexxxx', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', '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', - ], + 'startTime' => ['description' => 'The start of the time range. The time range cannot exceed one year.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '2024-05-01 00:00:00'."\n"], + 'endTime' => ['description' => 'The end of the time range. The time range cannot exceed one year.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '2024-06-01 00:00:00'."\n"], + 'nextToken' => ['description' => 'The pagination token from a previous request. Use this token to retrieve the next page of results.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '1'], + 'maxResults' => ['description' => 'The maximum number of results to return per page.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '10'], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -20023,141 +8476,95 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', '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', - ], + 'totalCount' => ['description' => 'The total number of entries that match the query.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'], + 'nextToken' => ['description' => 'The pagination token to retrieve the next page of results. If this field is `null`, there are no more results.', 'type' => 'string', 'title' => '', 'example' => '2'], + 'maxResults' => ['description' => 'The number of entries on the current page.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], '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', - ], + 'description' => 'The results of the query.', + 'type' => 'array', + 'items' => [ + 'description' => 'A work time object.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The auto-incrementing ID of the record.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '49506082'], + 'gmtCreate' => ['description' => 'The time the record was created, as a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1714978610000'], + 'gmtModified' => ['description' => 'The time the record was last updated, as a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1714978610000'], + 'identifier' => ['description' => 'The unique identifier of the work time entry.', 'type' => 'string', 'title' => '', 'example' => 'da70ce5824231ca3c04ef808e0'], + 'isDeleted' => ['description' => 'Indicates whether the entry is deleted. Valid values are `Y` and `N`.', 'type' => 'string', 'title' => '', 'example' => 'N'], + 'organizationId' => ['description' => 'The ID of the organization.', 'type' => 'string', 'title' => '', 'example' => '61db9af2148974246bexxxx'], + 'recorderId' => ['description' => 'The ID of the user who recorded the work time.', 'type' => 'string', 'title' => '', 'example' => '65659358c319d2a0f912xxxx'], + 'source' => ['description' => 'The source of the data. Valid values include `projex` and `Teambition`.', 'type' => 'string', 'title' => '', 'example' => 'projex'], + 'value' => ['description' => 'The duration of the work time, in hours.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '120'], + 'workitemId' => ['description' => 'The ID of the work item.', 'type' => 'string', 'title' => '', 'example' => '17bc1cf9a037a15fc9ce76xxxx'], + 'projectId' => ['description' => 'The ID of the project.', 'type' => 'string', 'title' => '', 'example' => '09670872890eb1a0bb998exxxx'], + 'type' => ['description' => 'The category of the actual work time.', 'type' => 'string', 'title' => '', 'example' => '研发'], + 'gmtStart' => ['description' => 'The start time of the actual work time, as a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1714924800000'], + 'gmtEnd' => ['description' => 'The end time of the actual work time, as a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1715011199999'], + 'uuid' => ['description' => 'The unique identifier for a split work time entry.', 'type' => 'string', 'title' => '', 'example' => '000000000cd82d3df50d5e5a5c094094fd7b4461'], + 'actualValue' => ['description' => 'The duration of the split work time entry, in hours.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '120'], + 'description' => ['description' => 'The description of the work time.', 'type' => 'string', 'title' => '', 'example' => '描述信息'], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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"}]', + 'title' => 'Export WorkTime', + 'description' => 'The Effectiveness Insight data export API is a feature of the advanced edition. To learn more about the advanced edition of Alibaba Cloud DevOps, visit <https://help.aliyun.com/document_detail/173288.html>.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExportInsightWorkTime'], + ], ], - '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"}]', + 'ramActions' => [], ], - 'DeleteUserKey' => [ - 'summary' => '删除用户的SSH Key', - 'path' => '/api/v3/user/keys/{keyId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'ExportInsightWorkitemStatus' => [ + 'summary' => 'Retrieves data from the `workitem_status` table in Performance Insight for a specific enterprise.', + 'path' => '/organization/{organizationId}/data/workitemStatuses', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ 'name' => 'organizationId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'in' => 'path', + 'schema' => ['description' => 'The organization ID. You can find this ID in the Alibaba Cloud DevOps URL. For example: https\\://devops.aliyun.com/organization/#{organizationId}.', 'type' => 'string', 'required' => true, 'example' => '61db9af2148974246bexxxx'."\n", 'title' => ''], ], [ - 'name' => 'accessToken', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'startTime' => ['description' => 'The start of the time range for the query. This range cannot exceed one year.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '2024-05-01 00:00:00'."\n"], + 'endTime' => ['description' => 'The end of the time range for the query. This range cannot exceed one year.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '2024-06-01 00:00:00'."\n"], + 'nextToken' => ['description' => 'The token used to retrieve the next page of results.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '1'], + 'maxResults' => ['description' => 'The maximum number of results to return.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '10'], + ], 'required' => false, - 'example' => 'f0b1e61db5961df5975a93f9129d2513', - ], - ], - [ - 'name' => 'keyId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '50998', + 'title' => '', + 'example' => '', ], ], ], @@ -20165,187 +8572,114 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response schema.', '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', - ], + 'totalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'], + 'nextToken' => ['description' => 'The token for retrieving the next page of results. If this parameter is empty, all results have been returned.', 'type' => 'string', 'title' => '', 'example' => '2'], + 'maxResults' => ['description' => 'The number of records returned on the current page.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], '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', - ], + 'description' => 'An array of workitem status records.', + 'type' => 'array', + 'items' => [ + 'description' => 'The status details for a workitem.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The unique ID of the record.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '701615370'], + 'gmtCreate' => ['description' => 'The creation time, as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1713430241000'], + 'gmtModified' => ['description' => 'The last modification time, as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1713430241000'], + 'workitemId' => ['description' => 'The ID of the workitem.', 'type' => 'string', 'title' => '', 'example' => '636f661a612a945bbcdb4cxxxx'], + 'isDeleted' => ['description' => 'Specifies whether the workitem is deleted. Valid values are `Y` and `N`.', 'type' => 'string', 'title' => '', 'example' => 'N'], + 'organizationId' => ['description' => 'The ID of the organization.', 'type' => 'string', 'title' => '', 'example' => '61db9af2148974246bexxxx'], + 'assignedToId' => ['description' => 'The ID of the assignee.', 'type' => 'string', 'title' => '', 'example' => '65e836b981d758be7a25xxxx'], + 'creatorId' => ['description' => 'The ID of the workitem\'s creator.', 'type' => 'string', 'title' => '', 'example' => '65e836b981d758be7a25xxxx'], + 'gmtClosed' => ['description' => 'The actual closing time, as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '33166339200000'], + 'gmtTodo' => ['description' => 'The estimated start time, as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '33166339200000'], + 'gmtDue' => ['description' => 'The estimated due time, as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '33166339200000'], + 'gmtStart' => ['description' => 'The actual start time (when a requirement is scheduled or confirmed), as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '33166339200000'], + 'isArchived' => ['description' => 'Specifies whether the workitem is archived. Valid values are `Y` and `N`.', 'type' => 'string', 'title' => '', 'example' => 'N'], + 'isDone' => ['description' => 'Specifies whether the workitem is complete. Valid values are `Y` and `N`.', 'type' => 'string', 'title' => '', 'example' => 'Y'], + 'parentId' => ['description' => 'The ID of the parent workitem.', 'type' => 'string', 'title' => '', 'example' => 'c3640ab6233fcc10a7e3aaxxxx'], + 'participantIds' => ['description' => 'A comma-separated string of participant IDs.', 'type' => 'string', 'title' => '', 'example' => '6135b21fb383ef39551cxxxx,63466a385dc8531eebd7xxxx'], + 'phase' => ['description' => 'The major phase of the workitem (a value from 10 to 100), corresponding to To-do, Doing, and Done.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], + 'stage' => ['description' => 'The minor stage of the workitem (a value from 10 to 100), corresponding to projex stages such as confirmation, analysis, processing, design, and development.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], + 'priority' => ['description' => 'The priority of the workitem, on a scale of 0 to 9.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'], + 'productId' => ['description' => 'The ID of the product.', 'type' => 'string', 'title' => '', 'example' => '无'], + 'projectId' => ['description' => 'The ID of the project.', 'type' => 'string', 'title' => '', 'example' => '505ac6433dfbda8df0b08bxxxx'], + 'source' => ['description' => 'The source system, such as `teambition` or `projex`.', 'type' => 'string', 'title' => '', 'example' => 'projex'], + 'sprintId' => ['description' => 'The ID of the sprint.', 'type' => 'string', 'title' => '', 'example' => '505ac6433dfbda8df0b08bxxxx'], + 'status' => ['description' => 'The name of the status.', 'type' => 'string', 'title' => '', 'example' => '待处理'], + 'statusId' => ['description' => 'The ID of the status.', 'type' => 'string', 'title' => '', 'example' => '100005'], + 'storyPoint' => ['description' => 'The number of story points.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '10.0'], + 'subject' => ['description' => 'The title of the workitem.', 'type' => 'string', 'title' => '', 'example' => '测试'], + 'type' => ['description' => 'The major type of the workitem, such as requirement, task, or defect.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'subType' => ['description' => 'The subtype of the workitem, such as a technical requirement or a product requirement.', 'type' => 'string', 'title' => '', 'example' => '9uy29901re573f561d69xxxx'], + 'versionId' => ['description' => 'The ID of the version.', 'type' => 'string', 'title' => '', 'example' => '无'], + 'workTime' => ['description' => 'The actual time spent on the workitem, in minutes.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], + 'expectedWorkTime' => ['description' => 'The estimated time required for the workitem, in minutes.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], + 'versions' => ['description' => 'A string representation of an array of associated version IDs.', 'type' => 'string', 'title' => '', 'example' => '[6a8cdda167415bea1506c7262c]'], + 'serialNumber' => ['title' => 'Serial number within the Space', 'description' => 'The serial number of the workitem within its space.', 'type' => 'integer', 'format' => 'int32', 'example' => '66'], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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', + '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"}]', + 'title' => 'Export WorkitemStatus ', + 'description' => 'The Efficiency Insight data export API is available only to Advanced Edition customers. Learn more about the Alibaba Cloud DevOps Advanced Edition at <https://help.aliyun.com/document_detail/173288.html>', + 'changeSet' => [ + ['createdAt' => '2024-08-02T13:30:03.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExportInsightWorkitemStatus'], + ], ], + 'ramActions' => [], + ], + 'ExportInsightWorkitemStatusJoinWorkitemDefectExtra' => [ + 'summary' => 'Joins the `workitem_status` and `workitem_defect_extra` tables to retrieve efficiency insight data for a specified enterprise.', + 'path' => '/organization/{organizationId}/data/workitemStatusJoinWorkitemDefectExtras', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'list'], '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', - ], + 'in' => 'path', + 'schema' => ['description' => 'The organization ID. You can find this ID in the Alibaba Cloud DevOps URL, for example, https\\://devops.aliyun.com/organization/#{organizationId}.', 'type' => 'string', 'required' => true, 'example' => '61db9af2148974246bexxxx'."\n", 'title' => ''], ], [ - 'name' => 'orderBy', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'startTime' => ['description' => 'The start time. The specified time range cannot exceed one year.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '2024-05-01 00:00:00'."\n"], + 'endTime' => ['description' => 'The end time. The specified time range cannot exceed one year.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '2024-06-01 00:00:00'."\n"], + 'nextToken' => ['description' => 'The token to retrieve the next page of results. This is the nextToken value from a previous response. If omitted, the first page of results is returned.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '1'], + 'maxResults' => ['description' => 'The maximum number of results to return per page. If more results are available, the response includes a nextToken to retrieve the next page. If omitted, a default value is used.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '10'], + ], 'required' => false, - 'example' => 'created_at', + 'title' => '', + 'example' => '', ], ], ], @@ -20353,234 +8687,123 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response schema.', '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', - ], + 'totalCount' => ['description' => 'The total number of entries that match the query.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'], + 'nextToken' => ['description' => 'The token for the next page. A `null` value means no more pages are available.', 'type' => 'string', 'title' => '', 'example' => '2'], + 'maxResults' => ['description' => 'The number of entries returned on the current page.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], 'result' => [ - 'description' => '', + 'description' => 'An array of the returned data entries.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'An object that contains the joined data from the `workitem_status` and `workitem_defect_extra` tables.', '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', - ], - ], + 'id' => ['description' => 'The auto-incrementing ID of the record.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '701615370'], + 'gmtCreate' => ['description' => 'The time when the record was created. The value is a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1713430241000'], + 'gmtModified' => ['description' => 'The time when the record was last modified. The value is a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1714755985000'], + 'workitemId' => ['description' => 'The unique identifier of the work item.', 'type' => 'string', 'title' => '', 'example' => '636f661a612a945bbcdb4cxxxx'], + 'isDeleted' => ['description' => 'Indicates whether the work item is deleted. Valid values: `Y` (Yes) and `N` (No).', 'type' => 'string', 'title' => '', 'example' => 'N'], + 'organizationId' => ['description' => 'The ID of the organization.', 'type' => 'string', 'title' => '', 'example' => '61db9af2148974246bexxxx'], + 'assignedToId' => ['description' => 'The ID of the user assigned to the work item.', 'type' => 'string', 'title' => '', 'example' => '65e836b981d758be7a25xxxx'], + 'creatorId' => ['description' => 'The ID of the creator.', 'type' => 'string', 'title' => '', 'example' => '65e836b981d758be7a25xxxx'], + 'gmtClosed' => ['description' => 'The actual time when the work item was closed. The value is a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '33166339200000'], + 'gmtTodo' => ['description' => 'The estimated start time for the work item. The value is a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '33166339200000'], + 'gmtDue' => ['description' => 'The estimated due time for the work item. The value is a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '33166339200000'], + 'gmtStart' => ['description' => 'The actual start time of the work item, such as when it was scheduled or confirmed. The value is a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '33166339200000'], + 'isArchived' => ['description' => 'Indicates whether the work item is archived. Valid values: `Y` (Yes) and `N` (No).', 'type' => 'string', 'title' => '', 'example' => 'N'], + 'isDone' => ['description' => 'Indicates whether the work item is completed. Valid values: `Y` (Yes) and `N` (No).', 'type' => 'string', 'title' => '', 'example' => 'Y'], + 'parentId' => ['description' => 'The ID of the parent work item.', 'type' => 'string', 'title' => '', 'example' => 'a80a203a9078a7a1b1f2c6xxxx'], + 'participantIds' => ['description' => 'A comma-separated string of participant IDs.', 'type' => 'string', 'title' => '', 'example' => '6135b21fb383ef39551cf02e,63466a385dc8531eebd764e9'], + 'phase' => ['description' => 'The major phase of the work item, which corresponds to To-do, Doing, or Done. The value ranges from 10 to 100.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], + 'stage' => ['description' => 'The specific stage within a phase. The value ranges from 10 to 100. This stage corresponds to Projex stages such as Confirmation, Analysis, Processing, Design, and Development.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], + 'priority' => ['description' => 'The priority level. The value ranges from 0 to 9.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '2'], + 'productId' => ['description' => 'The ID of the product.', 'type' => 'string', 'title' => '', 'example' => '无'], + 'projectId' => ['description' => 'The ID of the project.', 'type' => 'string', 'title' => '', 'example' => '6732a29d846bf998dc09e7xxxx'], + 'source' => ['description' => 'The source of the work item. For example, `teambition` or `projex`.', 'type' => 'string', 'title' => '', 'example' => 'projex'], + 'sprintId' => ['description' => 'The ID of the sprint.', 'type' => 'string', 'title' => '', 'example' => '731c83a40bbf3c2f080e07xxxx'], + 'status' => ['description' => 'The name of the status.', 'type' => 'string', 'title' => '', 'example' => '待处理'], + 'statusId' => ['description' => 'The ID of the status.', 'type' => 'string', 'title' => '', 'example' => '100005'], + 'storyPoint' => ['description' => 'The number of story points for the work item.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '10.0'], + 'subject' => ['description' => 'The title of the work item.', 'type' => 'string', 'title' => '', 'example' => '测试'], + 'type' => ['description' => 'The main type of the work item. For example, requirement, task, or defect.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'subType' => ['description' => 'The subtype of the work item. For example, a technical requirement or a product requirement.', 'type' => 'string', 'title' => '', 'example' => '9uy29901re573f561d69xxxx'], + 'versionId' => ['description' => 'The ID of the version.', 'type' => 'string', 'title' => '', 'example' => '无'], + 'workTime' => ['description' => 'The actual time spent on the work item, in minutes.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], + 'expectedWorkTime' => ['description' => 'The estimated time required for the work item, in minutes.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], + 'versions' => ['description' => 'The IDs of associated versions, returned as a string.', 'type' => 'string', 'title' => '', 'example' => '{6a8cdda167415bea1506c7262c}'."\n"], + 'extraId' => ['description' => 'The auto-incrementing ID from the `extra` table.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '123'], + 'foundPhase' => ['description' => 'The phase in which the defect was found. The value ranges from 10 to 100.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], + 'gmtFixed' => ['description' => 'The actual time when the defect was fixed. The value is a Unix timestamp in milliseconds.', 'type' => 'string', 'title' => '', 'example' => '无'], + 'isStupid' => ['description' => 'Indicates whether the defect is considered an avoidable error. Valid values: `Y` (Yes) and `N` (No).', 'type' => 'string', 'title' => '', 'example' => '无'], + 'reopenNum' => ['description' => 'The number of times the work item was reopened.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '无'], + 'seriousLevel' => ['description' => 'The severity level of the defect. The value ranges from 0 to 9.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '无'], + 'solution' => ['description' => 'The type of solution applied.', 'type' => 'string', 'title' => '', 'example' => '无'], + 'extraIsDeleted' => ['description' => 'Indicates whether the entry in the `extra` table is deleted or archived. Valid values: `Y` (Deleted or archived) and `N` (Normal).', 'type' => 'string', 'title' => '', 'example' => 'N'], + 'verifierId' => ['description' => 'The ID of the verifier.', 'type' => 'string', 'title' => '', 'example' => '65e836b981d758be7a25xxxx'], + 'serialNumber' => ['title' => 'Serial number within the Space', 'description' => 'The serial number of the work item within its project or space.', 'type' => 'integer', 'format' => 'int32', 'example' => '66'], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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', + '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"}]', + 'title' => 'Export WorkitemStatus and WorkitemDefectExtra', + 'description' => 'The Insights data export API is exclusive to Advanced Edition customers. For more information about the features of Alibaba Cloud DevOps Advanced Edition, see <https://help.aliyun.com/document_detail/173288.html>', + 'changeSet' => [ + ['createdAt' => '2024-08-02T13:30:03.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExportInsightWorkitemStatusJoinWorkitemDefectExtra'], + ], ], + 'ramActions' => [], + ], + 'ExportInsightWorkitemVersion' => [ + 'summary' => 'Retrieves data from the `workitem_version` table for a specified enterprise in Insight.', + 'path' => '/organization/{organizationId}/data/workitemVersions', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ 'name' => 'organizationId', - 'in' => 'query', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '66c0c9fffeb86b450c199fcd', - ], + 'in' => 'path', + 'schema' => ['description' => 'The organization ID. You can find this ID in your organization\'s URL on Alibaba Cloud DevOps, for example, https\\://devops.aliyun.com/organization/#{organizationId}.', 'type' => 'string', 'required' => true, 'example' => '61db9af2148974246bexxxx', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', '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', - ], + 'startTime' => ['description' => 'The start of the time range. The time range cannot exceed one year.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '2024-05-01 00:00:00'."\n"], + 'endTime' => ['description' => 'The end of the time range. The time range cannot exceed one year.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '2024-06-01 00:00:00'."\n"], + 'nextToken' => ['description' => 'The token to retrieve the next page of results. The response includes a nextToken if the number of results exceeds maxResults. To continue pagination, provide the nextToken from the previous response in your next request.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '1'], + 'maxResults' => ['description' => 'The maximum number of results to return per page.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '10'], ], - 'required' => true, + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -20588,250 +8811,92 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', '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', - ], + 'totalCount' => ['description' => 'The total number of matching entries.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'], + 'nextToken' => ['description' => 'The token for the next page of results. A `null` value indicates that no more results are available.', 'type' => 'string', 'title' => '', 'example' => '2'], + 'maxResults' => ['description' => 'The maximum number of results returned per page.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], 'result' => [ - 'description' => '', + 'description' => 'The data returned by the query.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'A work item version.', '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', - ], - ], - ], - ], + 'id' => ['description' => 'The auto-incrementing ID of the record.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '648131'], + 'gmtCreate' => ['description' => 'The creation time of the record, in Unix timestamp format (milliseconds).', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1704251228000'], + 'gmtModified' => ['description' => 'The modification time of the record, in Unix timestamp format (milliseconds).', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1704251228000'], + 'identifier' => ['description' => 'The unique identifier of the version.', 'type' => 'string', 'title' => '', 'example' => '7ba6e8261b973c976df76b7de1'], + 'isDeleted' => ['description' => 'Indicates whether the version is deleted. Valid values: `Y` (Yes) and `N` (No).', 'type' => 'string', 'title' => '', 'example' => 'N'], + 'organizationId' => ['description' => 'The ID of the organization to which the work item version belongs.', 'type' => 'string', 'title' => '', 'example' => '61db9af2148974246bexxxx'], + 'name' => ['description' => 'The name of the version.', 'type' => 'string', 'title' => '', 'example' => '版本0501'], + 'gmtStart' => ['description' => 'The start time of the version, in Unix timestamp format (milliseconds).', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1704297600000'], + 'gmtPublish' => ['description' => 'The release time of the version, in Unix timestamp format (milliseconds).', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1704902400000'], + 'status' => ['description' => 'The status of the version. Valid values: `10` (TODO), `50` (DOING), and `100` (ARCHIVED).', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '100'], + 'lockStatus' => ['description' => 'The lock status of the version.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'], + 'targetType' => ['description' => 'The type of the target entity.', 'type' => 'string', 'title' => '', 'example' => 'Project'], + 'targetId' => ['description' => 'The ID of the target entity.', 'type' => 'string', 'title' => '', 'example' => '7eee44ec7f699d4e6980faxxxx'], + 'source' => ['description' => 'The source of the data. Examples: `projex` and `teambition`.', 'type' => 'string', 'title' => '', 'example' => 'projex'], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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"}]', + 'title' => 'Export WorkitemVersion', + 'description' => 'The Insights data export API is available only to Enterprise Edition customers. For details about the features of Alibaba Cloud DevOps Enterprise Edition, visit <https://help.aliyun.com/document_detail/173288.html>.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExportInsightWorkitemVersion'], + ], ], - '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"}]', + 'ramActions' => [], ], - 'ListSearchRepository' => [ - 'summary' => '搜索代码仓库数据', - 'path' => '/search/repo', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ExportWorkitemActivity' => [ + 'summary' => 'Exports work item activity data from performance insight for a specified organization.', + 'path' => '/organization/{organizationId}/data/workitemActivities', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ 'name' => 'organizationId', - 'in' => 'query', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '61e54b0e0bb300d827e1ae27', - ], + 'in' => 'path', + 'schema' => ['description' => 'The organization ID. You can find this ID in your organization\'s URL in Alibaba Cloud DevOps, which follows the format `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'required' => true, 'example' => '61db9af2148974246bexxxx', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', '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, - ], + 'startTime' => ['description' => 'The start time. The interval between the start time and end time cannot exceed one year.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '2024-05-01 00:00:00'], + 'endTime' => ['description' => 'The end time. The interval between the start time and end time cannot exceed one year.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '2024-06-01 00:00:00'], + 'nextToken' => ['description' => 'The token for retrieving the next page of results. If the number of results exceeds the `maxResults` value, the response includes a `nextToken`. Pass this token in a subsequent request to fetch the next page.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '1'], + 'maxResults' => ['description' => 'The maximum number of results to return. The maximum value is 10,000.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '10'], ], - 'required' => true, + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -20839,267 +8904,153 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response schema.', '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', - ], + 'totalCount' => ['description' => 'The total count of results.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'], + 'nextToken' => ['description' => 'The token to retrieve the next page of results. A null value indicates that there are no more pages.', 'type' => 'string', 'title' => '', 'example' => '2'], + 'maxResults' => ['description' => 'The maximum number of results to return per page, which corresponds to the `maxResults` value in the request.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], 'result' => [ - 'description' => '', + 'description' => 'An array of work item activity objects.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'A work item activity object.', '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', - ], - ], - ], - ], + 'id' => ['description' => 'The auto-increment ID of the record.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '4406380356'], + 'gmtEvent' => ['description' => 'The event time, expressed as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1714961337000'], + 'identifier' => ['description' => 'A unique identifier for the event.', 'type' => 'string', 'title' => '', 'example' => '254662353'], + 'organizationId' => ['description' => 'The organization ID.', 'type' => 'string', 'title' => '', 'example' => '61db9af2148974246bexxxx'], + 'newValue' => ['description' => 'The new value of the changed field.', 'type' => 'string', 'title' => '', 'example' => '1'], + 'oldValue' => ['description' => 'The old value of the changed field.', 'type' => 'string', 'title' => '', 'example' => '2'], + 'projectId' => ['description' => 'The project ID.', 'type' => 'string', 'title' => '', 'example' => '2a62349afcbef7f23d8f31xxxx'], + 'source' => ['description' => 'The source of the event.', 'type' => 'string', 'title' => '', 'example' => 'projex'], + 'type' => ['description' => 'The event type.', 'type' => 'string', 'title' => '', 'example' => 'workitem.update.priority'], + 'workitemId' => ['description' => 'The work item ID.', 'type' => 'string', 'title' => '', 'example' => 'ec69eae498acce08ff7260xxxx'], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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 \\"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"}]', + 'title' => 'Export WorkitemActivity ', + 'description' => 'The performance insight data export API is available only to Advanced Edition customers. To learn more about the features of the Alibaba Cloud DevOps Advanced Edition, visit <https://help.aliyun.com/document_detail/173288.html>.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExportWorkitemActivity'], ], ], - '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"}]', + 'ramActions' => [], ], - 'ListSearchCommit' => [ - 'summary' => '搜索代码提交数据', - 'path' => '/search/commit', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetApplication' => [ + 'summary' => 'Retrieves details of a specific application.', + 'path' => '/appstack/apps/{appName}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'tags' => ['应用'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '数据面 api 经安全评估统一不做处理,后续逐步安排下线', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ + 'name' => 'appName', + 'in' => 'path', + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'testApp', 'title' => ''], + ], + [ 'name' => 'organizationId', 'in' => 'query', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '60d54f3daccf2bbd6659f3ad', - ], + 'schema' => ['description' => 'The organization ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '66c0c9fffeb86b450c199fcd', 'title' => ''], ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ + 'description' => '已按名称查找到应用详情', '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, - ], + 'name' => ['description' => 'The application name.', 'type' => 'string', 'example' => 'testApp', 'title' => ''], + 'gmtCreate' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2024-01-01T00:00:00.000+00:00', 'title' => ''], + 'creatorAccountId' => ['description' => 'The creator\'s Alibaba Cloud UID.', 'type' => 'string', 'example' => '1332695887xxxxxx', 'title' => ''], + 'description' => ['description' => 'The application description.', 'type' => 'string', 'example' => '应用描述', 'title' => ''], + 'requestId' => ['description' => 'The unique request ID. This ID is returned with each request and can be used to troubleshoot issues.', 'type' => 'string', 'example' => 'FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F', 'title' => ''], + 'appTemplateName' => ['title' => 'Application template name', 'description' => 'The application template name.', 'type' => 'string', 'example' => '应用模版名称A'], + 'appTemplateDisplayName' => ['title' => 'Application template display name', 'description' => 'The application template display name.', 'type' => 'string', 'example' => '应用模版展示名称A'], ], - 'required' => true, + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 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"}]', + 'title' => 'Query application details', + 'changeSet' => [ + ['createdAt' => '2024-04-25T03:35:35.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetApplication'], + ], + ], + 'ramActions' => [], + ], + 'GetBranchInfo' => [ + 'summary' => 'Query information about code repository branches.', + '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' => 'Organization identity, also known as organization ID, in string form. It can be obtained from the Alibaba Cloud DevOps access link, for example: https://devops.aliyun.com/organization/【OrganizationId】', 'type' => 'string', 'required' => true, 'example' => '5fbe3118672533690be72b12'], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => ['description' => 'Personal access token. '."\n" + .'This field is not required when using Alibaba Cloud AccessKey ID and AccessKey Secret or Security Token Service (STS) temporary authorization.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => ['description' => 'Repository ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2334743', 'title' => ''], + ], + [ + 'name' => 'branchName', + 'in' => 'query', + 'schema' => ['description' => 'Branch Name', 'type' => 'string', 'required' => true, 'example' => 'master', 'title' => ''], + ], ], 'responses' => [ 200 => [ @@ -21108,334 +9059,322 @@ '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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID ', 'type' => 'string', 'example' => '6177543A-8D54-5736-A93B-E0195A1512CB'], + 'errorMessage' => ['description' => 'Error message ', 'type' => 'string', 'example' => '""', 'title' => ''], + 'errorCode' => ['description' => 'Error code ', 'type' => 'string', 'example' => 'Openapi.RequestError', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request succeeded ', 'type' => 'boolean', 'example' => 'true', 'title' => ''], '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', - ], + 'description' => 'Return Result', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'Branch Name', 'type' => 'string', 'example' => 'master', 'title' => ''], + 'protected' => ['description' => 'Indicates whether the branch is a protected branch.', 'type' => 'string', 'example' => 'false', 'title' => ''], + 'commit' => [ + 'description' => 'Information about the most recent commit on the branch.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'Commit ID ', 'type' => 'string', 'example' => 'e0297d8fb0393c833a8531e7cc8832739e3cba6d', 'title' => ''], + 'shortId' => ['description' => 'Short commit ID', 'type' => 'string', 'example' => 'e0297d8f', 'title' => ''], + 'title' => ['description' => 'Commit title, which is the first line of the commit content', 'type' => 'string', 'example' => '修改main.txt文件', 'title' => ''], + 'authorName' => ['description' => 'Author name ', 'type' => 'string', 'example' => '阿里云云效', 'title' => ''], + 'authorEmail' => ['description' => 'Author mailbox', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + 'createdAt' => ['description' => 'Creation Time', 'type' => 'string', 'example' => '2022-03-18 10:00:00', 'title' => ''], + 'message' => ['description' => 'Submission Content', 'type' => 'string', 'example' => '修改main.txt文件', 'title' => ''], + 'authoredDate' => ['description' => 'Author\'s submission time ', 'type' => 'string', 'example' => '2022-03-18 08:00:00', 'title' => ''], + 'committedDate' => ['description' => 'Committer\'s submission time ', 'type' => 'string', 'example' => '2022-03-18 09:00:00', 'title' => ''], + 'committerEmail' => ['description' => 'Submitter\'s Mailbox', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + 'committerName' => ['description' => 'Committer name ', 'type' => 'string', 'example' => '阿里云云效Committer', 'title' => ''], + 'parentIds' => [ + 'description' => 'List of parent commit IDs ', + 'type' => 'array', + 'items' => ['description' => 'Parent commit ID ', 'type' => 'string', 'example' => 'de02b625ba8488f92eb204bcb3773a40c1b4ddac', 'title' => ''], + 'title' => '', + 'example' => '', ], - ], - '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' => 'username@example.com', - ], - ], - ], + 'author' => [ + 'description' => 'Author information ', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'User ID in Codeup ', 'type' => 'integer', 'format' => 'int64', 'example' => '28056', 'title' => ''], + 'name' => ['description' => 'Author name ', 'type' => 'string', 'example' => 'codeup-test', 'title' => ''], + 'username' => ['description' => 'User nickname ', 'type' => 'string', 'example' => 'testtest', 'title' => ''], + 'state' => ['description' => 'Status '."\n" + .'Valid values: active / blocked. Default value: active ', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'avatarUrl' => ['description' => 'Profile picture URL ', 'type' => 'string', 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', 'title' => ''], + 'email' => ['description' => 'User mailbox ', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'committer' => [ + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'Codeup User ID', 'type' => 'integer', 'format' => 'int64', 'example' => '5035', 'title' => ''], + 'name' => ['description' => 'Submitter\'s Name', 'type' => 'string', 'example' => 'codeup-commit', 'title' => ''], + 'username' => ['description' => 'User nickname ', 'type' => 'string', 'example' => 'commitcommit', 'title' => ''], + 'state' => ['description' => 'Status '."\n" + .'Valid values: active / blocked. Default Value: active', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'avatarUrl' => ['description' => 'Profile Picture URL', 'type' => 'string', 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', 'title' => ''], + 'email' => ['description' => 'User Mailbox', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + ], + 'description' => 'Submitter Information', + 'title' => '', + 'example' => '', ], + 'signature' => [ + 'description' => 'Signature information', + 'type' => 'object', + 'properties' => [ + 'gpgKeyId' => ['description' => 'GPG key ID used for signing', 'type' => 'string', 'example' => '""', 'title' => ''], + 'verificationStatus' => ['description' => 'GPG validation status '."\n" + .'- unverified: Not validated '."\n" + .'- verified: GPG public key authentication passed and the email matches '."\n" + .'- same_user_different_email: GPG public key signature verification passed; the committer\'s email belongs to the current user but differs from the certificate email '."\n" + .'- other_user: GPG public key signature verification passed, but the committer\'s email does not belong to the key owner '."\n" + .'- unverified_key: The email associated with the key is not in the user\'s mailbox list '."\n" + .'- unknown_key: GPG key does not exist', 'type' => 'string', 'example' => 'verified', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'commentsCount' => ['description' => 'Number of comments ', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => '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.', 'description' => ''], + ], ], - '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\\": \\"username@example.com\\"\\n }\\n }\\n }\\n ]\\n}","type":"json"}]', - ], - 'GetSearchCodePreview' => [ - 'summary' => '预览代码片段', - 'path' => '/search/code_preview', - 'methods' => [ - 'get', + '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\\": \\"username@example.com\\",\\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\\": \\"username@example.com\\",\\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\\": \\"username@example.com\\"\\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\\": \\"username@example.com\\"\\n },\\n \\"signature\\": {\\n \\"gpgKeyId\\": \\"\\\\\\"\\\\\\"\\",\\n \\"verificationStatus\\": \\"verified\\"\\n },\\n \\"commentsCount\\": 0\\n }\\n }\\n}","type":"json"}]', + 'title' => 'Query branch information', + 'changeSet' => [ + ['createdAt' => '2023-07-24T06:14:48.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetBranchInfo'], + ], ], + 'ramActions' => [], + ], + 'GetCheckRun' => [ + 'summary' => 'Retrieves a single check run.', + 'path' => '/api/v4/projects/check_runs/get_check_run', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'query', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '627475075b46541dd2ff01bc', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The ID of the organization. You can get this ID from your Alibaba Cloud DevOps URL, for example, `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ - 'name' => 'docId', + 'name' => 'accessToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '60d54f3daccf2bbd6659f3ad/gitlabhq/master/config/environments/test.rb', - ], + 'schema' => ['description' => 'A personal access token. This parameter is optional if you authenticate with an Alibaba Cloud AccessKey pair or temporary credentials from Security Token Service (STS).', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], ], [ - 'name' => 'keyword', + 'name' => 'repositoryIdentity', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['description' => 'The repository ID or full path.', 'type' => 'string', 'required' => true, 'example' => '2835387 或 codeup/codeup-demo', 'title' => ''], ], [ - 'name' => 'isDsl', + 'name' => 'checkRunId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The ID of the check run.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response schema.', '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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'success' => ['description' => 'Indicates whether the request succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'errorCode' => ['description' => 'The error code returned when the request fails.', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'errorMessage' => ['description' => 'The error message returned when the request fails.', 'type' => 'string', 'example' => '""', 'title' => ''], 'result' => [ - 'description' => '', + 'description' => 'The data returned for the request.', 'type' => 'object', 'properties' => [ - 'docId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxx', - ], - 'highlightTextMap' => [ - 'description' => '', + 'id' => ['description' => 'The unique ID of the check run.', 'type' => 'integer', 'format' => 'int64', 'example' => '5240', 'title' => ''], + 'createdAt' => ['description' => 'The creation time of the check run, in ISO 8601 format.', 'type' => 'string', 'example' => '2022-01-14T21:08:26+08:00'."\n", 'title' => ''], + 'updatedAt' => ['description' => 'The last update time of the check run, in ISO 8601 format.', 'type' => 'string', 'example' => '2022-01-14T21:08:26+08:00'."\n", 'title' => ''], + 'startedAt' => ['description' => 'The time when the check run started, in ISO 8601 format.', 'type' => 'string', 'example' => '2023-03-15T08:00:00Z'."\n", 'title' => ''], + 'completedAt' => ['description' => 'The time when the check run completed, in ISO 8601 format.', 'type' => 'string', 'example' => '2023-03-15T08:00:00Z'."\n", 'title' => ''], + 'externalId' => ['description' => 'The ID of the check run in an external system.', 'type' => 'string', 'example' => '42', 'title' => ''], + 'name' => ['description' => 'The name of the check run.', 'type' => 'string', 'example' => 'my-check-ci'."\n", 'title' => ''], + 'headSha' => ['description' => 'The commit ID of the head commit.', 'type' => 'string', 'example' => '40f4ccfe019cdd4a62d4acb0c57130106fc7e1be', 'title' => ''], + 'status' => ['description' => 'The status of the check run. Valid values:'."\n" + ."\n" + .'- `queued`: The check run is queued.'."\n" + ."\n" + .'- `in_progress`: The check run is in progress.'."\n" + ."\n" + .'- `completed`: The check run is completed.', 'type' => 'string', 'example' => 'completed', 'title' => ''], + 'conclusion' => ['description' => 'The final conclusion of the check run. Available only when the `status` is `completed`. Valid values:'."\n" + ."\n" + .'- `cancelled`: The check run was cancelled.'."\n" + ."\n" + .'- `failure`: The check run failed.'."\n" + ."\n" + .'- `neutral`: The check run had a neutral conclusion, which is considered a success.'."\n" + ."\n" + .'- `success`: The check run succeeded.'."\n" + ."\n" + .'- `skipped`: The check run was skipped, which is considered a success.'."\n" + ."\n" + .'- `timed_out`: The check run timed out.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'detailsUrl' => ['description' => 'The URL for the details page in a third-party system. The user defines this URL, and Alibaba Cloud DevOps only provides a redirect.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'checkSuite' => [ + 'description' => 'The check suite to which the check run belongs.', 'type' => 'object', 'properties' => [ - 'organizationId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5ffd468b1e45db3c1cc26ad6', - ], - 'fileName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test.rb', - ], - 'clob' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxx', - ], + 'id' => ['description' => 'The unique ID of the check suite.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'source' => [ - 'description' => '', + 'writer' => [ + 'description' => 'Information about the writer.', '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', + 'id' => ['description' => 'The writer\'s Alibaba Cloud account ID.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'type' => ['description' => 'The type of the writer. Valid value:'."\n" + ."\n" + .'- `User`: A user.', 'type' => 'string', 'example' => 'User', 'title' => ''], + 'name' => ['description' => 'The name of the writer.', 'type' => 'string', 'example' => 'test-codeup'."\n", 'title' => ''], + 'slug' => ['description' => 'The slug of the writer.', 'type' => 'string', 'example' => 'test-codeup', 'title' => ''], + 'logoUrl' => ['description' => 'The URL of the writer\'s avatar.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'output' => [ + 'description' => 'The output to display in the UI.', + 'type' => 'object', + 'properties' => [ + 'title' => ['description' => 'The title of the UI module (not the check run name).', 'type' => 'string', 'example' => 'Mighty Readme report'."\n", 'title' => ''], + 'summary' => ['description' => 'A summary of the check run.'."\n" + ."\n" + .'> Supports Markdown. Maximum length: 64 KB (65,535 characters).', 'type' => 'string', 'example' => '摘要信息内容'."\n", 'title' => ''], + 'text' => ['description' => 'Detailed information about the check run.'."\n" + ."\n" + .'> Supports Markdown. Maximum length: 64 KB (65,535 characters).', 'type' => 'string', 'example' => '详情信息内容'."\n", 'title' => ''], + 'images' => [ + 'description' => 'A list of images to display in the output.'."\n" + ."\n" + .'>', + 'type' => 'array', + 'items' => [ + 'description' => 'Information about an image.', + 'type' => 'object', + 'properties' => [ + 'alt' => ['description' => 'The alternative text for the image.', 'type' => 'string', 'example' => 'test-image-alt'."\n", 'title' => ''], + 'imageUrl' => ['description' => 'The URL of the image. The UI cannot render the image if the URL is inaccessible.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'caption' => ['description' => 'A description of the image.', 'type' => 'string', 'example' => 'test', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', + ], + 'annotations' => [ + 'description' => 'A list of annotations for the check run.', + 'type' => 'array', + 'items' => [ + 'description' => 'An annotation.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The unique ID of the annotation.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'path' => ['description' => 'The file path.', 'type' => 'string', 'example' => 'demo/test.txt'."\n", 'title' => ''], + 'startLine' => ['description' => 'The start line of the annotation in the file.'."\n" + ."\n" + .'> Line numbering starts at 1. The annotation cannot be rendered if the line number is invalid for the file.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'endLine' => ['description' => 'The end line of the annotation in the file.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'startColumn' => ['description' => 'The column number where the annotation begins.'."\n" + ."\n" + .'> Only applies when `startLine` and `endLine` have the same value.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'endColumn' => ['description' => 'The column number where the annotation ends.'."\n" + ."\n" + .'> Only applies when `startLine` and `endLine` have the same value.', 'type' => 'integer', 'format' => 'int64', 'example' => '4', 'title' => ''], + 'annotationLevel' => ['description' => 'The severity level of the annotation. Valid values:'."\n" + ."\n" + .'- `notice`: A notice.'."\n" + ."\n" + .'- `warning`: A warning.'."\n" + ."\n" + .'- `failure`: A failure.', 'type' => 'string', 'example' => 'warning', 'title' => ''], + 'message' => ['description' => 'A description of the annotation.', 'type' => 'string', 'example' => '回写检查注释的简要描述信息'."\n", 'title' => ''], + 'title' => ['description' => 'The title of the annotation.', 'type' => 'string', 'example' => '检查注释的标题'."\n", 'title' => ''], + 'rawDetails' => ['description' => 'Detailed information about the annotation. Maximum size: 64 KB.', 'type' => 'string', 'example' => '详情信息', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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"}]', + 'title' => 'Query check run ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCheckRun'], + ], ], - '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"}]', + 'ramActions' => [], ], 'GetCodeupOrganization' => [ - 'summary' => '获取企业信息', + 'summary' => 'Obtain enterprise information from Codeup based on the enterprise identity (Alibaba Cloud DevOps enterprise ID or enterprise path).', 'path' => '/api/organization/{identity}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], @@ -21443,22 +9382,13 @@ [ 'name' => 'identity', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '60de7a6852743a5162b5f957', - ], + 'schema' => ['description' => 'The enterprise identity, also known as the enterprise ID or enterprise path, is a string that can be obtained from the Alibaba Cloud DevOps access link, such as https://devops.aliyun.com/organization/【OrganizationId】.', 'type' => 'string', 'required' => true, 'example' => '60de7a6852743a5162b5f957', 'title' => ''], ], [ 'name' => 'accessToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'f0b1e61db5961df5975a93f9129d2513', - ], + 'schema' => ['description' => 'Personal access token. '."\n" + .'This field is not required when using Alibaba Cloud AccessKey ID and AccessKey secret or Security Token Service (STS) temporary authorization.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], ], ], 'responses' => [ @@ -21467,422 +9397,391 @@ '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', - ], + 'errorMessage' => ['description' => 'Error message', 'type' => 'string', 'example' => '""', 'title' => ''], + 'requestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', 'title' => ''], + 'errorCode' => ['description' => 'Error code', 'type' => 'string', 'example' => 'InvalidTagGroup.IdNotFound', 'title' => ''], + 'success' => ['description' => 'Indicates whether the invocation succeeded', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'result' => [ - 'description' => '', + 'description' => 'Return Result', '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', - ], + 'namespaceId' => ['description' => 'ID of the group or enterprise Space to which the repository belongs', 'type' => 'integer', 'format' => 'int64', 'example' => '100003', 'title' => ''], + 'userRole' => ['description' => 'User role in the enterprise '."\n" + .'- ORG_MEMBER: Enterprise member '."\n" + .'- ORG_ADMIN: Enterprise administrator '."\n" + .'- ORG_OWNER: Enterprise owner '."\n" + .'- ORG_EXTERNAL_MEMBER: External enterprise member '."\n" + .'- NO_ACCESS: No permission '."\n" + .'- ADMIN: Super administrator', 'type' => 'string', 'example' => 'ORG_MEMBER', 'title' => ''], + 'path' => ['description' => 'Code repository path', 'type' => 'string', 'example' => 'test-codeup', 'title' => ''], + 'createdAt' => ['description' => 'Creation Time', 'type' => 'string', 'example' => '2022-03-12 12:00:00', 'title' => ''], + 'updatedAt' => ['description' => 'Update Time', 'type' => 'string', 'example' => '2022-03-18 14:24:54', 'title' => ''], + 'id' => ['description' => 'Primary key ID', 'type' => 'integer', 'format' => 'int64', 'example' => '3624', 'title' => ''], + 'organizationId' => ['description' => 'Enterprise identity, also known as enterprise ID, in string form. It can be obtained from the Alibaba Cloud DevOps access link, for example: https://devops.aliyun.com/organization/【OrganizationId】', 'type' => 'string', 'example' => '60de7a6852743a5162b5f957', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorCode' => 'SystemError.UnKnownError', - 'errorMessage' => 'An error occurred while processing your request.', - ], + ['errorCode' => 'SystemError.UnKnownError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''], ], ], - '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', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query the enterprise information to which a Codeup repository belongs', + 'changeSet' => [ + ['createdAt' => '2022-11-21T13:16:40.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-03-18T06:00:14.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCodeupOrganization'], + ], ], + 'ramActions' => [], + ], + 'GetCompareDetail' => [ + 'summary' => 'Compares two commits (branches and tags are treated as commits) and returns a list of commits between them, along with the diff content for building a tree of file changes.', + 'path' => '/repository/{repositoryId}/commits/compare/detail', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'accessToken', + 'name' => 'organizationId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The organization ID. You can find this ID in the URL of the Alibaba Cloud DevOps console, for example, `https://devops.aliyun.com/organization/{OrganizationId}`.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ - 'name' => 'accessLevel', + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => ['description' => 'The repository ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2369234', 'title' => ''], + ], + [ + 'name' => 'from', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '5', - ], + 'schema' => ['description' => 'The start version (commit ID).', 'type' => 'string', 'required' => true, 'example' => 'c9fb781f3d66ef6ee60bdd5c414f5106454b1426', 'title' => ''], ], [ - 'name' => 'minAccessLevel', + 'name' => 'to', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '60', - ], + 'schema' => ['description' => 'The end version (commit ID).', 'type' => 'string', 'required' => true, 'example' => 'b8f6f28520b1936aafe2e638373e19ccafa42b02', 'title' => ''], + ], + [ + 'name' => 'mergeBase', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to use the merge base for the comparison.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'maxDiffFile', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of files to return.'."\n" + ."\n" + .'> The maximum value for this parameter is 5,000.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5000', 'title' => ''], + ], + [ + 'name' => 'maxDiffByte', + 'in' => 'query', + 'schema' => ['description' => 'The maximum size of the diff to return, in bytes.'."\n" + ."\n" + .'> The maximum value for this parameter is 24 MB (25,165,824 bytes).', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '24 * 1024 * 1024', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', + 'description' => 'The response body.', '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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], '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', + 'description' => 'The comparison details.', + 'properties' => [ + 'messages' => [ + 'description' => 'A list of messages.', + 'items' => ['description' => 'The message content.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'type' => 'array', + 'title' => '', + 'example' => '', + ], + 'commits' => [ + 'description' => 'A list of commits in the comparison.', + 'items' => [ + 'description' => 'The commit details.', + 'properties' => [ + 'id' => ['description' => 'The commit ID.', 'type' => 'string', 'example' => 'b8f6f28520b1936aafe2e638373e19ccafa42b02', 'title' => ''], + 'shortId' => ['description' => 'The short commit ID.', 'type' => 'string', 'example' => 'b8f6f285', 'title' => ''], + 'title' => ['description' => 'The commit title, which is the first line of the commit message.', 'type' => 'string', 'example' => '提交标题', 'title' => ''], + 'message' => ['description' => 'The commit message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'authorName' => ['description' => 'The author\'s name.', 'type' => 'string', 'example' => '云效Codeup', 'title' => ''], + 'authorEmail' => ['description' => 'The email address of the author as recorded in the git commit.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + 'authoredDate' => ['description' => 'The timestamp when the commit was authored.', 'type' => 'string', 'example' => '2023-01-03T15:41:26+08:00', 'title' => ''], + 'createdAt' => ['description' => 'The timestamp when the commit object was created in Codeup.', 'type' => 'string', 'example' => '2023-01-03T15:41:26+08:00', 'title' => ''], + 'committerName' => ['description' => 'The committer\'s name.', 'type' => 'string', 'example' => '云效CodeupCommitter', 'title' => ''], + 'committerEmail' => ['description' => 'The email address of the committer as recorded in the git commit.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + 'committedDate' => ['description' => 'The timestamp when the commit was made.', 'type' => 'string', 'example' => '2023-01-03T15:41:26+08:00', 'title' => ''], + 'parentIds' => [ + 'description' => 'A list of parent commit IDs.', + 'items' => ['description' => 'A parent commit ID.', 'type' => 'string', 'example' => 'c9fb781f3d66ef6ee60bdd5c414f5106454b1426', 'title' => ''], + 'type' => 'array', + 'title' => '', + 'example' => '', + ], + 'author' => [ + 'description' => 'The details of the commit author.', + 'properties' => [ + 'id' => ['description' => 'The user ID in Codeup.', 'type' => 'integer', 'format' => 'int64', 'example' => '21396', 'title' => ''], + 'name' => ['description' => 'The user\'s name.', 'type' => 'string', 'example' => '云效', 'title' => ''], + 'username' => ['description' => 'The user\'s username.', 'type' => 'string', 'example' => 'Codeup', 'title' => ''], + 'state' => ['description' => 'The user\'s state. Valid values: `active` and `blocked`. Default: `active`.', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'avatarUrl' => ['description' => 'The user\'s avatar URL.', 'type' => 'string', 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', 'title' => ''], + 'email' => ['description' => 'The email address associated with the user\'s Codeup account.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + ], + 'type' => 'object', + 'title' => '', + 'example' => '', + ], + 'committer' => [ + 'description' => 'The details of the commit committer.', + 'properties' => [ + 'id' => ['description' => 'The user ID in Codeup.', 'type' => 'integer', 'format' => 'int64', 'example' => '43910', 'title' => ''], + 'name' => ['description' => 'The user\'s name.', 'type' => 'string', 'example' => '云效Committer', 'title' => ''], + 'username' => ['description' => 'The user\'s username.', 'type' => 'string', 'example' => 'Codeup-commiter', 'title' => ''], + 'state' => ['description' => 'The user\'s state. Valid values: `active` and `blocked`. Default: `active`.', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'avatarUrl' => ['description' => 'The user\'s avatar URL.', 'type' => 'string', 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', 'title' => ''], + 'email' => ['description' => 'The email address associated with the user\'s Codeup account.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + ], + 'type' => 'object', + 'title' => '', + 'example' => '', + ], + 'commentsCount' => ['description' => 'The number of comments on the commit.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + ], + 'type' => 'object', + 'title' => '', 'example' => '', ], - 'organizationRole' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ORG_ADMIN', - ], - 'organizationAlias' => [ - 'type' => 'string', - ], - 'namespaceId' => [ - 'type' => 'string', + 'type' => 'array', + 'title' => '', + 'example' => '', + ], + 'diffs' => [ + 'description' => 'A list of file diffs from the comparison.', + 'items' => [ + 'description' => 'Details of a single file diff.', + 'properties' => [ + 'diff' => ['description' => 'The diff content in unified format.', 'type' => 'string', 'example' => '--- /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', 'title' => ''], + 'newPath' => ['description' => 'The new file path.', 'type' => 'string', 'example' => 'new_test.txt', 'title' => ''], + 'oldPath' => ['description' => 'The old file path.', 'type' => 'string', 'example' => 'test.txt', 'title' => ''], + 'aMode' => ['description' => 'The file mode of the old path, which includes information such as file type and permissions. For example, `100644` indicates a regular file and `100755` indicates an executable file.', 'type' => 'string', 'example' => '100644', 'title' => ''], + 'bMode' => ['description' => 'The file mode of the new path, which includes information such as file type and permissions. For example, `100644` indicates a regular file and `100755` indicates an executable file.', 'type' => 'string', 'example' => '100644', 'title' => ''], + 'newFile' => ['description' => 'Indicates whether the file was added.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'renamedFile' => ['description' => 'Indicates whether the file was renamed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'deletedFile' => ['description' => 'Indicates whether the file was deleted.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'isBinary' => ['description' => 'Indicates whether the file is a binary file.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'oldId' => ['description' => 'The Git object ID of the old file.', 'type' => 'string', 'example' => '6c268061a546378276559c713d0ad377d4dsjfh', 'title' => ''], + 'newId' => ['description' => 'The Git object ID of the new file.', 'type' => 'string', 'example' => 'cb75846da2df3d3d7f290c3569236fcf3dd17224', 'title' => ''], + 'isNewLfs' => ['description' => 'Indicates whether the new file is a Large File Storage (LFS) object.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'isOldLfs' => ['description' => 'Indicates whether the old file is a Large File Storage (LFS) object.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + ], + 'type' => 'object', + 'title' => '', + 'example' => '', ], + 'type' => 'array', + 'title' => '', + 'example' => '', ], ], + 'type' => 'object', + 'title' => '', + 'example' => '', ], ], + 'title' => 'Schema of Response', + 'type' => 'object', + 'example' => '', ], ], ], - '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', + '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\\": \\"username@example.com\\",\\n \\"authoredDate\\": \\"2023-01-03T15:41:26+08:00\\",\\n \\"createdAt\\": \\"2023-01-03T15:41:26+08:00\\",\\n \\"committerName\\": \\"云效CodeupCommitter\\",\\n \\"committerEmail\\": \\"username@example.com\\",\\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 \\"email\\": \\"username@example.com\\"\\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 \\"email\\": \\"username@example.com\\"\\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"}]', + 'title' => 'Compare API', + 'changeSet' => [ + ['createdAt' => '2023-07-24T06:14:47.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCompareDetail'], + ], ], + 'ramActions' => [], + ], + 'GetCustomFieldOption' => [ + 'summary' => 'Retrieve custom options for a field. ', + 'path' => '/organization/{organizationId}/fields/{fieldId}/getCustomOption', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'organizationId', + 'in' => 'path', + 'schema' => ['description' => 'Organization identity, also known as organization ID, in string form. It can be obtained from the Alibaba Cloud DevOps access link, for example: https://devops.aliyun.com/organization/【OrganizationId】', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx', 'title' => ''], + ], + [ + 'name' => 'spaceIdentifier', 'in' => 'query', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '61e54b0e0bb300d827e1ae27', - ], + 'schema' => ['title' => '', 'description' => 'project ID, equivalent to projectId; the UUID of the project', 'type' => 'string', 'required' => true, 'example' => 'e8bxxxxxxxxxxxxxxxx23'], + ], + [ + 'name' => 'spaceType', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'resource type; currently defaults to Project', 'type' => 'string', 'required' => true, 'example' => 'Project'], + ], + [ + 'name' => 'workitemTypeIdentifier', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Work item type ID, which can be obtained from the ListProjectWorkitemTypes API and corresponds to the identifier field.', 'type' => 'string', 'required' => true, 'example' => '9uyxxxx1re573f561dxxxxx'], + ], + [ + 'name' => 'fieldId', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'Field ID', 'type' => 'string', 'required' => true, 'example' => '1019xxxxx5f5c33xxxxx9920d44'], ], ], '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' => 'username@example.com', - ], - 'avatarUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + 'requestId' => ['title' => '', 'description' => 'Request ID. Each request has a unique value, which facilitates troubleshooting later.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMsg' => ['title' => '', 'description' => 'error message', 'type' => 'string', 'example' => 'error'], + 'errorCode' => ['title' => '', 'description' => 'error code', 'type' => 'string', 'example' => 'Openapi.RequestError'], + 'success' => ['title' => '', 'description' => 'true or false', 'type' => 'boolean', 'example' => 'true'], + 'fileds' => [ + 'title' => '', + 'description' => 'Field value information ', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'displayValue' => ['title' => '', 'description' => 'Display value ', 'type' => 'string', 'example' => '223'], + 'fieldIdentifier' => ['title' => '', 'description' => 'Field UUID ', 'type' => 'string', 'example' => 'e8bxxxxxxxxxxxxxxxx23'], + 'identifier' => ['title' => '', 'description' => 'Iteration Unique Identifier ', 'type' => 'string', 'example' => '3345'], + 'level' => ['title' => '', 'description' => 'Display level, ranging from 1 to 9. A higher number indicates a lighter color. ', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'position' => ['title' => '', 'description' => 'Option order ', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'value' => ['title' => '', 'description' => 'Field Display Name ', 'type' => 'string', 'example' => '223'], + 'valueEn' => ['title' => '', 'description' => 'Field English Name ', 'type' => 'string', 'example' => '223'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Openapi.RequestError', 'errorMessage' => 'request error', 'description' => ''], + ], 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' => 'Operate.NoPermission', 'errorMessage' => 'NoPermission', 'description' => 'You are not authorized to perform this operation.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Retrieve Custom Options for a Field', + 'changeSet' => [ + ['createdAt' => '2022-01-06T13:27:07.000Z', 'description' => 'OpenAPI offline'], ], - '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\\": \\"username@example.com\\",\\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', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCustomFieldOption'], + ], ], + 'ramActions' => [], + ], + 'GetFileBlobs' => [ + 'summary' => 'Query the specific content of a file in a code repository.', + 'path' => '/repository/{repositoryId}/files/blobs', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, for example: https://devops.aliyun.com/organization/【OrganizationId】', 'type' => 'string', 'required' => true, 'example' => '60de7a6852743a5162b5f957', 'title' => ''], ], [ 'name' => 'accessToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'f0b1e61db5961df5975a93f9129d2513'."\n", - ], + 'schema' => ['description' => 'Personal access token. '."\n" + .'This field is not required if you use an Alibaba Cloud AccessKey ID and AccessKey secret or temporary authorization from Security Token Service (STS). '."\n", 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], ], [ - 'name' => 'userIds', + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => ['description' => 'Code repository ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2744800', 'title' => ''], + ], + [ + 'name' => 'filePath', 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1,2,3', - ], + 'schema' => ['description' => 'File Path', 'type' => 'string', 'required' => true, 'example' => 'src/Test.java', 'title' => ''], ], [ - 'name' => 'page', + 'name' => 'ref', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'Branch name, tag name, or commit version number', 'type' => 'string', 'required' => true, 'example' => 'master / tag1.0 / ecykhdd', 'title' => ''], ], [ - 'name' => 'pageSize', + 'name' => 'from', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'Starting line of the file. If empty, the entire file content is retrieved.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'to', + 'in' => 'query', + 'schema' => ['description' => 'Ending line of the file. This parameter is valid only when from is not empty.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ @@ -21892,581 +9791,197 @@ '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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => 'F590C9D8-E908-5B6C-95AC-56B7E8011FFA'], + 'errorMessage' => ['description' => 'Error message', 'type' => 'string', 'example' => '”“', 'title' => ''], + 'errorCode' => ['description' => 'Error code', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'success' => ['description' => 'Indicates whether the invocation succeeded', 'type' => 'boolean', 'example' => 'true', 'title' => ''], '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' => 'username@example.com', - ], - ], - ], - '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', - ], - ], - ], - ], - ], - ], - ], + 'description' => 'Return Result', + 'type' => 'object', + 'properties' => [ + 'content' => ['description' => 'File Content', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'totalLines' => ['description' => 'Total number of lines in the file', 'type' => 'integer', 'format' => 'int32', 'example' => '65535', 'title' => ''], + 'size' => ['description' => 'Content size of the file, in bytes', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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.', 'description' => ''], + ['errorCode' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], + ], ], - '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\\": \\"username@example.com\\"\\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', + '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"}]', + 'title' => 'Query File Content', + 'changeSet' => [ + ['createdAt' => '2023-10-24T02:40:31.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFileBlobs'], + ], ], + 'ramActions' => [], + ], + 'GetFileLastCommit' => [ + 'summary' => 'Query the most recent Git commit for the specified file.', + 'path' => '/repository/{repositoryId}/files/lastCommit', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', '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, - ], + 'name' => 'accessToken', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['title' => '', 'description' => 'Personal access token. '."\n" + .'This field is not required when using Alibaba Cloud AccessKey ID and AccessKey secret or temporary authorization via Security Token Service (STS).', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513'], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'Repository ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '2825387'], + ], + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Organization identifier, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps URL, such as https://devops.aliyun.com/organization/【OrganizationId】', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '60de7a6852743a5162b5f957'], + ], + [ + 'name' => 'sha', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Branch name, tag name, or commit ID. '."\n" + .'For example: '."\n" + .'Branch name: master '."\n" + .'Tag name: tag001 '."\n" + .'Commit ID: ff4fb5ac6d1f44f452654336d2dba468ae6c8d04 ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'master'], + ], + [ + 'name' => 'filePath', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'File path', 'type' => 'string', 'required' => true, 'example' => 'src/main/test.java'], + ], + [ + 'name' => 'showSignature', + 'in' => 'query', + 'schema' => ['description' => 'Show signature. Default value: false', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], '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', - ], + 'errorMessage' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => '""'], + 'requestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9'], + 'success' => ['title' => '', 'description' => 'Request result', 'type' => 'boolean', 'example' => 'true'], + 'errorCode' => ['title' => '', 'description' => 'Error code', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR'], 'result' => [ - 'description' => '', + 'title' => '', + 'description' => 'Response Result', 'type' => 'object', 'properties' => [ - 'accessToken' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2aeb4cd012af879e54f0d37dfa526f51', - ], - 'scope' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'read:repo', - ], - 'tokenType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'code', + 'shortId' => ['title' => '', 'description' => 'Short ID', 'type' => 'string', 'example' => 'ff4fb5ac'], + 'authorName' => ['title' => '', 'description' => 'Author name ', 'type' => 'string', 'example' => 'test-codeup'], + 'authorDate' => ['title' => '', 'description' => 'Author\'s submitted time', 'type' => 'string', 'example' => '2022-08-08 18:09:09'], + 'createdAt' => ['title' => '', 'description' => 'Creation Time ', 'type' => 'string', 'example' => '2022-03-18 14:24:54'], + 'message' => ['title' => '', 'description' => 'Commit content ', 'type' => 'string', 'example' => '提交的具体内容'], + 'title' => ['title' => '', 'description' => 'Title, which is the first line of the commit ', 'type' => 'string', 'example' => '提交标题'], + 'committerName' => ['title' => '', 'description' => 'Committer name', 'type' => 'string', 'example' => 'committer-codeup'], + 'authorEmail' => ['title' => '', 'description' => 'Author\'s mailbox', 'type' => 'string', 'example' => 'username@example.com'], + 'id' => ['title' => 'Commit ID', 'description' => 'Commit ID ', 'type' => 'string', 'example' => 'ff4fb5ac6d1f44f452654336d2dba468ae6c8d04 '], + 'committerEmail' => ['title' => '', 'description' => 'Committer mailbox ', 'type' => 'string', 'example' => 'username@example.com'], + 'committedDate' => ['title' => '', 'description' => 'Committer submission time ', 'type' => 'string', 'example' => '2022-03-18 15:00:02'], + 'parentIds' => [ + 'title' => '', + 'description' => 'Parent commit ID ', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'Parent commit ID ', 'type' => 'string', 'example' => 'de02b625ba8488f92eb204bcb3773a40c1b4ddac'], + 'example' => '', ], - 'id' => [ - 'description' => 'id', - 'type' => 'string', - 'example' => '30815', + 'signature' => [ + 'title' => '', + 'description' => 'Signature', + 'type' => 'object', + 'properties' => [ + 'verificationStatus' => ['title' => '验证状态', 'description' => 'GPG validation status '."\n" + .'- unverified: Not validated '."\n" + .'- verified: GPG public key verification passed and the mailbox matches '."\n" + .'- same_user_different_email: GPG public key signature verification passed; the committer’s mailbox belongs to the current user but differs from the certificate’s mailbox '."\n" + .'- other_user: GPG public key signature verification passed, but the committer’s mailbox does not belong to the key’s user '."\n" + .'- unverified_key: The mailbox associated with the key is not in the user’s mailbox list '."\n" + .'- unknown_key: GPG key does not exist', 'type' => 'string', 'example' => 'verified'], + 'gpgKeyId' => ['title' => 'GPG密钥ID', 'description' => 'GPG密钥ID', 'type' => 'string', 'example' => '34d2c47c7ce46a5c4639c5ffe208'], + ], + 'example' => '', ], ], + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - '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', + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'SystemError.UnKnownError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","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\\": \\"username@example.com\\",\\n \\"id\\": \\"ff4fb5ac6d1f44f452654336d2dba468ae6c8d04 \\",\\n \\"committerEmail\\": \\"username@example.com\\",\\n \\"committedDate\\": \\"2022-03-18 15:00:02\\",\\n \\"parentIds\\": [\\n \\"de02b625ba8488f92eb204bcb3773a40c1b4ddac\\"\\n ],\\n \\"signature\\": {\\n \\"verificationStatus\\": \\"verified\\",\\n \\"gpgKeyId\\": \\"34d2c47c7ce46a5c4639c5ffe208\\"\\n }\\n }\\n}","type":"json"}]', + 'title' => 'Query the most recent commit information for a file', + 'changeSet' => [ + ['createdAt' => '2023-01-10T09:24:45.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-11-21T13:16:40.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-10-14T08:38:54.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-03-18T06:00:14.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFileLastCommit'], + ], ], + 'ramActions' => [], + ], + 'GetFlowTagGroup' => [ + 'summary' => 'Retrieve tag categorization.', + 'path' => '/organization/{organizationId}/flow/tagGroups/{id}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURErdcCL5BE0', - ], - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'path', - 'schema' => [ - 'title' => '企业标识,也称企业id,字符串形式,可在云效访问链接中获取,如 https:// devops.aliyun.com/organization/【OrgId】', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['title' => '', 'description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, such as https://devops.aliyun.com/organization/【OrganizationId】', '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, - ], + 'name' => 'id', + 'in' => 'path', + 'schema' => ['description' => 'Tag categorization ID', 'type' => 'string', 'required' => true, 'example' => '11', 'title' => ''], ], ], 'responses' => [ @@ -22476,557 +9991,391 @@ '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', + 'requestId' => ['title' => '', 'description' => 'Request ID. Each request has a unique value, which facilitates troubleshooting later.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['title' => '', 'description' => 'error message', 'type' => 'string', 'example' => '”“'], + 'success' => ['title' => '', 'description' => 'true if the API call succeeded, false if the API call failed', 'type' => 'boolean', 'example' => 'true 接口调用成功,false 接口调用失败'], + 'errorCode' => ['title' => '', 'description' => 'Error code', 'type' => 'string', 'example' => '”“'], + 'flowTagGroup' => [ + 'description' => 'tag categorization', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'ID of the tag categorization', 'type' => 'integer', 'format' => 'int64', 'example' => '1111', 'title' => ''], + 'name' => ['description' => 'Name of the tag categorization', 'type' => 'string', 'example' => '标签分类名称', 'title' => ''], + 'creatorAccountId' => ['description' => 'Creator', 'type' => 'string', 'example' => '1111111111111', 'title' => ''], + 'modiferAccountId' => ['description' => 'Updater', 'type' => 'string', 'example' => '1111111111111', 'title' => ''], + 'flowTagList' => [ + 'description' => 'List of tags', + 'type' => 'array', + 'items' => [ + 'description' => 'tag', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'Tag ID', 'type' => 'integer', 'format' => 'int64', 'example' => '111', 'title' => ''], + 'name' => ['description' => 'Tag Name', 'type' => 'string', 'example' => '标签名称', 'title' => ''], + 'color' => ['description' => 'Tag color', 'type' => 'string', 'example' => '#1F9AEF', 'title' => ''], + 'creatorAccountId' => ['description' => 'Creator', 'type' => 'string', 'example' => '1111111111111', 'title' => ''], + 'modiferAccountId' => ['description' => 'Updater', 'type' => 'string', 'example' => '1111111111111', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + '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.', - ], + ['errorCode' => 'InvalidCluster.NotFound', 'errorMessage' => 'No cluster is available to generate the workspace.', 'description' => 'No cluster is available to generate the workspace.'], + ['errorCode' => 'InvalidCodeUrl.NotSupportSVN', 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', 'description' => 'The parameter codeUrl is invalid. SVN is not supported.'], + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidResource.NotFound', 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', 'description' => 'No resource is found. You cannot create the workspace. Please try again later.'], + ['errorCode' => 'InvalidResourceRole.NotFoun', 'errorMessage' => 'The member role is invalid.', 'description' => 'The member role is invalid.'], + ['errorCode' => 'InvalidResourceRole.NotFound', 'errorMessage' => 'The member role is invalid.', 'description' => ''], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => 'The user that is invoking the API service is not a registered user.'], + ['errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', 'errorMessage' => 'Resource owner cannot be deleted.', 'description' => 'The resource owner cannot be deleted.'], + ['errorCode' => 'InvalidUser.ResourceMemberNotExists', 'errorMessage' => 'The resource member does not exist.', 'description' => 'The resource member does not exist.'], + ['errorCode' => 'InvalidUser.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization.', 'description' => '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.', 'description' => 'The workspace status is invalid. You can only operate workspaces with the SUCCESS status.'], + ['errorCode' => 'InvalidWorkspaceTemplate.NotFound', 'errorMessage' => 'The parameter workspaceTemplate is not found.', 'description' => 'The parameter workspaceTemplate is not found.'], ], 403 => [ - [ - 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', - 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', - ], + ['errorCode' => 'Forbidden.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], ], [ - [ - 'errorCode' => 'InvalidOrganization.NotFound', - 'errorMessage' => 'The organization is not found.', - ], + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], + ['errorCode' => 'InvalidPipeline.NotFound', 'errorMessage' => 'The pipeline is not found.', 'description' => 'The pipeline does not exist.'], + ['errorCode' => 'InvalidPipelineRun.NotFound', 'errorMessage' => 'The pipeline execution instance is not found.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'InvalidWorkspace.NotFound', 'errorMessage' => 'The workspace is not found.', 'description' => 'The workspace 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', + '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"}]', + 'title' => 'Obtain tag categorization', + 'changeSet' => [ + ['createdAt' => '2021-12-15T03:07:17.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFlowTagGroup'], + ], ], + 'ramActions' => [], + ], + 'GetGroupByPath' => [ + 'summary' => 'Retrieves information about a group by its full path.', + 'path' => '/api/4/groups/find_by_path', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'organizationId', - 'in' => 'path', - 'schema' => [ - 'title' => '企业标识,也称企业id,字符串形式,可在云效访问链接中获取,如 https:// devops.aliyun.com/organization/【OrgId】', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'in' => 'query', + 'schema' => ['title' => 'A short description of struct', 'description' => 'The ID of the organization. You can obtain the organization ID from the URL in Alibaba Cloud DevOps, for example, https\\://devops.aliyun.com/organization/{organizationId}.', 'type' => 'string', 'required' => true, 'example' => '60de7a6852743a5162b5f957'], ], [ - 'name' => 'serviceAuthType', + 'name' => 'identity', 'in' => 'query', - 'schema' => [ - 'title' => '授权类型,目前只支持RAM', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'RAM', - 'enum' => [ - 'RAM', - ], - ], + 'schema' => ['description' => 'The full path or ID of the group.', 'type' => 'string', 'required' => true, 'example' => '60de7a6852743a5162b5f957/test-group', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response schema.', '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', + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '6177543A-8D54-5736-A93B-E0195A1512CB'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'result' => [ + 'description' => 'The details of the group.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The ID of the group. This ID also serves as the namespace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '30815', 'title' => ''], + 'name' => ['description' => 'The name of the group.', 'type' => 'string', 'example' => 'test-group', 'title' => ''], + 'path' => ['description' => 'The path of the group.', 'type' => 'string', 'example' => 'test-group', 'title' => ''], + 'pathWithNamespace' => ['description' => 'The full path of the group, which includes the parent path.', 'type' => 'string', 'example' => 'codeup-test-org/test-group', 'title' => ''], + 'nameWithNamespace' => ['description' => 'The full name of the group, which includes the parent path. The slash (/) is padded with spaces.', 'type' => 'string', 'example' => 'codeup-test-org / test-group(斜杠两侧有空格)', 'title' => ''], + 'visibilityLevel' => ['description' => 'The visibility level of the group.'."\n" + ."\n" + .'- `0`: private'."\n" + ."\n" + .'- `10`: internal', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'description' => ['description' => 'The description of the group.', 'type' => 'string', 'example' => '描述内容', 'title' => ''], + 'avatarUrl' => ['description' => 'The URL of the group\'s avatar.', 'type' => 'string', 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', 'title' => ''], + 'webUrl' => ['description' => 'The web URL of the group.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'parentId' => ['description' => 'The ID of the parent group.', 'type' => 'string', 'example' => '26842', 'title' => ''], + 'ownerId' => ['description' => 'The ID of the group owner.', 'type' => 'string', 'example' => '19230', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + '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.', - ], + '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"}]', + 'title' => 'Query code group information (Path) ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGroupByPath'], ], ], - '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"}]', + 'ramActions' => [], ], - 'CreateServiceCredential' => [ - 'summary' => '创建用户名密码类型的证书', - 'path' => '/organization/{organizationId}/serviceCredentials', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetGroupDetail' => [ + 'summary' => 'Queries the information of a specified code group.', + 'path' => '/repository/groups/get_detail', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + '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', - ], + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The enterprise identifier, also known as the enterprise ID, in string format. You can obtain it from the Yunxiao access URL, such as https://devops.aliyun.com/organization/{OrganizationId}.', 'type' => 'string', 'required' => true, 'example' => '6218766746d4d2ca636d0497'], ], [ - '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, - ], + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => ['description' => 'The personal access token. '."\n" + .'This field is not required if you use an Alibaba Cloud AK/SK or STS temporary authorization.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], + ], + [ + 'name' => 'groupId', + 'in' => 'query', + 'schema' => ['description' => 'The primary key ID of the code group.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '36612', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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', + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '4CA06B0B-5867-5DE6-A0FA-9F39C97B524C'], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Openapi.RequestError', 'title' => ''], + 'success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'result' => [ + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The primary key ID of the code group.', 'type' => 'integer', 'format' => 'int64', 'example' => '36612', 'title' => ''], + 'name' => ['description' => 'The name of the code group.', 'type' => 'string', 'example' => 'test-group-detail', 'title' => ''], + 'path' => ['description' => 'The path of the code group.', 'type' => 'string', 'example' => 'test-group-detail', 'title' => ''], + 'description' => ['description' => 'The description of the code group.', 'type' => 'string', 'example' => '描述信息的具体内容'."\n", 'title' => ''], + 'avatarUrl' => ['description' => 'The avatar URL of the code group.', 'type' => 'string', 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', 'title' => ''], + 'webUrl' => ['description' => 'The URL for accessing the page.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'pathWithNamespace' => ['description' => 'The path, including the parent path.', 'type' => 'string', 'example' => 'codeup-test-org/test-group-detail', 'title' => ''], + 'nameWithNamespace' => ['description' => 'The name, including the parent path.', 'type' => 'string', 'example' => 'codeup-test-org / test-group-detail(斜杠两侧有空格)', 'title' => ''], + 'type' => ['description' => 'The type. Default value: Group.', 'type' => 'string', 'example' => 'Group', 'title' => ''], + 'visibilityLevel' => ['description' => 'The visibility level of the code group. Valid values:'."\n" + .'- 0: private.'."\n" + .'- 10: visible to the enterprise.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'parentId' => ['description' => 'The parent path ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '26842', 'title' => ''], + 'ownerId' => ['description' => 'The owner ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '19230', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + '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' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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"}]', + 'title' => 'Query code group information', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGroupDetail'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"id\\": 11222\\n}","type":"json"}]', + 'ramActions' => [], ], - 'ListServiceCredentials' => [ - 'summary' => '获取服务证书列表', - 'path' => '/organization/{organizationId}/serviceCredentials', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetHostGroup' => [ + 'summary' => 'You can obtain a host group.', + 'path' => '/organization/{organizationId}/hostGroups/{id}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'path', - 'schema' => [ - 'title' => '企业标识,也称企业id,字符串形式,可在云效访问链接中获取,如 https:// devops.aliyun.com/organization/【OrgId】', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['title' => '', 'description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, such as https://devops.aliyun.com/organization/【OrgId】.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ - 'name' => 'serviceCredentialType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'username_password', - 'enum' => [ - 'USERNAME_PASSWORD', - ], - ], + 'name' => 'id', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'Host group ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '21221'], ], ], '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', + 'requestId' => ['title' => '', 'description' => 'The request ID. Each request has a unique value, which facilitates troubleshooting later.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => '""'], + 'errorCode' => ['title' => '', 'description' => 'Error code', 'type' => 'string', 'example' => '""'], + 'success' => ['title' => '', 'description' => 'true indicates that the API call succeeded. false indicates that the API call failed.', 'type' => 'boolean', 'example' => 'true'], + 'hostGroup' => [ + 'description' => 'Host group', + 'type' => 'object', + 'properties' => [ + 'creatorAccountId' => ['description' => 'Creator Alibaba Cloud account ID', 'type' => 'string', 'example' => '111111', 'title' => ''], + 'upateTIme' => ['description' => 'Update Time', 'type' => 'integer', 'format' => 'int64', 'example' => '1586863220000', 'title' => ''], + 'hostNum' => ['description' => 'Number of hosts', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'modifierAccountId' => ['description' => 'Alibaba Cloud account ID of the modifier', 'type' => 'string', 'example' => '11111', 'title' => ''], + 'description' => ['description' => 'Host group description', 'type' => 'string', 'example' => '主机组描述', 'title' => ''], + 'type' => ['description' => 'Host group type', 'type' => 'string', 'example' => 'ECS', 'title' => ''], + 'createTime' => ['description' => 'Creation Time', 'type' => 'integer', 'format' => 'int64', 'example' => '1586863220000', 'title' => ''], + 'ecsType' => ['description' => 'ECS type. Only ECS_ALIYUN is supported for now.', 'type' => 'string', 'example' => 'ECS_ALIYUN', 'title' => ''], + 'aliyunRegion' => ['description' => 'Alibaba Cloud region', 'type' => 'string', 'example' => 'cn-bejing', 'title' => ''], + 'ecsLabelKey' => ['description' => 'ECS label key', 'type' => 'string', 'example' => 'ecs', 'title' => ''], + 'id' => ['description' => 'Host group ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'name' => ['description' => 'Host group name', 'type' => 'string', 'example' => '主机组名称', 'title' => ''], + 'serviceConnectionId' => ['description' => 'Service connection ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'hostInfos' => [ + 'description' => 'Host information', + 'type' => 'array', + 'items' => [ + 'description' => 'Host information', + 'type' => 'object', + 'properties' => [ + 'updateTime' => ['description' => 'Update Time', 'type' => 'integer', 'format' => 'int64', 'example' => '1586863220000', 'title' => ''], + 'creatorAccountId' => ['description' => 'Creator Alibaba Cloud account', 'type' => 'string', 'example' => '11111', 'title' => ''], + 'instanceName' => ['description' => 'hostname', 'type' => 'string', 'example' => 'ceshi', 'title' => ''], + 'modifierAccountId' => ['description' => 'Alibaba Cloud account of the modifier', 'type' => 'string', 'example' => '11111111111', 'title' => ''], + 'ip' => ['description' => 'Machine IP', 'type' => 'string', 'example' => '127.0.0.1', 'title' => ''], + 'createTime' => ['description' => 'Creation Time', 'type' => 'integer', 'format' => 'int64', 'example' => '1586863220000', 'title' => ''], + 'objectType' => ['description' => 'MachineInfo. The value is fixed as MachineInfo.', 'type' => 'string', 'example' => 'MachineInfo', 'title' => ''], + 'aliyunRegionId' => ['description' => 'Alibaba Cloud region', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'machineSn' => ['description' => 'Machine serial number', 'type' => 'string', 'example' => '1ssasa', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'ecsLabelValue' => ['description' => 'ECS label value', 'type' => 'string', 'example' => 'ecs', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + '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.', - ], + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => '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' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], ], [ - [ - 'errorCode' => 'InvalidOrganization.NotFound', - 'errorMessage' => 'The organization is not found.', - ], + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Retrieve a host group', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHostGroup'], + ], ], - '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"}]', + 'ramActions' => [], ], - 'ListServiceAuths' => [ - 'summary' => '获取服务授权列表', - 'path' => '/organization/{organizationId}/serviceAuths', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetMergeRequest' => [ + 'summary' => 'Gets the details of a single merge request.', + 'path' => '/api/v4/projects/{repositoryId}/merge_requests/{localId}/detail', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'organizationId', - 'in' => 'path', - 'schema' => [ - 'title' => '企业标识,也称企业id,字符串形式,可在云效访问链接中获取,如 https:// devops.aliyun.com/organization/【OrgId】', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'in' => 'query', + 'schema' => ['title' => 'A short description of struct', 'description' => 'The organization ID. This ID is part of your Alibaba Cloud DevOps URL. For example: https\\://devops.aliyun.com/organization/{organizationId}.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ - 'name' => 'serviceAuthType', + 'name' => 'accessToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'RAM', - 'enum' => [ - 'RAM', - ], - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The personal access token. This parameter is optional if you use an Alibaba Cloud AccessKey or STS temporary authorization.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513'], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the repository.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2464454', 'title' => ''], + ], + [ + 'name' => 'localId', + 'in' => 'path', + 'schema' => ['description' => 'The sequential ID of the merge request within the repository.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -23036,435 +10385,557 @@ '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' => '张三', + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9'], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Openapi.RequestError', 'title' => ''], + 'success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'result' => [ + 'description' => 'The result object.', + 'type' => 'object', + 'properties' => [ + 'mrBizId' => ['description' => 'The unique ID of the merge request.', 'type' => 'string', 'example' => 'bca90244c4b749e0b109df52ac0eb570', 'title' => ''], + 'projectId' => ['description' => 'The ID of the repository.', 'type' => 'integer', 'format' => 'int64', 'example' => '2369234', 'title' => ''], + 'localId' => ['description' => 'The sequential ID of the merge request, unique within the repository.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'createTime' => ['description' => 'The creation time of the merge request.', 'type' => 'string', 'example' => '2023-05-30T02:53:36Z', 'title' => ''], + 'updateTime' => ['description' => 'The last update time of the merge request.', 'type' => 'string', 'example' => '2023-05-30T02:53:36Z', 'title' => ''], + 'mrType' => ['description' => 'The type of the merge request. Valid values:'."\n" + ."\n" + .'- `CODE_REVIEW`: A code review.'."\n" + ."\n" + .'- `REF_REVIEW`: A reference review.', 'type' => 'string', 'example' => 'CODE_REVIEW', 'title' => ''], + 'sourceProjectId' => ['description' => 'The ID of the source repository.', 'type' => 'integer', 'format' => 'int64', 'example' => '2369234', 'title' => ''], + 'sourceBranch' => ['description' => 'The source branch.', 'type' => 'string', 'example' => 'test-merge-request', 'title' => ''], + 'targetProjectId' => ['description' => 'The ID of the target repository.', 'type' => 'integer', 'format' => 'int64', 'example' => '2369234', 'title' => ''], + 'targetBranch' => ['description' => 'The target branch.', 'type' => 'string', 'example' => 'master', 'title' => ''], + 'title' => ['description' => 'The title of the merge request.', 'type' => 'string', 'example' => 'test-合并请求标题', 'title' => ''], + 'description' => ['description' => 'The description of the merge request.', 'type' => 'string', 'example' => 'test-合并请求的具体描述内容', 'title' => ''], + 'reviewers' => [ + 'description' => 'A list of reviewers.', + 'type' => 'array', + 'items' => [ + 'description' => 'Details of a reviewer.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The ID of the Codeup user.', 'type' => 'integer', 'format' => 'int64', 'example' => '90452', 'title' => ''], + 'name' => ['description' => 'The user\'s name.', 'type' => 'string', 'example' => 'test-codeup', 'title' => ''], + 'username' => ['description' => 'The user\'s username.', 'type' => 'string', 'example' => 'root-test-codeup', 'title' => ''], + 'state' => ['description' => 'The user\'s state. Valid values:'."\n" + ."\n" + .'- `active`: The user is active.'."\n" + ."\n" + .'- `blocked`: The user is blocked or unavailable.', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'avatarUrl' => ['description' => 'The URL of the user\'s avatar.', 'type' => 'string', 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', 'title' => ''], + 'email' => ['description' => 'The user\'s email address.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + 'hasReviewed' => ['description' => 'Indicates whether the reviewer has reviewed the merge request.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'reviewOpinionStatus' => ['description' => 'The reviewer\'s opinion. This parameter is empty if no review has been submitted. Valid values:'."\n" + ."\n" + .'- `PASS`: Passed'."\n" + ."\n" + .'- `NOT_PASS`: Not passed', 'type' => 'string', 'example' => 'NOT_PASS', 'title' => ''], + 'reviewTime' => ['description' => 'The completion time of the review.'."\n" + ."\n" + .'> This parameter is empty if the reviewer has not completed the review.', 'type' => 'string', 'example' => '2023-05-30T02:53:36Z', 'title' => ''], + 'hasCommented' => ['description' => 'Indicates whether the reviewer has commented on the merge request.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'type' => [ - 'title' => '服务授权类型', - 'description' => '', - 'type' => 'string', - 'example' => 'Codeup', + 'title' => '', + 'example' => '', + ], + 'author' => [ + 'description' => 'Details of the author.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The ID of the Codeup user.', 'type' => 'integer', 'format' => 'int64', 'example' => '19927', 'title' => ''], + 'name' => ['description' => 'The user\'s name.', 'type' => 'string', 'example' => 'test-codeup', 'title' => ''], + 'username' => ['description' => 'The user\'s username.', 'type' => 'string', 'example' => 'root-test-codeup', 'title' => ''], + 'state' => ['description' => 'The user\'s state. Valid values:'."\n" + ."\n" + .'- `active`: The user is active.'."\n" + ."\n" + .'- `blocked`: The user is blocked or unavailable.', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'avatarUrl' => ['description' => 'The URL of the user\'s avatar.', 'type' => 'string', 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', 'title' => ''], + 'email' => ['description' => 'The user\'s email address.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'subscribers' => [ + 'description' => 'A list of subscribers.', + 'type' => 'array', + 'items' => [ + 'description' => 'Details of a subscriber.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The ID of the Codeup user.', 'type' => 'integer', 'format' => 'int64', 'example' => '90452', 'title' => ''], + 'name' => ['description' => 'The user\'s name.', 'type' => 'string', 'example' => 'test-subscriber', 'title' => ''], + 'username' => ['description' => 'The user\'s username.', 'type' => 'string', 'example' => 'test-subscriber', 'title' => ''], + 'state' => ['description' => 'The user\'s state. Valid values:'."\n" + ."\n" + .'- `active`: The user is active.'."\n" + ."\n" + .'- `blocked`: The user is blocked or unavailable.', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'avatarUrl' => ['description' => 'The URL of the user\'s avatar.', 'type' => 'string', 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', 'title' => ''], + 'email' => ['description' => 'The user\'s email address.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'ownerStaffId' => [ - 'title' => '授权用户的 StaffId', - 'description' => '', - 'type' => 'string', - 'example' => '123456789', + 'title' => '', + 'example' => '', + ], + 'status' => ['description' => 'The merge request status. Valid values:'."\n" + ."\n" + .'- `UNDER_DEV`: In development'."\n" + ."\n" + .'- `UNDER_REVIEW`: In review'."\n" + ."\n" + .'- `TO_BE_MERGED`: To be merged'."\n" + ."\n" + .'- `CLOSED`: Closed'."\n" + ."\n" + .'- `MERGED`: Merged', 'type' => 'string', 'example' => 'UNDER_REVIEW', 'title' => ''], + 'createFrom' => ['description' => 'How the merge request was created. Valid values:'."\n" + ."\n" + .'- `WEB`: Created on the web UI.'."\n" + ."\n" + .'- `COMMAND_LINE`: Created from the command line.', 'type' => 'string', 'example' => 'WEB', 'title' => ''], + 'ahead' => ['description' => 'The number of commits that the source branch is ahead of the target branch.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'behind' => ['description' => 'The number of commits that the source branch is behind the target branch.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'todoList' => [ + 'description' => 'A list of checks to be completed before merging.', + 'type' => 'object', + 'properties' => [ + 'requirementCheckItems' => [ + 'description' => 'A list of requirement check items.', + 'type' => 'array', + 'items' => [ + 'description' => 'Details of a requirement check.', + 'type' => 'object', + 'properties' => [ + 'itemType' => ['description' => 'The type of requirement check. Valid values:'."\n" + ."\n" + .'- `MERGE_CONFLICT_CHECK`: A merge conflict check.'."\n" + ."\n" + .'- `COMMENTS_CHECK`: A comments check.'."\n" + ."\n" + .'- `CI_CHECK`: A CI check.'."\n" + ."\n" + .'- `REVIEWER_APPROVED_CHECK`: A reviewer approved check.', 'type' => 'string', 'example' => 'COMMENTS_CHECK', 'title' => ''], + 'pass' => ['description' => 'Indicates whether the requirement check passed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], ], + 'title' => '', + 'example' => '', ], + 'allRequirementsPass' => ['description' => 'Indicates whether all requirement checks passed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'supportMergeFastForwardOnly' => ['description' => 'Indicates if a fast-forward-only merge is supported.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'detailUrl' => ['description' => 'The URL for the merge request details.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'webUrl' => ['description' => 'The URL of the merge request page.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'targetProjectNameWithNamespace' => ['description' => 'The full name of the target repository, including the complete namespace.', 'type' => 'string', 'example' => 'orgId / test-group / test-target-repo(斜杠两侧有空格)', 'title' => ''], + 'targetProjectPathWithNamespace' => ['description' => 'The full path of the target repository, including the complete namespace.', 'type' => 'string', 'example' => 'orgId/test-group/test-target-repo', 'title' => ''], + 'mergedRevision' => ['description' => 'The commit SHA after the merge.', 'type' => 'string', 'example' => '1a072f5367c21f9de3464b8c0ee8546e47764d2d', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + '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.', - ], + '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\\": \\"username@example.com\\",\\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\\": \\"username@example.com\\"\\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\\": \\"username@example.com\\"\\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"}]', + 'title' => 'Query merge requests ', + 'description' => 'This API is for enterprises using the new MR, which can be confirmed by checking if the merge request page is the new version.', + 'changeSet' => [ + ['createdAt' => '2024-01-29T11:52:26.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-01-11T02:39:13.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMergeRequest'], ], - 403 => [ - [ - 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', - 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', - ], + ], + 'ramActions' => [], + ], + 'GetMergeRequestChangeTree' => [ + 'summary' => 'Retrieves diff statistics for a merge request, including a file change tree, total added and deleted lines, and per-file line change statistics.', + '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' => [ [ - [ - 'errorCode' => 'InvalidOrganization.NotFound', - 'errorMessage' => 'The organization is not found.', + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => ['title' => 'A short description of struct', 'description' => 'The ID of the organization. Find this ID in the URL of Alibaba Cloud DevOps: `https://devops.aliyun.com/organization/<organizationId>`.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => ['description' => 'The personal access token. Not required if authenticating with an Alibaba Cloud AccessKey pair (AK/SK) or Security Token Service (STS).', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], + ], + [ + 'name' => 'repositoryIdentity', + 'in' => 'query', + 'schema' => ['description' => 'The ID or full path of the repository.', 'type' => 'string', 'required' => true, 'example' => '2835387 或 codeup/codeup-demo'."\n", 'title' => ''], + ], + [ + 'name' => 'localId', + 'in' => 'query', + 'schema' => ['description' => 'The local ID of the merge request within its repository.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7', 'title' => ''], + ], + [ + 'name' => 'fromPatchSetBizId', + 'in' => 'query', + 'schema' => ['description' => 'The business ID of the patch set for the merge target.'."\n" + ."\n" + .'> In APIs related to merge requests and comparisons, `from` and `to` may seem counterintuitive. `from` specifies the merge target, and `to` specifies the merge source. This order aligns with the execution sequence of a native Git command. The source and target labels in the UI are adjusted for clarity.', 'type' => 'string', 'required' => true, 'example' => '5e733626d53f4b04a6aa0e23d4ff72b8', 'title' => ''], + ], + [ + 'name' => 'toPatchSetBizId', + 'in' => 'query', + 'schema' => ['description' => 'The business ID of the patch set for the merge source.'."\n" + ."\n" + .'> In APIs related to merge requests and comparisons, `from` and `to` may seem counterintuitive. `from` specifies the merge target, and `to` specifies the merge source. This order aligns with the execution sequence of a native Git command. The source and target labels in the UI are adjusted for clarity.', 'type' => 'string', 'required' => true, 'example' => '513fcfd81a9142d2bb0db4f72c0aa15b', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response object.', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => 'The unique identifier for the request, useful for troubleshooting.', 'type' => 'string', 'example' => 'HC93CE1A-8D7A-13A9-8306-7465DE2E5C0F'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'errorCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'errorMessage' => ['description' => 'The error message that provides details about a failed request.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'result' => [ + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'changedFilesCount' => ['description' => 'The total number of changed files.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'totalAddLines' => ['description' => 'The total number of added lines.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'totalDelLines' => ['description' => 'The total number of deleted lines.', 'type' => 'integer', 'format' => 'int64', 'example' => '50', 'title' => ''], + 'changedFilesInfos' => [ + 'description' => 'An array of objects, each containing information about a changed file.', + 'type' => 'array', + 'items' => [ + 'description' => 'An object containing statistics for a single changed file.', + 'type' => 'object', + 'properties' => [ + 'newPath' => ['description' => 'The new path of the file.', 'type' => 'string', 'example' => 'test.txt', 'title' => ''], + 'oldPath' => ['description' => 'The old path of the file.', 'type' => 'string', 'example' => 'test.txt', 'title' => ''], + 'newFile' => ['description' => 'Whether the file is new.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'renamedFile' => ['description' => 'Whether the file was renamed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'deletedFile' => ['description' => 'Whether the file was deleted.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'binaryFile' => ['description' => 'Whether the file is a binary file.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'addLines' => ['description' => 'The number of added lines in the file.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'delLines' => ['description' => 'The number of deleted lines in the file.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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"}]', + 'title' => 'Query Diff statistics information for a merge request ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMergeRequestChangeTree'], + ], ], - '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"}]', + 'ramActions' => [], ], - 'ListServiceConnections' => [ - 'summary' => '获取服务连接列表', - 'path' => '/organization/{organizationId}/serviceConnections', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetOrganizationMember' => [ + 'summary' => 'Obtain enterprise member information based on specified conditions.', + 'path' => '/organization/{organizationId}/members/{accountId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'path', - 'schema' => [ - 'title' => '企业标识,也称企业id,字符串形式,可在云效访问链接中获取,如 https:// devops.aliyun.com/organization/【OrgId】', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['description' => 'Organization identity, also known as organization ID', 'type' => 'string', 'required' => true, 'example' => '66c0c9fffeb86b450c199fcd', 'title' => ''], ], [ - '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', - ], + 'name' => 'accountId', + 'in' => 'path', + 'schema' => ['description' => 'Alibaba Cloud User UID', 'type' => 'string', 'required' => true, 'example' => '123456677888', 'title' => ''], ], ], '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' => '""', - ], - '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', + 'requestId' => ['title' => '', 'description' => 'Request ID. Each request has a unique value, which facilitates troubleshooting later.', 'type' => 'string', 'example' => 'HC93CE1A-8D7A-13A9-8306-7465DE2E5C0F'], + 'errorMessage' => ['title' => '', 'description' => 'error message', 'type' => 'string', 'example' => 'error info'], + 'member' => [ + 'title' => '', + 'description' => 'member', + 'type' => 'object', + 'properties' => [ + 'accountId' => ['title' => '', 'description' => 'Alibaba Cloud User UID', 'type' => 'string', 'example' => '123456677888'], + 'birthday' => ['title' => '', 'description' => 'Birthday', 'type' => 'integer', 'format' => 'int64', 'example' => '1631845101798'], + 'deptLists' => [ + 'title' => '', + 'description' => 'List of department names', + 'type' => 'array', + 'items' => ['description' => 'Department Name', 'type' => 'string', 'example' => '测试部门', 'title' => ''], + 'example' => '', + ], + 'email' => ['title' => '', 'description' => 'Mailbox', 'type' => 'string', 'example' => '123@mail.com'], + 'hiredDate' => ['title' => '', 'description' => 'Hire date', 'type' => 'integer', 'format' => 'int64', 'example' => '1631845101798'], + 'identities' => [ + 'title' => '', + 'description' => 'Third-party information', + 'type' => 'object', + 'properties' => [ + 'externUid' => ['title' => '', 'description' => 'User ID in the third-party system', 'type' => 'string', 'example' => '1236666'], + 'provider' => ['title' => '', 'description' => 'Third-party system', 'type' => 'string', 'example' => 'Dingtalk'], ], + 'example' => '', ], + 'joinTime' => ['title' => '', 'description' => 'Time when the member joined the Alibaba Cloud DevOps enterprise', 'type' => 'integer', 'format' => 'int64', 'example' => '1631845101798'], + 'lastVisitTime' => ['title' => '', 'description' => 'Last access time', 'type' => 'integer', 'format' => 'int64', 'example' => '1631845101798'], + 'mobile' => ['title' => '', 'description' => 'Phone number', 'type' => 'string', 'example' => '1390000****'], + 'organizationMemberName' => ['title' => '', 'description' => 'Organization member name', 'type' => 'string', 'example' => '名字1'], + 'organizationRoleName' => ['title' => '', 'description' => 'Enterprise role name', 'type' => 'string', 'example' => '管理员'], + 'jobNumber' => ['description' => 'Job number', 'type' => 'string', 'example' => '373***', 'title' => ''], + 'organizationRoleId' => ['title' => '', 'description' => 'Organization role ID', 'type' => 'string', 'example' => '8fc0c9ff039711dd64acd000'], + 'state' => ['title' => '', 'description' => 'User status (Normal, blocked, deleted)', 'type' => 'string', 'example' => 'normal'], ], + 'example' => '', ], + 'errorCode' => ['title' => '', 'description' => 'Error code', 'type' => 'string', 'example' => 'null'], + 'success' => ['title' => '', 'description' => 'true if the API call succeeded, false if the API call failed', 'type' => 'boolean', 'example' => 'true'], ], + '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.', - ], + ['errorCode' => 'InvalidUser.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization.', 'description' => 'The user is not in the organization.'], ], 403 => [ - [ - '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.', 'description' => ''], ], [ - [ - 'errorCode' => 'InvalidOrganization.NotFound', - 'errorMessage' => 'The organization is not found.', - ], + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], ], ], - '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', + 'responseDemo' => '[{"errorExample":"","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\\": \\"123@mail.com\\",\\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}","type":"json"}]', + 'title' => 'Query organization member information', + 'changeSet' => [ + ['createdAt' => '2023-11-27T13:01:22.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-09-27T12:22:42.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-09-22T12:34:01.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOrganizationMember'], + ], ], + 'ramActions' => [], + ], + 'GetPipeline' => [ + 'summary' => 'You can retrieve pipeline information.', + '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/【OrganizationId】', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['title' => '', 'description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access Link, such as https://devops.aliyun.com/organization/【OrganizationId】', 'type' => 'string', 'required' => true, 'docRequired' => 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', - ], + 'schema' => ['title' => '', 'description' => 'Pipeline ID, which can be obtained from the pipeline Link, such as https://flow.aliyun.com/pipelines/【PipelineId】/current', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '234'], ], ], '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' => '”“', + 'requestId' => ['title' => '', 'description' => '请求id,每次请求都是唯一值,便于后续排查问题', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['title' => '', 'description' => '错误信息', 'type' => 'string', 'example' => '""'], + 'pipeline' => [ + 'title' => '', + 'description' => 'Pipeline', + 'type' => 'object', + 'properties' => [ + 'creatorAccountId' => ['title' => '', 'description' => 'Creator Alibaba Cloud account ID', 'type' => 'string', 'example' => '112222122'], + 'envId' => ['title' => '', 'description' => '环境id 0 日常环境 1预发环境 2正式环境', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'envName' => ['title' => '', 'description' => 'Environment Name ', 'type' => 'string', 'example' => '日常环境'], + 'createTime' => ['title' => '', 'description' => 'Creation Time', 'type' => 'integer', 'format' => 'int64', 'example' => '1586863220000'], + 'updateTime' => ['title' => '', 'description' => '更新时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1586863220000'], + 'groupId' => ['title' => '', 'description' => '流水线分组id', 'type' => 'integer', 'format' => 'int64', 'example' => '1111'], + 'modifierAccountId' => ['title' => '', 'description' => '更新人阿里云账号id', 'type' => 'string', 'example' => '112222122'], + 'name' => ['title' => '', 'description' => '流水线名称', 'type' => 'string', 'example' => '流水线'], + 'tagList' => [ + 'title' => '', + 'description' => 'Labels', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'id' => ['title' => '', 'description' => 'Tag ID', 'type' => 'integer', 'format' => 'int64', 'example' => '22'], + 'name' => ['title' => '', 'description' => 'Tag Name', 'type' => 'string', 'example' => '标签1'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'pipelineConfig' => [ + 'title' => '', + 'description' => 'Pipeline configuration', + 'type' => 'object', + 'properties' => [ + 'flow' => ['title' => '', 'description' => 'Pipeline Configuration Information ', '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' => 'Pipeline environment variables and other settings', 'type' => 'string', 'example' => '{}'], + 'sources' => [ + 'title' => '', + 'description' => 'Code source', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'sign' => ['title' => '', 'description' => 'UUID of the Code Source ', 'type' => 'string', 'example' => 'xxsxsxs'], + 'type' => ['title' => '', 'description' => 'Code source type: aliyunGit (Alibaba Cloud Code Repository), customGitlab (Self-hosted Git), giteeGit (Gitee), codeup (Codeup), git (Generic Git), gitlab (GitLab), bitbucket (Bitbucket), githubOAuth (GitHub) ', 'type' => 'string', 'example' => 'Codeup'], + 'data' => [ + 'title' => '', + 'description' => 'Code data', + 'type' => 'object', + 'properties' => [ + 'branch' => ['title' => '', 'description' => '[responses_200_schema_properties_pipeline_properties_pipelineConfig_properties_sources_items_properties_data_properties_triggerFilter_type]string', 'type' => 'string', 'example' => 'master'], + 'serviceConnectionId' => ['title' => '', 'description' => 'Service connection ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '12'], + 'label' => ['title' => '', 'description' => '[responses_200_schema_properties_pipeline_properties_pipelineConfig_properties_sources_items_properties_data_properties_serviceConnectionId_type]integer ', 'type' => 'string', 'example' => 'cdup/ss'], + 'isTrigger' => ['title' => '', 'description' => '[responses_200_schema_properties_pipeline_properties_pipelineConfig_properties_sources_items_properties_data_properties_credentialType_type]string ', 'type' => 'boolean', 'example' => 'true'], + 'repo' => ['title' => '', 'description' => '[responses_200_schema_properties_pipeline_properties_pipelineConfig_properties_sources_items_properties_data_properties_isSubmodule_type]boolean ', 'type' => 'string', 'example' => 'https://codeup.aliyun.com/test.git'], + 'triggerFilter' => ['title' => '', 'description' => 'Trigger filter condition ', 'type' => 'string', 'example' => '.*'], + 'webhook' => ['title' => '', 'description' => '[responses_200_schema_properties_pipeline_properties_pipelineConfig_properties_sources_items_properties_data_properties_branch_type]string ', 'type' => 'string', 'example' => 'https://flow.aliyun/webhook/asassasa'], + 'events' => [ + 'title' => '', + 'description' => 'Triggering event', + 'type' => 'array', + 'items' => ['description' => 'Management Event ', 'type' => 'string', 'example' => 'push', 'title' => ''], + 'example' => '', + ], + 'isBranchMode' => ['title' => '', 'description' => 'Indicates whether branch mode is enabled', 'type' => 'boolean', 'example' => 'false'], + 'isSubmodule' => ['title' => '', 'description' => 'Is submodule ', 'type' => 'boolean', 'example' => 'false'], + 'isCloneDepth' => ['title' => '', 'description' => 'Whether to set the clone depth ', 'type' => 'boolean', 'example' => 'true'], + 'cloneDepth' => ['title' => '', 'description' => 'Clone depth ', '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' => '', 'description' => 'GitHub namespace ', 'type' => 'string', 'example' => 'asasasas'], + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + 'example' => '', ], + 'success' => ['title' => '', 'description' => 'true 接口调用成功,false 接口调用失败', 'type' => 'boolean', 'example' => 'true'], + 'errorCode' => ['title' => '', 'description' => '错误码', 'type' => 'string', 'example' => '""'], ], + 'description' => '', + 'title' => '', + '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.', - ], + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => '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' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], ], [ - [ - '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.', - ], + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], + ['errorCode' => 'InvalidPipeline.NotFound', 'errorMessage' => 'The pipeline is not found.', 'description' => 'The pipeline does not exist.'], ], ], - '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', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Obtain pipeline information', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPipeline'], + ], ], + 'ramActions' => [], + ], + 'GetPipelineArtifactUrl' => [ + 'summary' => 'Obtain the download URL of pipeline build artifacts.', + 'path' => '/organization/{organizationId}/pipeline/getArtifactDownloadUrl', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -23476,48 +10947,17 @@ [ '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', - ], + 'schema' => ['title' => '', 'description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, such as https://devops.aliyun.com/organization/【OrganizationId】.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ - 'name' => 'deployOrderId', - 'in' => 'path', - 'schema' => [ - 'title' => '部署单ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '111111111', - ], + 'name' => 'filePath', + 'in' => 'query', + 'schema' => ['description' => 'File Path, which can be obtained through the API at https://help.aliyun.com/document_detail/460565.html.', 'type' => 'string', 'required' => true, 'example' => '/test/test/test.tgz', 'maxLength' => 1000, 'title' => ''], ], [ - 'name' => 'machineSn', - 'in' => 'path', - 'schema' => [ - 'title' => '机器SN', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'asssssssxsx', - ], + 'name' => 'fileName', + 'in' => 'query', + 'schema' => ['description' => 'File name, which can be obtained through the API at https://help.aliyun.com/document_detail/460565.html.', 'type' => 'string', 'required' => true, 'example' => 'test.tgz', 'title' => ''], ], ], 'responses' => [ @@ -23527,134 +10967,60 @@ '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' => '”“', - ], + 'requestId' => ['title' => '', 'description' => 'Request ID. Each request has a unique value, which facilitates troubleshooting later.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['title' => '', 'description' => 'error message', 'type' => 'string', 'example' => '”“'], + 'success' => ['title' => '', 'description' => 'true if the API call succeeded; false if the API call failed.', 'type' => 'boolean', 'example' => 'true 接口调用成功,false 接口调用失败'], + 'errorCode' => ['title' => '', 'description' => 'error code', 'type' => 'string', 'example' => '”“'], + 'fileUrl' => ['description' => 'Temporary file download path with a validity period of one hour.', 'type' => 'string', 'example' => 'http://aliyun.com/', 'title' => ''], ], + '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.', - ], + ['errorCode' => 'InvalidCluster.NotFound', 'errorMessage' => 'No cluster is available to generate the workspace.', 'description' => 'No cluster is available to generate the workspace.'], + ['errorCode' => 'InvalidCodeUrl.NotSupportSVN', 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', 'description' => 'The parameter codeUrl is invalid. SVN is not supported.'], + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidResource.NotFound', 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', 'description' => 'No resource is found. You cannot create the workspace. Please try again later.'], + ['errorCode' => 'InvalidResourceRole.NotFoun', 'errorMessage' => 'The member role is invalid.', 'description' => 'The member role is invalid.'], + ['errorCode' => 'InvalidResourceRole.NotFound', 'errorMessage' => 'The member role is invalid.', 'description' => ''], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => 'The user that is invoking the API service is not a registered user.'], + ['errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', 'errorMessage' => 'Resource owner cannot be deleted.', 'description' => 'The resource owner cannot be deleted.'], + ['errorCode' => 'InvalidUser.ResourceMemberNotExists', 'errorMessage' => 'The resource member does not exist.', 'description' => 'The resource member does not exist.'], + ['errorCode' => 'InvalidUser.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization.', 'description' => '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' => 'Forbidden.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], ], [ - [ - '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.', - ], + ['errorCode' => 'InvalidIdentifier.NotFound', 'errorMessage' => 'space id is error or not exist.', 'description' => ''], + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], + ['errorCode' => 'InvalidPipeline.NotFound', 'errorMessage' => 'The pipeline is not found.', 'description' => 'The pipeline does not exist.'], + ['errorCode' => 'InvalidPipelineRun.NotFound', 'errorMessage' => 'The pipeline execution instance is not found.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'InvalidWorkspace.NotFound', 'errorMessage' => 'The workspace is not found.', 'description' => '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', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\",\\n \\"fileUrl\\": \\"http://aliyun.com/\\"\\n}","type":"json"}]', + 'title' => 'Obtain the download URL of pipeline build artifacts.', + 'changeSet' => [ + ['createdAt' => '2021-12-30T14:20:57.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPipelineArtifactUrl'], + ], ], + 'ramActions' => [], + ], + 'GetPipelineEmasArtifactUrl' => [ + 'summary' => 'Obtain the temporary download URL for EMAS build artifacts from a pipeline.', + 'path' => '/organization/{organizationId}/pipeline/{pipelineId}/pipelineRun/{pipelineRunId}/emas/artifact/{emasJobInstanceId}/{md5}', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -23666,48 +11032,32 @@ [ 'name' => 'organizationId', 'in' => 'path', - 'schema' => [ - 'title' => '企业标识,也称企业id,字符串形式,可在云效访问链接中获取,如https://devops.aliyun.com/organization/【OrganizationId】', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['title' => '', 'description' => 'Organization identifier, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, such as https://devops.aliyun.com/organization/【OrganizationId】', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ - 'name' => 'pipelineId', + 'name' => 'emasJobInstanceId', 'in' => 'path', - 'schema' => [ - 'title' => '12222', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1111', - ], + 'schema' => ['description' => 'EMAS job ID. You can obtain it through the API at https://help.aliyun.com/document_detail/460565.html', 'type' => 'string', 'required' => true, 'example' => 'Psaxsa', 'title' => ''], ], [ - 'name' => 'deployOrderId', + 'name' => 'md5', 'in' => 'path', - 'schema' => [ - 'title' => '部署单ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '11111111', - ], + 'schema' => ['description' => 'MD5 hash of the EMAS build artifact. You can obtain it through the API at https://help.aliyun.com/document_detail/460565.html', 'type' => 'string', 'required' => true, 'example' => 'assasas', 'title' => ''], ], [ - 'name' => 'machineSn', + 'name' => 'pipelineId', 'in' => 'path', - 'schema' => [ - 'title' => '机器SN', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'assssssss', - ], + 'schema' => ['description' => 'Pipeline ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1111', 'title' => ''], + ], + [ + 'name' => 'pipelineRunId', + 'in' => 'path', + 'schema' => ['description' => 'Pipeline run instance ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'serviceConnectionId', + 'in' => 'query', + 'schema' => ['description' => 'Service connection ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '122', 'title' => ''], ], ], 'responses' => [ @@ -23717,686 +11067,348 @@ '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' => '”“', - ], + 'requestId' => ['title' => '', 'description' => 'Request ID. Each request has a unique value, which facilitates troubleshooting.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => '”“'], + 'success' => ['title' => '', 'description' => 'true if the API call succeeded; false if the API call failed.', 'type' => 'boolean', 'example' => 'true 接口调用成功,false 接口调用失败'], + 'errorCode' => ['title' => '', 'description' => 'Error code', 'type' => 'string', 'example' => '”“'], + 'fileUrl' => ['description' => 'Temporary download URL for EMAS build artifacts, with a validity period of one hour', 'type' => 'string', 'example' => 'http://aliyun.com', 'title' => ''], ], + '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.', - ], + ['errorCode' => 'InvalidCluster.NotFound', 'errorMessage' => 'No cluster is available to generate the workspace.', 'description' => 'No cluster is available to generate the workspace.'], + ['errorCode' => 'InvalidCodeUrl.NotSupportSVN', 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', 'description' => 'The parameter codeUrl is invalid. SVN is not supported.'], + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidResource.NotFound', 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', 'description' => 'No resource is found. You cannot create the workspace. Please try again later.'], + ['errorCode' => 'InvalidResourceRole.NotFoun', 'errorMessage' => 'The member role is invalid.', 'description' => 'The member role is invalid.'], + ['errorCode' => 'InvalidResourceRole.NotFound', 'errorMessage' => 'The member role is invalid.', 'description' => ''], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => 'The user that is invoking the API service is not a registered user.'], + ['errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', 'errorMessage' => 'Resource owner cannot be deleted.', 'description' => 'The resource owner cannot be deleted.'], + ['errorCode' => 'InvalidUser.ResourceMemberNotExists', 'errorMessage' => 'The resource member does not exist.', 'description' => 'The resource member does not exist.'], + ['errorCode' => 'InvalidUser.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization.', 'description' => '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' => 'Forbidden.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], ], [ - [ - '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.', - ], + ['errorCode' => 'InvalidIdentifier.NotFound', 'errorMessage' => 'space id is error or not exist.', 'description' => ''], + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], + ['errorCode' => 'InvalidPipeline.NotFound', 'errorMessage' => 'The pipeline is not found.', 'description' => 'The pipeline does not exist.'], + ['errorCode' => 'InvalidPipelineRun.NotFound', 'errorMessage' => 'The pipeline execution instance is not found.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'InvalidWorkspace.NotFound', 'errorMessage' => 'The workspace is not found.', 'description' => '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', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\",\\n \\"fileUrl\\": \\"http://aliyun.com\\"\\n}","type":"json"}]', + 'title' => 'Obtain the temporary download URL for EMAS build artifacts from a pipeline', + 'changeSet' => [ + ['createdAt' => '2021-12-30T14:20:57.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPipelineEmasArtifactUrl'], + ], ], + 'ramActions' => [], + ], + 'GetPipelineGroup' => [ + 'summary' => 'Retrieve pipeline groups.', + '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' => [ - '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', - ], + 'schema' => ['description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, such as https://devops.aliyun.com/organization/【OrganizationId】'."\n" + ."\n", 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx', 'title' => ''], ], [ - 'name' => 'deployOrderId', + 'name' => 'groupId', 'in' => 'path', - 'schema' => [ - 'title' => '部署单ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '11111', - ], + 'schema' => ['description' => 'Pipeline group ID. The value 0 indicates that the pipeline is ungrouped.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '111', 'title' => ''], ], ], 'responses' => [ 200 => [ + 'headers' => [], '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' => '”“', + 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID. Each request has a unique value, which facilitates troubleshooting later.'."\n" + ."\n", 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['description' => 'error message', 'type' => 'string', 'example' => '""', 'title' => ''], + 'success' => ['description' => 'true indicates that the API call succeeded; false indicates that the API call failed.'."\n" + ."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'errorCode' => ['description' => 'error code', 'type' => 'string', 'example' => '""', 'title' => ''], + 'pipelineGroup' => [ + 'description' => 'Pipeline group', + 'type' => 'object', + 'properties' => [ + 'createTime' => ['description' => 'Creation Time', 'type' => 'integer', 'format' => 'int64', 'example' => '1586863220000', 'title' => ''], + 'id' => ['description' => 'Pipeline group ID', 'type' => 'integer', 'format' => 'int64', 'example' => '111', 'title' => ''], + 'name' => ['description' => 'Pipeline group name', 'type' => 'string', 'example' => '流水线分组名称', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + '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' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], ], [ - [ - '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.', - ], + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], + ['errorCode' => 'InvalidUser.UserNotInCurrentOrganization', 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', 'description' => ''], ], ], - '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', + '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"}]', + 'title' => 'Retrieve pipeline groups', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPipelineGroup'], + ], ], + 'ramActions' => [], + ], + 'GetPipelineRun' => [ + 'summary' => 'Retrieves a pipeline run.', + '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/【OrganizationId】', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['description' => 'The ID of the organization. You can get this ID from the URL of your organization in Alibaba Cloud DevOps, for example, `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5ebbc0228123212b59xxxxx', 'title' => ''], ], [ 'name' => 'pipelineId', 'in' => 'path', - 'schema' => [ - 'title' => '12222', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1222', - ], + 'schema' => ['description' => 'The ID of the pipeline. You can get this ID from the pipeline URL, for example, `https://flow.aliyun.com/pipelines/{pipelineId}/current`.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '12222', 'title' => ''], ], [ - 'name' => 'deployOrderId', + 'name' => 'pipelineRunId', 'in' => 'path', - 'schema' => [ - 'title' => '部署单ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '11111', - ], + 'schema' => ['description' => 'The ID of the pipeline run.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], ], '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' => '', + 'requestId' => ['description' => 'The unique ID for the request, used for troubleshooting.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', 'title' => ''], + 'errorMessage' => ['description' => 'The error message that is returned when an error occurs.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'pipelineRun' => [ + 'title' => '', + 'description' => 'The pipeline run.', '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', + 'creatorAccountId' => ['description' => 'The Alibaba Cloud account ID of the creator.', 'type' => 'string', 'example' => '1111111111', 'title' => ''], + 'createTime' => ['description' => 'The creation time of the pipeline run, provided as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1586863220000', 'title' => ''], + 'updateTime' => ['description' => 'The last update time of the pipeline run, provided as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1586863220000', 'title' => ''], + 'modifierAccountId' => ['description' => 'The Alibaba Cloud account ID of the user who last updated the pipeline run.', 'type' => 'string', 'example' => '11111111111', 'title' => ''], + 'pipelineId' => ['description' => 'The pipeline ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'pipelineRunId' => ['description' => 'The pipeline run ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'status' => ['description' => 'The status of the pipeline run. Valid values: `FAIL` (Failed), `SUCCESS` (Succeeded), and `RUNNING` (Running).', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'triggerMode' => ['description' => '- The trigger mode. Valid values:'."\n" + ."\n" + .' `1`: Manual'."\n" + ."\n" + .' `2`: Schedule'."\n" + ."\n" + .' `3`: Code commit'."\n" + ."\n" + .' `5`: Pipeline'."\n" + ."\n" + .' `6`: Webhook', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'stageGroup' => [ + 'title' => '', + 'description' => 'The topology of the pipeline stages.', + 'type' => 'array', + 'items' => [ + 'description' => 'A group of stages that run in parallel.', + 'type' => 'array', + 'items' => ['description' => 'The name of the stage.', 'type' => 'string', 'example' => '阶段名称', 'title' => ''], + 'title' => '', + 'example' => '', + ], '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', + 'sources' => [ + 'title' => '', + 'description' => 'The code sources.', + 'type' => 'array', + 'items' => [ + 'description' => 'The code source.', + 'type' => 'object', + 'properties' => [ + 'sign' => ['description' => 'The unique identifier of the code source.', 'type' => 'string', 'example' => 'assaaaaaasasasa', 'title' => ''], + 'type' => ['description' => 'The repository type. Valid values are `Codeup` (for Codeup), `aliyunGit` (for Alibaba Cloud Code), and `giteeGit` (for Gitee).', 'type' => 'string', 'example' => 'Codeup', 'title' => ''], + 'data' => [ + 'title' => '', + 'description' => 'Details of the code source.', + 'type' => 'object', + 'properties' => [ + 'branch' => ['description' => 'The branch.', 'type' => 'string', 'example' => 'master', 'title' => ''], + 'commint' => ['description' => 'The details of the commit, in JSON format.', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'repo' => ['description' => 'The repository URL.', 'type' => 'string', 'example' => 'http://codeup.aliyun.com/a.git', 'title' => ''], + ], + 'example' => '', + ], ], - 'deployMachines' => [ - 'title' => '部署机器列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'stages' => [ + 'title' => '', + 'description' => 'The details of the stages.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The name of the stage.', 'type' => 'string', 'example' => 'Java构建', 'title' => ''], + 'stageInfo' => [ + 'title' => '', + 'description' => 'The details of the stage.', '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' => '', + 'endTime' => ['description' => 'The end time of the stage, provided as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1586863220000', 'title' => ''], + 'startTime' => ['description' => 'The start time of the stage, provided as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1586863220000', 'title' => ''], + 'name' => ['description' => 'The name of the stage.', 'type' => 'string', 'example' => 'Java构建', 'title' => ''], + 'status' => ['description' => 'The status of the stage. Valid values: `FAIL` (Failed), `SUCCESS` (Succeeded), and `RUNNING` (Running).', 'type' => 'string', 'example' => 'RUNNING', 'title' => ''], + 'jobs' => [ + 'title' => '', + 'description' => 'The jobs in the stage.', 'type' => 'array', 'items' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'type' => [ - 'title' => 'Action', - 'description' => '', - 'type' => 'string', - 'example' => 'RetryVMDeployMachine', - ], - 'disable' => [ - 'title' => '是否可用', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'params' => [ + 'endTime' => ['description' => 'The end time of the job, provided as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1586863220000', 'title' => ''], + 'id' => ['description' => 'The job ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '21212', 'title' => ''], + 'name' => ['description' => 'The name of the job.', 'type' => 'string', 'example' => 'Java构建', 'title' => ''], + 'params' => ['description' => 'The parameters for the job.', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'status' => ['description' => 'The status of the job. Valid values: `FAIL` (Failed), `SUCCESS` (Succeeded), and `RUNNING` (Running).', 'type' => 'string', 'example' => 'RUNNING', 'title' => ''], + 'startTime' => ['description' => 'The start time of the job, provided as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1586863220000', 'title' => ''], + 'actions' => [ 'title' => '', - 'description' => '', - 'type' => 'any', - 'example' => '{}', + 'description' => 'The actions for the job. For details, see the documentation at https\\://help.aliyun.com/document\\_detail/2360596.html.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'type' => ['type' => 'string', 'example' => 'PassPipelineValidate', 'description' => '', 'title' => ''], + 'disable' => ['type' => 'boolean', 'example' => 'true', 'description' => '', 'title' => ''], + 'params' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => ['type' => 'any', 'description' => '', 'title' => '', 'example' => ''], + 'example' => '{}', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - ], - 'batchNum' => [ - 'title' => '部署批次', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '22', + 'example' => '', ], ], + 'example' => '', ], ], - ], - ], - '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' => '{}', - ], - ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], + 'success' => ['description' => 'Indicates whether the request was successful. `true` indicates a successful request, and `false` indicates a failed request.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'errorCode' => ['description' => 'The error code that is returned when an error occurs.', 'type' => 'string', 'example' => '""', 'title' => ''], ], + 'description' => '', + 'title' => '', + '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.', - ], + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => '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' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], ], [ - [ - '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.', - ], + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], + ['errorCode' => 'InvalidPipeline.NotFound', 'errorMessage' => 'The pipeline is not found.', 'description' => 'The pipeline does not exist.'], + ['errorCode' => 'InvalidPipelineRun.NotFound', 'errorMessage' => 'The pipeline execution instance is not found.', 'description' => 'The pipeline execution instance 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', + '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"}]', + 'title' => 'Retrieve a pipeline run instance', + 'description' => 'API name: GetPipelineRun', + 'changeSet' => [ + ['createdAt' => '2022-07-28T13:00:29.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-06-17T13:08:01.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-08-31T06:42:08.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPipelineRun'], + ], ], + 'ramActions' => [], + ], + 'GetPipelineScanReportUrl' => [ + 'summary' => 'Obtain a temporary download URL for the pipeline scan report.', + 'path' => '/organization/{organizationId}/pipeline/getPipelineScanReportUrl', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -24408,48 +11420,12 @@ [ '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', - ], + 'schema' => ['title' => '', 'description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, such as https://devops.aliyun.com/organization/【OrganizationId】', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ - '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', - ], + 'name' => 'reportPath', + 'in' => 'formData', + 'schema' => ['description' => 'Path to the scan report, which can be retrieved through the API at https://help.aliyun.com/document_detail/460565.html', 'type' => 'string', 'required' => true, 'example' => '/test/test/test.html', 'maxLength' => 1000, 'title' => ''], ], ], 'responses' => [ @@ -24459,180 +11435,65 @@ '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', - ], - ], - ], + 'requestId' => ['title' => '', 'description' => 'Request ID. Each request has a unique value, which facilitates troubleshooting later.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['title' => '', 'description' => 'error message', 'type' => 'string', 'example' => '”“'], + 'success' => ['title' => '', 'description' => 'true if the API call succeeded, false if the API call failed', 'type' => 'boolean', 'example' => 'true 接口调用成功,false 接口调用失败'], + 'errorCode' => ['title' => '', 'description' => 'error code', 'type' => 'string', 'example' => '”“'], + 'reportUrl' => ['description' => 'Temporary download URL for the scan report, with a validity period of one hour', 'type' => 'string', 'example' => 'http://aliyun.com', 'title' => ''], ], + '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.', - ], + ['errorCode' => 'InvalidCluster.NotFound', 'errorMessage' => 'No cluster is available to generate the workspace.', 'description' => 'No cluster is available to generate the workspace.'], + ['errorCode' => 'InvalidCodeUrl.NotSupportSVN', 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', 'description' => 'The parameter codeUrl is invalid. SVN is not supported.'], + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidResource.NotFound', 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', 'description' => 'No resource is found. You cannot create the workspace. Please try again later.'], + ['errorCode' => 'InvalidResourceRole.NotFound', 'errorMessage' => 'The member role is invalid.', 'description' => ''], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => 'The user that is invoking the API service is not a registered user.'], + ['errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', 'errorMessage' => 'Resource owner cannot be deleted.', 'description' => 'The resource owner cannot be deleted.'], + ['errorCode' => 'InvalidUser.ResourceMemberNotExists', 'errorMessage' => 'The resource member does not exist.', 'description' => 'The resource member does not exist.'], + ['errorCode' => 'InvalidUser.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization.', 'description' => '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' => 'Forbidden.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], ], [ - [ - '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.', - ], + ['errorCode' => 'InvalidIdentifier.NotFound', 'errorMessage' => 'space id is error or not exist.', 'description' => ''], + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], + ['errorCode' => 'InvalidPipeline.NotFound', 'errorMessage' => 'The pipeline is not found.', 'description' => 'The pipeline does not exist.'], + ['errorCode' => 'InvalidPipelineRun.NotFound', 'errorMessage' => 'The pipeline execution instance is not found.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'InvalidWorkspace.NotFound', 'errorMessage' => 'The workspace is not found.', 'description' => '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', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\",\\n \\"reportUrl\\": \\"http://aliyun.com\\"\\n}","type":"json"}]', + 'title' => 'Obtain a temporary download URL for the pipeline scan report', + 'changeSet' => [ + ['createdAt' => '2022-07-19T12:05:57.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2021-12-30T14:20:57.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPipelineScanReportUrl'], + ], ], + 'ramActions' => [], + ], + 'GetProjectInfo' => [ + 'summary' => 'Obtain basic project information by projectId.', + 'path' => '/organization/{organizationId}/project/{projectId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [], - 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], @@ -24640,1099 +11501,951 @@ [ 'name' => 'organizationId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['description' => 'Organization identifier, also known as organization ID, in string form. It can be obtained from the Alibaba Cloud DevOps access URL, for example: https://devops.aliyun.com/organization/【OrganizationId】', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx', 'title' => ''], ], [ - 'name' => 'name', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - 'maxLength' => 40, - ], + 'name' => 'projectId', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'Project ID, same as spaceIdentifier', 'type' => 'string', 'required' => true, 'example' => 'e8b2xxxxxxx09b07d23'], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Project information', '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' => '', + 'requestId' => ['description' => 'Request ID. Each request has a unique value, facilitating troubleshooting later.'."\n" + ."\n", 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', 'title' => ''], + 'errorCode' => ['description' => 'Error code'."\n" + ."\n", 'type' => 'string', 'example' => 'Openapi.RequestError', 'title' => ''], + 'errorMessage' => ['description' => 'Error message'."\n" + ."\n", 'type' => 'string', 'example' => 'error', 'title' => ''], + 'success' => ['description' => 'true or false'."\n" + ."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'project' => [ + 'title' => '', + 'description' => 'Project information', 'type' => 'object', 'properties' => [ - 'id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '111', - ], - 'name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], + 'category' => ['description' => 'Space category', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'categoryIdentifier' => ['description' => 'Space category ID; the value for projects is always "Project"', 'type' => 'string', 'example' => 'Project', 'title' => ''], + 'creator' => ['description' => 'Creator\'s Alibaba Cloud account ID', 'type' => 'string', 'example' => '19xx7043xxxxxxx914', 'title' => ''], + 'customCode' => ['description' => 'Custom code, unique within the enterprise', 'type' => 'string', 'example' => 'OJAY', 'title' => ''], + 'description' => ['description' => 'Description', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'gmtCreate' => ['description' => 'Creation Time UNIX timestamp, in milliseconds', 'type' => 'integer', 'format' => 'int64', 'example' => '1623916393000', 'title' => ''], + 'gmtModified' => ['description' => 'UNIX timestamp of the modification time, in milliseconds', 'type' => 'integer', 'format' => 'int64', 'example' => '1623916393000', 'title' => ''], + 'iconGroup' => ['description' => 'Icon group, a JSON-formatted string', 'type' => 'string', 'example' => '{"small":"https://xxxxxx.png","big":"https://img.yyyyyy.png"}', 'title' => ''], + 'icon' => ['description' => 'Icon', 'type' => 'string', 'example' => 'https://xxxxxx.png', 'title' => ''], + 'iconBig' => ['description' => 'Large icon', 'type' => 'string', 'example' => 'https://xxxxxx.png', 'title' => ''], + 'iconSmall' => ['description' => 'Small icon', 'type' => 'string', 'example' => 'https://img.yyyyyy.png', 'title' => ''], + 'id' => ['description' => 'Project ID', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'identifier' => ['description' => 'Unique Identifier of the project', 'type' => 'string', 'example' => 'e8bxxxxxxxxxxxxxxxx23', 'title' => ''], + 'identifierPath' => ['description' => 'Space path', 'type' => 'string', 'example' => 'e8b2xxxxxx2abdxxxxxxxx23', 'title' => ''], + 'logicalStatus' => ['description' => 'Project status', 'type' => 'string', 'example' => 'NORMAL', 'title' => ''], + 'modifier' => ['description' => 'Modifier\'s Alibaba Cloud account ID', 'type' => 'string', 'example' => '19xx7043xxxxxxx914', 'title' => ''], + 'name' => ['description' => 'Project Name', 'type' => 'string', 'example' => 'demo示例项目', 'title' => ''], + 'organizationIdentifier' => ['description' => 'Enterprise ID', 'type' => 'string', 'example' => '5e70xxxxxxcd000xxxxe96', 'title' => ''], + 'parentIdentifier' => ['description' => 'Parent project ID', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'scope' => ['description' => 'Visible To', 'type' => 'string', 'example' => 'public', 'title' => ''], + 'statusIdentifier' => ['description' => 'Status ID', 'type' => 'string', 'example' => '8a40xxxxxxxxxxxxx64', 'title' => ''], + 'statusStageIdentifier' => ['description' => 'Status stage ID. By default, project statuses include Not Started, In Progress, and Completed. This field specifies the ID of the current status.', 'type' => 'string', 'example' => '8a4058a71159b68254......', 'title' => ''], + 'subType' => ['description' => 'Space subcategory', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'typeIdentifier' => ['description' => 'Space subcategory ID; this field is deprecated', 'type' => 'string', 'example' => 'CustomProject', 'title' => ''], ], + 'example' => '', ], ], + 'title' => '', + '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.', - ], + ['errorCode' => 'Operate.NoPermission', 'errorMessage' => 'NoPermission', 'description' => 'You are not authorized to perform this operation.'], ], ], - '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', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Retrieve project details', + 'changeSet' => [ + ['createdAt' => '2022-06-07T02:05:18.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2021-12-10T03:23:12.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetProjectInfo'], + ], ], + 'ramActions' => [], + ], + 'GetProjectMember' => [ + 'summary' => 'Query repository member information by Alibaba Cloud account ID (aliyunPk).', + 'path' => '/repository/{repositoryId}/members/get/{aliyunPk}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [], - 'produces' => [], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'organizationId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, for example: https://devops.aliyun.com/organization/【OrganizationId】', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5eb53bb338076f00011bcfd5'], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Personal access token. '."\n" + .'This field is not required when using Alibaba Cloud AccessKey ID and AccessKey Secret or when using temporary authorization from Security Token Service (STS).', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513'], + ], + [ + 'name' => 'repositoryId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['title' => '', 'description' => 'Repository ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1869702'], ], [ - 'name' => 'groupId', + 'name' => 'aliyunPk', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '111', - ], + 'schema' => ['title' => '', 'description' => 'Alibaba Cloud account ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1232456789123467'], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Response parameters', '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' => '""', + 'errorMessage' => ['description' => 'Error message', 'type' => 'string', 'example' => '""', 'title' => ''], + 'requestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '30C99C69-A340-5E2E-ACE4-8888FF50CF52', 'title' => ''], + 'errorCode' => ['description' => 'Error code', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR'."\n", 'title' => ''], + 'success' => ['description' => 'Indicates whether the invocation succeeded', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'result' => [ + 'description' => 'Return Result', + 'type' => 'object', + 'properties' => [ + 'accessLevel' => ['description' => 'Permission Type '."\n" + .'20 – Viewer '."\n" + .'30 – Developer '."\n" + .'40 – Administrator'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'name' => ['description' => 'Username', 'type' => 'string', 'example' => 'codeup', 'title' => ''], + 'avatarUrl' => ['description' => 'Profile picture URL', 'type' => 'string', 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c4ef67f1bea827c4/w/100/h/100', 'title' => ''], + 'id' => ['description' => 'Codeup User ID, which has no practical business meaning', 'type' => 'integer', 'format' => 'int64', 'example' => '2959', 'title' => ''], + 'email' => ['description' => 'User mailbox', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + '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 \\"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\\": \\"username@example.com\\"\\n }\\n}","type":"json"}]', + 'title' => 'Query Repository Members', + 'description' => 'Ensure that aliyunPk has previously logged on to an Alibaba Cloud DevOps product.', + 'changeSet' => [ + ['createdAt' => '2024-01-11T02:39:13.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-07-24T06:14:49.000Z', 'description' => 'Response parameters changed, Error codes changed'], + ['createdAt' => '2022-11-21T13:16:40.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-03-18T06:00:14.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetProjectMember'], ], ], - '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":""}]', + 'ramActions' => [], ], - 'JoinPipelineGroup' => [ - 'summary' => '加入流水线分组', - 'path' => '/organization/{organizationId}/pipelineGroups/join', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetReleaseStagePipelineRun' => [ + 'summary' => 'Retrieves a pipeline run in the development stage.', + 'path' => '/appstack/apps/{appName}/releaseWorkflows/{releaseWorkflowSn}/releaseStages/{releaseStageSn}/executions/{executionNumber}:getPipelineRun', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [], - 'produces' => [], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'get', 'autoTest' => false, 'notSupportAutoTestReason' => '数据面 api 经安全评估统一不做处理,后续逐步安排下线', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'organizationId', + 'in' => 'query', + 'schema' => ['description' => 'The organization ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '66c0c9fffeb86b450c199fcd', 'title' => ''], + ], + [ + 'name' => 'appName', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'example' => 'testApp', 'title' => ''], ], [ - 'name' => 'pipelineIds', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '122,122', - ], + 'name' => 'releaseWorkflowSn', + 'in' => 'path', + 'schema' => ['description' => 'The release workflow ID.', 'type' => 'string', 'required' => true, 'example' => 'ce51b31b996246ecaf8747368383****', 'title' => ''], ], [ - 'name' => 'groupId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '11', - ], + 'name' => 'releaseStageSn', + 'in' => 'path', + 'schema' => ['description' => 'The release stage ID.', 'type' => 'string', 'required' => true, 'example' => 'e173f3c11db5445eb426ca33c922****', 'title' => ''], + ], + [ + 'name' => 'executionNumber', + 'in' => 'path', + 'schema' => ['description' => 'The execution number.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => 'GetPipelineRunResponse', + 'description' => 'GetPipelineRunResponse', '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' => '""', + 'pipelineRun' => [ + 'description' => 'The pipeline run instance.', + 'type' => 'object', + 'properties' => [ + 'creatorAccountId' => ['description' => 'The ID of the creator\'s Alibaba Cloud account.', 'type' => 'string', 'example' => '1111111111', 'title' => ''], + 'createTime' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1586863220000', 'title' => ''], + 'updateTime' => ['description' => 'The update time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1586863220000', 'title' => ''], + 'modifierAccountId' => ['description' => 'The ID of the modifier\'s Alibaba Cloud account.', 'type' => 'string', 'example' => '11111111111', 'title' => ''], + 'pipelineId' => ['description' => 'The pipeline ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'pipelineRunId' => ['description' => 'The pipeline run ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'status' => ['description' => 'The status. Valid values: `FAIL`, `SUCCESS`, and `RUNNING`.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'triggerMode' => ['description' => '- The trigger mode.'."\n" + ."\n" + .' `1`: manual trigger'."\n" + ."\n" + .' `2`: scheduled trigger'."\n" + ."\n" + .' `3`: code commit trigger'."\n" + ."\n" + .' `5`: pipeline trigger'."\n" + ."\n" + .' `6`: webhook trigger', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'stageGroup' => [ + 'description' => 'The topology of stages.', + 'type' => 'array', + 'items' => [ + 'description' => 'A group of stages that run in parallel.', + 'type' => 'array', + 'items' => ['description' => 'The stage.', 'type' => 'string', 'example' => '阶段名称', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'stages' => [ + 'description' => 'The stage information.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The stage name.', 'type' => 'string', 'example' => 'Java构建', 'title' => ''], + 'stageInfo' => [ + 'description' => 'The stage details.', + 'type' => 'object', + 'properties' => [ + 'startTime' => ['description' => 'The start time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1586863220000', 'title' => ''], + 'endTime' => ['description' => 'The end time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1586863220000', 'title' => ''], + 'name' => ['description' => 'The stage name.', 'type' => 'string', 'example' => 'Java构建', 'title' => ''], + 'status' => ['description' => 'The status.', 'type' => 'string', 'example' => 'RUNNING', 'title' => ''], + 'jobs' => [ + 'description' => 'The jobs.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The job ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '21212', 'title' => ''], + 'name' => ['description' => 'The job name.', 'type' => 'string', 'example' => 'Java构建', 'title' => ''], + 'startTime' => ['description' => 'The start time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1586863220000', 'title' => ''], + 'endTime' => ['description' => 'The end time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1586863220000', 'title' => ''], + 'status' => ['description' => 'The status. Valid values: `FAIL`, `SUCCESS`, and `RUNNING`.', 'type' => 'string', 'example' => 'RUNNING', 'title' => ''], + 'params' => ['description' => 'The trigger parameters.', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'actions' => [ + 'description' => 'The post-job actions. For more information, see https\\://help.aliyun.com/document\\_detail/2360596.html.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => 'The action type. For more information, see https\\://help.aliyun.com/document\\_detail/2360596.html.', 'type' => 'string', 'example' => 'PassPipelineValidate', 'title' => ''], + 'disable' => ['description' => 'Indicates whether the action is disabled. For more information, see https\\://help.aliyun.com/document\\_detail/2360596.html.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'params' => ['description' => 'The action parameters. For more information, see https\\://help.aliyun.com/document\\_detail/2360596.html.', 'type' => 'any', 'example' => '{}', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'sources' => [ + 'description' => 'The code sources.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => 'The repository type. Valid values: `Codeup`, `aliyunGit` (Alibaba Cloud Code), and `giteeGit` (Gitee).', 'type' => 'string', 'example' => 'Codeup', 'title' => ''], + 'sign' => ['description' => 'The unique identifier of the code source.', 'type' => 'string', 'example' => 'assaaaaaasasasa', 'title' => ''], + 'data' => [ + 'description' => 'The code source details.', + 'type' => 'object', + 'properties' => [ + 'branch' => ['description' => 'The code branch.', 'type' => 'string', 'example' => 'master', 'title' => ''], + 'commit' => ['description' => 'The commit information in JSON format.', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'repo' => ['description' => 'The repository URL.', 'type' => 'string', 'example' => 'http://codeup.aliyun.com/a.git', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + '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.', - ], + '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"}]', + 'title' => 'Obtain R&D stage pipeline run instance', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetReleaseStagePipelineRun'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', + 'ramActions' => [], ], - 'UpdatePipelineGroup' => [ - 'summary' => '更新流水线分组', - 'path' => '/organization/{organizationId}/pipelineGroups/{groupId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetRepository' => [ + 'summary' => 'Query a code repository. You can query by repository ID and repository path.', + 'path' => '/repository/get', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [], - 'produces' => [], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'organizationId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Organization identity, also known as organization ID, in string form. It can be obtained from the Alibaba Cloud DevOps access link, such as https://devops.aliyun.com/organization/【OrganizationId】 ', 'type' => 'string', 'required' => true, 'example' => '60de7a6852743a5162b5f957'], ], [ - 'name' => 'name', + 'name' => 'accessToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - 'maxLength' => 40, - ], + 'schema' => ['title' => '', 'description' => 'Personal access token. '."\n" + .'This field is not required when using Alibaba Cloud AccessKey ID and AccessKey Secret or temporary authorization via Security Token Service (STS). ', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513'], ], [ - 'name' => 'groupId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '111', - ], + 'name' => 'identity', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Code repository ID or path ', 'type' => 'string', 'required' => true, 'example' => '2835387 或 codeup/codeup-demo'], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'Response Result', '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' => '""', + 'requestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '37294673-00CA-5B8B-914F-A8B35511E90A'], + 'errorCode' => ['title' => '', 'description' => 'Error code', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR'], + 'errorMessage' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => '""'], + 'success' => ['title' => '', 'description' => 'Indicates whether the invocation succeeded.', 'type' => 'boolean', 'example' => 'true'], + 'repository' => [ + 'title' => '', + 'description' => 'Code repository information', + 'type' => 'object', + 'properties' => [ + 'archive' => ['title' => '', 'description' => 'Data archiving indicator', 'type' => 'boolean', 'example' => 'false'], + 'avatarUrl' => ['title' => '', 'description' => 'Repository profile picture URL', 'type' => 'string', 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100'], + 'createdAt' => ['title' => '', 'description' => 'Creation Time', 'type' => 'string', 'example' => '2020-06-19T04:02:00.744Z'], + 'creatorId' => ['title' => '', 'description' => 'Creator ID', 'type' => 'integer', 'format' => 'int64', 'example' => '19258'], + 'defaultBranch' => ['title' => '', 'description' => 'Default branch', 'type' => 'string', 'example' => 'master'], + 'demoProjectStatus' => ['title' => '', 'description' => 'DEMO repository identity ', 'type' => 'boolean', 'example' => 'false'], + 'description' => ['title' => '', 'description' => 'Description', 'type' => 'string', 'example' => 'repo desc'], + 'httpUrlToRepository' => ['title' => '', 'description' => 'HTTP clone URL', 'type' => 'string', 'example' => 'https://codeup.aliyun.com/xxx/test/test.git'], + 'id' => ['title' => '', 'description' => 'Code repository ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'lastActivityAt' => ['title' => '', 'description' => 'Last Activity Time', 'type' => 'string', 'example' => '2020-06-19T04:02:00.744Z'], + 'name' => ['title' => '', 'description' => 'Name ', 'type' => 'string', 'example' => 'test'], + 'nameWithNamespace' => ['title' => '', 'description' => 'Full repository name (including full group name)', 'type' => 'string', 'example' => 'test / test(斜杠两侧有空格)'], + 'namespace' => [ + 'title' => '', + 'description' => 'Parent Space ', + 'type' => 'object', + 'properties' => [ + 'id' => ['title' => 'id', 'description' => 'id', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'avatar' => ['title' => '', 'description' => 'Profile picture URL ', 'type' => 'string', 'example' => 'https://xxx.jpg'], + 'createdAt' => ['title' => '', 'description' => 'Creation Time ', 'type' => 'string', 'example' => '2020-06-19T04:02:00.744Z'], + 'description' => ['title' => '', 'description' => 'Description ', 'type' => 'string', 'example' => 'repo desc'], + 'name' => ['title' => '', 'description' => 'Parent Space Name ', 'type' => 'string', 'example' => 'xxx'], + 'ownerId' => ['title' => '', 'description' => 'Owner ID '."\n" + ."\n" + .'> That is, the User primary key ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'path' => ['title' => '', 'description' => 'Parent Space path ', 'type' => 'string', 'example' => 'test'], + 'updatedAt' => ['title' => '', 'description' => 'Update Time ', 'type' => 'string', 'example' => '2020-06-19T04:02:00.744Z'], + 'visibilityLevel' => ['title' => '', 'description' => 'Visibility '."\n" + .'0 - private, visible only to Code repository members '."\n" + .'10 - internal, visible to enterprise members ', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + ], + 'example' => '', + ], + 'path' => ['title' => '', 'description' => 'Path', 'type' => 'string', 'example' => 'test'], + 'pathWithNamespace' => ['title' => '', 'description' => 'Full path of the code repository (including the full group path) ', 'type' => 'string', 'example' => 'test/test'], + 'sshUrlToRepository' => ['title' => '', 'description' => 'Secure Shell (SSH) clone URL', 'type' => 'string', 'example' => 'git@codeup.aliyun.com:xxx/test/test.git'], + 'visibilityLevel' => ['title' => '', 'description' => 'Visibility '."\n" + .'0 - private, visible only to Code repository members '."\n" + .'10 - internal, visible to enterprise members ', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'webUrl' => ['title' => '', 'description' => 'Page access URL', 'type' => 'string', 'example' => 'https://codeup.aliyun.com/xxx/test/test'], + ], + 'example' => '', ], ], + '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\\": \\"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\\": \\"git@codeup.aliyun.com:xxx/test/test.git\\",\\n \\"visibilityLevel\\": 0,\\n \\"webUrl\\": \\"https://codeup.aliyun.com/xxx/test/test\\"\\n }\\n}","type":"json"}]', + 'title' => 'Query code repository ', + 'changeSet' => [ + ['createdAt' => '2022-03-18T06:00:14.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRepository'], ], ], - '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":""}]', + 'ramActions' => [], ], - 'GetPipelineGroup' => [ - 'summary' => '获取流水线分组', - 'path' => '/organization/{organizationId}/pipelineGroups/{groupId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetRepositoryCommit' => [ + 'summary' => 'Gets details of a single commit in a code repository.', + 'path' => '/repository/{repositoryId}/commits/{sha}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [], - 'produces' => [], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'organizationId', + 'in' => 'query', + 'schema' => ['description' => 'Specifies the organization ID. You can obtain this ID from your Alibaba Cloud DevOps URL. For example: `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'required' => true, 'example' => '60de7a6852743a5162b5f957', 'title' => ''], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => ['description' => 'The personal access token. This parameter is not required if you use an Alibaba Cloud AccessKey pair or an STS token for authentication.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], + ], + [ + 'name' => 'repositoryId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['title' => 'The ID of a project', 'description' => 'The unique identifier for the repository.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2464454'], ], [ - 'name' => 'groupId', + 'name' => 'sha', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '111', - ], + 'schema' => ['title' => 'The commit hash or name of a repository branch or tag', 'description' => 'A commit reference, such as a branch name, tag name, or commit ID.', 'type' => 'string', 'required' => true, 'example' => 'master'], + ], + [ + 'name' => 'showSignature', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to show the signature. The default value is false.', 'type' => 'boolean', 'default' => 'false', 'title' => '', 'required' => false, 'example' => 'false'], ], ], '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' => '', + 'requestId' => ['description' => 'The unique identifier for the request.', 'type' => 'string', 'example' => 'A7586FEB-E48D-5579-983F-74981FBFF627', 'title' => ''], + 'errorMessage' => ['description' => 'The error message returned when an error occurs.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'errorCode' => ['description' => 'The error code returned when an error occurs.', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'result' => [ + 'description' => 'The details of the commit.', 'type' => 'object', 'properties' => [ - 'createTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1586863220000', + 'id' => ['description' => 'The full commit ID (SHA-1 hash).', 'type' => 'string', 'example' => 'ff4fb5ac6d1f44f452654336d2dba468ae6c8d04 ', 'title' => ''], + 'shortId' => ['description' => 'The short commit ID. For example, if the full commit ID is `ff4fb5ac6d1f44f452654336d2dba468ae6c8d04`, the short ID is `ff4fb5ac`.', 'type' => 'string', 'example' => 'ff4fb5ac', 'title' => ''], + 'title' => ['description' => 'The commit title (the first line of the commit message).', 'type' => 'string', 'example' => '云效Codeup提交Title', 'title' => ''], + 'authorName' => ['description' => 'The name of the author.', 'type' => 'string', 'example' => 'test-codeup', 'title' => ''], + 'authorEmail' => ['description' => 'The email address of the author.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + 'createdAt' => ['description' => 'The time when the commit was recorded in Alibaba Cloud Codeup.', 'type' => 'string', 'example' => '2022-03-18 14:24:54', 'title' => ''], + 'message' => ['description' => 'The full commit message.', 'type' => 'string', 'example' => '具体的提交内容', 'title' => ''], + 'authoredDate' => ['description' => 'The time when the commit was authored.', 'type' => 'string', 'example' => '2022-03-18 15:00:00', 'title' => ''], + 'committedDate' => ['description' => 'The time when the commit was committed.', 'type' => 'string', 'example' => '2022-03-18 15:00:02', 'title' => ''], + 'committerEmail' => ['description' => 'The email address of the committer.', 'type' => 'string', 'example' => 'username@example.com'."\n", 'title' => ''], + 'committerName' => ['description' => 'The name of the committer.', 'type' => 'string', 'example' => 'committer-codeup', 'title' => ''], + 'parentIds' => [ + 'description' => 'A list of parent commit IDs.', + 'type' => 'array', + 'items' => ['description' => 'A parent commit ID.', 'type' => 'string', 'example' => 'de02b625ba8488f92eb204bcb3773a40c1b4ddac', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '111', + 'author' => [ + 'description' => 'Details about the author.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The Alibaba Cloud Codeup user ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '19927', 'title' => ''], + 'name' => ['description' => 'The user name.', 'type' => 'string', 'example' => 'test-codeup', 'title' => ''], + 'username' => ['description' => 'The user\'s nickname.', 'type' => 'string', 'example' => 'test-nickname', 'title' => ''], + 'state' => ['description' => 'The state of the user. Valid values: `active` and `blocked`. The default value is `active`.', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'avatarUrl' => ['description' => 'The avatar URL.', 'type' => 'string', 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c4ef67f1bea827c4/w/100/h/100', 'title' => ''], + 'websiteUrl' => ['description' => 'The URL of the user\'s personal website.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'email' => ['description' => 'The user\'s email address.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'name' => [ - 'description' => '', - 'type' => 'string', + 'committer' => [ + 'description' => 'Details about the committer.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The Alibaba Cloud Codeup user ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '24661', 'title' => ''], + 'name' => ['description' => 'The user name.', 'type' => 'string', 'example' => 'committer-codeup', 'title' => ''], + 'username' => ['description' => 'The user\'s nickname.', 'type' => 'string', 'example' => 'nickname', 'title' => ''], + 'state' => ['description' => 'The state of the user. Valid values: `active` and `blocked`.', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'avatarUrl' => ['description' => 'The avatar URL.', 'type' => 'string', 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c4ef67f1bea827c4/w/100/h/100', 'title' => ''], + 'websiteUrl' => ['description' => 'The URL of the user\'s personal website.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'email' => ['description' => 'The user\'s email address.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'signature' => [ + 'description' => 'Details of the GPG signature for the commit.', + 'type' => 'object', + 'properties' => [ + 'gpgKeyId' => ['description' => 'The key ID of the GPG signature.', 'type' => 'string', 'example' => '34d2c47c7ce46a5c4639c5ffe208', 'title' => ''], + 'verificationStatus' => ['description' => 'The GPG verification status.'."\n" + ."\n" + .'- `unverified`: The GPG signature is unverified.'."\n" + ."\n" + .'- `verified`: The GPG signature is verified, and the committer\'s email address matches the one in the GPG key.'."\n" + ."\n" + .'- `same_user_different_email`: The GPG signature is verified, but the committer\'s email address, while belonging to the key\'s user, does not match the email address in the GPG key.'."\n" + ."\n" + .'- `other_user`: The GPG signature is verified, but the committer\'s email address does not belong to the user of the GPG key.'."\n" + ."\n" + .'- `unverified_key`: The email address in the GPG key is not one of the verified email addresses for the committer\'s account.'."\n" + ."\n" + .'- `unknown_key`: The GPG key used for the signature does not exist in Alibaba Cloud Codeup.', 'type' => 'string', 'example' => 'verified', 'title' => ''], + ], + 'title' => '', 'example' => '', ], + 'commentsCount' => ['description' => 'The number of comments on the commit.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + '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.', - ], + ['errorCode' => 'Forbidden.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => '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.', 'description' => ''], ], ], - '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', + '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\\": \\"username@example.com\\",\\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\\": \\"username@example.com\\\\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\\": \\"username@example.com\\"\\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\\": \\"username@example.com\\"\\n },\\n \\"signature\\": {\\n \\"gpgKeyId\\": \\"34d2c47c7ce46a5c4639c5ffe208\\",\\n \\"verificationStatus\\": \\"verified\\"\\n },\\n \\"commentsCount\\": 1\\n }\\n}","type":"json"}]', + 'title' => 'Query code repository commit information ', + 'changeSet' => [ + ['createdAt' => '2023-07-24T06:14:55.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-11-15T02:18:43.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRepositoryCommit'], + ], ], + 'ramActions' => [], + ], + 'GetRepositoryTag' => [ + 'summary' => 'Retrieves information about a single tag in a code repository.', + 'path' => '/repository/{repositoryId}/tag/info', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [], - 'produces' => [], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', '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', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The organization ID. You can find this ID in the URL for Alibaba Cloud DevOps, such as `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'required' => true, 'example' => '60de7a6852743a5162b5f957'], ], [ - 'name' => 'nextToken', + 'name' => 'accessToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'aaaa', - ], + 'schema' => ['description' => 'The personal access token. This parameter is optional when authenticating with an Alibaba Cloud AccessKey pair or STS temporary authorization.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], ], [ - 'name' => 'groupId', + 'name' => 'repositoryId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '111', - ], + 'schema' => ['description' => 'The repository ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2369234', 'title' => ''], ], [ - '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', + 'name' => 'tagName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1586863220000', - ], + 'schema' => ['description' => 'The tag name.', 'type' => 'string', 'required' => true, 'example' => 'tag v1.0', 'title' => ''], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Response schema.', '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', + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CE7353E3-F989-56A9-B97C-897ABBDB9A01'], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Openapi.RequestError', 'title' => ''], + 'success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'result' => [ + 'description' => 'The result of the API call.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The tag ID.', 'type' => 'string', 'example' => '9a494e7b88ca35cde00579af2df4ab46136c022e', 'title' => ''], + 'name' => ['description' => 'The tag name.', 'type' => 'string', 'example' => 'tag v1.0'."\n", 'title' => ''], + 'message' => ['description' => 'The description of the tag.', 'type' => 'string', 'example' => '具体的描述内容', 'title' => ''], + 'commit' => [ + 'description' => 'Information about the commit that the tag points to.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The commit ID.', 'type' => 'string', 'example' => 'e0297d8fb0393c833a8531e7cc8832739e3cba6d', 'title' => ''], + 'shortId' => ['description' => 'The short commit ID.', 'type' => 'string', 'example' => 'e0297d8f', 'title' => ''], + 'title' => ['description' => 'The commit title, which is the first line of the commit message.', 'type' => 'string', 'example' => '提交标题', 'title' => ''], + 'message' => ['description' => 'The commit message.', 'type' => 'string', 'example' => '具体的提交内容', 'title' => ''], + 'createdAt' => ['description' => 'The time the commit was created.', 'type' => 'string', 'example' => '2022-03-18 10:00:00', 'title' => ''], + 'parentIds' => [ + 'description' => 'The parent commit IDs.', + 'type' => 'array', + 'items' => ['description' => 'The parent commit ID.', 'type' => 'string', 'example' => '34d2c47c7ce46a5c4639c5ffe208a66dda975a05', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'authorName' => ['description' => 'The name of the author.', 'type' => 'string', 'example' => '阿里云云效', 'title' => ''], + 'authorEmail' => ['description' => 'The email address of the author.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + 'authoredDate' => ['description' => 'The time the commit was authored.', 'type' => 'string', 'example' => '2022-03-18 08:00:00', 'title' => ''], + 'committerName' => ['description' => 'The name of the committer.', 'type' => 'string', 'example' => '阿里云云效Committer', 'title' => ''], + 'committerEmail' => ['description' => 'The email address of the committer.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + 'committedDate' => ['description' => 'The time the commit was committed.', 'type' => 'string', 'example' => '2022-03-18 09:00:00', 'title' => ''], + 'signature' => [ + 'description' => 'Information about the signature.', + 'type' => 'object', + 'properties' => [ + 'gpgKeyId' => ['description' => 'The ID of the GPG key for the signature.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'verificationStatus' => ['description' => 'The GPG verification status.'."\n" + ."\n" + .'- `unverified`: The signature is not verified.'."\n" + ."\n" + .'- `verified`: The GPG public key is verified, and the committer\'s email address matches the email address in the key.'."\n" + ."\n" + .'- `same_user_different_email`: The GPG public key is verified, and the committer\'s email address belongs to the current user, but it does not match the email address in the key.'."\n" + ."\n" + .'- `other_user`: The GPG public key is verified, but the committer\'s email address does not belong to the key owner.'."\n" + ."\n" + .'- `unverified_key`: The email address in the key is not in the user\'s list of verified email addresses.'."\n" + ."\n" + .'- `unknown_key`: The GPG key does not exist.', 'type' => 'string', 'example' => 'verified', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], ], + 'title' => '', + 'example' => '', ], ], - ], - 'totalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'nextToken' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'aaaa', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ - [ - 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', - 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', - ], + ['errorCode' => 'Forbidden.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => '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.', 'description' => ''], ], - [ - [ - '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.', - ], + ], + '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\\": \\"username@example.com\\",\\n \\"authoredDate\\": \\"2022-03-18 08:00:00\\",\\n \\"committerName\\": \\"阿里云云效Committer\\",\\n \\"committerEmail\\": \\"username@example.com\\",\\n \\"committedDate\\": \\"2022-03-18 09:00:00\\",\\n \\"signature\\": {\\n \\"gpgKeyId\\": \\"\\\\\\"\\\\\\"\\",\\n \\"verificationStatus\\": \\"verified\\"\\n }\\n }\\n }\\n}","type":"json"}]', + 'title' => 'Query a single label', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRepositoryTag'], ], ], - '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":""}]', + 'ramActions' => [], ], - 'ListPipelineGroups' => [ - 'summary' => '获取流水线分组列表', - 'path' => '/organization/{organizationId}/pipelineGroups', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetSearchCodePreview' => [ + 'summary' => 'Gets a code preview using a document ID and a keyword.', + 'path' => '/search/code_preview', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [], - 'produces' => [], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'organizationId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'in' => 'query', + 'schema' => ['title' => 'A short description of struct', 'description' => 'The enterprise ID. You can find this ID in the URL of your browser after you log in to the Alibaba Cloud DevOps console: `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'required' => true, 'example' => '627475075b46541dd2ff01bc'], ], [ - 'name' => 'maxResults', + 'name' => 'docId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '50', - 'minimum' => '1', - 'example' => '20', - 'default' => '10', - ], + 'schema' => ['description' => 'The document ID.', 'type' => 'string', 'required' => true, 'example' => '60d54f3daccf2bbd6659f3ad/gitlabhq/master/config/environments/test.rb', 'title' => ''], ], [ - 'name' => 'nextToken', + 'name' => 'keyword', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'aaaaaaaaaa', - ], + 'schema' => ['description' => 'The search keyword.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'isDsl', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether the search is a DSL search.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response schema.', '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', + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'A7586FEB-E48D-5579-983F-74981FBFF627'], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'result' => [ + 'description' => 'The search result object.', + 'type' => 'object', + 'properties' => [ + 'docId' => ['description' => 'The document ID.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'highlightTextMap' => [ + 'description' => 'Information about the highlighted text.', + 'type' => 'object', + 'properties' => [ + 'organizationId' => ['description' => 'The enterprise ID.', 'type' => 'string', 'example' => '5ffd468b1e45db3c1cc26ad6', 'title' => ''], + 'fileName' => ['description' => 'The highlighted file name.', 'type' => 'string', 'example' => 'test.rb', 'title' => ''], + 'clob' => ['description' => 'A snippet of the matched content.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], ], + 'title' => '', + 'example' => '', + ], + 'source' => [ + 'description' => 'The source information from Elasticsearch (ES).', + 'type' => 'object', + 'properties' => [ + 'repoPath' => ['description' => 'The full path of the code repository, including the group path.', 'type' => 'string', 'example' => 'codeup/test-repo', 'title' => ''], + 'fileName' => ['description' => 'The name of the file.', 'type' => 'string', 'example' => 'test.rb', 'title' => ''], + 'filePath' => ['description' => 'The full file path.', 'type' => 'string', 'example' => 'config/environments/test.rb', 'title' => ''], + 'language' => ['description' => 'The programming language.', 'type' => 'string', 'example' => 'Ruby', 'title' => ''], + 'checkinDate' => ['description' => 'The time of the last commit.', 'type' => 'string', 'example' => '2022-12-12 12:12:12', 'title' => ''], + 'branch' => ['description' => 'The name of the branch.', 'type' => 'string', 'example' => 'master', 'title' => ''], + 'organizationId' => ['description' => 'The enterprise ID. You can find this ID in the URL of your browser after you log in to the Alibaba Cloud DevOps console: `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'example' => '5f9f9f6122a8c7ff3934f99a', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], - ], - 'totalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', - ], - 'nextToken' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ssaassasass', + 'title' => '', + 'example' => '', ], ], + '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.', - ], + '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"}]', + 'title' => 'Query preview code snippet ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSearchCodePreview'], ], ], - '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"}]', + 'ramActions' => [], ], - 'CreateFlowTag' => [ - 'summary' => '创建标签', - 'path' => '/organization/{organizationId}/flow/tags', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetSprintInfo' => [ + 'summary' => 'Retrieve iteration details.', + 'path' => '/organization/{organizationId}/sprints/{sprintId}/getSprintinfo', + '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' => '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', - ], - ], + 'schema' => ['description' => 'Organization identifier, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps URL, for example: https://devops.aliyun.com/organization/【OrganizationId】 ', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx', 'title' => ''], ], [ - 'name' => 'flowTagGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '111', - ], + 'name' => 'sprintId', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'Iteration ID', 'type' => 'string', 'required' => true, 'example' => 'd061ca90d47a0b7cd4d2...'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Iteration request result', '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', + 'requestId' => ['description' => 'Request ID. Each request has a unique value to facilitate troubleshooting.'."\n" + ."\n", 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', 'title' => ''], + 'errorCode' => ['description' => 'Error code ', 'type' => 'string', 'example' => 'Openapi.RequestError', 'title' => ''], + 'errorMessage' => ['description' => 'Error message ', 'type' => 'string', 'example' => 'error', 'title' => ''], + 'success' => ['description' => 'true or false'."\n" + ."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'sprint' => [ + 'title' => '', + 'description' => 'Iteration information', + 'type' => 'object', + 'properties' => [ + 'creator' => ['title' => '', 'description' => 'Creator ID', 'type' => 'string', 'example' => '19xx7043xxxxxxx914'], + 'description' => ['title' => '', 'description' => 'Description', 'type' => 'string', 'example' => '迭代详细描述'], + 'gmtCreate' => ['title' => '', 'description' => 'Creation Time ', 'type' => 'integer', 'format' => 'int64', 'example' => '1623916393000'], + 'gmtModified' => ['title' => '', 'description' => 'Updated At', 'type' => 'integer', 'format' => 'int64', 'example' => '1623916393000'], + 'endDate' => ['title' => '', 'description' => 'End Time', 'type' => 'integer', 'format' => 'int64', 'example' => '1623916393000'], + 'startDate' => ['title' => '', 'description' => 'Start Time ', 'type' => 'integer', 'format' => 'int64', 'example' => '1638403200000'], + 'identifier' => ['title' => '', 'description' => 'Unique Identifier of the iteration', 'type' => 'string', 'example' => 'e8bxxxxxxxxxxxxxxxx23'], + 'modifier' => ['title' => '', 'description' => 'Updated By', 'type' => 'string', 'example' => '19xx7043xxxxxxx914'], + 'name' => ['title' => '', 'description' => 'Iteration Name ', 'type' => 'string', 'example' => 'demo示例项目'], + 'spaceIdentifier' => ['title' => '', 'description' => 'Project ID', 'type' => 'string', 'example' => '5e70xxxxxxcd000xxxxe96'], + 'scope' => ['title' => '', 'description' => 'Visible To ', 'type' => 'string', 'example' => 'public'], + 'status' => ['title' => '', 'description' => 'Status '."\n" + .'Not started: Todo '."\n" + .'In progress: Doing '."\n" + .'Completed: Done ', 'type' => 'string', 'example' => 'Todo'], + 'owners' => [ + 'description' => 'List of iteration owners ', + 'type' => 'array', + 'items' => ['description' => 'Alibaba Cloud ID of the iteration owner ', 'type' => 'string', 'example' => '19xx7043xxxxxxx914', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], + 'title' => '', + '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' => 'Openapi.RequestError', 'errorMessage' => 'request error', 'description' => ''], ], 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' => 'Operate.NoPermission', 'errorMessage' => 'NoPermission', 'description' => 'You are not authorized to perform this 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 \\"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}","type":"json"}]', + 'title' => 'Get Iteration Details ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSprintInfo'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\",\\n \\"id\\": 111\\n}","type":"json"}]', + 'ramActions' => [], ], - 'CreateFlowTagGroup' => [ - 'summary' => '创建标签分类', - 'path' => '/organization/{organizationId}/flow/tagGroups', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetTestResultList' => [ + 'summary' => 'Retrieves a list of test cases in a test plan that can be filtered.', + 'path' => '/organization/{organizationId}/testhub/testplan/{testPlanIdentifier}/testresults', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -25744,494 +12457,358 @@ [ 'name' => 'organizationId', 'in' => 'path', - 'schema' => [ - 'title' => '企业标识,也称企业id,字符串形式,可在云效访问链接中获取,如https://devops.aliyun.com/organization/【OrganizationId】', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['description' => 'The organization ID.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx', 'title' => ''], ], [ - 'name' => 'name', - 'in' => 'query', + 'name' => 'testPlanIdentifier', + 'in' => 'path', + 'schema' => ['description' => 'The unique identifier for the test plan.', 'type' => 'string', 'required' => true, 'example' => '592531xxxxxx15f2e98dbc7e27', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'directoryIdentifier' => ['description' => 'The unique directory identifier, which corresponds to the directory ID in the test plan.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'e27b8eace6501ce51cf5d56784'], + 'conditions' => ['description' => 'The filter conditions.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '{\'conditionGroups\': [[{\'fieldIdentifier\': \'gmtModified\', \'operator\': \'MORE_THAN_AND_EQUAL\', \'value\': [\'2023-04-20 18:03:12.442140\'], \'className\': \'dateTime\', \'format\': \'input\'}]]}'], + ], + 'required' => false, + 'title' => '', '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', + 'requestId' => ['description' => 'The unique ID of the request. It is used for troubleshooting.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', 'title' => ''], + 'errorMsg' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'error', 'title' => ''], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Openapi.RequestError', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful. Valid values are `true` and `false`.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'testResult' => [ + 'description' => 'An array of test results.', + 'title' => 'Work item information ', + 'type' => 'array', + 'items' => [ + 'description' => 'The content of the test result.', + 'type' => 'object', + 'properties' => [ + 'testResultIdentifier' => ['title' => 'ID of the test result ', 'description' => 'The unique identifier of the test result.', 'type' => 'string', 'example' => 'a8bxxxxxxxxxxxxxxxx54'], + 'testResultStatus' => ['title' => 'Status of the test result ', 'description' => 'The status of the test result.', 'type' => 'string', 'example' => 'TO DO'], + 'testResultExecutor' => [ + 'description' => 'Details of the test result executor.', + 'title' => 'Object of the test plan executor', + 'type' => 'object', + 'properties' => [ + 'executorIdentifier' => ['title' => 'Unique identifier (aliyunPk) of the executor', 'description' => 'The unique identifier of the executor. The value is the `aliyunPk`.', 'type' => 'string', 'example' => '1243xxxxx234xx'], + 'name' => ['title' => 'Executed By Name ', 'description' => 'The name of the executor.', 'type' => 'string', 'example' => '人员名称'], + ], + 'example' => '', + ], + 'testResultGmtCreate' => ['description' => 'The creation time of the test result.', 'type' => 'integer', 'format' => 'int64', 'example' => '1621578648000'."\n", 'title' => ''], + 'testcaseIdentifier' => ['description' => 'The unique identifier of the test case.', 'type' => 'string', 'example' => '943d20fe5e385a08fdd6b593fb', 'title' => ''], + 'bugCount' => ['description' => 'The number of bugs associated with the test result.', 'type' => 'integer', 'format' => 'int64', 'example' => '8', 'title' => ''], + 'subject' => ['title' => 'Test Case Title ', 'description' => 'The subject of the test case.', 'type' => 'string', 'example' => '测试工作项'], + 'assignedTo' => [ + 'description' => 'Details of the assignee.', + 'title' => 'Owner information ', + 'type' => 'object', + 'properties' => [ + 'assignedToIdenttifier' => ['title' => 'Owner ID, the UUID of the owner ', 'description' => 'The unique identifier of the assignee.', 'type' => 'string', 'example' => '1243xxxxx234xx'], + 'name' => ['title' => 'Owner Name ', 'description' => 'The name of the assignee.', 'type' => 'string', 'example' => '人员名称'], + ], + 'example' => '', + ], + 'spaceIdentifier' => ['title' => 'ID of the test library to which the test case belongs', 'description' => 'The identifier of the test repository (space).', 'type' => 'string', 'example' => '592531647d7b15f2e98dbc7e27'], + 'categoryIdentifier' => ['title' => 'ID of the test case category', 'description' => 'The category identifier of the test case.', 'type' => 'string', 'example' => 'Req'], + 'gmtCreate' => ['title' => 'Creation Time of the test case', 'description' => 'The creation time of the test case.', 'type' => 'integer', 'format' => 'int64', 'example' => '1621578648000'], + 'customFields' => [ + 'description' => 'An array of custom fields.', + 'title' => 'Array of Custom Fields ', + 'type' => 'array', + 'items' => [ + 'description' => 'Details of a custom field.', + 'type' => 'object', + 'properties' => [ + 'fieldIdentifier' => ['title' => 'Field ID, UUID of the custom field ', 'description' => 'The unique identifier of the custom field.', 'type' => 'string', 'example' => '943d20fe5e385a08fdd6b593fb'], + 'value' => ['title' => 'Custom Field Value', 'description' => 'The value of the custom field.', 'type' => 'string', 'example' => 'd7f112f9d023e2108fa1b0d8'], + 'fieldFormat' => ['title' => 'Custom Field Format ', 'description' => 'The format of the custom field.', 'type' => 'string', 'example' => 'Input'], + 'fieldClassName' => ['title' => 'Custom Field Type ', 'description' => 'The class name of the custom field.', 'type' => 'string', 'example' => 'User'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + '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.', - ], + ['errorCode' => 'Openapi.RequestError', 'errorMessage' => 'request error', 'description' => ''], ], 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' => 'Operate.NoPermission', 'errorMessage' => 'NoPermission', 'description' => 'You are not authorized to perform this 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.', - ], + ], + '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"}]', + 'title' => 'Retrieve the list of test cases in a test plan ', + 'description' => 'Retrieves the test cases in a test plan. Use the `condtion` field to filter the results.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTestResultList'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\",\\n \\"id\\": 1223\\n}","type":"json"}]', + 'ramActions' => [], ], - 'DeleteFlowTagGroup' => [ - 'summary' => '删除标签分类', - 'path' => '/organization/{organizationId}/flow/tagGroups/{id}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetTestcaseList' => [ + 'summary' => 'Retrieves a filterable list of test cases from the test case repository.', + '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,字符串形式,可在云效访问链接中获取,如https://devops.aliyun.com/organization/【OrganizationId】', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['description' => 'The ID of the organization.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx', 'title' => ''], ], [ - 'name' => 'id', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '111', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'spaceIdentifier' => ['description' => 'The unique identifier of the test case library.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '6d5984c7d92b23fa53d4743c37'], + 'directoryIdentifier' => ['description' => 'The unique identifier of the directory. Omit this parameter to return all test cases from the test case library.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'e27b8eace6501ce51cf5d56784'], + 'conditions' => ['description' => 'The conditions for filtering test cases, provided as a JSON string.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '{\\"conditionGroups\\":[[{\\"fieldIdentifier\\":\\"status\\",\\"operator\\":\\"CONTAINS\\",\\"value\\":[\\"cc961a18adf770c6e423ccc5\\"],\\"toValue\\":null,,\\"className\\":\\"status\\",\\"format\\":\\"list\\"}]]}'], + 'nextToken' => ['description' => 'The token for paginating results. Leave this parameter empty for the first request. For subsequent requests, use the `nextToken` value from the previous response to retrieve the next page.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2591861102250c4522380b33a6'], + 'maxResult' => ['description' => 'The maximum number of results to return per page. The default value is 20.', 'type' => 'string', 'example' => '20', 'title' => '', 'required' => false], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], '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' => '”“', + 'totalCount' => ['description' => 'The total number of results.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'nextToken' => ['description' => 'The pagination token. This value is empty when there are no more results.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'maxResults' => ['description' => 'The maximum number of items returned per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'requestId' => ['description' => 'The unique ID of the request, used for troubleshooting.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', 'title' => ''], + 'errorMsg' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'error', 'title' => ''], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Openapi.RequestError', 'title' => ''], + 'success' => ['description' => 'Indicates if the request was successful. Valid values: `true` and `false`.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'testcase' => [ + 'title' => '', + 'description' => 'The test cases.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'identifier' => ['description' => 'The unique ID of the test case.', 'type' => 'string', 'example' => 'e8bxxxxxxxxxxxxxxxx23', 'title' => ''], + 'subject' => ['description' => 'The title of the test case.', 'type' => 'string', 'example' => '测试工作项', 'title' => ''], + 'assignedTo' => [ + 'title' => '', + 'description' => 'The assignee.', + 'type' => 'object', + 'properties' => [ + 'assignedToIdenttifier' => ['description' => 'The unique ID of the assignee.', 'type' => 'string', 'title' => '', 'example' => '12xxxxx456'], + 'name' => ['description' => 'The name of the assignee.', 'type' => 'string', 'title' => '', 'example' => '人员名称'], + ], + 'example' => '', + ], + 'space' => [ + 'title' => '', + 'description' => 'The test case library.', + 'type' => 'object', + 'properties' => [ + 'spaceIdentifier' => ['description' => 'The unique ID of the test case library.', 'type' => 'string', 'title' => '', 'example' => '22c32972b853cd703dbf0efe4c'], + 'type' => ['description' => 'The space type.', 'type' => 'string', 'title' => '', 'example' => 'TestRepo'], + ], + 'example' => '', + ], + 'categoryIdentifier' => ['description' => 'The category ID of the test case.', 'type' => 'string', 'example' => 'Req', 'title' => ''], + 'gmtCreate' => ['description' => 'The creation time of the test case, in Unix milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1621578648000', 'title' => ''], + 'customFields' => [ + 'title' => '', + 'description' => 'The custom fields.', + 'type' => 'array', + 'items' => [ + 'description' => 'A custom field.', + 'type' => 'object', + 'properties' => [ + 'fieldIdentifier' => ['description' => 'The unique ID of the custom field.', 'type' => 'string', 'title' => '', 'example' => '85702b33f14bfa82cb458173ba'], + 'value' => ['description' => 'The value of the custom field.', 'type' => 'string', 'title' => '', 'example' => 'd7f112f9d023e2108fa1b0d8'], + 'fieldFormat' => ['description' => 'The format of the custom field.', 'type' => 'string', 'title' => '', 'example' => 'Input'], + 'fieldClassName' => ['description' => 'The class name of the custom field.', 'type' => 'string', 'title' => '', 'example' => 'User'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'tags' => [ + 'title' => '', + 'description' => 'The tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'A tag.', + 'type' => 'object', + 'properties' => [ + 'tagIdentifier' => ['description' => 'The unique ID of the tag.', 'type' => 'string', 'title' => '', 'example' => '85702b33f14bxxxxxx58173ba'], + 'name' => ['description' => 'The name of the tag.', 'type' => 'string', 'title' => '', 'example' => '标签名称'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'description' => 'A test case.', + 'title' => '', + 'example' => '', + ], + 'example' => '', ], ], + 'description' => 'The response object.', + 'title' => '', + '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.', - ], + ['errorCode' => 'Openapi.RequestError', 'errorMessage' => 'request error', 'description' => ''], ], 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' => 'Operate.NoPermission', 'errorMessage' => 'NoPermission', 'description' => 'You are not authorized to perform this 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.', - ], + ], + '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"}]', + 'title' => 'Retrieve the list of test cases from the test case library ', + 'description' => 'Retrieves a list of test cases from the test case library. You can use the `conditions` parameter to filter the results.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTestcaseList'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\"\\n}","type":"json"}]', + 'ramActions' => [], ], - 'DeleteFlowTag' => [ - 'summary' => '删除标签', - 'path' => '/organization/{organizationId}/flow/tags/{id}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetUserInfo' => [ + 'summary' => 'This operation retrieves user information from Codeup.', + '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' => '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', - ], + 'in' => 'query', + 'schema' => ['title' => 'A short description of struct', 'description' => 'The organization ID. You can obtain this string from the Alibaba Cloud DevOps URL, for example, `https://devops.aliyun.com/organization/{organizationId}`.'."\n" + ."\n" + .'><notice>'."\n" + ."\n" + .'This parameter is optional. If you do not specify an organization ID, the `name` field in the response contains the name from the user\'s personal settings. If you specify an organization ID, the field contains the user\'s name within that organization.'."\n" + ."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => '61e54b0e0bb300d827e1ae27'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response data.', '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' => '”“', + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9'], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'result' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The Codeup user ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '4205', 'title' => ''], + 'name' => ['description' => 'The display name of the user. This name corresponds to the user\'s name within the specified organization, or to their personal display name if no organization is specified.', 'type' => 'string', 'example' => '云效Codeup', 'title' => ''], + 'username' => ['description' => 'The username.', 'type' => 'string', 'example' => 'my-codeup-login-account', 'title' => ''], + 'email' => ['description' => 'The user\'s email address.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + 'avatarUrl' => ['description' => 'The avatar URL.', 'type' => 'string', 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + '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.', - ], + ['errorCode' => 'Forbidden.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => '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.', 'description' => ''], ], ], - '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', + '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\\": \\"username@example.com\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\"\\n }\\n}","type":"json"}]', + 'title' => 'Query current user information', + 'changeSet' => [ + ['createdAt' => '2023-07-24T06:14:54.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUserInfo'], + ], ], + 'ramActions' => [], + ], + 'GetVMDeployOrder' => [ + 'summary' => 'You can obtain the deployment order details.', + 'path' => '/organization/{organizationId}/pipelines/{pipelineId}/deploy/{deployOrderId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -26243,64 +12820,17 @@ [ 'name' => 'organizationId', 'in' => 'path', - 'schema' => [ - 'title' => '企业标识,也称企业id,字符串形式,可在云效访问链接中获取,如https://devops.aliyun.com/organization/【OrganizationId】', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['title' => '', 'description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access Link, such as https://devops.aliyun.com/organization/【OrganizationId】 ', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ - 'name' => 'id', + 'name' => 'pipelineId', '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', - ], - ], + 'schema' => ['title' => '12222', 'description' => 'The pipeline ID, which can be obtained from the pipeline link, such as https://flow.aliyun.com/pipelines/【PipelineId】/current', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1222'], ], [ - '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, - ], + 'name' => 'deployOrderId', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'Deployment order ID ', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11111'], ], ], 'responses' => [ @@ -26310,126 +12840,165 @@ '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' => '”“', + 'requestId' => ['title' => '', 'description' => 'Request ID. Each request has a unique value, which facilitates troubleshooting later.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['title' => '', 'description' => 'error message', 'type' => 'string', 'example' => '”“'], + 'success' => ['title' => '', 'description' => 'true if the API call succeeded, false if the API call failed', 'type' => 'boolean', 'example' => 'true 接口调用成功,false 接口调用失败'], + 'errorCode' => ['title' => '', 'description' => 'error code', 'type' => 'string', 'example' => '”“'], + 'deployOrder' => [ + 'title' => '', + 'description' => 'deployment order', + 'type' => 'object', + 'properties' => [ + 'deployOrderId' => ['title' => '', 'description' => 'Deployment order ID', 'type' => 'string', 'example' => '11111'], + 'createTime' => ['title' => '', 'description' => 'Creation time', 'type' => 'integer', 'format' => 'int64', 'example' => '111111111111'], + 'updateTime' => ['title' => '', 'description' => 'Updated At', 'type' => 'integer', 'format' => 'int64', 'example' => '11111111111'], + 'creator' => ['title' => '', 'description' => 'Creator', 'type' => 'string', 'example' => 'ssaassa'], + 'currentBatch' => ['title' => '', 'description' => 'current publish batch', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'totalBatch' => ['title' => '', 'description' => 'Total number of publish batches', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'status' => ['title' => '', 'description' => 'Publish status '."\n" + .' '."\n" + .'- Waiting (paused) '."\n" + .' '."\n" + .'- Running (deploying) '."\n" + .' '."\n" + .'- Cancelled (cancelled) '."\n" + .' '."\n" + .'- Success (Succeeded) ', 'type' => 'string', 'example' => 'Success'], + 'exceptionCode' => ['title' => '', 'description' => 'error code', 'type' => 'string', 'example' => '错误信息'], + 'deployMachineInfo' => [ + 'title' => '', + 'description' => 'Deployment machine information', + 'type' => 'object', + 'properties' => [ + 'hostGroupId' => ['title' => '', 'description' => 'host group ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1111'], + 'batchNum' => ['title' => '', 'description' => 'Publish batch', 'type' => 'integer', 'format' => 'int32', 'example' => '11'], + 'deployMachines' => [ + 'title' => '', + 'description' => 'List of deployment machines', + 'type' => 'array', + 'items' => [ + 'description' => 'Deployment machine', + 'type' => 'object', + 'properties' => [ + 'createTime' => ['title' => '', 'description' => 'Start Time', 'type' => 'integer', 'format' => 'int64', 'example' => '1111111111'], + 'updateTime' => ['title' => '', 'description' => 'Updated At', 'type' => 'integer', 'format' => 'int64', 'example' => '11111111'], + 'status' => ['title' => '', 'description' => '- Succeeded'."\n" + ."\n" + .'- Pending'."\n" + ."\n" + .'- Running'."\n" + ."\n" + .'- Cancelled'."\n" + ."\n" + .'- Queued'."\n" + ."\n" + .'- Failed'."\n" + ."\n" + .'- Skipped', 'type' => 'string', 'example' => 'Success'], + 'machineSn' => ['title' => '', 'description' => 'Machine serial number', 'type' => 'string', 'example' => 'sasssasa'], + 'clientStatus' => ['title' => '', 'description' => 'ok (Normal) error (Connection failed)', 'type' => 'string', 'example' => 'ok'], + 'ip' => ['title' => '', 'description' => 'Machine IP', 'type' => 'string', 'example' => '127.0.0.1'], + 'actions' => [ + 'title' => '', + 'description' => 'Subsequent action', + 'type' => 'array', + 'items' => [ + 'description' => 'Action that can be executed subsequently', + 'type' => 'object', + 'properties' => [ + 'type' => ['title' => 'Action', 'description' => '- RetryVMDeployMachine: retry machine deployment '."\n" + .'- SkipVMDeployMachine: skip machine deployment '."\n" + .'- LogVMDeployMachine: view machine deployment log', 'type' => 'string', 'example' => 'RetryVMDeployMachine'], + 'disable' => ['title' => '', 'description' => 'Whether the current user has permission to perform the subsequent action', 'type' => 'boolean', 'example' => 'true'], + 'params' => ['title' => '', 'description' => 'parameter', 'type' => 'any', 'example' => '{}'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'batchNum' => ['title' => '', 'description' => 'Deployment batch', 'type' => 'integer', 'format' => 'int32', 'example' => '22'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'actions' => [ + 'title' => '', + 'description' => 'subsequent action', + 'type' => 'array', + 'items' => [ + 'description' => 'Available actions that can be performed next ', + 'type' => 'object', + 'properties' => [ + 'type' => ['title' => 'Action', 'description' => 'StopVMDeployOrder: cancel the deployment order '."\n" + .'ResumeVMDeployOrder: resume running the deployment order ', 'type' => 'string', 'example' => 'StopVMDeployOrder'], + 'disable' => ['title' => '', 'description' => 'Indicates whether the current User has permission to perform the subsequent action ', 'type' => 'boolean', 'example' => 'true'], + 'params' => ['title' => '', 'description' => 'Parameter ', 'type' => 'any', 'example' => '{}'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', ], ], + '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.', - ], + ['errorCode' => 'InvalidCluster.NotFound', 'errorMessage' => 'No cluster is available to generate the workspace.', 'description' => 'No cluster is available to generate the workspace.'], + ['errorCode' => 'InvalidCodeUrl.NotSupportSVN', 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', 'description' => 'The parameter codeUrl is invalid. SVN is not supported.'], + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidResource.NotFound', 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', 'description' => 'No resource is found. You cannot create the workspace. Please try again later.'], + ['errorCode' => 'InvalidResourceRole.NotFoun', 'errorMessage' => 'The member role is invalid.', 'description' => 'The member role is invalid.'], + ['errorCode' => 'InvalidResourceRole.NotFound', 'errorMessage' => 'The member role is invalid.', 'description' => ''], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => 'The user that is invoking the API service is not a registered user.'], + ['errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', 'errorMessage' => 'Resource owner cannot be deleted.', 'description' => 'The resource owner cannot be deleted.'], + ['errorCode' => 'InvalidUser.ResourceMemberNotExists', 'errorMessage' => 'The resource member does not exist.', 'description' => 'The resource member does not exist.'], + ['errorCode' => 'InvalidUser.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization.', 'description' => '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.', 'description' => 'The workspace status is invalid. You can only operate workspaces with the SUCCESS status.'], + ['errorCode' => 'InvalidWorkspaceTemplate.NotFound', 'errorMessage' => 'The parameter workspaceTemplate is not found.', 'description' => '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' => 'Forbidden.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], ], [ - [ - '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.', - ], + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], + ['errorCode' => 'InvalidPipeline.NotFound', 'errorMessage' => 'The pipeline is not found.', 'description' => 'The pipeline does not exist.'], + ['errorCode' => 'InvalidPipelineRun.NotFound', 'errorMessage' => 'The pipeline execution instance is not found.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'InvalidWorkspace.NotFound', 'errorMessage' => 'The workspace is not found.', 'description' => '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', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Retrieve deployment order details ', + 'changeSet' => [ + ['createdAt' => '2022-06-17T13:08:02.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-11-25T13:20:39.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetVMDeployOrder'], + ], ], + 'ramActions' => [], + ], + 'GetVariableGroup' => [ + 'summary' => 'You can retrieve a variable group.', + 'path' => '/organization/{organizationId}/variableGroups/{id}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -26441,1518 +13010,1187 @@ [ 'name' => 'organizationId', 'in' => 'path', - 'schema' => [ - 'title' => '企业标识,也称企业id,字符串形式,可在云效访问链接中获取,如https://devops.aliyun.com/organization/【OrganizationId】', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['title' => '', 'description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access URL, for example: https://devops.aliyun.com/organization/【OrganizationId】 ', '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, - ], + 'schema' => ['title' => '', 'description' => 'Variable group ID ', '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,每次请求都是唯一值,便于后续排查问题', - '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' => '”“', + 'requestId' => ['title' => '', 'description' => 'The request ID. Each request has a unique value, which facilitates troubleshooting later.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['title' => '', 'description' => 'error message ', 'type' => 'string', 'example' => '""'], + 'errorCode' => ['title' => '', 'description' => 'error code ', 'type' => 'string', 'example' => '""'], + 'success' => ['title' => '', 'description' => 'true if the API call succeeded; false if the API call failed.', 'type' => 'boolean', 'example' => 'true'], + 'variableGroup' => [ + 'title' => '', + 'description' => 'Variable group', + 'type' => 'object', + 'properties' => [ + 'ccreatorAccountId' => ['title' => '', 'description' => 'Alibaba Cloud account ID of the creator', 'type' => 'string', 'example' => '13232343434343'], + 'description' => ['title' => '', 'description' => 'Variable Group Description ', 'type' => 'string', 'example' => '变量组'], + 'updateTime' => ['title' => '', 'description' => 'Update Time ', 'type' => 'integer', 'format' => 'int64', 'example' => '1586863220000'], + 'id' => ['title' => '', 'description' => 'Variable Group ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '12234'], + 'modifierAccountId' => ['title' => '', 'description' => 'Alibaba Cloud account ID of the updater ', 'type' => 'string', 'example' => '13232343434343'], + 'name' => ['title' => '', 'description' => 'Variable Group Name ', 'type' => 'string', 'example' => '变量组'], + 'relatedPipelines' => [ + 'title' => '', + 'description' => 'Associated Pipelines ', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'id' => ['title' => '', 'description' => 'ID of the associated pipeline ', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'], + 'name' => ['title' => '', 'description' => 'Associated Pipeline Name ', 'type' => 'string', 'example' => '流水线'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'variables' => [ + 'title' => '', + 'description' => 'Variables', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'value' => ['title' => '', 'description' => 'Variable value', 'type' => 'string', 'example' => 'value1'], + 'name' => ['title' => '', 'description' => 'Variable name', 'type' => 'string', 'example' => 'name1'], + 'isEncrypted' => ['title' => '', 'description' => 'Indicates whether the variable is encrypted.', 'type' => 'boolean', 'example' => 'true'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'createTime' => ['title' => '', 'description' => 'Creation Time ', 'type' => 'integer', 'format' => 'int64', 'example' => '1586863220000'], + ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + '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.', - ], + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => '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' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], ], [ - [ - '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.', - ], + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], ], ], - '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', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Retrieve a variable group ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetVariableGroup'], + ], ], + 'ramActions' => [], + ], + 'GetWorkItemActivity' => [ + 'summary' => 'Query work item dynamic information.', + 'path' => '/organization/{organizationId}/workitems/{workitemId}/getActivity', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURErdc3GIDZJ'], + ], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'path', - 'schema' => [ - 'title' => '企业标识,也称企业id,字符串形式,可在云效访问链接中获取,如https://devops.aliyun.com/organization/【OrganizationId】', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, for example: https://devops.aliyun.com/organization/【OrganizationId】', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx', 'title' => ''], ], [ - 'name' => 'id', + 'name' => 'workitemId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '11', - ], + 'schema' => ['title' => '', 'description' => 'Work item ID, same as workitemIdentifier, the UUID of the work item', 'type' => 'string', 'required' => true, 'example' => 'e8bxxxxxxxxxxxxxxxx23'], ], ], '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' => '', + 'requestId' => ['title' => '', 'description' => 'Request ID. Each request has a unique value to facilitate troubleshooting later.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMsg' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => 'error'], + 'errorCode' => ['title' => '', 'description' => 'Error code', 'type' => 'string', 'example' => 'Openapi.RequestError'], + 'success' => ['title' => '', 'description' => 'true or false', 'type' => 'boolean', 'example' => 'true'], + 'activities' => [ + 'title' => '', + 'description' => 'Dynamic information', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'eventType' => ['title' => '', 'description' => 'Management event type ', 'type' => 'string', 'example' => 'workitem.updated'], + 'actionType' => ['title' => '', 'description' => 'Action Type', 'type' => 'string', 'example' => 'update'], + 'eventTime' => ['title' => '', 'description' => 'event time ', 'type' => 'integer', 'format' => 'int64', 'example' => '1640867079624'], + 'resourceIdentifier' => ['title' => '', 'description' => 'Operation Object ', 'type' => 'string', 'example' => 'e8bxxxxxxxxxxxxxxxx23'], + 'operator' => ['title' => '', 'description' => 'Operator', 'type' => 'string', 'example' => '19xx7043xxxxxxx914'], + 'eventId' => ['title' => '', 'description' => 'Event ID', 'type' => 'integer', 'format' => 'int64', 'example' => '3201131'], + 'parentEventId' => ['title' => '', 'description' => 'Parent event ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '3201132'], + 'property' => [ + 'title' => '', + 'description' => 'Modified property ', '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', + 'propertyName' => ['title' => '', 'description' => 'Property key ', 'type' => 'string', 'example' => 'subject'], + 'propertyType' => ['title' => '', 'description' => 'Type ', 'type' => 'string', 'example' => 'null'], + 'propertyIdentifier' => ['title' => '', 'description' => 'Resource ID ', 'type' => 'string', 'example' => 'subject'], + 'displayName' => ['title' => '', 'description' => 'Display name of the property ', 'type' => 'string', 'example' => '标题'], + ], + 'example' => 'public', + ], + 'oldValue' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'resourceType' => ['description' => 'Type of the modified value, same as propertyName ', 'type' => 'string', 'example' => 'Sprint', 'title' => ''], + 'plainValue' => ['description' => 'Old value ', 'type' => 'string', 'example' => 'bed1cca179badeb501a72d1194', 'title' => ''], + 'displayValue' => ['description' => 'Display value of the old value ', 'type' => 'string', 'example' => 'Sprint-221124', 'title' => ''], ], - 'modiferAccountId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1111111111111', + 'description' => 'Value entity ', + 'title' => '', + 'example' => '', + ], + 'description' => 'Value before update ', + 'title' => '', + 'example' => '', + ], + 'newValue' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'resourceType' => ['description' => 'The type of the modified value, same as propertyName ', 'type' => 'string', 'example' => 'Sprint', 'title' => ''], + 'plainValue' => ['description' => 'New value', 'type' => 'string', 'example' => 'bed1cca179badeb501a72d1194', 'title' => ''], + 'displayValue' => ['description' => 'Display value of the new value', 'type' => 'string', 'example' => 'Sprint-221124', 'title' => ''], ], + 'description' => 'Value entity', + 'title' => '', + 'example' => '', ], + 'description' => 'Updated value', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + '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.', - ], + ['errorCode' => 'Openapi.RequestError', 'errorMessage' => 'request error', 'description' => ''], ], 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.', - ], + ['errorCode' => 'Operate.NoPermission', 'errorMessage' => 'NoPermission', 'description' => 'You are not authorized to perform this operation.'], ], ], - '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', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query work item dynamics', + 'changeSet' => [ + ['createdAt' => '2022-10-28T14:04:59.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-01-06T13:27:07.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetWorkItemActivity'], + ], ], + 'ramActions' => [], + ], + 'GetWorkItemInfo' => [ + 'summary' => 'Obtain basic information about a work item. ', + 'path' => '/organization/{organizationId}/workitems/{workitemId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '118506', + 'abilityTreeNodes' => ['FEATURErdcY249FB'], + ], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'path', - 'schema' => [ - 'title' => '企业标识,也称企业id,字符串形式,可在云效访问链接中获取,如https://devops.aliyun.com/organization/【OrganizationId】', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['description' => 'Organization identifier, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, such as https://devops.aliyun.com/organizatio', 'type' => 'string', 'required' => true, 'example' => '5e706xxxxxx01xxx96', 'title' => ''], + ], + [ + 'name' => 'workitemId', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'The work item ID, which is the same as the workitemIdentifier field and serves as the UUID of the work item. You can obtain it from the ListWorkItems API.', 'type' => 'string', 'required' => true, 'example' => 'ce2xxxx21580baxxxx633f13'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'Work item request result ', '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' => '标签名称', + 'requestId' => ['title' => '', 'description' => 'Request ID. Each request has a unique value to facilitate troubleshooting. ', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorCode' => ['title' => '', 'description' => 'error code ', 'type' => 'string', 'example' => 'Openapi.RequestError'], + 'errorMessage' => ['title' => '', 'description' => 'error message ', 'type' => 'string', 'example' => 'error'], + 'success' => ['title' => '', 'description' => 'true or false ', 'type' => 'boolean', 'example' => 'true'], + 'workitem' => [ + 'title' => '', + 'description' => 'Work item information ', + 'type' => 'object', + 'properties' => [ + 'identifier' => ['title' => '', 'description' => 'UUID of the work item ', 'type' => 'string', 'example' => 'e8bxxxxxxxxxxxxxxxx23'], + 'subject' => ['title' => '', 'description' => 'Work item title ', 'type' => 'string', 'example' => '测试工作项'], + 'document' => ['title' => '', 'description' => 'Work Item Content', 'type' => 'string', 'example' => 'html格式'], + 'documentFormat' => ['description' => 'Content format of the work item. Supported formats are RICHTEXT and MARKDOWN.', 'type' => 'string', 'example' => 'RICHTEXT', 'title' => ''], + 'assignedTo' => ['title' => '', 'description' => 'Owner ', 'type' => 'string', 'example' => '19xx7043xxxxxxx914'], + 'status' => ['title' => '', 'description' => 'Status Name', 'type' => 'string', 'example' => '待处理'], + 'statusStageIdentifier' => ['title' => '', 'description' => 'Status stage ID ', 'type' => 'string', 'example' => '1'], + 'spaceIdentifier' => ['title' => '', 'description' => 'Project ID ', 'type' => 'string', 'example' => 'e8b26xxxxx6e76aa20xxxxx23'], + 'spaceName' => ['title' => '', 'description' => 'Project name ', 'type' => 'string', 'example' => '需求项目'], + 'spaceType' => ['title' => '', 'description' => 'Project Mode ', 'type' => 'string', 'example' => 'Project'], + 'logicalStatus' => ['title' => '', 'description' => 'Logical status ', 'type' => 'string', 'example' => 'NORMAL'], + 'categoryIdentifier' => ['title' => '', 'description' => 'Work item category ID ', 'type' => 'string', 'example' => 'Req'], + 'parentIdentifier' => ['title' => '', 'description' => 'Parent work item ID ', 'type' => 'string', 'example' => 'e8bxxxxxxxxxxxxxxxx24'], + 'workitemTypeIdentifier' => ['title' => '', 'description' => 'Work item type ID ', 'type' => 'string', 'example' => '9uxxxxxxre573f5xxxxxx0'], + 'updateStatusAt' => ['title' => '', 'description' => 'UNIX timestamp of the status update, in milliseconds ', 'type' => 'integer', 'format' => 'int64', 'example' => '1640850328000'], + 'serialNumber' => ['title' => '', 'description' => 'Serial number of the work item within the project ', 'type' => 'string', 'example' => 'ABCD-1'], + 'gmtCreate' => ['title' => '', 'description' => 'UNIX timestamp of the Creation Time, in milliseconds', 'type' => 'integer', 'format' => 'int64', 'example' => '1640850318000'], + 'gmtModified' => ['title' => '', 'description' => 'UNIX timestamp of the modification time, in milliseconds ', 'type' => 'integer', 'format' => 'int64', 'example' => '1640850318000'], + 'creator' => ['title' => '', 'description' => 'Alibaba Cloud account ID of the Creator ', 'type' => 'string', 'example' => '19xx7043xxxxxxx914'], + 'modifier' => ['title' => '', 'description' => 'Alibaba Cloud account ID of the Updated By ', 'type' => 'string', 'example' => '19xx7043xxxxxxx914'], + 'statusIdentifier' => ['title' => '', 'description' => 'Status ID ', 'type' => 'string', 'example' => '例:100005'], + 'sprint' => [ + 'title' => '', + 'description' => 'Associated iteration ID ', + 'type' => 'array', + 'items' => ['description' => 'UUID of the iteration ', 'type' => 'string', 'example' => '81be626abf9b63e291bd......', 'title' => ''], + 'example' => '', + ], + 'tag' => [ + 'title' => '', + 'description' => 'List of label IDs ', + 'type' => 'array', + 'items' => ['description' => 'UUID of the label ', 'type' => 'string', 'example' => 'c76e0e4bf64801cfad73......', 'title' => ''], + 'example' => '', + ], + 'participant' => [ + 'title' => '', + 'description' => 'List of participant account IDs ', + 'type' => 'array', + 'items' => ['description' => 'Participant account ID ', 'type' => 'string', 'example' => '1561159309......', 'title' => ''], + 'example' => '', + ], + 'tracker' => [ + 'title' => '', + 'description' => 'List of carbon copy recipient account IDs ', + 'type' => 'array', + 'items' => ['description' => 'Account ID of the carbon copy recipient ', 'type' => 'string', 'example' => '1561159309......', 'title' => ''], + 'example' => '', + ], + 'verifier' => [ + 'title' => '', + 'description' => 'List of account IDs of verifiers', + 'type' => 'array', + 'items' => ['description' => 'Account ID of verifier', 'type' => 'string', 'example' => '1561159309......', 'title' => ''], + 'example' => '', + ], + 'customFields' => [ + 'title' => '', + 'description' => 'List of Custom Fields ', + 'type' => 'array', + 'items' => [ + 'description' => 'Custom Field ', + 'type' => 'object', + 'properties' => [ + 'fieldIdentifier' => ['title' => '', 'description' => 'UUID of the field ', 'type' => 'string', 'example' => '例:80'], + 'fieldFormat' => ['title' => '', 'description' => 'Field format, facilitating data query ', 'type' => 'string', 'example' => '例:input'], + 'fieldClassName' => ['title' => '', 'description' => 'Class name of the field, facilitating data query ', 'type' => 'string', 'example' => '例如:date'], + 'objectValue' => ['title' => '', 'description' => 'List of value objects', 'type' => 'string', 'example' => 'null'], + 'value' => ['title' => '', 'description' => 'Field Value, used when writing', 'type' => 'string', 'example' => '例:2022-01-06 00:00:00'], + 'workitemIdentifier' => ['title' => '', 'description' => 'UUID of the work item ', 'type' => 'string', 'example' => '5daa9a15c7fd55523996......'], + 'position' => ['title' => '', 'description' => 'Position of the Custom Fields value', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'level' => ['title' => '', 'description' => 'Display level, ranging from 1 to 9. A higher number indicates a lighter color.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'valueList' => [ + 'title' => '', + 'description' => 'List of value objects, used for queries', + 'type' => 'array', + 'items' => [ + 'description' => 'Value list of the custom field', + 'type' => 'object', + 'properties' => [ + 'value' => ['title' => '', 'description' => 'Field Value', 'type' => 'string', 'example' => '2022-02-01 00:00:00'], + 'valueEn' => ['title' => '', 'description' => 'English value of the field; currently, only List-type fields have English values', 'type' => 'string', 'example' => 'null'], + 'displayValue' => ['title' => '', 'description' => 'Retrieve the currently displayed value based on the language environment', 'type' => 'string', 'example' => '2022-02-01 00:00:00'], + 'identifier' => ['title' => '', 'description' => 'UUID of the object corresponding to the value when the field value is of object type, for example, the id in the option Table', 'type' => 'string', 'example' => '2022-02-01 00:00:00'], + 'level' => ['title' => '', 'description' => 'Display level, ranging from 1 to 9. A higher number indicates a lighter color.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], - 'creatorAccountId' => [ - 'title' => '创建人', + 'example' => '', + ], + 'finishTime' => ['description' => 'Finish Time ', 'type' => 'integer', 'format' => 'int64', 'example' => '1699366778000', 'title' => ''], + 'tagDetails' => [ + 'description' => 'Tag Details ', + 'type' => 'array', + 'items' => [ 'description' => '', - 'type' => 'string', - 'example' => '111111111', + 'type' => 'object', + 'properties' => [ + 'identifier' => ['description' => 'Tag UUID ', 'type' => 'string', 'example' => '8d859b4fce9d86bc324a9cf00c', 'title' => ''], + 'name' => ['description' => 'Tag Name ', 'type' => 'string', 'example' => 'paymentcenter', 'title' => ''], + 'color' => ['description' => 'Tag color ', 'type' => 'string', 'example' => '#1F9AEF', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'modiferAccountId' => [ - 'title' => '修改人', - 'description' => '', - 'type' => 'string', - 'example' => '11111111', + 'title' => '', + 'example' => '', + ], + 'versions' => [ + 'description' => 'Associated versions', + 'type' => 'array', + 'items' => [ + 'description' => 'Version', + 'type' => 'object', + 'properties' => [ + 'identifier' => ['description' => 'Version ID', 'type' => 'string', 'example' => 'ec65ce5dbc84790b53c272cb43', 'title' => ''], + 'name' => ['description' => 'Version Name', 'type' => 'string', 'example' => 'UAT', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], + '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.', - ], + ['errorCode' => 'Openapi.RequestError', 'errorMessage' => 'request error', 'description' => ''], ], 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.', - ], + ['errorCode' => 'Operate.NoPermission', 'errorMessage' => 'NoPermission', 'description' => 'You are not authorized to perform this operation.'], ], ], - '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', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Obtain basic information of a work item', + 'changeSet' => [ + ['createdAt' => '2024-12-12T13:18:45.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-04-19T13:00:42.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-02-28T13:03:37.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-11-07T14:17:19.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-02-24T08:23:15.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-02-24T08:23:15.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-02-24T08:23:15.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-01-06T13:27:07.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetWorkItemInfo'], + ], ], + 'ramActions' => [], + ], + 'GetWorkItemWorkFlowInfo' => [ + 'summary' => 'Retrieve workflow information for a work item.', + 'path' => '/organization/{organizationId}/workitems/{workitemId}/getWorkflowInfo', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURErdc3GIDZJ'], + ], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'path', - 'schema' => [ - 'title' => '企业标识,也称企业id,字符串形式,可在云效访问链接中获取,如 https:// devops.aliyun.com/organization/【OrgId】', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, for example: https://devops.aliyun.com/organization/【OrganizationId】 ', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx', 'title' => ''], + ], + [ + 'name' => 'configurationId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The pipeline configuration ID corresponding to the work item type. This value can be obtained from the following page API request: https://devops.aliyun.com/projex/api/workitem/workitemType/setting/space/getSpaceWorkitemTypeScope?spaceType=Project&spaceIdentifier=c595d0c3df4c743ac811......&workitemTypeIdentifier=ba102e46bc6a8483...... The corresponding Field Value is located in result → configurations → identifier where configType is Workflow. ', 'type' => 'string', 'required' => false, 'example' => '711d33c738b9171c45fa......'], + ], + [ + 'name' => 'workitemId', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'Work item ID, same as the workitemIdentifier field, which is the UUID of the work item ', 'type' => 'string', 'required' => false, 'example' => 'fd0xxxxx00d355b05df60xxxx'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Result of the work item request', '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' => '', + 'requestId' => ['title' => '', 'description' => 'Request ID; each request has a Unique value to facilitate troubleshooting', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorCode' => ['title' => '', 'description' => 'error code ', 'type' => 'string', 'example' => 'Openapi.RequestError'], + 'errorMessage' => ['title' => '', 'description' => 'error message ', 'type' => 'string', 'example' => 'error'], + 'success' => ['title' => '', 'description' => 'true or false', 'type' => 'boolean', 'example' => 'true'], + 'workflow' => [ + 'title' => '', + 'description' => 'Work item information', 'type' => 'object', 'properties' => [ - 'publicKey' => [ - 'title' => '企业公钥', - 'description' => '', - 'type' => 'string', - 'example' => 'assssssssssss', + 'identifier' => ['title' => '', 'description' => 'UUID of the pipeline', 'type' => 'string', 'example' => 'e8bxxxxxxxxxxxxxxxx23'], + 'name' => ['title' => '', 'description' => 'Pipeline name', 'type' => 'string', 'example' => '名称'], + 'description' => ['title' => '', 'description' => 'Description of the pipeline', 'type' => 'string', 'example' => '工作流的描述'], + 'ownerSpaceIdentifier' => ['title' => '', 'description' => 'identifier of the team Space or project to which the pipeline belongs', 'type' => 'string', 'example' => 'e8b26xxxxx6e76aa20xxxxx23'], + 'ownerSpaceType' => ['title' => '', 'description' => 'Project Mode of the team to which the pipeline belongs', 'type' => 'string', 'example' => 'null'], + 'defaultStatusIdentifier' => ['title' => '', 'description' => 'The default status ID of the workflow. The specific list of workflows can be found in the statuses list.', 'type' => 'string', 'example' => '100005'], + 'statusOrder' => ['title' => '', 'description' => 'Status order of the pipeline', 'type' => 'string', 'example' => 'null'], + 'resourceType' => ['title' => '', 'description' => 'Source of the resource: Project for project pipelines, Workitem for work item pipelines', 'type' => 'string', 'example' => 'Project'], + 'source' => ['title' => '', 'description' => 'The source of the workflow: "system" indicates built-in system workflows, "organization" indicates workflows configured by the enterprise, and "custom" indicates workflows defined by a project or team.', 'type' => 'string', 'example' => 'system'], + 'gmtCreate' => ['title' => '', 'description' => 'The UNIX timestamp of the creation time, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1640850318000'], + 'gmtModified' => ['title' => '', 'description' => 'UNIX timestamp of the update time, in milliseconds', 'type' => 'integer', 'format' => 'int64', 'example' => '1640850318000'], + 'creator' => ['title' => '', 'description' => 'Alibaba Cloud accountId of the Creator', 'type' => 'string', 'example' => '19xx7043xxxxxxx914'], + 'modifier' => ['title' => '', 'description' => 'Alibaba Cloud accountId of the Updated By', 'type' => 'string', 'example' => '19xx7043xxxxxxx914'], + 'workflowActions' => [ + 'title' => '', + 'description' => 'The steps for workflow transitions.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'id' => ['title' => '', 'description' => 'The ID of the transition step.', 'type' => 'integer', 'format' => 'int64', 'example' => '16274887'], + 'name' => ['title' => '', 'description' => 'The name of the action.', 'type' => 'string', 'example' => 'xxx'], + 'workflowIdentifier' => ['title' => '', 'description' => 'Pipeline corresponding to the action', 'type' => 'string', 'example' => 'fd0xxxxxd00d355b05dxxxx26'], + 'workflowStatusIdentifier' => ['title' => '', 'description' => 'Current status ID corresponding to the action', 'type' => 'string', 'example' => '100005'], + 'nextWorkflowStatusIdentifier' => ['title' => '', 'description' => 'The ID of the next status corresponding to the action.', 'type' => 'string', 'example' => '100011'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', ], - 'id' => [ - 'title' => '企业公钥id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', + 'statuses' => [ + 'title' => '', + 'description' => 'List of statuses', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'identifier' => ['title' => '', 'description' => 'UUID of the status', 'type' => 'string', 'example' => '156603'], + 'name' => ['title' => '', 'description' => 'Status name', 'type' => 'string', 'example' => '待处理'], + 'workflowStageName' => ['title' => '', 'description' => 'Stage information - Name', 'type' => 'string', 'example' => '确认阶段'], + 'workflowStageIdentifier' => ['title' => '', 'description' => 'UUID of the workflow stage', 'type' => 'string', 'example' => '1'], + 'source' => ['title' => '', 'description' => 'Status source. system: default status provided by the system; custom: status created by an enterprise, project, or team', 'type' => 'string', 'example' => 'system'], + 'gmtCreate' => ['title' => '', 'description' => 'UNIX timestamp of the Creation Time, in milliseconds', 'type' => 'integer', 'format' => 'int64', 'example' => '1613805843000'], + 'gmtModified' => ['title' => '', 'description' => 'UNIX timestamp of the modification time, in milliseconds', 'type' => 'integer', 'format' => 'int64', 'example' => '1613805843000'], + 'creator' => ['title' => '', 'description' => 'Creator Alibaba Cloud account ID', 'type' => 'string', 'example' => '19xx7043xxxxxxx914'], + 'modifier' => ['title' => '', 'description' => 'Updated By Alibaba Cloud account ID', 'type' => 'string', 'example' => '19xx7043xxxxxxx914'], + 'description' => ['title' => '', 'description' => 'Description', 'type' => 'string', 'example' => 'xxx'], + 'resourceType' => ['title' => '', 'description' => 'resource type to which the status applies: Project for projects, Workitem for work items', 'type' => 'string', 'example' => 'Workitem'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', ], ], + 'example' => '', ], ], + '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.', - ], + ['errorCode' => 'Openapi.RequestError', 'errorMessage' => 'request error', 'description' => ''], ], 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' => 'Operate.NoPermission', 'errorMessage' => 'NoPermission', 'description' => 'You are not authorized to perform this operation.'], ], ], - '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', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Obtain work item pipeline information ', + 'changeSet' => [ + ['createdAt' => '2022-10-28T14:04:59.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-01-06T13:27:07.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetWorkItemWorkFlowInfo'], + ], ], + 'ramActions' => [], + ], + 'GetWorkitemAttachmentCreatemeta' => [ + 'summary' => 'This API retrieves the metadata needed to upload a file as a work item attachment. It is the first of three steps:\\'."\n" + .'1\\. Call this API to get the upload information.\\'."\n" + .'2\\. Use the information in the response to upload the file to Object Storage Service (OSS).\\'."\n" + .'3\\. Call the `WorkitemAttachmentCreate` API to associate the uploaded file with the work item.\\'."\n" + .'\\'."\n" + .'For step 2, refer to the OSS documentation at https://help.aliyun.com/document_detail/31926.html. The request must use the `POST` method and be submitted as a form.\\'."\n" + .'\\'."\n" + .'\\'."\n" + .'\\'."\n" + .'\\', + 'path' => '/organization/{organizationId}/workitem/{workitemIdentifier}/attachment/createmeta', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURErdc3GIDZJ'], + ], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'path', - 'schema' => [ - 'title' => '企业标识,也称企业id,字符串形式,可在云效访问链接中获取,如 https:// devops.aliyun.com/organization/【OrgId】', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['description' => 'The organization ID. You can obtain this ID from the URL in Alibaba Cloud DevOps. Example: `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'required' => true, 'example' => '60de7a6852743a5162b5f957', 'title' => ''], + ], + [ + 'name' => 'workitemIdentifier', + 'in' => 'path', + 'schema' => ['description' => 'The unique identifier of the work item.', 'type' => 'string', 'required' => true, 'example' => '11234455454355', 'title' => ''], + ], + [ + 'name' => 'fileName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the file to upload.', 'type' => 'string', 'required' => true, 'example' => 'application.jar', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response 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' => '', + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID. A unique value generated for each request, used for troubleshooting.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorCode' => ['description' => '- If `success` is `false`, this field contains the error code.'."\n" + ."\n" + .'- If `success` is `true`, this field is empty.', 'type' => 'string', 'example' => 'Invalid.IdNotFound', 'title' => ''], + 'errorMessage' => ['description' => '- If `success` is `false`, this field contains the error message.'."\n" + ."\n" + .'- If `success` is `true`, this field is empty.', 'type' => 'string', 'example' => 'Forbidden.UserNotInCurrentOrganization', 'title' => ''], + 'success' => ['description' => 'Indicates whether the API call succeeded. `true` indicates success and `false` indicates failure.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'uploadInfo' => [ + 'description' => 'Contains the information required for uploading to OSS. For more information, see [PostObject](https://help.aliyun.com/document_detail/31926.html).', 'type' => 'object', 'properties' => [ - 'publicKey' => [ - 'title' => '企业公钥', - 'description' => '', - 'type' => 'string', - 'example' => 'saaaaaaaaaaaaaaaa', - ], - 'id' => [ - 'title' => '企业公钥id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1212', - ], + 'accessid' => ['description' => 'Use this value for the `OSSAccessKeyId` form field.', 'type' => 'string', 'example' => 'xxxxxxx', 'title' => ''], + 'policy' => ['description' => 'The upload policy.', 'type' => 'string', 'example' => 'xxxxxxx', 'title' => ''], + 'signature' => ['description' => 'The signature for the upload request.', 'type' => 'string', 'example' => 'xdWcrl/yTmIUA0kE7a3B0Ox4Vu8=', 'title' => ''], + 'dir' => ['description' => 'Use this value for the `key` form field.', 'type' => 'string', 'example' => 'ddd/dddd', 'title' => ''], + 'host' => ['description' => 'The endpoint for the file upload.', 'type' => 'string', 'example' => 'xxxxx', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + '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.', - ], + ['errorCode' => 'Openapi.RequestError', 'errorMessage' => 'request error', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', - 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', - ], + ['errorCode' => 'Operate.NoPermission', 'errorMessage' => 'NoPermission', 'description' => 'You are not authorized to perform this operation.'], ], - [ - [ - 'errorCode' => 'InvalidOrganization.NotFound', - 'errorMessage' => 'The organization is not found.', - ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Obtain information about the attachment uploaded to a work item ', + 'description' => 'Example for step 2:'."\n" + .'', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetWorkitemAttachmentCreatemeta'], ], ], - '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":""}]', + 'ramActions' => [], + '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"}]', ], - 'CreateResourceMember' => [ - 'summary' => '插入资源成员', - 'path' => '/organization/{organizationId}/{resourceType}/{resourceId}/members', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetWorkitemCommentList' => [ + 'summary' => 'Obtain the comment list of a work item.', + 'path' => '/organization/{organizationId}/workitems/{workitemId}/commentList', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURErdc3GIDZJ'], + ], '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', - ], - ], + 'schema' => ['title' => '', 'description' => 'Organization ID', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ - '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', + 'name' => 'workitemId', 'in' => 'path', - 'schema' => [ - 'title' => '资源类型 流水线 pipeline 部署组 deployGroup', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123', - ], + 'schema' => ['title' => '', 'description' => 'Work item ID, same as workitemIdentifier, the UUID of the work item ', 'type' => 'string', 'required' => true, 'example' => 'ce2xxxx21580baxxxx633f13'], ], ], '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' => '""', - ], - 'errorCode' => [ - 'title' => '错误码', - 'description' => '', - 'type' => 'string', - 'example' => '""', - ], - 'success' => [ - 'title' => 'true 接口调用成功,false 接口调用失败', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMsg' => ['description' => 'Error message', 'type' => 'string', 'example' => 'error', 'title' => ''], + 'errorCode' => ['description' => '- When success is false, returns the business error code. '."\n" + .'- When success is true, returns an empty value.', 'type' => 'string', 'example' => 'Openapi.RequestError', 'title' => ''], + 'success' => ['description' => 'true indicates that the API call succeeded; false indicates that the API call failed.', 'type' => 'string', 'example' => 'true 接口调用成功,false 接口调用失败', 'title' => ''], + 'commentList' => [ + 'description' => 'Comment List', + 'type' => 'array', + 'items' => [ + 'description' => 'Comment List', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'Comment ID', 'type' => 'integer', 'format' => 'int64', 'example' => '6573', 'title' => ''], + 'content' => ['description' => 'Comment content', 'type' => 'string', 'example' => '066961', 'title' => ''], + 'targetType' => ['description' => 'Resource Type', 'type' => 'string', 'example' => 'workitem', 'title' => ''], + 'targetIdentifier' => ['description' => 'Resource ID, which is the work item ID', 'type' => 'string', 'example' => '9144ef6b72d8exxxxx9e61a4d0', 'title' => ''], + 'parentId' => ['description' => 'Parent comment ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1013131897677566', 'title' => ''], + 'createTime' => ['description' => 'Creation Time', 'type' => 'integer', 'format' => 'int64', 'example' => '1667205617061', 'title' => ''], + 'modifiedTime' => ['description' => 'Updated At', 'type' => 'integer', 'format' => 'int64', 'example' => '1646323200000', 'title' => ''], + 'isTop' => ['description' => 'Is Pinned', 'type' => 'boolean', 'example' => 'true/false', 'title' => ''], + 'topTime' => ['description' => 'Pinned Time', 'type' => 'integer', 'format' => 'int64', 'example' => '1667205617089', 'title' => ''], + 'formatType' => ['description' => 'Format Type', 'type' => 'string', 'example' => 'RICHTEXT/MARKDOWN', 'title' => ''], + 'user' => [ + 'type' => 'object', + 'properties' => [ + 'account' => ['type' => 'string', 'description' => 'Account of the user', 'example' => 'null', 'title' => ''], + 'identifier' => ['type' => 'string', 'description' => 'UUID of the user', 'example' => '123xxxxxxx222', 'title' => ''], + 'realName' => ['type' => 'string', 'description' => 'Real name of the user', 'example' => '张三', 'title' => ''], + 'nickName' => ['type' => 'string', 'description' => 'Nickname of the user', 'example' => '李四', 'title' => ''], + 'avatar' => ['type' => 'string', 'description' => 'Icon', 'example' => 'null', 'title' => ''], + ], + 'description' => 'Creator Object', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + '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.', - ], - [ - 'errorCode' => 'InvalidResourceRole.NotFoun', - 'errorMessage' => 'The member role is invalid.', - ], + ['errorCode' => 'Openapi.RequestError', 'errorMessage' => 'request error', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', - 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', - ], + ['errorCode' => 'Operate.NoPermission', 'errorMessage' => 'NoPermission', 'description' => 'You are not authorized to perform this operation.'], ], - [ - [ - 'errorCode' => 'InvalidOrganization.NotFound', - 'errorMessage' => 'The organization is not found.', - ], + ], + '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"}]', + 'title' => 'Obtain the comment list of a work item', + 'description' => 'Obtain the comment list of a work item.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetWorkitemCommentList'], ], ], - '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":""}]', + 'ramActions' => [], ], - 'DeleteResourceMember' => [ - 'summary' => '删除资源成员', - 'path' => '/organization/{organizationId}/{resourceType}/{resourceId}/members/{accountId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetWorkitemFile' => [ + 'summary' => 'Retrieves information about a file associated with a work item, such as an image in the work item\'s description.', + 'path' => '/organization/{organizationId}/workitem/{workitemIdentifier}/files/{fileIdentifier}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURErdc3GIDZJ'], + ], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'path', - 'schema' => [ - 'title' => '企业标识,也称企业id,字符串形式,可在云效访问链接中获取,如 https:// devops.aliyun.com/organization/【OrgId】', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['description' => 'The ID of the organization. You can find this ID in the URL of the Alibaba Cloud DevOps console, for example: `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'required' => true, 'example' => '60811b5eed6e867404f6xxxx', 'title' => ''], ], [ - 'name' => 'resourceType', + 'name' => 'workitemIdentifier', 'in' => 'path', - 'schema' => [ - 'title' => '资源id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'maximum' => '999999999999999', - 'minimum' => '1', - 'example' => 'pipeline', - 'enum' => [ - 'pipeline', - 'hostGroup', - ], - ], + 'schema' => ['description' => 'The unique identifier of the work item.', 'type' => 'string', 'required' => true, 'example' => '11234455454355', 'title' => ''], ], [ - 'name' => 'resourceId', - 'in' => 'path', - 'schema' => [ - 'title' => '资源类型流水线 pipeline 部署组 deployGroup', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123', - ], - ], - [ - 'name' => 'accountId', + 'name' => 'fileIdentifier', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2211221', - ], + 'schema' => ['description' => 'The unique identifier of the file.', 'type' => 'string', 'required' => true, 'example' => 'dfsdfdsgdsfdsfff', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data returned for a successful request.', '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', + 'requestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMsg' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => 'error', 'title' => ''], + 'errorCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful. Valid values: `true` and `false`.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'workitemFile' => [ + 'description' => 'An object containing the file details.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The ID of the file.', 'type' => 'string', 'example' => 'sddrdfdf123df', 'title' => ''], + 'name' => ['description' => 'The name of the file.', 'type' => 'string', 'example' => 'ddc.pdf', 'title' => ''], + 'suffix' => ['description' => 'The file extension.', 'type' => 'string', 'example' => 'pdf', 'title' => ''], + 'size' => ['description' => 'The file size in bytes.', 'type' => 'integer', 'format' => 'int32', 'example' => '10001', 'title' => ''], + 'url' => ['description' => 'The download URL of the file.', 'type' => 'string', 'example' => 'http://tmaestro-oss.oss-cn-hongkong.aliyuncs.com/thread_1682129288279.log', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + '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.', - ], - [ - 'errorCode' => 'InvalidUser.ResourceMemberNotExists', - 'errorMessage' => 'The resource member does not exist.', - ], - [ - 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', - 'errorMessage' => 'Resource owner cannot be deleted.', - ], + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], ], - 403 => [ - [ - 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', - 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', - ], + 404 => [ + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], ], - [ - [ - 'errorCode' => 'InvalidOrganization.NotFound', - 'errorMessage' => 'The organization is not found.', - ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Obtain Work Item File Information ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetWorkitemFile'], ], ], - '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":""}]', + 'ramActions' => [], + '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"}]', ], - 'UpdateResourceMember' => [ - 'summary' => '更新资源成员', - 'path' => '/organization/{organizationId}/{resourceType}/{resourceId}/members/{accountId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetWorkitemRelations' => [ + 'summary' => 'Obtain associated work items.', + 'path' => '/organization/{organizationId}/workitems/{workitemId}/getRelations', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURErdc3GIDZJ'], + ], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'path', - 'schema' => [ - 'title' => '企业标识,也称企业id,字符串形式,可在云效访问链接中获取,如 https:// devops.aliyun.com/organization/【OrgId】', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['title' => '', 'description' => 'Organization ID', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ - 'name' => 'resourceType', + 'name' => 'workitemId', 'in' => 'path', - 'schema' => [ - 'title' => '资源Id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'maximum' => '999999999999999', - 'minimum' => '1', - 'example' => 'pipeline', - 'enum' => [ - 'pipeline', - 'hostGroup', - ], - ], + 'schema' => ['title' => '', 'description' => 'Work item ID, same as workitemidentifier, the UUID of the work item', 'type' => 'string', 'required' => true, 'example' => '8876ad01xxxxx65d9710b2631'], ], [ - 'name' => 'roleName', - 'in' => 'formData', + 'name' => 'relationType', + 'in' => 'query', 'schema' => [ - 'title' => '角色部署组 deployGroup user 成员,使用权限 admin 管理员,使用编辑权限 owner 拥有者,所有权限 流水线 pipeline owner 拥有者,所有权限 admin 查看、运行、编辑权限 member 运行权限 viewer 查看权限', - 'description' => '', + 'title' => '', + 'description' => 'There are six possible values: BLOCKING, BLOCKED, ASSOCIATED, DUPLICATED, SUB, and PARENT. Only relationships of work item type will be retrieved.', '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', + 'enumValueTitles' => ['SUB' => 'SUB', 'PARENT' => 'PARENT', 'BLOCKED' => 'BLOCKED', 'DUPLICATED' => 'DUPLICATED', 'BLOCKING' => 'BLOCKING', 'ASSOCIATED' => 'ASSOCIATED'], + 'example' => '一共有BLOCKING,BLOCKED,ASSOCIATED, DUPLICATED,SUB, PARENT,一共6个待选值,只会获得工作项类型的关系项', ], ], ], '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' => '""', - ], - 'errorCode' => [ - 'title' => '错误码', - 'description' => '', - 'type' => 'string', - 'example' => '""', - ], - 'success' => [ - 'title' => 'true 接口调用成功,false 接口调用失败', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMsg' => ['description' => 'Error description message.', 'type' => 'string', 'example' => 'error', 'title' => ''], + 'errorCode' => ['description' => '- When success is false, returns the business error code; '."\n" + .'- When success is true, returns an empty value.', 'type' => 'string', 'example' => 'InvalidGroup.IdNotFound', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request succeeded.'."\n" + ."\n" + .'- true: Succeeded'."\n" + ."\n" + .'- false: failed', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'relationList' => [ + 'description' => 'Information about pinned associated items', + 'type' => 'array', + 'items' => [ + 'description' => 'Work item information', + 'type' => 'object', + 'properties' => [ + 'identifier' => ['description' => 'Work item ID', 'type' => 'string', 'example' => 'deafe5f33xxxxx6a259d8dafd', 'title' => ''], + 'subject' => ['description' => 'Work item title', 'type' => 'string', 'example' => '标题内容', 'title' => ''], + 'assignedTo' => ['description' => 'Owner aliyunPk', 'type' => 'string', 'example' => ' aliyun_1384605', 'title' => ''], + 'spaceIdentifier' => ['description' => 'Project ID', 'type' => 'string', 'example' => '2b856dxxxxxxb61d93676255ba', 'title' => ''], + 'categoryIdentifier' => ['description' => 'Category ID of the work item', 'type' => 'string', 'example' => 'Req', 'title' => ''], + 'workitemTypeIdentifier' => ['description' => 'Work item type ID', 'type' => 'string', 'example' => '9uy29901re573f561d69jn40', 'title' => ''], + 'gmtCreate' => ['description' => 'Creation Time', 'type' => 'string', 'example' => '1667205617061', 'title' => ''], + 'gmtModified' => ['description' => 'Updated At', 'type' => 'string', 'example' => '1667205617089', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], '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.', - ], + ['errorCode' => 'Openapi.RequestError', 'errorMessage' => 'request error', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', - 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', - ], + ['errorCode' => 'Operate.NoPermission', 'errorMessage' => 'NoPermission', 'description' => 'You are not authorized to perform this operation.'], ], - [ - [ - 'errorCode' => 'InvalidOrganization.NotFound', - 'errorMessage' => 'The organization is not found.', - ], - [ - 'errorCode' => 'InvalidPipeline.NotFound', - 'errorMessage' => 'The pipeline is not found.', - ], + ], + '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"}]', + 'title' => 'Obtain work item associations', + 'description' => 'Obtain associated work items.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetWorkitemRelations'], ], ], - '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":""}]', + 'ramActions' => [], ], - 'ListResourceMembers' => [ - 'summary' => '获取资源成员列表', - 'path' => '/organization/{organizationId}/{resourceType}/{resourceId}/members', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetWorkitemTimeTypeList' => [ + 'path' => '/organization/{organizationId}/workitems/type/list', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURErdc3GIDZJ'], + ], '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', - ], + 'schema' => ['description' => 'The organization ID. You can obtain the ID from the URL of your organization page in Alibaba Cloud DevOps. The URL is in the format `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response object.', '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' => '', + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'HC93CE1A-8D7A-13A9-8306-7465DE2E5C0F'], + 'errorMsg' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'error', 'title' => ''], + 'errorCode' => ['description' => '- Returns the business error code if `success` is `false`.'."\n" + ."\n" + .'- Empty if `success` is `true`.', 'type' => 'string', 'example' => 'Invalid.IdNotFound', 'title' => ''], + 'success' => ['description' => 'Indicates if the request succeeded (`true`) or failed (`false`).', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'timeType' => [ + 'description' => 'A list of the returned time types.', 'type' => 'array', 'items' => [ + 'description' => 'An object representing a single time type.', 'type' => 'object', 'properties' => [ - 'accountId' => [ - 'title' => '账号id', - 'description' => '', - 'type' => 'string', - 'example' => '22212212', - ], - 'roleName' => [ - 'title' => '角色', - 'description' => '', - 'type' => 'string', - 'example' => 'admin', - ], - 'username' => [ - 'title' => '用户名称', - 'description' => '', - 'type' => 'string', - 'example' => '张三', - ], + 'identifier' => ['description' => 'The identifier of the time type.', 'type' => 'string', 'example' => '67fb001005aac8d3d2a3372416', 'title' => ''], + 'name' => ['description' => 'The name of the time type.', 'type' => 'string', 'title' => '', 'example' => ''], + 'displayName' => ['description' => 'The display name.', 'type' => 'string', 'example' => 'deploy', 'title' => ''], + 'description' => ['description' => 'The description.', 'type' => 'string', 'example' => '描述文案', 'title' => ''], + 'position' => ['description' => 'The display position.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + '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.', - ], + ['errorCode' => 'Openapi.RequestError', 'errorMessage' => 'request error', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', - 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', - ], + ['errorCode' => 'Operate.NoPermission', 'errorMessage' => 'NoPermission', 'description' => 'You are not authorized to perform this operation.'], ], - [ - [ - 'errorCode' => 'InvalidOrganization.NotFound', - 'errorMessage' => 'The organization is not found.', - ], + ], + 'title' => 'Obtain the list of work hour types', + 'summary' => 'Retrieves a list of time types for work items.', + 'description' => 'Retrieves a list of time types for work items.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetWorkitemTimeTypeList'], ], ], - '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":""}]', + 'ramActions' => [], + '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"}]', ], - 'CreateHostGroup' => [ - 'summary' => '创建主机组', - 'path' => '/organization/{organizationId}/hostGroups', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'JoinPipelineGroup' => [ + 'summary' => 'Add a pipeline to a pipeline group.', + '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', - ], + 'schema' => ['description' => 'The enterprise identity, also known as the enterprise ID, is a string that can be obtained from the Alibaba Cloud DevOps access link, for example: https://devops.aliyun.com/organization/【OrganizationId】'."\n" + ."\n", 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx', 'title' => ''], ], [ - 'name' => 'type', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ECS', - 'enum' => [ - 'ECS', - ], - ], + 'name' => 'pipelineIds', + 'in' => 'query', + 'schema' => ['description' => 'Pipeline IDs, separated by commas if multiple.', 'type' => 'string', 'required' => true, 'example' => '122,122', 'title' => ''], ], [ - 'name' => 'envId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], + 'name' => 'groupId', + 'in' => 'query', + 'schema' => ['description' => 'The pipeline group ID. A value of 0 indicates that the pipeline will be set to ungrouped.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11', 'title' => ''], ], - [ - 'name' => 'name', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ + 'headers' => [], 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID. Each request has a unique value, which facilitates troubleshooting later.'."\n" + ."\n", 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['description' => 'error message', 'type' => 'string', 'example' => '""', 'title' => ''], + 'success' => ['description' => 'true indicates that the API call succeeded; false indicates that the API call failed.'."\n" + ."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'errorCode' => ['description' => 'error code', 'type' => 'string', 'example' => '""', 'title' => ''], + ], 'example' => '', ], ], + ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], + ], [ - 'name' => 'serviceConnectionId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123', - ], + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], + ['errorCode' => 'InvalidUser.UserNotInCurrentOrganization', 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', + 'title' => 'Add a pipeline to a pipeline group', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'JoinPipelineGroup'], ], + ], + 'ramActions' => [], + ], + 'LinkMergeRequestLabel' => [ + 'summary' => 'Associates labels with a merge request.', + 'path' => '/api/v4/projects/merge_requests/link_labels', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'tagIds', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '12,234', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ [ - 'name' => 'ecsType', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ECS_ALIYUN', - 'enum' => [ - 'ECS_ALIYUN', - ], - ], + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => ['title' => 'A short description of struct', 'description' => 'The organization ID. Find the organization ID in the URL of your organization in Alibaba Cloud DevOps. For example, if the URL is `https://devops.aliyun.com/organization/5ebbc0228123212b59xxxxx`, the organization ID is `5ebbc0228123212b59xxxxx`.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ - 'name' => 'ecsLabelKey', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ecs', - ], + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => ['description' => 'The personal access token. This parameter is not required if you authenticate using an Alibaba Cloud AccessKey pair or Security Token Service (STS).', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], ], [ - 'name' => 'ecsLabelValue', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ecs', - ], + 'name' => 'repositoryIdentity', + 'in' => 'query', + 'schema' => ['description' => 'The ID or full path of the repository.', 'type' => 'string', 'required' => true, 'example' => '2835387 或 codeup/codeup-demo', 'title' => ''], ], [ - 'name' => 'aliyunRegion', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'name' => 'localId', + 'in' => 'query', + 'schema' => ['description' => 'The local ID of the merge request, which is unique to the repository.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'machineInfos', - 'in' => 'formData', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'labelIds' => [ + 'description' => 'A list of label IDs to associate with the merge request.'."\n" + ."\n" + .'><notice>'."\n" + ."\n" + .'This is an overwrite operation. To retain existing labels, include their IDs in the request along with the new label IDs. Otherwise, this operation unlinks all existing labels.'."\n" + ."\n" + .'></notice>', + 'type' => 'array', + 'items' => ['description' => 'The ID of a label.', 'type' => 'string', 'required' => false, 'example' => 'f2bf0e0b4ce34a348b2d971c69a1d11f', 'title' => ''], + 'required' => true, + 'title' => '', + 'example' => '', + ], + ], 'required' => false, - 'example' => '[{"aliyunRegionId":"cn-beijing","machineSn":"i-sssssss","instanceName":"ceshi","ip":"120.0.0.0"}]', + 'title' => '', + 'example' => '', ], ], ], @@ -27960,1791 +14198,1192 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response schema.', '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', + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'success' => ['description' => 'Indicates whether the request succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'result' => [ + 'description' => 'The result of the request.', + 'type' => 'object', + 'properties' => [ + 'result' => ['description' => 'Indicates whether the operation successfully linked the labels.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + '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.', - ], + '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"}]', + 'title' => 'Associate Labels with Merge Request', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'LinkMergeRequestLabel'], ], ], - '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":""}]', + 'ramActions' => [], ], - 'DeleteHostGroup' => [ - 'summary' => '删除主机组', - 'path' => '/organization/{organizationId}/hostGroups/{id}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListAllReleaseWorkflows' => [ + 'summary' => 'Retrieves all release workflows for an app.', + 'path' => '/appstack/apps/{appName}/releaseWorkflows', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ 'name' => 'organizationId', - 'in' => 'path', - 'schema' => [ - 'title' => '企业标识,也称企业id,字符串形式,可在云效访问链接中获取,如 https:// devops.aliyun.com/organization/【OrgId】', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'in' => 'query', + 'schema' => ['description' => 'The ID of the organization.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '66c0c9fffeb86b450c199fcd', 'title' => ''], ], [ - 'name' => 'id', + 'name' => 'appName', 'in' => 'path', - 'schema' => [ - 'title' => '部署组Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '11222', - ], + 'schema' => ['description' => 'The name of the app.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'testApp'], ], ], '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', + 'title' => 'List<ReleaseWorkflow>', + 'description' => 'A list of release workflows.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'appName' => ['description' => 'The name of the app.', 'type' => 'string', 'title' => '', 'example' => 'testApp'], + 'sn' => ['description' => 'The unique identifier of the release workflow.', 'type' => 'string', 'title' => '', 'example' => 'ce51b31b996246ecaf874736838360b2'], + 'name' => ['description' => 'The name of the release workflow.', 'type' => 'string', 'title' => '', 'example' => '标准研发流程'], + 'order' => ['description' => 'The order of the release workflow.', 'type' => 'string', 'title' => '', 'example' => '1'], + 'releaseStages' => [ + 'title' => '', + 'description' => 'A list of release stages.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'appName' => ['description' => 'The name of the app.', 'type' => 'string', 'title' => '', 'example' => 'testApp'], + 'name' => ['description' => 'The name of the stage.', 'type' => 'string', 'title' => '', 'example' => '开发阶段'], + 'sn' => ['description' => 'The unique identifier of the release stage.', 'type' => 'string', 'title' => '', 'example' => '5aa8cc67e75e41bf9dddeb708775bcc3'], + 'releaseWorkflowSn' => ['description' => 'The unique identifier (sn) of the release workflow that contains this stage.', 'type' => 'string', 'title' => '', 'example' => 'ce51b31b996246ecaf874736838360b2'], + 'order' => ['description' => 'The order of the stage.', 'type' => 'string', 'title' => '', 'example' => '1'], + 'variableGroups' => [ + 'title' => '', + 'description' => 'A list of variable groups associated with the stage.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The name of the variable group.', 'type' => 'string', 'title' => '', 'example' => 'dev'], + 'displayName' => ['description' => 'The display name of the variable group.', 'type' => 'string', 'title' => '', 'example' => '开发环境变量组'], + 'type' => [ + 'description' => 'The type of the variable group. Valid values: `GLOBAL` for a global variable group and `APP` for an app variable group.', + 'type' => 'string', + 'enum' => ['GLOBAL', 'APP'], + 'title' => '', + 'example' => 'APP', + ], + ], + 'description' => 'The details of a variable group.', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'description' => 'The details of a release stage.', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'note' => ['description' => 'Notes about the release workflow.', 'type' => 'string', 'title' => '', 'example' => '""'], ], + 'description' => 'The details of a release workflow.', + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], ], - '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.', - ], + '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"}]', + 'title' => 'Retrieve all development flows under an application ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAllReleaseWorkflows'], ], ], - '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":""}]', + 'ramActions' => [], ], - 'UpdateHostGroup' => [ - 'summary' => '更新主机组', - 'path' => '/organization/{organizationId}/hostGroups/{id}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListAppReleaseStageExecutionIntegratedMetadata' => [ + 'summary' => 'Retrieves the integrated metadata for a release stage execution.', + 'path' => '/appstack/apps/{appName}/releaseWorkflows/{releaseWorkflowSn}/releaseStages/{releaseStageSn}/executions/{executionNumber}/integratedMetadata', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURErdcI0DEJM', - ], - ], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ 'name' => 'organizationId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the organization.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '66c0c9fffeb86b450c199fcd', 'title' => ''], + ], + [ + 'name' => 'appName', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'testApp'], ], [ - 'name' => 'type', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ECS', - 'enum' => [ - 'ECS', - ], - ], + 'name' => 'releaseWorkflowSn', + 'in' => 'path', + 'schema' => ['description' => 'The unique identifier of the release workflow.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ce51b31b996246ecaf874736838360b2'], ], [ - 'name' => 'envId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], + 'name' => 'releaseStageSn', + 'in' => 'path', + 'schema' => ['description' => 'The unique identifier of the release stage.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'e173f3c11db5445eb426ca33c92207c8'], ], [ - 'name' => 'name', - 'in' => 'formData', + 'name' => 'executionNumber', + 'in' => 'path', + 'schema' => ['title' => 'Execution Record Number of the R&D Stage ', 'description' => 'The execution number of the release stage.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, + 'title' => 'List<ReleaseStageInstanceIntegratedMetadataVO>', + 'description' => 'A list of integrated metadata objects.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'releaseBranch' => ['description' => 'The release branch.', 'type' => 'string', 'title' => '', 'example' => 'release/20240625-152603220321211_release_3252057_1'], + 'releaseRevision' => ['description' => 'The release revision.', 'type' => 'string', 'title' => '', 'example' => 'a66cfa8c6869b96bb7d111ba2144c9c764d556b7'], + 'repoUrl' => ['description' => 'The URL of the repository.', 'type' => 'string', 'title' => '', 'example' => 'https://codeup.aliyun.com/60d54f3daccf2bbd6659f3ad/auto-test.git'], + 'repoType' => ['description' => 'The repository type.', 'type' => 'string', 'title' => '', 'example' => 'CODEUP'], + 'changeRequests' => [ + 'title' => '', + 'description' => 'The change requests included in this release.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'sn' => ['description' => 'The unique identifier of the change request.', 'type' => 'string', 'title' => '', 'example' => 'fcd37726a6f84c60b7eb9c5856007c2f'], + 'name' => ['description' => 'The name of the change request.', 'type' => 'string', 'title' => '', 'example' => '变更名称'], + 'branchName' => ['description' => 'The branch associated with the change request.', 'type' => 'string', 'title' => '', 'example' => 'feature/20240625'], + 'commitId' => ['description' => 'The commit ID of the change request.', 'type' => 'string', 'title' => '', 'example' => 'a66cfa8c6869b96bb7d111ba2144c9c764d556b7'], + 'ownerAccountId' => ['description' => 'The owner\'s Alibaba Cloud account ID.', 'type' => 'string', 'title' => '', 'example' => '262579140573491041'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], 'example' => '', ], ], + ], + '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"}]', + 'title' => 'Query Integration Change Information of Execution Records in the R&D Stage ', + 'changeSet' => [ + ['createdAt' => '2024-06-28T02:06:37.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAppReleaseStageExecutionIntegratedMetadata'], + ], + ], + 'ramActions' => [], + ], + 'ListAppReleaseStageExecutions' => [ + 'summary' => 'Lists release stage executions.', + 'path' => '/appstack/apps/{appName}/releaseWorkflows/{releaseWorkflowSn}/releaseStages/{releaseStageSn}/executions', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'serviceConnectionId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list'], + 'parameters' => [ [ - 'name' => 'tagIds', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '12,23', - ], + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => ['description' => 'The organization ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '66c0c9fffeb86b450c199fcd', 'title' => ''], ], [ - 'name' => 'ecsType', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ECS_ALIYUN', - 'enum' => [ - 'ECS_ALIYUN', - ], - ], + 'name' => 'appName', + 'in' => 'path', + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'testApp'], ], [ - 'name' => 'ecsLabelKey', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ecs', - ], + 'name' => 'releaseWorkflowSn', + 'in' => 'path', + 'schema' => ['description' => 'The serial number (SN) of the release workflow.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '340beb481a334fd49b006816382f0c11'], ], [ - 'name' => 'ecsLabelValue', - 'in' => 'formData', + 'name' => 'releaseStageSn', + 'in' => 'path', + 'schema' => ['description' => 'The serial number (SN) of the release stage.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'e173f3c11db5445eb426ca33c92207c8'], + ], + [ + 'name' => 'pagination', + 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The pagination mode. Set this to `keyset` to use keyset pagination.', + 'enumValueTitles' => ['keyset' => 'keyset'], 'type' => 'string', 'required' => false, - 'example' => 'ecs', + 'example' => 'keyset', + 'title' => '', ], ], [ - 'name' => 'aliyunRegion', - 'in' => 'formData', + 'name' => 'perPage', + 'in' => 'query', + 'schema' => ['description' => 'The number of items to return per page. The value must be an integer from 1 to 100. Default: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'orderBy', + 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The property to sort the results by. Default: `gmtCreate`.', + 'enumValueTitles' => ['id' => 'id', 'gmtCreate' => 'gmtCreate'], 'type' => 'string', 'required' => false, - 'example' => 'cn-hangzhou', + 'example' => 'gmtCreate', + 'title' => '', ], ], [ - 'name' => 'machineInfos', - 'in' => 'formData', + 'name' => 'sort', + 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The sort order. Use `asc` for ascending order and `desc` for descending order. Default: `desc`.', + 'enumValueTitles' => ['asc' => 'asc', 'desc' => 'desc'], 'type' => 'string', 'required' => false, - 'example' => '[{"aliyunRegionId":"cn-beijing","machineSn":"i-sssssss","instanceName":"ceshi","ip":"120.0.0.0"}]', + 'example' => 'desc', + 'title' => '', ], ], [ - 'name' => 'id', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123', - ], + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['description' => 'The pagination token for keyset pagination. To retrieve the next page of results, pass the `nextToken` value from the previous response. Omit this parameter to retrieve the first page.', 'type' => 'string', 'required' => false, 'example' => '""', 'title' => ''], + ], + [ + 'name' => 'page', + 'in' => 'query', + 'schema' => ['description' => 'The page number to retrieve. This parameter is used for page number-based pagination and is ignored if `pagination` is set to `keyset`.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => 'PageList<ReleaseStageInstanceVO>', + 'description' => 'A paginated list of release stage executions.', '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', + 'nextToken' => ['description' => 'The pagination token used to retrieve the next page of results. This parameter is returned only for keyset pagination.', 'type' => 'string', 'title' => '', 'example' => 'vxc2341gfssad12'], + 'data' => [ + 'title' => '', + 'description' => 'An array of objects. Each object represents a release stage execution.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'number' => ['description' => 'The pipeline execution number.', 'type' => 'string', 'title' => '', 'example' => '1'], + 'state' => [ + 'description' => 'The pipeline execution state.', + 'type' => 'string', + 'enum' => ['RUNNING', 'SUCCESS', 'FAILED', 'CANCELED', 'UNKNOWN'], + 'title' => '', + 'example' => 'SUCCESS', + ], + 'triggerMode' => ['description' => 'The pipeline execution\'s trigger mode.', 'type' => 'string', 'title' => '', 'example' => 'MANUAL'], + 'startTime' => ['description' => 'The time when the pipeline execution started.', 'type' => 'string', 'title' => '', 'example' => '2024-06-25T07:25:54.000+00:00'], + 'endTime' => ['description' => 'The time when the pipeline execution ended.', 'type' => 'string', 'title' => '', 'example' => '2024-06-25T07:26:18.000+00:00'], + ], + 'description' => 'Details of a single release stage execution.', + 'title' => '', + 'example' => '', + ], + 'example' => '', ], + 'total' => ['description' => 'The total number of entries. This parameter is returned only for page number-based pagination.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '2'], + 'current' => ['description' => 'The current page number. This parameter is returned only for page number-based pagination.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], + 'perPage' => ['description' => 'The number of entries on the current page. This parameter is returned only for page number-based pagination.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '20'], + 'pages' => ['description' => 'The total number of pages. This parameter is returned only for page number-based pagination.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], ], + '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.', - ], + '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"}]', + 'title' => 'Batch query execution records of development stages', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAppReleaseStageExecutions'], ], ], - '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":""}]', + 'ramActions' => [], ], - 'GetHostGroup' => [ - 'summary' => '获取主机组信息', - 'path' => '/organization/{organizationId}/hostGroups/{id}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListApplicationMembers' => [ + 'summary' => 'Queries the member list for a specified application.', + 'path' => '/appstack/apps/{appName}/members', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'tags' => ['应用'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'organizationId', + 'name' => 'appName', 'in' => 'path', - 'schema' => [ - 'title' => '企业标识,也称企业id,字符串形式,可在云效访问链接中获取,如 https:// devops.aliyun.com/organization/【OrgId】', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'testApp', 'title' => ''], ], [ - 'name' => 'id', - 'in' => 'path', - 'schema' => [ - 'title' => '主机组id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '21221', - ], + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => ['description' => 'The organization ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '66c0c9fffeb86b450c199fcd', 'title' => ''], ], ], 'responses' => [ 200 => [ + 'description' => '分页查找完成(包括未查找到对象的情况)', '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', + 'total' => ['description' => 'The total count.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'current' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'pageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'pages' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'records' => [ + 'title' => '', + 'description' => 'The member list.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The member ID. If the member type is `User`, this value is the Alibaba Cloud UID of the member.', 'type' => 'string', 'example' => '1332695887xxxxxx', 'title' => ''], + 'type' => ['description' => 'The member type. Currently, only `User` is supported.', 'type' => 'string', 'example' => 'User', 'title' => ''], + 'displayName' => ['description' => 'The display name of the member.', 'type' => 'string', 'example' => '成员1', 'title' => ''], + 'description' => ['description' => 'The description of the member.', 'type' => 'string', 'example' => '成语描述', 'title' => ''], + 'avatar' => ['description' => 'The URL of the avatar.', 'type' => 'string', 'example' => 'http://', 'title' => ''], + 'roleList' => [ + 'title' => '', + 'description' => 'The member\'s role list.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The role name.', 'type' => 'string', 'example' => 'developer', 'title' => ''], + 'displayName' => ['description' => 'The display name of the role.', 'type' => 'string', 'example' => '开发者', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], - 'ecsLabelValue' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ecs', - ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], + 'requestId' => ['description' => 'The unique request ID, used for troubleshooting.', 'type' => 'string', 'example' => 'FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F', 'title' => ''], ], + 'description' => 'The response body.', + 'title' => '', + 'example' => '', ], ], + 500 => ['description' => '服务端内部异常'], ], - '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 \\"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"}]', + 'title' => 'Query application member list', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListApplicationMembers'], ], ], - '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":""}]', + 'ramActions' => [], ], - 'ListHostGroups' => [ - 'summary' => '获取主机组列表', - 'path' => '/organization/{organizationId}/hostGroups', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListApplications' => [ + 'summary' => 'Retrieves a list of applications.', + 'path' => '/appstack/apps:search', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'tags' => ['应用'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + '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' => 'ids', - 'in' => 'query', - 'schema' => [ - 'title' => '主机组id,多个逗号分割', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '121,1212121232', - ], - ], - [ - 'name' => 'createStartTime', + 'name' => 'pagination', 'in' => 'query', - 'schema' => [ - 'title' => '主机组创建时间', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1586863220000', - ], + 'schema' => ['description' => 'The pagination method. Currently, only `keyset` pagination is supported.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'keyset', 'title' => ''], ], [ - 'name' => 'createEndTime', + 'name' => 'perPage', 'in' => 'query', - 'schema' => [ - 'title' => '主机组结束时间', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1586863220000', - ], + 'schema' => ['description' => 'The maximum number of items to return per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '20', 'title' => ''], ], [ - 'name' => 'name', + 'name' => 'orderBy', 'in' => 'query', - 'schema' => [ - 'title' => '主机组名称', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '主机组', - ], + 'schema' => ['description' => 'The property to sort the results by. For consistent iteration, use the `id` property.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'id', 'title' => ''], ], [ - 'name' => 'creatorAccountIds', + 'name' => 'sort', 'in' => 'query', - 'schema' => [ - 'title' => '创建阿里云账号id,多个逗号分割', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1112122121,3223332', - ], + 'schema' => ['description' => 'The sort order. Valid values: `asc` (ascending) and `desc` (descending). Use ascending order for consistent iteration.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'asc', 'title' => ''], ], [ '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', - ], + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The token for keyset pagination. Omit this parameter for the first page. For subsequent pages, use the `nextToken` value from the previous response.', 'type' => 'string', 'example' => 'vxc2341gfssad12', 'title' => '', 'required' => false], ], [ - 'name' => 'pageOrder', + 'name' => 'organizationId', 'in' => 'query', - 'schema' => [ - 'title' => '排序顺序', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'DESC', - ], + 'schema' => ['description' => 'The organization ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '66c0c9fffeb86b450c199fcd', 'title' => ''], ], ], 'responses' => [ 200 => [ + 'description' => '分页查找完成(包括未查找到对象的情况)', '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' => '', + 'nextToken' => ['description' => 'The token for the next page. If this parameter is not returned, no more results are available.', 'type' => 'string', 'example' => 'vxc2341gfssad12', 'title' => ''], + 'data' => [ + 'description' => 'A list of applications.', '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', - ], + 'creatorAccountId' => ['description' => 'The Alibaba Cloud UID of the application creator.', 'type' => 'string', 'example' => '1332695887xxxxxx', 'title' => ''], + 'name' => ['description' => 'The application name.', 'type' => 'string', 'example' => 'testApp', 'title' => ''], + 'gmtCreate' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2024-01-01T00:00:00.000+00:00', 'title' => ''], + 'description' => ['description' => 'The application description.', 'type' => 'string', 'example' => '应用描述', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'totalCount' => [ - 'title' => '总数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '50', - ], - 'nextToken' => [ - 'title' => '分页token,空表示最后一页', - 'description' => '', - 'type' => 'string', - 'example' => 'asassasassa', - ], + 'requestId' => ['description' => 'A unique identifier for the request. Use this ID for troubleshooting.', 'type' => 'string', 'example' => 'FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 500 => ['description' => '服务端内部异常'], ], - '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 \\"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"}]', + 'title' => 'Query application list', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListApplications'], ], ], - '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":""}]', + 'ramActions' => [], ], - 'CreateVariableGroup' => [ - 'summary' => '创建变量组', - 'path' => '/organization/{organizationId}/variableGroups', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListChangeRequestWorkflowExecutions' => [ + 'summary' => 'Lists the execution records for a change request workflow.', + 'path' => '/appstack/apps/{appName}/changeRequests/{sn}/executions', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'list', 'autoTest' => false, 'notSupportAutoTestReason' => '数据面 api 经安全评估统一不做处理,后续逐步安排下线', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'organizationId', + 'in' => 'query', + 'schema' => ['description' => 'The organization ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '66c0c9fffeb86b450c199fcd', 'title' => ''], + ], + [ + 'name' => 'appName', 'in' => 'path', - 'schema' => [ - 'title' => '企业标识,也称企业id,字符串形式,可在云效访问链接中获取,如 https:// devops.aliyun.com/organization/【OrgId】', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test-app'], ], [ - 'name' => 'name', - 'in' => 'formData', - 'schema' => [ - 'title' => '变量组名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '变量组', - ], + 'name' => 'sn', + 'in' => 'path', + 'schema' => ['description' => 'The unique change identifier.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ce51b31b996246ecaf874736838360b2'], ], [ - 'name' => 'description', - 'in' => 'formData', + 'name' => 'perPage', + 'in' => 'query', + 'schema' => ['description' => 'Specifies the maximum number of records to return per page.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '20'], + ], + [ + 'name' => 'page', + 'in' => 'query', + 'schema' => ['description' => 'The page number to retrieve. The default is `1`.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'orderBy', + 'in' => 'query', 'schema' => [ - 'title' => '变量组描述', - 'description' => '', + 'description' => 'The attribute to use for sorting records. For consistent traversal, use the `id` attribute.', + 'enumValueTitles' => ['id' => 'id'], 'type' => 'string', + 'example' => 'id', + 'default' => 'id', + 'title' => '', 'required' => false, - 'example' => '变量组', ], ], [ - 'name' => 'variables', - 'in' => 'formData', + 'name' => 'sort', + 'in' => 'query', 'schema' => [ - 'title' => '变量信息json字符串 isEncrypted 是否加密 name 变量名称 value 变量值', - 'description' => '', + 'description' => 'The sort order. For consistent traversal, use `asc`.', + 'enumValueTitles' => ['asc' => 'Sorts the results in ascending order.', 'desc' => 'Sorts the results in descending order.'], 'type' => 'string', - 'required' => true, - 'example' => '[{"isEncrypted":true,"name":"name1","value":"vaue1"}]', + 'example' => 'desc', + 'default' => 'desc', + 'title' => '', + 'required' => false, ], ], + [ + 'name' => 'releaseWorkflowSn', + 'in' => 'query', + 'schema' => ['description' => 'The unique identifier of the release workflow.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ce51b31b996246ecaf874736838360b2'], + ], + [ + 'name' => 'releaseStageSn', + 'in' => 'query', + 'schema' => ['description' => 'The unique identifier of the release workflow stage.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'e173f3c11db5445eb426ca33c92207c8'], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Pagination<ChangeRequestExecutionVO>', + 'description' => 'A paginated list of execution records.', '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', + 'total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + 'current' => ['description' => 'The current page.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'pageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'pages' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'records' => [ + 'description' => 'The list of records.', + 'type' => 'array', + 'items' => ['description' => 'The record details.', 'type' => 'any', 'example' => '{"commit":{"id":"9ab34fe4c056"},"state":"RUNNING","runNumber":"123"}', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + '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.', - ], + '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"}]', + 'title' => 'Query the Execution History of a Change Request Development Flow', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListChangeRequestWorkflowExecutions'], ], ], - '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":""}]', + 'ramActions' => [], ], - 'DeleteVariableGroup' => [ - 'summary' => '删除变量组', - 'path' => '/organization/{organizationId}/variableGroups/{id}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListChangeRequests' => [ + 'summary' => 'Retrieves a list of change requests.', + 'path' => '/appstack/apps/{appName}/changeRequests', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'list', 'autoTest' => false, 'notSupportAutoTestReason' => '数据面 api 经安全评估统一不做处理,后续逐步安排下线', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'organizationId', - 'in' => 'path', - 'schema' => [ - 'title' => '企业标识,也称企业id,字符串形式,可在云效访问链接中获取,如 https:// devops.aliyun.com/organization/【OrgId】', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'in' => 'query', + 'schema' => ['description' => 'The organization ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '66c0c9fffeb86b450c199fcd', 'title' => ''], ], [ - 'name' => 'id', + 'name' => 'appName', '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.', - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'app-name'], ], [ - [ - 'errorCode' => 'InvalidOrganization.NotFound', - 'errorMessage' => 'The organization is not found.', + 'name' => 'pagination', + 'in' => 'query', + 'schema' => [ + 'description' => 'The pagination mode. Currently, only keyset pagination is supported.', + 'enumValueTitles' => ['keyset' => 'Keyset pagination.'], + 'type' => 'string', + 'required' => false, + 'example' => 'keyset', + 'default' => 'keyset', + 'title' => '', ], ], - ], - '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' => [], + 'name' => 'perPage', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of items to return per page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '20'], ], - ], - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ [ - 'name' => 'organizationId', - 'in' => 'path', + 'name' => 'orderBy', + 'in' => 'query', 'schema' => [ - 'title' => '企业标识,也称企业id,字符串形式,可在云效访问链接中获取,如 https:// devops.aliyun.com/organization/【OrgId】', - 'description' => '', + 'description' => 'The sort property. To ensure consistent traversal, we recommend setting this to `id`.', + 'enumValueTitles' => ['id' => 'id'], 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', + 'required' => false, + 'example' => 'id', + 'default' => 'desc', + 'title' => '', ], ], [ - 'name' => 'name', - 'in' => 'formData', + 'name' => 'sort', + 'in' => 'query', 'schema' => [ - 'title' => '变量组名称', - 'description' => '', + 'description' => 'The sort order. For consistent traversal, we recommend using ascending order.', + 'enumValueTitles' => ['asc' => 'ascending', 'desc' => 'descending'], 'type' => 'string', - 'required' => true, - 'example' => '变量组', + 'title' => '', + 'required' => false, + 'example' => 'desc', ], ], [ - 'name' => 'description', - 'in' => 'formData', + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['description' => 'The next token for keyset pagination. Omit this parameter for the first page. For subsequent pages, use the `nextToken` value from the previous response.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '4dc150725770510122396e2476'], + ], + [ + 'name' => 'stateList', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '变量组描述', - 'description' => '', - 'type' => 'string', + 'title' => '', + 'description' => 'Filters the results by one or more states.', + 'type' => 'array', + 'items' => [ + 'description' => 'The state value.', + 'enumValueTitles' => ['DEVELOPING' => 'DEVELOPING', 'RELEASED' => 'RELEASED', 'CLOSED' => 'CLOSED', 'INTEGRATING' => 'INTEGRATING'], + 'type' => 'string', + 'required' => false, + 'example' => 'DEVELOPING', + 'title' => '', + ], 'required' => false, - 'example' => '变量组', + 'example' => '', ], ], [ - 'name' => 'variables', - 'in' => 'formData', + 'name' => 'ownerIdList', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '变量信息json字符串 isEncrypted 是否加密 name 变量名称 value 变量值', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '[{"isEncrypted":true,"name":"name1","value":"vaue1"}]', + 'title' => '', + 'description' => 'Filters the results by one or more owner IDs.', + 'type' => 'array', + 'items' => ['description' => 'The owner ID.', 'type' => 'string', 'required' => false, 'example' => 'eycodj8dshsmf6ss65s', 'title' => ''], + 'required' => false, + 'example' => '', ], ], [ - 'name' => 'id', - 'in' => 'path', + 'name' => 'appNameList', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '变量组id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123', + 'title' => '', + 'description' => 'Filters the results by one or more application names.', + 'type' => 'array', + 'items' => ['description' => 'The application name.', 'type' => 'string', 'required' => false, 'example' => 'app-name', 'title' => ''], + 'required' => false, + 'example' => '', ], ], + [ + 'name' => 'displayNameKeyword', + 'in' => 'query', + 'schema' => ['description' => 'The keyword for a fuzzy search on display names.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'change1'], + ], + [ + 'name' => 'page', + 'in' => 'query', + 'schema' => ['description' => 'The page number to retrieve. This parameter is used for page-based pagination.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'PageList<ChangeRequestVO>', + 'description' => 'A paginated list of change request objects.', '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', + 'nextToken' => ['description' => 'The token to use to retrieve the next page of results. This field is returned for keyset pagination. To get the next page, pass this value in the `nextToken` parameter of your next request.', 'type' => 'string', 'title' => '', 'example' => 'eb13ac6049d3d78159d60f84af'], + 'data' => [ + 'title' => '', + 'description' => 'The list of paginated results.', + 'type' => 'array', + 'items' => ['description' => 'The change request information.', '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}', 'title' => ''], + 'example' => '', ], + 'total' => ['description' => 'The total count of results. This field is returned for page-based pagination.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'], + 'current' => ['description' => 'The current page number. This field is returned for page-based pagination.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], + 'perPage' => ['description' => 'The page size. This field is returned for page-based pagination.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '20'], + 'pages' => ['description' => 'The total number of pages. This field is returned for page-based pagination.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '5'], ], + '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.', - ], + '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"}]', + 'title' => 'Query the change list.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListChangeRequests'], ], ], - '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":""}]', + 'ramActions' => [], ], - 'GetVariableGroup' => [ - 'summary' => '获取变量组', - 'path' => '/organization/{organizationId}/variableGroups/{id}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListCheckRuns' => [ + 'summary' => 'Returns a paginated list of check runs.', + 'path' => '/api/v4/projects/check_runs/list_check_runs', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'organizationId', - 'in' => 'path', - 'schema' => [ - 'title' => '企业标识,也称企业id,字符串形式,可在云效访问链接中获取,如 https:// devops.aliyun.com/organization/【OrgId】', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'in' => 'query', + 'schema' => ['title' => 'A short description of struct', 'description' => 'The organization ID. You can find it in your Alibaba Cloud DevOps URL, for example, https\\://devops.aliyun.com/organization/\\[OrganizationId].', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ - 'name' => 'id', - 'in' => 'path', - 'schema' => [ - 'title' => '变量组id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123', - ], + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => ['description' => 'A personal access token. This parameter is not required if you use an AccessKey pair or temporary credentials from Security Token Service (STS).', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513'."\n", 'title' => ''], + ], + [ + 'name' => 'repositoryIdentity', + 'in' => 'query', + 'schema' => ['description' => 'The repository ID or full path.', 'type' => 'string', 'required' => true, 'example' => '2835387 或 codeup/codeup-demo', 'title' => ''], + ], + [ + 'name' => 'ref', + 'in' => 'query', + 'schema' => ['description' => 'A branch name, a tag name, or a commit ID.', 'type' => 'string', 'required' => true, 'example' => '40f4ccfe019cdd4a62d4acb0c57130106fc7e1be', 'title' => ''], + ], + [ + 'name' => 'page', + 'in' => 'query', + 'schema' => ['description' => 'The page number. The default value is 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of results to return per page. The default value is 20, and the value must be between 1 and 100.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response 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' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'result' => [ + 'description' => 'The list of results.', + 'type' => 'array', + 'items' => [ + 'description' => 'The result.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The unique ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'createdAt' => ['description' => 'The time when the check run was created.', 'type' => 'string', 'example' => '2022-01-14T21:08:26+08:00'."\n", 'title' => ''], + 'updatedAt' => ['description' => 'The time when the check run was last updated.', 'type' => 'string', 'example' => '2022-01-14T21:08:26+08:00'."\n", 'title' => ''], + 'startedAt' => ['description' => 'The time when the check run started.', 'type' => 'string', 'example' => '2023-03-15T08:00:00Z'."\n", 'title' => ''], + 'completedAt' => ['description' => 'The time when the check run was completed.', 'type' => 'string', 'example' => '2023-03-15T08:00:00Z'."\n", 'title' => ''], + 'externalId' => ['description' => 'The ID of the check run in the external system.', 'type' => 'string', 'example' => '42', 'title' => ''], + 'name' => ['description' => 'The name of the check run.', 'type' => 'string', 'example' => 'my-check-ci'."\n", 'title' => ''], + 'headSha' => ['description' => 'The commit ID.', 'type' => 'string', 'example' => '40f4ccfe019cdd4a62d4acb0c57130106fc7e1be', 'title' => ''], + 'status' => ['description' => 'The status of the check run. Valid values:'."\n" + ."\n" + .'- `queued`: The check run is in the queue.'."\n" + ."\n" + .'- `in_progress`: The check run is in progress.'."\n" + ."\n" + .'- `completed`: The check run is completed.', 'type' => 'string', 'example' => 'completed', 'title' => ''], + 'conclusion' => ['description' => 'The conclusion of the check run. Valid values:'."\n" + ."\n" + .'- `cancelled`: The check run was canceled.'."\n" + ."\n" + .'- `failure`: The check run failed.'."\n" + ."\n" + .'- `neutral`: The check run is neutral and is considered successful.'."\n" + ."\n" + .'- `success`: The check run was successful.'."\n" + ."\n" + .'- `skipped`: The check run was skipped and is considered successful.'."\n" + ."\n" + .'- `timed_out`: The check run timed out.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'detailsUrl' => ['description' => 'The URL of the details page of the third-party interactive system. The user determines the URL, and the platform provides only redirection.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'checkSuite' => [ + 'description' => 'The check suite.', 'type' => 'object', 'properties' => [ - 'id' => [ - 'title' => '关联的流水线Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'name' => [ - 'title' => '关联的流水线名称', - 'description' => '', - 'type' => 'string', - 'example' => '流水线', - ], + 'id' => ['description' => 'The unique ID of the check suite.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - ], - 'variables' => [ - 'title' => '变量', - 'description' => '', - 'type' => 'array', - 'items' => [ + 'writer' => [ + 'description' => 'The information about the writer.', 'type' => 'object', 'properties' => [ - 'value' => [ - 'title' => '变量值', - 'description' => '', - 'type' => 'string', - 'example' => 'value1', - ], - 'name' => [ - 'title' => '变量名', - 'description' => '', - 'type' => 'string', - 'example' => 'name1', - ], - 'isEncrypted' => [ - 'title' => '是否加密', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'id' => ['description' => 'The Alibaba Cloud account ID of the user.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'type' => ['description' => 'The type of the writer.'."\n" + ."\n" + .'- `User`: a user.', 'type' => 'string', 'example' => 'User', 'title' => ''], + 'name' => ['description' => 'The name of the writer.', 'type' => 'string', 'example' => 'test-codeup'."\n", 'title' => ''], + 'slug' => ['description' => 'The alias.', 'type' => 'string', 'example' => 'test-codeup'."\n", 'title' => ''], + 'logoUrl' => ['description' => 'The URL of the writer\'s avatar.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'output' => [ + 'description' => 'The information to display on the page.', + 'type' => 'object', + 'properties' => [ + 'title' => ['description' => 'The title of the UI module, which is different from the `name` parameter.', 'type' => 'string', 'example' => 'Mighty Readme report'."\n", 'title' => ''], + 'summary' => ['description' => 'The summary of the check run.'."\n" + ."\n" + .'> This field supports Markdown and the maximum length is 65,535 characters (64 KB).', 'type' => 'string', 'example' => '摘要信息内容', 'title' => ''], + 'text' => ['description' => 'The details of the check run.'."\n" + ."\n" + .'> This field supports Markdown and the maximum length is 65,535 characters (64 KB).', 'type' => 'string', 'example' => '详情信息内容', 'title' => ''], + 'images' => [ + 'description' => 'The list of images.'."\n" + ."\n" + .'> A check run can display images in the output module.', + 'type' => 'array', + 'items' => [ + 'description' => 'The image information.', + 'type' => 'object', + 'properties' => [ + 'alt' => ['description' => 'The alternative text for the image.', 'type' => 'string', 'example' => 'test-image-alt'."\n", 'title' => ''], + 'imageUrl' => ['description' => 'The URL of the image. You must ensure that the URL is valid. Otherwise, the image cannot be displayed.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'caption' => ['description' => 'A short description of the image.', 'type' => 'string', 'example' => 'test', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', + ], + 'annotations' => [ + 'description' => 'The list of check annotations.', + 'type' => 'array', + 'items' => [ + 'description' => 'The check annotation.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The unique ID of the check annotation.', 'type' => 'integer', 'format' => 'int64', 'example' => '11806', 'title' => ''], + 'path' => ['description' => 'The file path.', 'type' => 'string', 'example' => 'demo/test.txt'."\n", 'title' => ''], + 'startLine' => ['description' => 'The start line.'."\n" + ."\n" + .'> The value starts from 1. You must ensure that the line number is valid. Otherwise, the annotation cannot be displayed.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'endLine' => ['description' => 'The end line.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'startColumn' => ['description' => 'The start column.'."\n" + ."\n" + .'> This parameter is valid only when `startLine` and `endLine` are the same.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'endColumn' => ['description' => 'The end column.'."\n" + ."\n" + .'> This parameter is valid only when `startLine` and `endLine` are the same.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], + 'annotationLevel' => ['description' => 'The level of the check annotation. Valid values:'."\n" + ."\n" + .'- `notice`: minor'."\n" + ."\n" + .'- `warning`: warning'."\n" + ."\n" + .'- `failure`: severe', 'type' => 'string', 'example' => 'warning', 'title' => ''], + 'message' => ['description' => 'A short description.', 'type' => 'string', 'example' => '回写检查注释的简要描述信息'."\n", 'title' => ''], + 'title' => ['description' => 'The title of the check annotation.', 'type' => 'string', 'example' => '检查注释的标题', 'title' => ''], + 'rawDetails' => ['description' => 'The details, with a maximum size of 64 KB.', 'type' => 'string', 'example' => '详情信息'."\n", 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1586863220000', - ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + '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.', - ], + '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"}]', + 'title' => 'Query the list of check runs ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCheckRuns'], ], ], - '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":""}]', + 'ramActions' => [], ], - 'ListVariableGroups' => [ - 'summary' => '获取变量组列表', - 'path' => '/organization/{organizationId}/variableGroups', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListCommitStatuses' => [ + 'summary' => 'Gets a paginated list of commit statuses.', + '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' => [], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'organizationId', - 'in' => 'path', - 'schema' => [ - 'title' => '企业标识,也称企业id,字符串形式,可在云效访问链接中获取,如 https:// devops.aliyun.com/organization/【OrgId】', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'in' => 'query', + 'schema' => ['title' => 'A short description of struct', 'description' => 'The organization ID. You can obtain the ID from the URL of your organization in Alibaba Cloud DevOps. The URL is in the format `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ - 'name' => 'pageSort', + 'name' => 'accessToken', 'in' => 'query', - 'schema' => [ - 'title' => '排序条件', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ID', - ], + 'schema' => ['description' => 'The personal access token. This parameter is not required if you use an Alibaba Cloud AccessKey pair or Security Token Service (STS) credentials to authenticate your identity.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], ], [ - 'name' => 'pageOrder', + 'name' => 'repositoryIdentity', 'in' => 'query', - 'schema' => [ - 'title' => '排序顺序', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'DESC', - ], + 'schema' => ['description' => 'The ID or full path of the repository.', 'type' => 'string', 'required' => true, 'example' => '2835387 或 codeup/codeup-demo', 'title' => ''], ], [ - 'name' => 'nextToken', + 'name' => 'sha', 'in' => 'query', - 'schema' => [ - 'title' => '分页token,上一次请求的出参nextToken', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'aaaaaa', - ], + 'schema' => ['description' => 'The commit ID. You must provide the SHA value of the commit.', 'type' => 'string', 'required' => true, 'example' => '61cc69557962d29f737a91730b3e86f497f083a3', 'title' => ''], ], [ - 'name' => 'maxResults', + 'name' => 'page', 'in' => 'query', - 'schema' => [ - 'title' => '最大返回数,默认30', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 20. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], ], ], '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' => '', + 'title' => 'Schema of Response', + 'description' => 'The root object of the response.', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`'."\n" + ."\n" + .'- `false`', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'total' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '28', 'title' => ''], + 'result' => [ + 'description' => 'The list of commit statuses.', 'type' => 'array', 'items' => [ + 'description' => 'The commit status objects.', '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', + 'id' => ['description' => 'The ID of the status. This ID is for internal use only.', 'type' => 'integer', 'format' => 'int64', 'example' => '19285', 'title' => ''], + 'sha' => ['description' => 'The commit ID.', 'type' => 'string', 'example' => '61cc69557962d29f737a91730b3e86f497f083a3', 'title' => ''], + 'context' => ['description' => 'A string that identifies the system that created the status. The string is displayed as a title in the UI. The default value is `default`. The value is case-insensitive and must be 50 characters or less.', 'type' => 'string', 'example' => 'test-commit-status-context', 'title' => ''], + 'state' => ['description' => 'The status. Valid values:'."\n" + ."\n" + .'- `error`: An error occurred.'."\n" + ."\n" + .'- `failure`: The operation failed.'."\n" + ."\n" + .'- `pending`: The operation is in progress.'."\n" + ."\n" + .'- `success`: The operation was successful.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'targetUrl' => ['description' => 'The target URL for the status. The UI includes a link to this URL. You can point this to a third-party system.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'description' => ['description' => 'A brief description of the commit status. The description must be 3,000 characters or less.', 'type' => 'string', 'example' => '描述信息的具体内容'."\n", 'title' => ''], + 'creator' => [ + 'description' => 'Details about the user or application that created the commit status.', + 'type' => 'object', + 'properties' => [ + 'aliyunPk' => ['description' => 'The Alibaba Cloud account ID. This parameter is empty if the value of `type` is `Bot`.', 'type' => 'string', 'example' => '235671547828975455', 'title' => ''], + 'login' => ['description' => 'The login name. If `type` is `User`, this parameter indicates the username. If `type` is `Bot`, this parameter indicates the application name.', 'type' => 'string', 'example' => 'codeup', 'title' => ''], + 'avatarUrl' => ['description' => 'The avatar URL.', 'type' => 'string', 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', 'title' => ''], + 'type' => ['description' => 'The type of the creator. Valid values:'."\n" + ."\n" + .'- `User`: a regular user'."\n" + ."\n" + .'- `Bot`: an application', 'type' => 'string', 'example' => 'User', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], - ], - 'totalCount' => [ - 'title' => '变量组总数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - ], - 'nextToken' => [ - 'title' => '下一次查询的token,为空表示最后一页', - 'description' => '', - 'type' => 'string', - 'example' => 'assassa', + 'title' => '', + 'example' => '', ], ], + '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.', - ], + '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"}]', + 'title' => 'Query commit status List ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCommitStatuses'], ], ], - '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":""}]', + 'ramActions' => [], ], - 'CreatePipeline' => [ - 'summary' => '创建流水线。', - 'path' => '/organization/{organizationId}/pipelines', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListFlowTagGroups' => [ + 'summary' => 'Retrieve the list of pipeline categorizations.', + 'path' => '/organization/{organizationId}/flow/tagGroups', + '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' => 'name', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - ], - [ - 'name' => 'content', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], + 'schema' => ['title' => '', 'description' => 'The enterprise identity, also known as the enterprise ID, is a string that can be obtained from the Alibaba Cloud DevOps access link, such as https://devops.aliyun.com/organization/【OrganizationId】', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], ], 'responses' => [ @@ -29754,1057 +15393,1392 @@ '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", + 'requestId' => ['title' => '', 'description' => 'Request ID. Each request has a unique value, which facilitates troubleshooting later.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => '”“'], + 'success' => ['title' => '', 'description' => 'true if the API call succeeded, false if the API call failed.', 'type' => 'boolean', 'example' => 'true 接口调用成功,false 接口调用失败'], + 'errorCode' => ['title' => '', 'description' => 'Error code', 'type' => 'string', 'example' => '”“'], + 'flowTagGroups' => [ + 'title' => '', + 'description' => 'Tag categorization', + 'type' => 'array', + 'items' => [ + 'description' => 'Tag categorization', + 'type' => 'object', + 'properties' => [ + 'id' => ['title' => '', 'description' => 'Tag categorization ID', 'type' => 'integer', 'format' => 'int64', 'example' => '111'], + 'name' => ['title' => '', 'description' => 'Tag categorization name', 'type' => 'string', 'example' => '标签名称'], + 'creatorAccountId' => ['title' => '', 'description' => 'Creator', 'type' => 'string', 'example' => '111111111'], + 'modiferAccountId' => ['title' => '', 'description' => 'Updated By', 'type' => 'string', 'example' => '11111111'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], ], + '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.', - ], + ['errorCode' => 'InvalidCluster.NotFound', 'errorMessage' => 'No cluster is available to generate the workspace.', 'description' => 'No cluster is available to generate the workspace.'], + ['errorCode' => 'InvalidCodeUrl.NotSupportSVN', 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', 'description' => 'The parameter codeUrl is invalid. SVN is not supported.'], + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidResource.NotFound', 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', 'description' => 'No resource is found. You cannot create the workspace. Please try again later.'], + ['errorCode' => 'InvalidResourceRole.NotFoun', 'errorMessage' => 'The member role is invalid.', 'description' => 'The member role is invalid.'], + ['errorCode' => 'InvalidResourceRole.NotFound', 'errorMessage' => 'The member role is invalid.', 'description' => ''], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => 'The user that is invoking the API service is not a registered user.'], + ['errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', 'errorMessage' => 'Resource owner cannot be deleted.', 'description' => 'The resource owner cannot be deleted.'], + ['errorCode' => 'InvalidUser.ResourceMemberNotExists', 'errorMessage' => 'The resource member does not exist.', 'description' => 'The resource member does not exist.'], + ['errorCode' => 'InvalidUser.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization.', 'description' => '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.', 'description' => 'The workspace status is invalid. You can only operate workspaces with the SUCCESS status.'], + ['errorCode' => 'InvalidWorkspaceTemplate.NotFound', 'errorMessage' => 'The parameter workspaceTemplate is not found.', 'description' => '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' => 'Forbidden.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], ], [ - [ - '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' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], + ['errorCode' => 'InvalidPipeline.NotFound', 'errorMessage' => 'The pipeline is not found.', 'description' => 'The pipeline does not exist.'], + ['errorCode' => 'InvalidPipelineRun.NotFound', 'errorMessage' => 'The pipeline execution instance is not found.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'InvalidWorkspace.NotFound', 'errorMessage' => 'The workspace is not found.', 'description' => 'The workspace 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', + '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"}]', + 'title' => 'Obtain the pipeline categorization list', + 'changeSet' => [ + ['createdAt' => '2021-12-15T03:07:17.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListFlowTagGroups'], + ], ], + 'ramActions' => [], + ], + 'ListGroupMember' => [ + 'summary' => 'Retrieves a list of members in a code group. The results are not paginated or sorted.', + 'path' => '/repository/groups/{groupId}/list', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', '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', - ], + 'in' => 'query', + 'schema' => ['title' => 'A short description of struct', 'description' => 'The organization ID. You can obtain the organization ID from your Alibaba Cloud DevOps URL, for example, `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'required' => true, 'example' => '632bbfdf419338aaa2b1360a'], ], [ - 'name' => 'pipelineId', + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => ['description' => 'The personal access token. This parameter is not required if you use an Alibaba Cloud AccessKey pair or Security Token Service (STS) for temporary authorization.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513'."\n", 'title' => ''], + ], + [ + 'name' => 'groupId', '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', - ], + 'schema' => ['description' => 'The primary key ID of the code group.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '22901', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response object.', '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', + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'C8F8B434-B006-59FB-8B9C-0382CF3D5680'], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '”“', 'title' => ''], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'result' => [ + 'description' => 'An array of objects, where each object represents a member.', + 'type' => 'array', + 'items' => [ + 'description' => 'A member object. The fields below are properties of each object in the result array.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The Codeup user ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', 'title' => ''], + 'name' => ['description' => 'The user name.', 'type' => 'string', 'example' => 'test-codeup', 'title' => ''], + 'username' => ['description' => 'The username.', 'type' => 'string', 'example' => 'test-codeup-nickname', 'title' => ''], + 'state' => ['description' => 'The state of the member. Valid values: `active` and `blocked`.', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'avatarUrl' => ['description' => 'The avatar URL.', 'type' => 'string', 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', 'title' => ''], + 'email' => ['description' => 'The email address.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + 'accessLevel' => ['description' => 'The access level.'."\n" + ."\n" + .'- `20`: Guest'."\n" + ."\n" + .'- `30`: Developer'."\n" + ."\n" + .'- `40`: Master', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'memberType' => ['description' => 'The member type. Valid values: `TEAMS` (department) and `USERS` (employee). The default is `USERS`.', 'type' => 'string', 'example' => 'USERS', 'title' => ''], + 'sourceId' => ['description' => 'The ID of the associated source. For this operation, this is the ID of the code group.', 'type' => 'integer', 'format' => 'int64', 'example' => '223241', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + '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.', - ], + '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\\": \\"username@example.com\\",\\n \\"accessLevel\\": 30,\\n \\"memberType\\": \\"USERS\\",\\n \\"sourceId\\": 223241\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query group member list ', + 'changeSet' => [ + ['createdAt' => '2023-07-24T06:14:48.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListGroupMember'], ], ], - '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":""}]', + 'ramActions' => [], ], - 'DeletePipelineRelations' => [ - 'summary' => '删除流水线关联', - 'path' => '/organization/{organizationId}/{pipelineId}/pipelineRelations', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListGroupRepositories' => [ + 'summary' => 'Retrieves a list of repositories for a given group ID.', + 'path' => '/repository/groups/{groupId}/projects', + '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', - ], + 'in' => 'query', + 'schema' => ['description' => 'The ID of the organization. You can obtain the organization ID from the URL of the organization\'s homepage in the console. The URL is in the following format: https\\://devops.aliyun.com/organization/{organizationId}.', 'type' => 'string', 'required' => true, 'example' => '60ee8a814690c27532d412f8', 'title' => ''], ], [ - 'name' => 'pipelineId', + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => ['description' => 'The personal access token. If you use an AccessKey pair or STS for temporary authorization, you do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], + ], + [ + 'name' => 'groupId', 'in' => 'path', - 'schema' => [ - 'title' => '流水线ID,可在流水线链接中获取,如https://flow.aliyun.com/pipelines/【PipelineId】/current', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '11', - ], + 'schema' => ['description' => 'The unique ID of the group.', 'type' => 'string', 'required' => true, 'example' => '35117', 'title' => ''], ], [ - 'name' => 'relObjectType', + 'name' => 'page', 'in' => 'query', - 'schema' => [ - 'title' => '关联的资源类型,目前只支持VARIABLE_GROUP', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'VARIABLE_GROUP', - 'enum' => [ - 'VARIABLE_GROUP', - ], - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'relObjectId', + 'name' => 'pageSize', 'in' => 'query', - 'schema' => [ - 'title' => '关联的资源id,目前只支持变量组id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '11', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 20. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'search', + 'in' => 'query', + 'schema' => ['description' => 'The keyword for searching for code groups by name.', 'type' => 'string', 'required' => false, 'example' => 'Demo', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'title' => 'Schema of Response', + 'description' => 'Response 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', + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '9293CBDA-B5BC-5AD6-A8F4-C7873AC7A3DF'], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'result' => [ + 'description' => 'The list of results.', + 'type' => 'array', + 'items' => [ + 'description' => 'A repository object.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The repository ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '89616', 'title' => ''], + 'name' => ['description' => 'The repository name.', 'type' => 'string', 'example' => 'test-group-repo', 'title' => ''], + 'path' => ['description' => 'The repository path.', 'type' => 'string', 'example' => 'test-group-repo', 'title' => ''], + 'nameWithNamespace' => ['description' => 'The full repository name, including the full group name.', 'type' => 'string', 'example' => 'codeup-test-org / test-group-repo(斜杠两侧有空格)', 'title' => ''], + 'pathWithNamespace' => ['description' => 'The full repository path, including the full group path.', 'type' => 'string', 'example' => 'codeup-test-org/test-group-repo', 'title' => ''], + 'lastActivityAt' => ['description' => 'The timestamp of the last activity.', 'type' => 'string', 'example' => '2022-03-18 14:24:54', 'title' => ''], + 'createdAt' => ['description' => 'The creation timestamp.', 'type' => 'string', 'example' => '2022-03-18 14:24:54', 'title' => ''], + 'updatedAt' => ['description' => 'The last update timestamp.', 'type' => 'string', 'example' => '2022-03-18 14:24:54', 'title' => ''], + 'visibilityLevel' => ['description' => 'The visibility level of the repository.<br>0: Private. The repository is visible only to its members.<br>10: Internal. The repository is visible to all users in the enterprise.<br><br>', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'starCount' => ['description' => 'The number of times the repository has been starred.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'webUrl' => ['description' => 'The URL for the repository\'s web page.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'sshUrl' => ['description' => 'The SSH clone URL for the repository.', 'type' => 'string', 'example' => 'git@xxx:xxx/test/test.git', 'title' => ''], + 'httpUrl' => ['description' => 'The HTTP clone URL for the repository.', 'type' => 'string', 'example' => 'https://xxx/test/test', 'title' => ''], + 'description' => ['description' => 'The repository description.', 'type' => 'string', 'example' => '描述详情内容', 'title' => ''], + 'privateFlag' => ['description' => 'Indicates whether the repository is private.'."\n" + ."\n" + .'- `true`: Private.'."\n" + ."\n" + .'- `false`: Internal.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'creatorId' => ['description' => 'The ID of the user who created the repository.', 'type' => 'integer', 'format' => 'int64', 'example' => '19238', 'title' => ''], + 'issuesEnabled' => ['description' => 'Indicates whether issues are enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'mergeRequestsEnabled' => ['description' => 'Indicates whether merge requests are enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'wikiEnabled' => ['description' => 'Indicates whether the wiki is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'namespaceId' => ['description' => 'The ID of the group or enterprise to which the repository belongs.', 'type' => 'boolean', 'example' => '100003', 'title' => ''], + 'snippetsEnabled' => ['description' => 'Indicates whether snippets are enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'importUrl' => ['description' => 'The URL of a repository to import, such as a GitHub repository URL.', 'type' => 'string', 'example' => 'http://xxx/x', 'title' => ''], + 'archived' => ['description' => 'Indicates whether the repository is archived.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'commitCount' => ['description' => 'The number of commits in the repository.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'isStared' => ['description' => 'Indicates whether the repository is starred by the current user.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + '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.', - ], + '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"}]', + 'title' => 'Query the List of Repositories under a Code Group', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListGroupRepositories'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true\\n}","type":"json"}]', + 'ramActions' => [], ], - 'UpdatePipeline' => [ - 'summary' => '更新流水线。', - 'path' => '/organization/{organizationId}/pipelines/update', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListHostGroups' => [ + 'summary' => 'You can obtain the host group list.', + 'path' => '/organization/{organizationId}/hostGroups', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['title' => '', 'description' => 'Organization identity, also known as organization ID, in string format. You can obtain it from the Alibaba Cloud DevOps access link, for example: https://devops.aliyun.com/organization/【OrgId】', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], + ], + [ + 'name' => 'ids', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Host group IDs, separated by commas ', 'type' => 'string', 'required' => false, 'example' => '121,1212121232'], + ], + [ + 'name' => 'createStartTime', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Host group creation time', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1586863220000'], + ], + [ + 'name' => 'createEndTime', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Host group end time', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1586863220000'], ], [ 'name' => 'name', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Host group Name ', 'type' => 'string', 'required' => false, 'example' => '主机组'], ], [ - 'name' => 'content', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], + 'name' => 'creatorAccountIds', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Alibaba Cloud account IDs of the creators, separated by commas ', 'type' => 'string', 'required' => false, 'example' => '1112122121,3223332'], ], [ - 'name' => 'pipelineId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '111xxx', - ], + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Paging token ', 'type' => 'string', 'required' => false, 'example' => '221212221'], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Number of results to return ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30'], + ], + [ + 'name' => 'pageSort', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Sorting condition ID', 'type' => 'string', 'required' => false, 'example' => 'ID'], + ], + [ + 'name' => 'pageOrder', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Sorting order: DESC for descending, ASC for ascending', 'type' => 'string', 'required' => false, 'example' => 'DESC'], ], ], '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', + 'requestId' => ['title' => '', 'description' => 'The request ID. Each request has a unique value, which facilitates troubleshooting later.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => '""'], + 'errorCode' => ['title' => '', 'description' => 'Error code', 'type' => 'string', 'example' => '""'], + 'success' => ['title' => '', 'description' => 'true indicates that the API call succeeded; false indicates that the API call failed.', 'type' => 'boolean', 'example' => 'true'], + 'hostGroups' => [ + 'title' => '', + 'description' => 'Host group', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'creatorAccountId' => ['title' => '', 'description' => 'Creator Alibaba Cloud account ID ', 'type' => 'string', 'example' => '2222222222222'], + 'updateTime' => ['title' => '', 'description' => 'Update Time', 'type' => 'integer', 'format' => 'int64', 'example' => '1586863220000'], + 'hostNum' => ['title' => '', 'description' => 'Number of hosts', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'modifierAccountId' => ['title' => '', 'description' => 'Updated By Alibaba Cloud account ID ', 'type' => 'string', 'example' => '211111111'], + 'description' => ['title' => '', 'description' => 'Description', 'type' => 'string', 'example' => '主机组'], + 'type' => ['title' => '', 'description' => 'Type', 'type' => 'string', 'example' => 'ECS'], + 'createTime' => ['title' => '', 'description' => 'Host creation time ', 'type' => 'integer', 'format' => 'int64', 'example' => '1586863220000'], + 'ecsType' => ['title' => '', 'description' => 'Host type', 'type' => 'string', 'example' => 'ECS_ALIYUN'], + 'aliyunRegion' => ['title' => '', 'description' => 'Alibaba Cloud region', 'type' => 'string', 'example' => 'cn-beijing'], + 'ecsLabelKey' => ['title' => '', 'description' => 'ECS label key ', 'type' => 'string', 'example' => 'ecs'], + 'name' => ['title' => '', 'description' => 'Deployment group name ', 'type' => 'string', 'example' => '部署组'], + 'id' => ['title' => '323232', 'description' => '323232', 'type' => 'integer', 'format' => 'int64', 'example' => '444xxxx'], + 'serviceConnectionId' => ['title' => '', 'description' => 'Service connection ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '1212122'], + 'ecsLabelValue' => ['title' => '', 'description' => 'ECS tag value', 'type' => 'string', 'example' => 'value'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', ], + 'totalCount' => ['title' => '', 'description' => 'Total count', 'type' => 'integer', 'format' => 'int64', 'example' => '50'], + 'nextToken' => ['title' => '', 'description' => 'The paging token. An empty value indicates the last page.', 'type' => 'string', 'example' => 'asassasassa'], ], + 'description' => '', + 'title' => '', + '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.', - ], + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => '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' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], ], [ - [ - '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' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Obtain the host group list', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListHostGroups'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"success\\": true,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\"\\n}","type":"json"}]', + 'ramActions' => [], ], - 'StartPipelineRun' => [ - 'summary' => '运行流水线', - 'path' => '/organizations/{organizationId}/pipelines/{pipelineId}/run', - 'methods' => [ - 'post', + 'ListJoinedOrganizations' => [ + 'summary' => 'Lists the organizations that the current account has joined.', + '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>', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '11D0EE6E-5803-5D4C-A652-E672BE1F3D8F', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'organizations' => [ + 'description' => 'The organizations that the current account has joined.', + 'type' => 'array', + 'items' => [ + 'description' => 'An organization object.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The organization ID.', 'type' => 'string', 'example' => '65f25d0fa54c216dcf6b1dbd', 'title' => ''], + 'name' => ['description' => 'The organization name.', 'type' => 'string', 'example' => '云效测试企业', 'title' => ''], + 'isOrgAdmin' => ['description' => 'Indicates whether the user is an organization administrator.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], ], - 'schemes' => [ - 'http', - 'https', + '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"}]', + 'title' => 'Query the list of joined enterprises', + 'changeSet' => [ + ['createdAt' => '2024-03-29T08:50:16.000Z', 'description' => 'Response parameters changed'], ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListJoinedOrganizations'], + ], + ], + 'ramActions' => [], + ], + 'ListMergeRequestComments' => [ + 'summary' => 'Retrieve an unpaginated list of comments for a merge request. Comments can be nested up to three levels deep.', + 'path' => '/api/v4/projects/merge_requests/comments/list_comments', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'organizationId', - 'in' => 'path', - 'schema' => [ - 'title' => '企业标识,也称企业id,字符串形式,可在云效访问链接中获取,如 https:// devops.aliyun.com/organization/【OrgId】', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'in' => 'query', + 'schema' => ['title' => 'A short description of struct', 'description' => 'The organization ID. You can find it in the URL when you access Alibaba Cloud DevOps. The URL is in the format https\\://devops.aliyun.com/organization/{organizationId}.', 'type' => 'string', 'required' => true, 'example' => '60de7a6852743a5162b5f957'], ], [ - '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' => 'accessToken', + 'in' => 'query', + 'schema' => ['description' => 'The personal access token. This parameter is not required if you use an Alibaba Cloud AK/SK or STS temporary authorization for authentication.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], ], [ - 'name' => 'params', - 'in' => 'formData', + 'name' => 'repositoryIdentity', + 'in' => 'query', + 'schema' => ['description' => 'The ID or full path of the repository.', 'type' => 'string', 'required' => true, 'example' => '2835387 或 codeup/codeup-demo', 'title' => ''], + ], + [ + 'name' => 'localId', + 'in' => 'query', + 'schema' => ['description' => 'The local ID of the merge request. This ID is unique within the repository.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', '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" } }', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'patchSetBizIds' => [ + 'description' => 'A list of business IDs for the patch sets.'."\n" + ."\n" + .'> Each comment belongs to a specific patch set. A global comment belongs to the latest patch set from the source branch.', + 'type' => 'array', + 'items' => ['description' => 'The business ID of the patch set.', 'type' => 'string', 'required' => false, 'example' => '5e733626d53f4b04a6aa0e23d4ff72b8', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'commentType' => ['description' => 'The type of the comment. Valid values:'."\n" + ."\n" + .'- GLOBAL\\_COMMENT: A global comment on the merge request.'."\n" + ."\n" + .'- INLINE\\_COMMENT: An inline comment on a specific line in a file.', 'type' => 'string', 'required' => false, 'example' => 'GLOBAL_COMMENT', 'title' => ''], + 'filePath' => ['description' => 'The file path.', 'type' => 'string', 'required' => false, 'example' => '/src/main/test.java', 'title' => ''], + 'state' => ['description' => 'The comment state. Valid values:'."\n" + ."\n" + .'- DRAFT: The comment is a draft.'."\n" + ."\n" + .'- OPENED: The comment is published.', 'type' => 'string', 'required' => false, 'example' => 'OPENED', 'title' => ''], + 'resolved' => ['description' => 'Indicates if the comment thread is resolved.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response body.', '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' => '""', + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '56C33A95-C04F-59F0-B3CD-E2A2EB9FADBB'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'errorCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => 'Openapi.RequestError', 'title' => ''], + 'errorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'result' => [ + 'description' => 'The list of results.', + 'type' => 'array', + 'items' => [ + 'description' => 'A comment object.'."\n" + ."\n" + .'><notice>'."\n" + ."\n" + .'A comment structure of up to three levels is supported. Comments that exceed this depth are not returned.'."\n" + ."\n" + .'></notice>', + 'type' => 'object', + 'properties' => [ + 'commentBizId' => ['description' => 'The unique business ID of the comment.', 'type' => 'string', 'example' => '5c399e3685e542a28db16d93e9f82abb', 'title' => ''], + 'commentType' => ['description' => 'The comment type. Valid values:'."\n" + ."\n" + .'- `GLOBAL_COMMENT`: a global comment.'."\n" + ."\n" + .'- `INLINE_COMMENT`: an inline comment.', 'type' => 'string', 'example' => 'GLOBAL_COMMENT', 'title' => ''], + 'state' => ['description' => 'The comment state. Valid values:'."\n" + ."\n" + .'- `DRAFT`: a draft.'."\n" + ."\n" + .'- `OPENED`: The comment is published.', 'type' => 'string', 'example' => 'OPENED', 'title' => ''], + 'resolved' => ['description' => 'Indicates whether the comment thread is resolved.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'deleted' => ['description' => 'Indicates whether the comment is deleted.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'commentTime' => ['description' => 'The time when the comment was created.', 'type' => 'string', 'example' => '2022-03-18 14:24:54'."\n", 'title' => ''], + 'lastEditTime' => ['description' => 'The time when the comment was last edited.', 'type' => 'string', 'example' => '2022-03-18 14:24:54'."\n", 'title' => ''], + 'content' => ['description' => 'The content of the comment, in rich text format.', 'type' => 'string', 'example' => '{\\"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\\"]]]]}', 'title' => ''], + 'author' => [ + 'description' => 'The author of the comment.', + 'type' => 'object', + 'properties' => [ + 'aliyunPk' => ['description' => 'The Alibaba Cloud account ID.', 'type' => 'string', 'example' => '284692704493684695', 'title' => ''], + 'name' => ['description' => 'The user name.', 'type' => 'string', 'example' => 'codeup', 'title' => ''], + 'username' => ['description' => 'The username.', 'type' => 'string', 'example' => 'test-codeup', 'title' => ''], + 'state' => ['description' => 'The user state. Valid values:'."\n" + ."\n" + .'- `active`: The user is active.'."\n" + ."\n" + .'- `blocked`: The user is blocked.', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'avatarUrl' => ['description' => 'The avatar URL.', 'type' => 'string', 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', 'title' => ''], + 'email' => ['description' => 'The user\'s email address.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + 'id' => ['description' => 'The primary key of the user. This value has no business significance.', 'type' => 'integer', 'format' => 'int64', 'example' => '19230', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'relatedPatchSet' => [ + 'description' => 'The related patch set.', + 'type' => 'object', + 'properties' => [ + 'patchSetNo' => ['description' => 'The patch set number.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'patchSetBizId' => ['description' => 'The unique business ID of the patch set.', 'type' => 'string', 'example' => '513fcfd81a9142d2bb0db4f72c0aa15b', 'title' => ''], + 'patchSetName' => ['description' => 'The name of the patch set.', 'type' => 'string', 'example' => '版本1', 'title' => ''], + 'commitId' => ['description' => 'The commit ID associated with the patch set.', 'type' => 'string', 'example' => '1a072f5367c21f9de3464b8c0ee8546e47764d2d', 'title' => ''], + 'shortId' => ['description' => 'The short commit ID.', 'type' => 'string', 'example' => '1a072f53', 'title' => ''], + 'relatedMergeItemType' => ['description' => 'The type of the related merge item. Valid values:'."\n" + ."\n" + .'- `MERGE_SOURCE`: The related item is the merge source.'."\n" + ."\n" + .'- `MERGE_TARGET`: The related item is the merge target.', 'type' => 'string', 'example' => 'MERGE_SOURCE', 'title' => ''], + 'createdAt' => ['description' => 'The time when the patch set was created.', 'type' => 'string', 'example' => '2022-03-18 14:24:54'."\n", 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'lineNumber' => ['description' => 'The line number in the file where the comment was made. This parameter is returned only for inline comments.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'filePath' => ['description' => 'The file path.', 'type' => 'string', 'example' => 'src/main/test.java', 'title' => ''], + 'parentCommentBizId' => ['description' => 'The business ID of the parent comment.', 'type' => 'string', 'example' => '4c5dcec6a8dc41e69c369737dadc1841', 'title' => ''], + 'rootCommentBizId' => ['description' => 'The business ID of the root comment.', 'type' => 'string', 'example' => 'dcf2b23cebfc418f98dbd35e423d9fd3', 'title' => ''], + 'childComments' => [ + 'description' => 'A list of child comments.', + 'type' => 'array', + 'items' => [ + 'description' => 'A child comment.', + 'type' => 'object', + 'properties' => [ + 'commentBizId' => ['description' => 'The unique business ID of the comment.', 'type' => 'string', 'example' => '63f0e293357f48f9846ddc4dbbebd0e3', 'title' => ''], + 'commentType' => ['description' => 'The comment type. Valid values:'."\n" + ."\n" + .'- `GLOBAL_COMMENT`: a global comment.'."\n" + ."\n" + .'- `INLINE_COMMENT`: an inline comment.', 'type' => 'string', 'example' => 'GLOBAL_COMMENT', 'title' => ''], + 'state' => ['description' => 'The comment state. Valid values:'."\n" + ."\n" + .'- `DRAFT`: a draft.'."\n" + ."\n" + .'- `OPENED`: The comment is published.', 'type' => 'string', 'example' => 'OPENED', 'title' => ''], + 'resolved' => ['description' => 'Indicates whether the comment thread is resolved.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'deleted' => ['description' => 'Indicates whether the comment is deleted.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'commentTime' => ['description' => 'The time when the comment was created.', 'type' => 'string', 'example' => '2022-03-18 14:24:54', 'title' => ''], + 'lastEditTime' => ['description' => 'The time when the comment was last edited.', 'type' => 'string', 'example' => '2022-03-18 14:24:54', 'title' => ''], + 'content' => ['description' => 'The content of the comment, in rich text format.', 'type' => 'string', 'example' => '{\\"htmlValue\\":\\"'."\n" + .'测试动态创建整体评论-2'."\n" + ."\n" + .'\\",\\"jsonMLValue\\":[\\"root\\",{},[\\"p\\",{},[\\"span\\",{\\"data-type\\":\\"text\\"},[\\"span\\",{\\"data-type\\":\\"leaf\\"},\\"测试动态创建整体评论-2\\"]]]]}', 'title' => ''], + 'author' => [ + 'description' => 'The author of the comment.', + 'type' => 'object', + 'properties' => [ + 'aliyunPk' => ['description' => 'The Alibaba Cloud account ID.', 'type' => 'string', 'example' => '204485087002425236', 'title' => ''], + 'name' => ['description' => 'The user name.', 'type' => 'string', 'example' => 'codeup', 'title' => ''], + 'username' => ['description' => 'The username.', 'type' => 'string', 'example' => 'test-codeup', 'title' => ''], + 'state' => ['description' => 'The user state. Valid values:'."\n" + ."\n" + .'- `active`: The user is active.'."\n" + ."\n" + .'- `blocked`: The user is blocked.', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'avatarUrl' => ['description' => 'The avatar URL.', 'type' => 'string', 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', 'title' => ''], + 'email' => ['description' => 'The user\'s email address.', 'type' => 'string', 'example' => 'username@example.com'."\n", 'title' => ''], + 'id' => ['description' => 'The primary key of the user. This value has no business significance.', 'type' => 'integer', 'format' => 'int64', 'example' => '132582', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'relatedPatchSet' => [ + 'description' => 'The related patch set.', + 'type' => 'object', + 'properties' => [ + 'patchSetNo' => ['description' => 'The patch set number.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'patchSetBizId' => ['description' => 'The unique business ID of the patch set.', 'type' => 'string', 'example' => '513fcfd81a9142d2bb0db4f72c0aa15b', 'title' => ''], + 'patchSetName' => ['description' => 'The name of the patch set.', 'type' => 'string', 'example' => '版本1'."\n", 'title' => ''], + 'commitId' => ['description' => 'The commit ID associated with the patch set.', 'type' => 'string', 'example' => '1a072f5367c21f9de3464b8c0ee8546e47764d2d', 'title' => ''], + 'shortId' => ['description' => 'The short commit ID.', 'type' => 'string', 'example' => '1a072f53', 'title' => ''], + 'relatedMergeItemType' => ['description' => 'The type of the related merge item. Valid values:'."\n" + ."\n" + .'- `MERGE_SOURCE`: The related item is the merge source.'."\n" + ."\n" + .'- `MERGE_TARGET`: The related item is the merge target.', 'type' => 'string', 'example' => 'MERGE_SOURCE', 'title' => ''], + 'createdAt' => ['description' => 'The time when the patch set was created.', 'type' => 'string', 'example' => '2022-03-18 14:24:54'."\n", 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'lineNumber' => ['description' => 'The line number in the file where the comment was made. This parameter is returned only for inline comments.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'filePath' => ['description' => 'The file path.', 'type' => 'string', 'example' => 'src/main/test.java'."\n", 'title' => ''], + 'parentCommentBizId' => ['description' => 'The business ID of the parent comment.', 'type' => 'string', 'example' => '5c399e3685e542a28db16d93e9f82abb', 'title' => ''], + 'rootCommentBizId' => ['description' => 'The business ID of the root comment.', 'type' => 'string', 'example' => 'dcf2b23cebfc418f98dbd35e423d9fd3', 'title' => ''], + 'finalChildComments' => [ + 'description' => 'A list of child comments at the third and final supported level.', + 'type' => 'array', + 'items' => [ + 'description' => 'A third-level child comment.', + 'type' => 'object', + 'properties' => [ + 'commentBizId' => ['description' => 'The unique business ID of the comment.', 'type' => 'string', 'example' => '5c399e3685e542a28db16d93e9f82abb', 'title' => ''], + 'commentType' => ['description' => 'The comment type. Valid values:'."\n" + ."\n" + .'- `GLOBAL_COMMENT`: a global comment.'."\n" + ."\n" + .'- `INLINE_COMMENT`: an inline comment.', 'type' => 'string', 'example' => 'GLOBAL_COMMENT', 'title' => ''], + 'state' => ['description' => 'The comment state. Valid values:'."\n" + ."\n" + .'- `DRAFT`: a draft.'."\n" + ."\n" + .'- `OPENED`: The comment is published.', 'type' => 'string', 'example' => 'OPENED', 'title' => ''], + 'resolved' => ['description' => 'Indicates whether the comment thread is resolved.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'deleted' => ['description' => 'Indicates whether the comment is deleted.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'commentTime' => ['description' => 'The time when the comment was created.', 'type' => 'string', 'example' => '2022-03-18 14:24:54', 'title' => ''], + 'lastEditTime' => ['description' => 'The time when the comment was last edited.', 'type' => 'string', 'example' => '2022-03-18 14:24:54', 'title' => ''], + 'content' => ['description' => 'The content of the comment, in rich text format.', 'type' => 'string', 'example' => '{\\"htmlValue\\":\\"'."\n" + .'测试动态创建整体评论-2'."\n" + ."\n" + .'\\",\\"jsonMLValue\\":[\\"root\\",{},[\\"p\\",{},[\\"span\\",{\\"data-type\\":\\"text\\"},[\\"span\\",{\\"data-type\\":\\"leaf\\"},\\"测试动态创建整体评论-2\\"]]]]}', 'title' => ''], + 'author' => [ + 'description' => 'The author of the comment.', + 'type' => 'object', + 'properties' => [ + 'aliyunPk' => ['description' => 'The Alibaba Cloud account ID.', 'type' => 'string', 'example' => '235671547828975455', 'title' => ''], + 'name' => ['description' => 'The user name.', 'type' => 'string', 'example' => 'codeup', 'title' => ''], + 'username' => ['description' => 'The username.', 'type' => 'string', 'example' => 'test-codeup', 'title' => ''], + 'state' => ['description' => 'The user state. Valid values:'."\n" + ."\n" + .'- `active`: The user is active.'."\n" + ."\n" + .'- `blocked`: The user is blocked.', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'avatarUrl' => ['description' => 'The avatar URL.', 'type' => 'string', 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', 'title' => ''], + 'email' => ['description' => 'The user\'s email address.', 'type' => 'string', 'example' => 'username@example.com'."\n", 'title' => ''], + 'id' => ['description' => 'The primary key of the user. This value has no business significance.', 'type' => 'integer', 'format' => 'int64', 'example' => '567035', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'relatedPatchSet' => [ + 'description' => 'The related patch set.', + 'type' => 'object', + 'properties' => [ + 'patchSetNo' => ['description' => 'The patch set number.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'patchSetBizId' => ['description' => 'The unique business ID of the patch set.', 'type' => 'string', 'example' => '513fcfd81a9142d2bb0db4f72c0aa15b', 'title' => ''], + 'patchSetName' => ['description' => 'The name of the patch set.', 'type' => 'string', 'example' => '版本1', 'title' => ''], + 'commitId' => ['description' => 'The commit ID associated with the patch set.', 'type' => 'string', 'example' => '1a072f5367c21f9de3464b8c0ee8546e47764d2d', 'title' => ''], + 'shortId' => ['description' => 'The short commit ID.', 'type' => 'string', 'example' => '1a072f53', 'title' => ''], + 'relatedMergeItemType' => ['description' => 'The type of the related merge item. Valid values:'."\n" + ."\n" + .'- `MERGE_SOURCE`: The related item is the merge source.'."\n" + ."\n" + .'- `MERGE_TARGET`: The related item is the merge target.', 'type' => 'string', 'example' => 'MERGE_SOURCE', 'title' => ''], + 'createdAt' => ['description' => 'The time when the patch set was created.', 'type' => 'string', 'example' => '2022-03-18 14:24:54', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'lineNumber' => ['description' => 'The line number in the file where the comment was made. This parameter is returned only for inline comments.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'filePath' => ['description' => 'The file path.', 'type' => 'string', 'example' => 'src/main/test.java', 'title' => ''], + 'parentCommentBizId' => ['description' => 'The business ID of the parent comment.', 'type' => 'string', 'example' => '4c5dcec6a8dc41e69c369737dadc1841', 'title' => ''], + 'rootCommentBizId' => ['description' => 'The business ID of the root comment.', 'type' => 'string', 'example' => 'dcf2b23cebfc418f98dbd35e423d9fd3'."\n", 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + '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.', - ], + '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\\": \\"username@example.com\\",\\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\\": \\"username@example.com\\\\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\\": \\"username@example.com\\\\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"}]', + 'title' => 'Query the list of merge request comments ', + 'changeSet' => [ + ['createdAt' => '2024-01-29T11:52:26.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMergeRequestComments'], ], ], - '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":""}]', + 'ramActions' => [], ], - 'StopPipelineJobRun' => [ - 'summary' => '终止流水线任务运行', - 'path' => '/organization/{organizationId}/pipelines/{pipelineId}/pipelineRuns/{pipelineRunId}/jobs/{jobId}/stop', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListMergeRequestFilesReads' => [ + 'summary' => 'Retrieves a list of users who have read the changed files in a merge request.', + 'path' => '/api/v4/projects/merge_requests/diffs/files_read_infos', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'organizationId', - 'in' => 'path', - 'schema' => [ - 'title' => '企业标识,也称企业id,字符串形式,可在云效访问链接中获取,如 https:// devops.aliyun.com/organization/【OrgId】', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'in' => 'query', + 'schema' => ['title' => 'A short description of struct', 'description' => 'The ID of the organization. You can find this ID in your Alibaba Cloud DevOps URL, for example, `https://devops.aliyun.com/organization/[organizationId]`.', 'type' => 'string', 'required' => true, 'example' => '60de7a6852743a5162b5f957'], ], [ - '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' => 'accessToken', + 'in' => 'query', + 'schema' => ['description' => 'The personal access token. This parameter is not required if you authenticate using an Alibaba Cloud AccessKey pair (AK/SK) or temporary credentials from the Security Token Service (STS).', 'type' => 'string', 'required' => false, 'example' => 'agp_4d57a6796b3626f52064ab1fba5384a5', 'title' => ''], ], [ - 'name' => 'pipelineRunId', - 'in' => 'path', - 'schema' => [ - 'title' => '流水线运行实例id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '3', - ], + 'name' => 'repositoryIdentity', + 'in' => 'query', + 'schema' => ['description' => 'The ID or full path of the repository.', 'type' => 'string', 'required' => true, 'example' => '2835387 或 codeup/codeup-demo', 'title' => ''], ], [ - 'name' => 'jobId', - 'in' => 'path', - 'schema' => [ - 'title' => '流水线运行任务Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '2324334', - ], + 'name' => 'localId', + 'in' => 'query', + 'schema' => ['description' => 'The sequential ID of the merge request within the repository.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '5', 'title' => ''], + ], + [ + 'name' => 'fromPatchSetBizId', + 'in' => 'query', + 'schema' => ['description' => 'The business ID of the patch set for the target branch.'."\n" + ."\n" + .'> In APIs for merge requests and comparisons, the `from` and `to` parameters can be counter-intuitive: `from` is the target branch and `to` is the source branch. This order matches the Git execution sequence. The UI reverses these terms for clarity.', 'type' => 'string', 'required' => true, 'example' => '5e733626d53f4b04a6aa0e23d4ff72b8', 'title' => ''], + ], + [ + 'name' => 'toPatchSetBizId', + 'in' => 'query', + 'schema' => ['description' => 'The business ID of the patch set for the source branch.'."\n" + ."\n" + .'> In APIs for merge requests and comparisons, the `from` and `to` parameters can be counter-intuitive: `from` is the target branch and `to` is the source branch. This order matches the Git execution sequence. The UI reverses these terms for clarity.', 'type' => 'string', 'required' => true, 'example' => '513fcfd81a9142d2bb0db4f72c0aa15b', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response object.', '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', + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'result' => [ + 'description' => 'The list of results.', + 'type' => 'array', + 'items' => [ + 'description' => 'The read status of each changed file.', + 'type' => 'object', + 'properties' => [ + 'oldFilePath' => ['description' => 'The old file path.', 'type' => 'string', 'example' => 'text.txt', 'title' => ''], + 'newFilePath' => ['description' => 'The new file path.', 'type' => 'string', 'example' => 'text.txt', 'title' => ''], + 'newFile' => ['description' => 'Indicates whether it is a new file.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'renamedFile' => ['description' => 'Indicates whether the file was renamed.', 'type' => 'string', 'example' => 'false', 'title' => ''], + 'deletedFile' => ['description' => 'Indicates whether the file was deleted.', 'type' => 'string', 'example' => 'false', 'title' => ''], + 'readUsers' => [ + 'description' => 'The list of users who have read the file.', + 'type' => 'array', + 'items' => [ + 'description' => 'User information.', + 'type' => 'object', + 'properties' => [ + 'aliyunPk' => ['description' => 'The Alibaba Cloud account ID.', 'type' => 'string', 'example' => '204485087002425236', 'title' => ''], + 'name' => ['description' => 'The user\'s name.', 'type' => 'string', 'example' => 'codeup', 'title' => ''], + 'username' => ['description' => 'The user\'s username.', 'type' => 'string', 'example' => 'test-codeup', 'title' => ''], + 'state' => ['description' => 'The user\'s state.'."\n" + ."\n" + .'- `active`: The user is active.'."\n" + ."\n" + .'- `blocked`: The user is blocked.', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'avatarUrl' => ['description' => 'The user\'s avatar URL.', 'type' => 'string', 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', 'title' => ''], + 'email' => ['description' => 'The user\'s email address.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + '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.', - ], + '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\\": \\"username@example.com\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query read status of changed files in a merge request ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMergeRequestFilesReads'], ], ], - '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":""}]', + 'ramActions' => [], ], - 'StopPipelineRun' => [ - 'summary' => '终止流水线运行', - 'path' => '/organization/{organizationId}/pipelines/{pipelineId}/pipelineRuns/{pipelineRunId}/stop', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListMergeRequestLabels' => [ + 'summary' => 'Lists the labels associated with a specific merge request.', + 'path' => '/api/v4/projects/merge_requests/labels', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'organizationId', - 'in' => 'path', - 'schema' => [ - 'title' => '企业标识,也称企业id,字符串形式,可在云效访问链接中获取,如 https:// devops.aliyun.com/organization/【OrgId】', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'in' => 'query', + 'schema' => ['title' => 'A short description of struct', 'description' => 'The organization ID. You can obtain the organization ID from the URL used to access Alibaba Cloud DevOps, such as `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'required' => true, 'example' => '60de7a6852743a5162b5f957'], ], [ - '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' => 'accessToken', + 'in' => 'query', + 'schema' => ['description' => 'The personal access token. This parameter is optional if you use an Alibaba Cloud AccessKey pair or Security Token Service (STS) temporary credentials.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513'."\n", 'title' => ''], ], [ - 'name' => 'pipelineRunId', - 'in' => 'path', - 'schema' => [ - 'title' => '流水线运行实例id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '223', - ], + 'name' => 'repositoryIdentity', + 'in' => 'query', + 'schema' => ['description' => 'The repository ID or full path.', 'type' => 'string', 'required' => true, 'example' => '2835387 或 codeup/codeup-demo'."\n", 'title' => ''], + ], + [ + 'name' => 'localId', + 'in' => 'query', + 'schema' => ['description' => 'The local ID of the merge request, which is its sequence number within the repository.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response 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', + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '4D6AF7CC-B43B-5454-86AB-023D25E44868'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'errorCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => 'Invalid.IdNotFound', 'title' => ''], + 'errorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'result' => [ + 'description' => 'The list of labels.', + 'type' => 'array', + 'items' => [ + 'description' => 'An object that contains the details of a label.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The label ID.', 'type' => 'string', 'example' => 'f2bf0e0b4ce34a348b2d971c69a1d11f', 'title' => ''], + 'name' => ['description' => 'The label name.', 'type' => 'string', 'example' => '优化', 'title' => ''], + 'description' => ['description' => 'The label description.', 'type' => 'string', 'example' => '已有内容的优化或重构', 'title' => ''], + 'color' => ['description' => 'The label color.', 'type' => 'string', 'example' => '#A16AD7', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + '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.', - ], + '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"}]', + 'title' => 'Query the list of labels for a merge request', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMergeRequestLabels'], ], - 403 => [ - [ - 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', - 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', - ], + ], + 'ramActions' => [], + ], + 'ListMergeRequestPatchSets' => [ + 'summary' => 'Lists all patch sets for a merge request, including the patch sets for the merge source and merge target.', + 'path' => '/api/v4/projects/merge_requests/diffs/list_patchsets', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ [ - [ - '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.', - ], + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => ['title' => 'A short description of struct', 'description' => 'The organization ID. You can find the ID in the URL when you log on to the Apsara DevOps console. The URL is in the format of `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => ['description' => 'The personal access token. This parameter is not required if you use an AccessKey pair or STS token for authentication.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], + ], + [ + 'name' => 'repositoryIdentity', + 'in' => 'query', + 'schema' => ['description' => 'The ID or full path of the repository.', 'type' => 'string', 'required' => true, 'example' => '2835387 或 codeup/codeup-demo'."\n", 'title' => ''], + ], + [ + 'name' => 'localId', + 'in' => 'query', + 'schema' => ['description' => 'The local ID of the merge request. The ID is unique in a repository.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '4', 'title' => ''], ], ], - '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', + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response object.', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'result' => [ + 'description' => 'The list of results.', + 'type' => 'array', + 'items' => [ + 'description' => 'The result object.', + 'type' => 'object', + 'properties' => [ + 'patchSetNo' => ['description' => 'The version number of the patch set.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'patchSetBizId' => ['description' => 'The business ID of the patch set. The ID is unique and has business implications. Use this ID in other API operations that require a patch set ID.', 'type' => 'string', 'example' => '513fcfd81a9142d2bb0db4f72c0aa15b', 'title' => ''], + 'patchSetName' => ['description' => 'The name of the patch set.', 'type' => 'string', 'example' => '版本1', 'title' => ''], + 'commitId' => ['description' => 'The commit ID.', 'type' => 'string', 'example' => '1a072f5367c21f9de3464b8c0ee8546e47764d2d', 'title' => ''], + 'shortCommitId' => ['description' => 'The short commit ID.', 'type' => 'string', 'example' => '1a072f53', 'title' => ''], + 'relatedMergeItemType' => ['description' => 'The type of the merge.'."\n" + ."\n" + .'- `MERGE_SOURCE`: the source branch of the merge.'."\n" + ."\n" + .'- `MERGE_TARGET`: the target branch of the merge.', 'type' => 'string', 'example' => 'MERGE_SOURCE', 'title' => ''], + 'createdAt' => ['description' => 'The time when the patch set was created.', 'type' => 'string', 'example' => '2022-03-18 14:24:54', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], ], - 'schemes' => [ - 'http', - 'https', + '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"}]', + 'title' => 'Query the list of merge request versions', + 'description' => 'A patch set represents a push and corresponds to a specific commit SHA. If a push includes multiple commits, the patch set uses the commit ID of the latest commit.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMergeRequestPatchSets'], + ], ], + 'ramActions' => [], + ], + 'ListMergeRequests' => [ + 'summary' => 'Queries a list of merge requests with support for pagination, sorting, and filtering.'."\n" + ."\n" + .'This API can query both legacy and new merge requests. If you have never used legacy merge requests or no legacy merge request data exists, ignore the fields related to legacy merge requests in the response.', + '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' => 'path', - 'schema' => [ - 'title' => '企业标识,也称企业id,字符串形式,可在云效访问链接中获取,如https://devops.aliyun.com/organization/【OrganizationId】', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The organization ID, in string format. You can obtain this ID from the Yunxiao access URL, such as https://devops.aliyun.com/organization/<OrganizationId>.', 'type' => 'string', 'required' => true, 'example' => '60de7a6852743a5162b5f957'], ], [ - 'name' => 'pipelineId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '12', - ], + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The personal access token.'."\n" + .'This field is not required if you use an Alibaba Cloud AK/SK pair or STS temporary authorization.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513'."\n"], ], [ - 'name' => 'pipelineName', + 'name' => 'page', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], + 'schema' => ['description' => 'The page number. Default value: 1. Pages start from page 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'envId', + 'name' => 'pageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - 'enum' => [ - '0', - '1', - '2', - ], - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 20. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'tagList', + 'name' => 'groupIds', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '"11,222,33"', - ], + 'schema' => ['description' => 'The code group IDs. Multiple IDs are separated by commas.', 'type' => 'string', 'required' => false, 'example' => '889910, 889911', 'title' => ''], + ], + [ + 'name' => 'projectIds', + 'in' => 'query', + 'schema' => ['description' => 'The repository IDs. Multiple IDs are separated by commas.', 'type' => 'string', 'required' => false, 'example' => '2308912, 2308913', 'title' => ''], + ], + [ + 'name' => 'authorIds', + 'in' => 'query', + 'schema' => ['description' => 'The Alibaba Cloud account IDs of the creators. Multiple IDs are separated by commas.', 'type' => 'string', 'required' => false, 'example' => '1234567890', 'title' => ''], + ], + [ + 'name' => 'reviewerIds', + 'in' => 'query', + 'schema' => ['description' => 'The Alibaba Cloud account IDs of the reviewers. Multiple IDs are separated by commas.', 'type' => 'string', 'required' => false, 'example' => '1234567890123', 'title' => ''], + ], + [ + 'name' => 'state', + 'in' => 'query', + 'schema' => ['description' => 'The merge request state. By default, merge requests in all states are queried. Valid values:'."\n" + .'- opened: open, including the under review, to be merged, and under development states.'."\n" + .'- closed: closed.'."\n" + .'- merged: merged.'."\n" + .'- all: all states. If the value is all, you do not need to pass this parameter. Other invalid characters also default to querying all states.', 'type' => 'string', 'required' => false, 'example' => 'opened', 'title' => ''], + ], + [ + 'name' => 'search', + 'in' => 'query', + 'schema' => ['description' => 'The search keyword. Matches against the merge request title.', 'type' => 'string', 'required' => false, 'example' => 'test-search', 'title' => ''], + ], + [ + 'name' => 'orderBy', + 'in' => 'query', + 'schema' => ['description' => 'The field by which to sort results. Default value: updated_at. Valid values:'."\n" + .'- created_at: creation time.'."\n" + .'- updated_at: update time.'."\n" + ."\n" + .'If an invalid value is passed, updated_at is used by default.', 'type' => 'string', 'required' => false, 'example' => 'updated_at', 'title' => ''], + ], + [ + 'name' => 'sort', + 'in' => 'query', + 'schema' => ['description' => 'The sort order. Default value: desc. Valid values:'."\n" + .'- desc: descending order.'."\n" + .'- asc: ascending order.', 'type' => 'string', 'required' => false, 'example' => 'desc', 'title' => ''], + ], + [ + 'name' => 'filter', + 'in' => 'query', + 'schema' => ['description' => 'Filters merge requests by version. By default, no filtering is applied and both new and legacy merge requests are returned. If you have always used the new merge request version, you can ignore this parameter. Valid values:'."\n" + .'- new: queries only new merge requests.'."\n" + .'- old: queries only legacy merge requests.', 'type' => 'string', 'required' => false, 'example' => 'new', 'title' => ''], + ], + [ + 'name' => 'labelIds', + 'in' => 'query', + 'schema' => ['description' => 'The label IDs. Multiple IDs are separated by commas.', 'type' => 'string', 'required' => false, 'example' => 'b5b5738b94954bc6aa5a293316ed1d24', 'title' => ''], + ], + [ + 'name' => 'createdBefore', + 'in' => 'query', + 'schema' => ['description' => 'The start of the creation time range.'."\n" + ."\n" + .'> ISO 8601 format, such as 2019-03-15T08:00:00Z. The comparison is "greater than or equal to".', 'type' => 'string', 'required' => false, 'example' => '2019-03-15T08:00:00Z', 'title' => ''], + ], + [ + 'name' => 'createdAfter', + 'in' => 'query', + 'schema' => ['description' => 'The end of the creation time range.'."\n" + ."\n\n" + .'> ISO 8601 format, such as 2019-03-15T08:00:00Z. The comparison is "less than".'."\n" + ."\n\n" + .'> The creation time range is [createdBefore, createdAfter), which is a left-closed, right-open interval.', 'type' => 'string', 'required' => false, 'example' => '2019-03-15T08:00:00Z', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '”“', + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Openapi.RequestError', 'title' => ''], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'success' => ['description' => 'Indicates whether the call is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], + 'result' => [ + 'description' => 'The list of results.', + 'type' => 'array', + 'items' => [ + 'description' => 'The merge request information.', + 'type' => 'object', + 'properties' => [ + 'newMergeRequestIdentifier' => ['description' => 'The identifier that distinguishes new and legacy merge requests. A value of true indicates a new merge request. A value of false indicates a legacy merge request.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'projectId' => ['description' => 'The repository ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '2369234', 'title' => ''], + 'id' => ['description' => 'The ID of the legacy merge request. This value is empty for new merge requests.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'iid' => ['description' => 'The local ID of the merge request, which indicates the sequence number of the merge request within the repository. This value is empty for new merge requests.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'mrBizId' => ['description' => 'The unique ID of the new merge request. This value is available only for new merge requests.', 'type' => 'string', 'example' => 'bca90244c4b749e0b109df52ac0eb570', 'title' => ''], + 'localId' => ['description' => 'The local ID of the merge request, which indicates the sequence number of the merge request within the repository. This field is used for new merge requests.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'title' => ['description' => 'The title of the merge request.', 'type' => 'string', 'example' => 'test-合并请求标题', 'title' => ''], + 'description' => ['description' => 'The description of the merge request.', 'type' => 'string', 'example' => '描述信息的具体内容'."\n", 'title' => ''], + 'state' => ['description' => 'The state of the legacy merge request. Valid values:'."\n" + .'- opened: open.'."\n" + .'- reopened: reopened.'."\n" + .'- closed: closed.'."\n" + .'- accepted: review approved (not merged).'."\n" + .'- merged: review approved (merged).'."\n" + .'- locked: merge locked.', 'type' => 'string', 'example' => 'opened', 'title' => ''], + 'newVersionState' => ['description' => 'The state of the new merge request. Valid values:'."\n" + .'- UNDER_DEV: under development.'."\n" + .'- UNDER_REVIEW: under review.'."\n" + .'- TO_BE_MERGED: to be merged.'."\n" + .'- CLOSED: closed.'."\n" + .'- MERGED: merged.', 'type' => 'string', 'example' => 'UNDER_REVIEW', 'title' => ''], + 'createdAt' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2022-03-18 14:24:54', 'title' => ''], + 'updatedAt' => ['description' => 'The update time.', 'type' => 'string', 'example' => '2022-03-18 14:24:54', 'title' => ''], + 'sourceBranch' => ['description' => 'The source branch.', 'type' => 'string', 'example' => 'test-merge-source-branch', 'title' => ''], + 'targetBranch' => ['description' => 'The target branch.', 'type' => 'string', 'example' => 'test-merge-target-branch', 'title' => ''], + 'author' => [ + 'description' => 'The author information.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The Codeup user ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '19927', 'title' => ''], + 'name' => ['description' => 'The username.', 'type' => 'string', 'example' => 'test-codeup', 'title' => ''], + 'username' => ['description' => 'The logon name of the user.', 'type' => 'string', 'example' => 'root-test-codeup', 'title' => ''], + 'state' => ['description' => 'The user state. Valid values:'."\n" + ."\n" + .'- active: active.'."\n" + .'- blocked: deprecated or unavailable.', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'avatarUrl' => ['description' => 'The avatar URL.', 'type' => 'string', 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', 'title' => ''], + 'email' => ['description' => 'The email address of the user.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'reviewers' => [ + 'description' => 'The list of reviewer information.', + 'type' => 'array', + 'items' => [ + 'description' => 'The reviewer information.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The Codeup user ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '43127', 'title' => ''], + 'name' => ['description' => 'The username.', 'type' => 'string', 'example' => 'test-review-user', 'title' => ''], + 'username' => ['description' => 'The logon name of the user.', 'type' => 'string', 'example' => 'root-test-review-user', 'title' => ''], + 'state' => ['description' => 'The user state. Valid values:'."\n" + .'- active: active.'."\n" + .'- blocked: deprecated or unavailable.', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'avatarUrl' => ['description' => 'The avatar URL of the reviewer.', 'type' => 'string', 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', 'title' => ''], + 'email' => ['description' => 'The email address of the user.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + 'status' => ['description' => 'The review status of the reviewer. Valid values:'."\n" + .'- approved: approved.'."\n" + .'- comment: commented.'."\n" + .'- pending: not yet reviewed.', 'type' => 'string', 'example' => 'approved', 'title' => ''], + 'reviewTime' => ['description' => 'The time when the reviewer completed the review.'."\n" + ."\n" + .'> This field is valid only for new merge requests. The field is populated only after the reviewer completes the review. Otherwise, the value is empty.', 'type' => 'string', 'example' => '2022-03-18 14:24:54', 'title' => ''], + 'hasReviewed' => ['description' => 'Indicates whether the reviewer has completed the review.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'hasCommented' => ['description' => 'Indicates whether the reviewer has posted a comment.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'reviewOpinionStatus' => ['description' => 'The review opinion. This value is empty if the reviewer has not reviewed. Valid values:'."\n" + .'- PASS: approved.'."\n" + .'- NOT_PASS: not approved.', 'type' => 'string', 'example' => 'PASS', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'subscribers' => [ + 'description' => 'The list of subscriber information.', + 'type' => 'array', + 'items' => [ + 'description' => 'The subscriber information.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The Codeup user ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1876119', 'title' => ''], + 'name' => ['description' => 'The username.', 'type' => 'string', 'example' => 'test-subscriber', 'title' => ''], + 'username' => ['description' => 'The logon name of the user.', 'type' => 'string', 'example' => 'root-test-subscriber', 'title' => ''], + 'state' => ['description' => 'The user state. Valid values:'."\n" + ."\n" + .'- active: active.'."\n" + .'- blocked: deprecated or unavailable.', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'avatarUrl' => ['description' => 'The avatar URL.', 'type' => 'string', 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', 'title' => ''], + 'email' => ['description' => 'The email address of the user.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'sourceProjectId' => ['description' => 'The source repository ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '2876119', 'title' => ''], + 'targetProjectId' => ['description' => 'The target repository ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '2876119', 'title' => ''], + 'workInProgress' => ['description' => 'Indicates whether the merge request is under development.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'detailUrl' => ['description' => 'The URL of the merge request details page.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'webUrl' => ['description' => 'The URL for web access.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'sshUrl' => ['description' => 'The SSH clone URL of the repository.', 'type' => 'string', 'example' => 'git@xxx:xxx/test/test.git', 'title' => ''], + 'creationMethod' => ['description' => 'The creation method. Valid values:'."\n" + .'- WEB: created through the web UI.'."\n" + .'- COMMAND_LINE: created through the command line.', 'type' => 'string', 'example' => 'WEB', 'title' => ''], + 'sourceType' => ['description' => 'For legacy merge requests, valid values:'."\n" + .'- BRANCH: branch.'."\n" + .'- COMMIT: commit.'."\n" + ."\n" + .'For new merge requests, valid values:'."\n" + .'- BRANCH: branch.'."\n" + .'- REF: commit or reference review.', 'type' => 'string', 'example' => 'BRANCH', 'title' => ''], + 'targetType' => ['description' => 'The target type. The value is typically BRANCH.', 'type' => 'string', 'example' => 'BRANCH', 'title' => ''], + 'nameWithNamespace' => ['description' => 'The full name of the repository, including the full group name.', 'type' => 'string', 'example' => 'codeup-test-org / test-create-group (斜杠两侧有空格)', 'title' => ''], + 'supportMergeFFOnly' => ['description' => 'Indicates whether the fast-forward-only merge method is supported.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'labels' => [ + 'description' => 'The list of labels.', + 'type' => 'array', + 'items' => [ + 'description' => 'The label information.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The label ID, which is a unique identifier.', 'type' => 'string', 'example' => 'b5b5738b94954bc6aa5a293316ed1d24', 'title' => ''], + 'name' => ['description' => 'The label name.', 'type' => 'string', 'example' => '新特性', 'title' => ''], + 'color' => ['description' => 'The label color.', 'type' => 'string', 'example' => '#006AD4', 'title' => ''], + 'description' => ['description' => 'The label description.', 'type' => 'string', 'example' => '新的特性或需求', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'mergedRevision' => ['description' => 'The merged revision (commit SHA).', 'type' => 'string', 'example' => '1a072f5367c21f9de3464b8c0ee8546e47764d2d', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + '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.', - ], + '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\\": \\"username@example.com\\"\\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\\": \\"username@example.com\\",\\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\\": \\"username@example.com\\"\\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"}]', + 'title' => 'Query merge requests', + 'description' => 'This operation requires that the current organization has adopted the new merge request (MR) version. Check whether the merge request page of the current organization uses the new version.', + 'changeSet' => [ + ['createdAt' => '2024-01-29T11:52:26.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2024-01-23T02:19:11.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2024-01-11T02:39:13.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMergeRequests'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\"\\n}","type":"json"}]', + 'ramActions' => [], ], - 'RetryPipelineJobRun' => [ - 'summary' => '重试流水线运行', - 'path' => '/organization/{organizationId}/pipelines/{pipelineId}/pipelineRuns/{pipelineRunId}/jobs/{jobId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListOrganizationMembers' => [ + 'summary' => 'Retrieve enterprise member information based on specified conditions.', + 'path' => '/organization/{organizationId}/members', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -30812,1586 +16786,877 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['description' => 'Organization identity, also known as organization ID ', 'type' => 'string', 'required' => true, 'example' => '66c0c9fffeb86b450c199fcd', 'title' => ''], ], [ - 'name' => 'pipelineId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'name' => 'organizationMemberName', + 'in' => 'query', + 'schema' => ['description' => 'Organization member name', 'type' => 'string', 'required' => false, 'example' => '名字1', 'title' => ''], ], [ - 'name' => 'pipelineRunId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'name' => 'provider', + 'in' => 'query', + 'schema' => ['description' => 'Third-party system (for example, DingTalk if synchronized from DingTalk). This parameter must be used together with the externUid parameter. Specifying only one of them has no effect.', 'type' => 'string', 'required' => false, 'example' => 'Dingtalk', 'title' => ''], ], [ - 'name' => 'jobId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'name' => 'externUid', + 'in' => 'query', + 'schema' => ['description' => 'User ID in the third-party system: if synchronized from DingTalk, this is the DingTalk employee User ID. This parameter must be used together with the provider parameter. Specifying only one of them has no effect.', 'type' => 'string', 'required' => false, 'example' => '1236666', 'title' => ''], + ], + [ + 'name' => 'state', + 'in' => 'query', + 'schema' => ['description' => 'Options: Normal (normal), Blocked (blocked), Deleted (deleted). Only one status can be specified. If not specified, members with Normal status are returned by default.', 'type' => 'string', 'required' => false, 'example' => 'normal', 'title' => ''], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['description' => 'Starting token for paging; use the nextToken value returned from the previous request.', 'type' => 'string', 'required' => false, 'example' => '""', 'title' => ''], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['description' => 'Maximum number of results to return, ranging from 0 to 50. Default value is 20.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '200', 'minimum' => '1', 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'joinTimeFrom', + 'in' => 'query', + 'schema' => ['description' => 'Time when the user joined the Alibaba Cloud DevOps organization, in milliseconds UNIX timestamp', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1631845101798', 'title' => ''], + ], + [ + 'name' => 'joinTimeTo', + 'in' => 'query', + 'schema' => ['description' => 'Time when the user joined the Alibaba Cloud DevOps organization, in milliseconds as a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1631845101798', 'title' => ''], + ], + [ + 'name' => 'containsExternInfo', + 'in' => 'query', + 'schema' => ['title' => '返回信息中是否包含第三方信息,默认不包含。', 'description' => '返回信息中是否包含第三方信息,默认不包含。', 'type' => 'boolean', 'required' => false, 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', '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', + 'requestId' => ['title' => '', 'description' => 'Request ID. Each request has a unique value, which facilitates troubleshooting later.', 'type' => 'string', 'example' => 'FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F'], + 'errorMessage' => ['title' => '', 'description' => 'Error message ', 'type' => 'string', 'example' => 'error info'], + 'success' => ['title' => '', 'description' => 'true if the API call succeeded; false if the API call failed.', 'type' => 'boolean', 'example' => 'true'], + 'errorCode' => ['title' => '', 'description' => 'Error code ', 'type' => 'string', 'example' => 'null'], + 'nextToken' => ['title' => '', 'description' => 'Paging token', 'type' => 'string', 'example' => '""'], + 'totalCount' => ['title' => '', 'description' => 'Total count ', 'type' => 'integer', 'format' => 'int64', 'example' => '15'], + 'members' => [ + 'title' => '', + 'description' => 'List of members', + 'type' => 'array', + 'items' => [ + 'description' => 'Member', + 'type' => 'object', + 'properties' => [ + 'accountId' => ['title' => '', 'description' => 'Alibaba Cloud User UID ', 'type' => 'string', 'example' => '123456677888'], + 'birthday' => ['title' => '', 'description' => 'Birthday', 'type' => 'integer', 'format' => 'int64', 'example' => '1631845101798'], + 'deptLists' => [ + 'title' => '', + 'description' => 'List of department names ', + 'type' => 'array', + 'items' => ['description' => 'Department name ', 'type' => 'string', 'example' => '测试部门', 'title' => ''], + 'example' => '', + ], + 'email' => ['title' => '', 'description' => 'Mailbox ', 'type' => 'string', 'example' => '123@mail.com'], + 'hiredDate' => ['title' => '', 'description' => 'Hire date ', 'type' => 'integer', 'format' => 'int64', 'example' => '1631845101798'], + 'identities' => [ + 'title' => '', + 'description' => 'Third-party information ', + 'type' => 'object', + 'properties' => [ + 'externUid' => ['title' => '', 'description' => 'User ID in the third-party system ', 'type' => 'string', 'example' => '1236666'], + 'provider' => ['title' => '', 'description' => 'Third-party system ', 'type' => 'string', 'example' => 'Dingtalk'], + ], + 'example' => '', + ], + 'joinTime' => ['title' => '', 'description' => 'Time when the member joined the Alibaba Cloud DevOps enterprise', 'type' => 'integer', 'format' => 'int64', 'example' => '1631845101798'], + 'lastVisitTime' => ['title' => '', 'description' => 'Last access time ', 'type' => 'integer', 'format' => 'int64', 'example' => '1631845101798'], + 'mobile' => ['title' => '', 'description' => 'Phone number', 'type' => 'string', 'example' => '1390000****'], + 'organizationMemberName' => ['title' => '', 'description' => 'Organization member name ', 'type' => 'string', 'example' => '名字1'], + 'organizationRoleName' => ['title' => '', 'description' => 'Enterprise role name', 'type' => 'string', 'example' => '管理员'], + 'organizationRoleId' => ['title' => '', 'description' => 'Organization role ID ', 'type' => 'string', 'example' => '8fc0c9ff039711dd64acd000'], + 'state' => ['title' => '', 'description' => 'User status (Normal, blocked, deleted) ', 'type' => 'string', 'example' => 'normal'], + 'jobNumber' => ['description' => 'Employee ID ', 'type' => 'string', 'example' => '373***', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], ], + '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.', - ], + ['errorCode' => 'InvalidUser.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization.', 'description' => 'The user is not in the organization.'], ], 403 => [ - [ - 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', - 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', - ], + ['errorCode' => 'InvalidParam.NoPermission', 'errorMessage' => 'No Permission.', 'description' => ''], ], [ - [ - '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.', - ], + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], ], ], - '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', + 'responseDemo' => '[{"errorExample":"","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\\": \\"123@mail.com\\",\\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}","type":"json"}]', + 'title' => 'Query the list of organization members ', + 'changeSet' => [ + ['createdAt' => '2024-02-27T13:33:47.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-04-13T13:22:01.000Z', 'description' => 'Error codes changed, Request parameters changed'], + ['createdAt' => '2021-09-27T12:22:42.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-09-23T03:43:50.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-09-22T12:34:01.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListOrganizationMembers'], + ], ], + 'ramActions' => [], + ], + 'ListOrganizations' => [ + 'summary' => 'Retrieves a list of organizations for the current user.', + 'path' => '/organizations/list', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'none'], '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' => 'accessToken', + 'in' => 'query', + 'schema' => ['description' => 'The personal access token. This parameter is not required when authenticating with an Alibaba Cloud AccessKey pair or Security Token Service (STS).', 'type' => 'string', 'required' => false, 'example' => 'agp_adf6bc4433173ab3cb43195b6ff9213d', 'title' => ''], ], [ - 'name' => 'pipelineRunId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'name' => 'accessLevel', + 'in' => 'query', + 'schema' => ['description' => 'Returns only organizations where the user has the specified access level.'."\n" + ."\n" + .'- 5: external member'."\n" + ."\n" + .'- 15: member'."\n" + ."\n" + .'- 60: administrator'."\n" + ."\n" + .'- 70: owner', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', 'title' => ''], ], [ - 'name' => 'jobId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'name' => 'minAccessLevel', + 'in' => 'query', + 'schema' => ['description' => 'Returns only organizations where the user\'s access level is greater than or equal to the specified value.'."\n" + ."\n" + .'- 5: external member'."\n" + ."\n" + .'- 15: member'."\n" + ."\n" + .'- 60: administrator'."\n" + ."\n" + .'- 70: owner'."\n" + ."\n" + .'> If specified, `minAccessLevel` takes precedence over `accessLevel`.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response object.', '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', + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '95FE5953-FF5B-5F80-94AD-FFF97D990FE0'], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'result' => [ + 'description' => 'A list of organization objects.', + 'type' => 'array', + 'items' => [ + 'description' => 'An object containing the details of a single organization.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The primary key ID of the organization.'."\n" + ."\n" + .'> This is an internal ID that is null if the organization has not enabled Alibaba Cloud Codeup.', 'type' => 'integer', 'format' => 'int64', 'example' => '5240', 'title' => ''], + 'accessLevel' => ['description' => 'The user\'s access level in the organization.'."\n" + ."\n" + .'- 5: external member'."\n" + ."\n" + .'- 15: member'."\n" + ."\n" + .'- 60: administrator'."\n" + ."\n" + .'- 70: owner', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => ''], + 'organizationId' => ['description' => 'The unique identifier for the organization, found in the URL on Alibaba Cloud DevOps: https\\://devops.aliyun.com/organization/\\[organizationId].', 'type' => 'string', 'example' => '60de7a6852743a5162b5f957', 'title' => ''], + 'organizationName' => ['description' => 'The organization name.', 'type' => 'string', 'example' => '云效Codeup', 'title' => ''], + 'organizationRole' => ['description' => 'The user\'s role in the organization.'."\n" + ."\n" + .'- ORG\\_EXTERNAL\\_MEMBER: external member'."\n" + ."\n" + .'- ORG\\_MEMBER: member'."\n" + ."\n" + .'- ORG\\_ADMIN: administrator'."\n" + ."\n" + .'- ORG\\_OWNER: owner', 'type' => 'string', 'example' => 'ORG_ADMIN', 'title' => ''], + 'organizationAlias' => ['description' => 'The organization alias.'."\n" + ."\n" + .'> This field is populated for organizations that have enabled Alibaba Cloud Codeup; otherwise, it is null or empty.', 'type' => 'string', 'example' => 'alias-云效Codeup', 'title' => ''], + 'namespaceId' => ['description' => 'The namespace ID.', 'type' => 'string', 'example' => '600002', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + '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.', - ], + '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"}]', + 'title' => 'Query the enterprise list of a user ', + 'changeSet' => [ + ['createdAt' => '2024-04-07T05:00:24.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-03-28T08:42:51.000Z', 'description' => 'Response parameters changed, Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListOrganizations'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true\\n}","type":"json"}]', + 'ramActions' => [], ], - 'PassPipelineValidate' => [ - 'summary' => '通过人工卡点', - 'path' => '/organization/{organizationId}/pipelines/{pipelineId}/pipelineRuns/{pipelineRunId}/jobs/{jobId}/pass', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListPipelineGroupPipelines' => [ + 'summary' => 'Obtain the list of pipelines under a pipeline group.', + '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' => [ - 'title' => '企业标识,也称企业id,字符串形式,可在云效访问链接中获取,如https://devops.aliyun.com/organization/【OrganizationId】', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, for example: https://devops.aliyun.com/organization/【OrganizationId】'."\n" + ."\n", 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx', 'title' => ''], ], [ - 'name' => 'pipelineId', - 'in' => 'path', - 'schema' => [ - 'title' => '流水线ID,可在流水线链接中获取,如https://flow.aliyun.com/pipelines/【PipelineId】/current', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '11222', - ], + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['description' => 'Number of items per page. Maximum supported value is 50.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '50', 'minimum' => '1', 'example' => '10', 'default' => '10', 'title' => ''], ], [ - 'name' => 'pipelineRunId', - 'in' => 'path', - 'schema' => [ - 'title' => '流水线运行实例id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1111', - ], + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['description' => 'Paging token', 'type' => 'string', 'required' => false, 'example' => 'aaaa', 'title' => ''], ], [ - 'name' => 'jobId', + 'name' => 'groupId', 'in' => 'path', - 'schema' => [ - 'title' => '1111', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '111', - ], + 'schema' => ['description' => 'Pipeline group ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '111', 'title' => ''], + ], + [ + 'name' => 'pipelineName', + 'in' => 'query', + 'schema' => ['description' => 'Pipeline name', 'type' => 'string', 'required' => false, 'example' => '流水线', 'title' => ''], + ], + [ + 'name' => 'executeStartTime', + 'in' => 'query', + 'schema' => ['description' => 'Last execution start time of the pipeline', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1586863220000', 'title' => ''], + ], + [ + 'name' => 'executeEndTime', + 'in' => 'query', + 'schema' => ['description' => 'Last execution end time of the pipeline', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1586863220000', 'title' => ''], + ], + [ + 'name' => 'createStartTime', + 'in' => 'query', + 'schema' => ['description' => 'Pipeline Creation Start Time', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1586863220000', 'title' => ''], + ], + [ + 'name' => 'resultStatusList', + 'in' => 'query', + 'schema' => ['description' => 'Last run status of the pipeline. Multiple values separated by commas. Valid values: SUCCESS (Succeeded), RUNNING (running), FAIL (failed), CANCELED (canceled), WAITING (waiting)', 'type' => 'string', 'required' => false, 'example' => 'RUNNING,SUCCESS', 'title' => ''], + ], + [ + 'name' => 'createEndTime', + 'in' => 'query', + 'schema' => ['description' => 'Pipeline Creation End Time', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1586863220000', 'title' => ''], ], ], 'responses' => [ 200 => [ + 'headers' => [], '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' => '""', + 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID. Each request has a unique value, which facilitates troubleshooting later.'."\n" + ."\n", 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['description' => 'Error message', 'type' => 'string', 'example' => '""', 'title' => ''], + 'success' => ['description' => 'true indicates that the API call succeeded; false indicates that the API call failed.'."\n" + ."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'errorCode' => ['description' => 'Error code', 'type' => 'string', 'example' => '""', 'title' => ''], + 'pipelines' => [ + 'description' => 'List of pipelines', + 'type' => 'array', + 'items' => [ + 'description' => 'Pipeline', + 'type' => 'object', + 'properties' => [ + 'pipelineName' => ['description' => 'Pipeline Name', 'type' => 'string', 'example' => '流水线名称', 'title' => ''], + 'createTime' => ['description' => 'Pipeline Creation Time', 'type' => 'integer', 'format' => 'int64', 'example' => '1586863220000', 'title' => ''], + 'pipelineId' => ['description' => 'Pipeline ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1111', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'totalCount' => ['description' => 'Total count', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'nextToken' => ['description' => 'Paging token. An empty value indicates that there is no next page.', 'type' => 'string', 'example' => 'aaaa', 'title' => ''], ], + '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' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], ], [ - [ - '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.', - ], + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], + ['errorCode' => 'InvalidUser.UserNotInCurrentOrganization', 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', 'description' => ''], ], ], - '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', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Obtain the list of pipelines under a pipeline group', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPipelineGroupPipelines'], + ], ], + 'ramActions' => [], + ], + 'ListPipelineGroups' => [ + 'summary' => 'Obtain the list of pipeline groups.', + 'path' => '/organization/{organizationId}/pipelineGroups', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => [], + 'produces' => [], + 'operationType' => 'write', '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', - ], + 'schema' => ['description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, such as https://devops.aliyun.com/organization/【OrganizationId】', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx', 'title' => ''], ], [ - 'name' => 'pipelineRunId', - 'in' => 'path', - 'schema' => [ - 'title' => '1', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '流水线运行实例id', - ], + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['description' => 'Maximum return value. Maximum value: 50 ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '50', 'minimum' => '1', 'example' => '20', 'default' => '10', 'title' => ''], ], [ - 'name' => 'jobId', - 'in' => 'path', - 'schema' => [ - 'title' => '11111', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1111', - ], + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['description' => 'Paging token ', 'type' => 'string', 'required' => false, 'example' => 'aaaaaaaaaa', 'title' => ''], ], ], 'responses' => [ 200 => [ + 'headers' => [], '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' => '""', + 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID. Each request has a unique value, which facilitates troubleshooting later.'."\n" + ."\n", 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['description' => 'Error message', 'type' => 'string', 'example' => '""', 'title' => ''], + 'success' => ['description' => 'true indicates that the API call succeeded; false indicates that the API call failed.'."\n" + ."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'errorCode' => ['description' => 'Error code', 'type' => 'string', 'example' => '""', 'title' => ''], + 'pipelineGroups' => [ + 'description' => 'List of pipeline groups', + 'type' => 'array', + 'items' => [ + 'description' => 'Pipeline group', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'Pipeline group name', 'type' => 'string', 'example' => '流水线分组名称', 'title' => ''], + 'id' => ['description' => 'Pipeline group ID', 'type' => 'integer', 'format' => 'int64', 'example' => '111', 'title' => ''], + 'createTime' => ['description' => 'Creation Time', 'type' => 'integer', 'format' => 'int64', 'example' => '1586863220000', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'totalCount' => ['description' => 'Total count', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], + 'nextToken' => ['description' => 'Paging token. An empty value indicates that there is no next page.', 'type' => 'string', 'example' => 'ssaassasass', 'title' => ''], ], + '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' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], ], [ - [ - '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.', - ], + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], + ['errorCode' => 'InvalidUser.UserNotInCurrentOrganization', 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', 'description' => ''], ], ], - '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', + '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"}]', + 'title' => 'Obtain the list of pipeline groups', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPipelineGroups'], + ], ], + 'ramActions' => [], + ], + 'ListPipelineJobHistorys' => [ + 'summary' => 'Retrieve the execution history of pipeline jobs.', + 'path' => '/organization/{organizationId}/pipeline/{pipelineId}/job/historys', + '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', - ], + 'schema' => ['title' => '', 'description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, for example: https://devops.aliyun.com/organization/【OrganizationId】', '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', - ], + 'schema' => ['description' => 'Pipeline ID', 'type' => 'string', 'required' => true, 'example' => '123', 'maxLength' => 1000, 'title' => ''], ], [ - 'name' => 'relObjectType', + 'name' => 'category', 'in' => 'query', 'schema' => [ - 'title' => '关联的资源类型,暂只支持VARIABLE_GROUP', - 'description' => '', + 'description' => 'Job category; currently only DEPLOY is supported', 'type' => 'string', 'required' => true, - 'example' => 'VARIABLE_GROUP', - 'enum' => [ - 'VARIABLE_GROUP', - ], + 'example' => 'DEPLOY', + 'enum' => ['DEPLOY'], + 'title' => '', ], ], [ - 'name' => 'relObjectIds', + 'name' => 'identifier', 'in' => 'query', - 'schema' => [ - 'title' => '关联的资源id,暂只支持变量组id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '11,22', - ], + 'schema' => ['description' => 'Job identifier', 'type' => 'string', 'required' => true, 'example' => '10_ssasasa', 'title' => ''], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['description' => 'Next page token', 'type' => 'string', 'required' => false, 'example' => 'xsaxsa', 'title' => ''], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['description' => 'Maximum number of data entries per page, up to 50 supported', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '50', 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + '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' => '""', - ], - 'errorCode' => [ - 'title' => '错误码', - 'description' => '', - 'type' => 'string', - 'example' => '""', - ], - 'success' => [ - 'title' => 'true 接口调用成功,false 接口调用失败', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'requestId' => ['title' => '', 'description' => 'Request ID. Each request has a unique value, which facilitates troubleshooting later.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['title' => '', 'description' => 'error message', 'type' => 'string', 'example' => '”“'], + 'success' => ['title' => '', 'description' => 'true indicates that the API call succeeded; false indicates that the API call failed.', 'type' => 'boolean', 'example' => 'true 接口调用成功,false 接口调用失败'], + 'errorCode' => ['title' => '', 'description' => 'error code', 'type' => 'string', 'example' => '”“'], + 'jobs' => [ + 'description' => 'List of jobs', + 'type' => 'array', + 'items' => [ + 'description' => 'Job', + 'type' => 'object', + 'properties' => [ + 'jobName' => ['description' => 'Task Name', 'type' => 'string', 'example' => '任务名称', 'title' => ''], + 'identifier' => ['description' => 'Job identity', 'type' => 'string', 'example' => '10_xaxxsxa', 'title' => ''], + 'pipelineId' => ['description' => 'Pipeline ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'executeNumber' => ['description' => 'Execution count of the job', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'jobId' => ['description' => 'Job ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'pipelineRunId' => ['description' => 'Pipeline run instance ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'sources' => ['description' => 'Code source information used when the job runs', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'status' => ['description' => 'Job execution status', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'operatorAccountId' => ['description' => 'Alibaba Cloud PK of the operator', 'type' => 'string', 'example' => 'ssaasssa', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'nextToken' => ['description' => 'Token for the next page', 'type' => 'string', 'example' => 'xsxxs', 'title' => ''], + 'totalCount' => ['description' => 'Total number of jobs', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], ], + '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.', - ], + ['errorCode' => 'InvalidCluster.NotFound', 'errorMessage' => 'No cluster is available to generate the workspace.', 'description' => 'No cluster is available to generate the workspace.'], + ['errorCode' => 'InvalidCodeUrl.NotSupportSVN', 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', 'description' => 'The parameter codeUrl is invalid. SVN is not supported.'], + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidResource.NotFound', 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', 'description' => 'No resource is found. You cannot create the workspace. Please try again later.'], + ['errorCode' => 'InvalidResourceRole.NotFoun', 'errorMessage' => 'The member role is invalid.', 'description' => 'The member role is invalid.'], + ['errorCode' => 'InvalidResourceRole.NotFound', 'errorMessage' => 'The member role is invalid.', 'description' => ''], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => 'The user that is invoking the API service is not a registered user.'], + ['errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', 'errorMessage' => 'Resource owner cannot be deleted.', 'description' => 'The resource owner cannot be deleted.'], + ['errorCode' => 'InvalidUser.ResourceMemberNotExists', 'errorMessage' => 'The resource member does not exist.', 'description' => 'The resource member does not exist.'], + ['errorCode' => 'InvalidUser.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization.', 'description' => 'The user is not in the organization.'], ], 403 => [ - [ - 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', - 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', - ], + ['errorCode' => 'Forbidden.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], ], [ - [ - 'errorCode' => 'InvalidOrganization.NotFound', - 'errorMessage' => 'The organization is not found.', - ], + ['errorCode' => 'InvalidIdentifier.NotFound', 'errorMessage' => 'space id is error or not exist.', 'description' => ''], + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], + ['errorCode' => 'InvalidPipeline.NotFound', 'errorMessage' => 'The pipeline is not found.', 'description' => 'The pipeline does not exist.'], + ['errorCode' => 'InvalidPipelineRun.NotFound', 'errorMessage' => 'The pipeline execution instance is not found.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'InvalidWorkspace.NotFound', 'errorMessage' => 'The workspace is not found.', 'description' => 'The workspace 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', + '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"}]', + 'title' => 'Retrieve Execution History of Pipeline Jobs', + 'changeSet' => [ + ['createdAt' => '2021-12-30T14:20:57.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPipelineJobHistorys'], + ], ], + 'ramActions' => [], + ], + 'ListPipelineJobs' => [ + 'summary' => 'Obtain pipeline execution jobs by job categorization.', + 'path' => '/organization/{organizationId}/pipeline/{pipelineId}/jobs', + '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', - ], + 'schema' => ['title' => '', 'description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, such as https://devops.aliyun.com/organization/【OrganizationId】', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ 'name' => 'pipelineId', 'in' => 'path', + 'schema' => ['description' => 'Pipeline ID', 'type' => 'string', 'required' => true, 'example' => '1111', 'maxLength' => 1000, 'title' => ''], + ], + [ + 'name' => 'category', + 'in' => 'query', 'schema' => [ - 'title' => '流水线ID,可在流水线链接中获取,如 https:// flow.aliyun.com/pipelines/【PipelineId】/current', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'Job categorization. Currently, only DEPLOY is supported.', + 'type' => 'string', 'required' => true, - 'docRequired' => true, - 'example' => '234', + 'example' => 'DEPLOY', + 'enum' => ['DEPLOY'], + 'title' => '', ], ], ], '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' => '""', - ], - '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', - ], - ], - ], - ], - ], - ], - ], + 'requestId' => ['title' => '', 'description' => 'Request ID. Each request has a unique value, which facilitates troubleshooting later.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => '”“'], + 'success' => ['title' => '', 'description' => 'true if the API call succeeded; false if the API call failed.', 'type' => 'boolean', 'example' => 'true 接口调用成功,false 接口调用失败'], + 'errorCode' => ['title' => '', 'description' => 'Error code', 'type' => 'string', 'example' => '”“'], + 'jobs' => [ + 'description' => 'Pipeline execution jobs', + 'type' => 'array', + 'items' => [ + 'description' => 'Pipeline execution jobs', + 'type' => 'object', + 'properties' => [ + 'jobName' => ['description' => 'Job Name', 'type' => 'string', 'example' => '任务名称', 'title' => ''], + 'identifier' => ['description' => 'Job identity', 'type' => 'string', 'example' => 'ss_saxsxsxs', 'title' => ''], + 'lastJobId' => ['description' => 'ID of the last executed job', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'lastJobParams' => ['description' => 'Parameters of the last executed job', 'type' => 'string', 'example' => '{}', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - ], - 'success' => [ - 'title' => 'true 接口调用成功,false 接口调用失败', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'errorCode' => [ - 'title' => '错误码', - 'description' => '', - 'type' => 'string', - 'example' => '""', + 'title' => '', + 'example' => '', ], ], + '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.', - ], + ['errorCode' => 'InvalidCluster.NotFound', 'errorMessage' => 'No cluster is available to generate the workspace.', 'description' => 'No cluster is available to generate the workspace.'], + ['errorCode' => 'InvalidCodeUrl.NotSupportSVN', 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', 'description' => 'The parameter codeUrl is invalid. SVN is not supported.'], + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidResource.NotFound', 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', 'description' => 'No resource is found. You cannot create the workspace. Please try again later.'], + ['errorCode' => 'InvalidResourceRole.NotFoun', 'errorMessage' => 'The member role is invalid.', 'description' => 'The member role is invalid.'], + ['errorCode' => 'InvalidResourceRole.NotFound', 'errorMessage' => 'The member role is invalid.', 'description' => ''], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => 'The user that is invoking the API service is not a registered user.'], + ['errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', 'errorMessage' => 'Resource owner cannot be deleted.', 'description' => 'The resource owner cannot be deleted.'], + ['errorCode' => 'InvalidUser.ResourceMemberNotExists', 'errorMessage' => 'The resource member does not exist.', 'description' => 'The resource member does not exist.'], + ['errorCode' => 'InvalidUser.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization.', 'description' => 'The user is not in the organization.'], ], 403 => [ - [ - 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', - 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', - ], + ['errorCode' => 'Forbidden.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], ], [ - [ - 'errorCode' => 'InvalidOrganization.NotFound', - 'errorMessage' => 'The organization is not found.', - ], - [ - 'errorCode' => 'InvalidPipeline.NotFound', - 'errorMessage' => 'The pipeline is not found.', - ], + ['errorCode' => 'InvalidIdentifier.NotFound', 'errorMessage' => 'space id is error or not exist.', 'description' => ''], + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], + ['errorCode' => 'InvalidPipeline.NotFound', 'errorMessage' => 'The pipeline is not found.', 'description' => 'The pipeline does not exist.'], + ['errorCode' => 'InvalidPipelineRun.NotFound', 'errorMessage' => 'The pipeline execution instance is not found.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'InvalidWorkspace.NotFound', 'errorMessage' => 'The workspace is not found.', 'description' => 'The workspace 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', + '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"}]', + 'title' => 'Obtain pipeline execution jobs by job categorization.', + 'changeSet' => [ + ['createdAt' => '2021-12-30T14:20:57.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPipelineJobs'], + ], ], + 'ramActions' => [], + ], + 'ListPipelineRelations' => [ + 'summary' => 'Retrieves the variable groups associated with a pipeline.', + 'path' => '/organization/{organizationId}/{pipelineId}/pipelineRelations', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', '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', - ], + 'schema' => ['description' => 'The ID of the organization. You can obtain this ID from your Alibaba Cloud DevOps URL. The URL format is `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx', 'title' => ''], ], [ 'name' => 'pipelineId', 'in' => 'path', - 'schema' => [ - 'title' => '流水线id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '12222', - ], + 'schema' => ['description' => 'The ID of the pipeline. You can obtain this ID from the pipeline URL. The URL format is `https://flow.aliyun.com/pipelines/{pipelineId}/current`.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '11'], ], [ - 'name' => 'pipelineRunId', - 'in' => 'path', + 'name' => 'relObjectType', + 'in' => 'query', 'schema' => [ - 'title' => '流水线运行实例id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The resource type to query. The only supported value is `VARIABLE_GROUP`.', + 'type' => 'string', 'required' => true, - 'example' => '1', + 'enum' => ['VARIABLE_GROUP', 'OSS_APP_ID'], + 'title' => '', + 'example' => 'VARIABLE_GROUP', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response body.', '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' => '', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'requestId' => ['description' => 'The unique ID for the request, used for troubleshooting.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', 'title' => ''], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'success' => ['description' => 'Indicates if the request was successful (`true`) or not (`false`).', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'pipelineRelations' => [ + 'title' => '', + 'description' => 'A list of associated variable groups.', + 'type' => 'array', + 'items' => [ + 'description' => 'A variable group associated with the pipeline.', + 'type' => 'object', + 'properties' => [ + 'refObjectId' => ['description' => 'The ID of the variable group.', 'type' => 'integer', 'format' => 'int64', 'example' => '12234', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - ], - 'success' => [ - 'title' => 'true 接口调用成功,false 接口调用失败', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'errorCode' => [ - 'title' => '错误码', - 'description' => '', - 'type' => 'string', - 'example' => '""', + 'example' => '', ], ], + 'title' => '', + '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.', - ], + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => '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' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], ], [ - [ - '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' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], ], ], - '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"}]', + '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"}]', + 'title' => 'Obtain the pipeline association list ', + 'changeSet' => [ + ['createdAt' => '2023-08-31T14:28:55.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPipelineRelations'], + ], + ], + 'ramActions' => [], ], 'ListPipelineRuns' => [ - 'summary' => '获取流水线运行历史', + 'summary' => 'You can obtain a list of pipeline run instances.', 'path' => '/organization/{organizationId}/pipelines/{pipelineId}/pipelineRuns', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'list', - ], + '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', - ], + 'schema' => ['title' => '', 'description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, for example: https://devops.aliyun.com/organization/【OrganizationId】 ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ 'name' => 'startTime', 'in' => 'query', - 'schema' => [ - 'title' => '开始时间', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1586863220000', - ], + 'schema' => ['title' => '', 'description' => 'Start Time', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1586863220000'], ], [ 'name' => 'endTime', 'in' => 'query', - 'schema' => [ - 'title' => '结束时间', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1586863220000', - ], + 'schema' => ['title' => '', 'description' => 'End Time', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1586863220000'], ], [ 'name' => 'status', 'in' => 'query', - 'schema' => [ - 'title' => '状态 状态 FAIL 运行失败 SUCCESS 运行成功 RUNNING 运行中', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'RUNNING', - ], + 'schema' => ['title' => '', 'description' => 'Status: FAIL indicates failed, SUCCESS indicates succeeded, RUNNING indicates running', 'type' => 'string', 'required' => false, 'example' => 'RUNNING'], ], [ 'name' => 'maxResults', 'in' => 'query', - 'schema' => [ - 'title' => '最大返回数量', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'example' => '20', - ], + 'schema' => ['title' => '', 'description' => 'Maximum number of returned results ', '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', - ], + 'schema' => ['title' => '', 'description' => 'Paging token ', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'aaaaaa'], ], [ 'name' => 'pipelineId', 'in' => 'path', - 'schema' => [ - 'title' => '流水线id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1233', - ], + 'schema' => ['title' => '', 'description' => 'Pipeline ID, which can be obtained from the pipeline link, for example: https://flow.aliyun.com/pipelines/【PipelineId】/current'."\n", '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', - ], + 'schema' => ['title' => '', 'description' => '- Trigger mode'."\n" + ."\n" + .' 1 Manual trigger'."\n" + .' '."\n" + .' 2 Scheduled trigger '."\n" + ."\n" + .' 3 Code submission trigger'."\n" + .' '."\n" + .' 5 Pipeline trigger'."\n" + ."\n" + .' 6 WEBHOOK trigger', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], ], 'responses' => [ @@ -32399,286 +17664,141 @@ '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', - ], + 'requestId' => ['title' => '', 'description' => 'Request ID. Each request has a unique value, which facilitates troubleshooting. ', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['title' => '', 'description' => 'Error message ', 'type' => 'string', 'example' => '”“'], + 'errorCode' => ['title' => '', 'description' => 'Error code ', 'type' => 'string', 'example' => '”“'], + 'success' => ['title' => '', 'description' => 'true indicates that the API call succeeded; false indicates that the API call failed. ', 'type' => 'boolean', 'example' => 'true'], + 'totalCount' => ['title' => '', 'description' => 'Total quantity ', 'type' => 'integer', 'format' => 'int64', 'example' => '50'], + 'nextToken' => ['title' => '', 'description' => 'The next paging token. If empty, there is no next page. ', 'type' => 'string', 'example' => 'xzxsasasaas'], 'pipelineRuns' => [ - 'title' => '流水线运行实例', - 'description' => '', + 'title' => '', + 'description' => 'Pipeline run instances', '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 运行中', - ], + 'pipelineId' => ['title' => '', 'description' => 'Pipeline ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'], + 'startTime' => ['title' => '', 'description' => 'Start Time', 'type' => 'integer', 'format' => 'int64', 'example' => '1586863220000'], + 'creatorAccountId' => ['title' => '', 'description' => 'Alibaba Cloud account ID of the runner', 'type' => 'string', 'example' => '1222222222'], + 'endTime' => ['title' => '', 'description' => 'End Time', 'type' => 'integer', 'format' => 'int64', 'example' => '1586863220000'], + 'pipelineRunId' => ['title' => '', 'description' => 'Pipeline instance ID', 'type' => 'integer', 'format' => 'int64', 'example' => '11'], + 'triggerMode' => ['title' => '', 'description' => '- Trigger pattern'."\n" + ."\n" + .' 1 Manual trigger'."\n" + .' '."\n" + .' 2 Scheduled trigger'."\n" + ."\n" + .' 3 Code commit trigger'."\n" + ."\n" + .' 5 Pipeline trigger'."\n" + ."\n" + .' 6 Webhook trigger', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'status' => ['title' => '', 'description' => 'Run status ', 'type' => 'string', 'example' => '状态 FAIL 运行失败 SUCCESS 运行成功 RUNNING 运行中'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + '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.', - ], + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => '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' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], ], [ - [ - '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' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], + ['errorCode' => 'InvalidPipeline.NotFound', 'errorMessage' => 'The pipeline is not found.', 'description' => 'The pipeline does not exist.'], + ['errorCode' => 'InvalidPipelineRun.NotFound', 'errorMessage' => 'The pipeline execution instance is not found.', 'description' => 'The pipeline execution instance is not found.'], + ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Retrieve the list of pipeline run instances ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPipelineRuns'], ], ], - '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":""}]', + 'ramActions' => [], ], 'ListPipelines' => [ - 'summary' => '获取流水线列表', + 'summary' => 'Gets a list of pipelines.', 'path' => '/organization/{organizationId}/pipelines', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'list', - ], + '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', - ], + 'schema' => ['description' => 'The organization ID. You can find this ID in the Alibaba Cloud DevOps URL, for example, `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5ebbc0228123212b59xxxxx', 'title' => ''], ], [ 'name' => 'pipelineName', 'in' => 'query', - 'schema' => [ - 'title' => '流水线名称', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '流水线', - ], + 'schema' => ['description' => 'The pipeline name.', 'type' => 'string', 'required' => false, 'example' => '流水线A', 'title' => ''], ], [ 'name' => 'creatorAccountIds', 'in' => 'query', - 'schema' => [ - 'title' => '创建人阿里云账号Id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '112122121', - ], + 'schema' => ['description' => 'A comma-separated list of the Alibaba Cloud account IDs of the creators.', 'type' => 'string', 'required' => false, 'example' => '112122121', 'title' => ''], ], [ 'name' => 'executeAccountIds', 'in' => 'query', - 'schema' => [ - 'title' => '执行人阿里云账号id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1111111', - ], + 'schema' => ['description' => 'A comma-separated list of the Alibaba Cloud account IDs of the executors.', 'type' => 'string', 'required' => false, 'example' => '1111111', 'title' => ''], ], [ 'name' => 'statusList', 'in' => 'query', - 'schema' => [ - 'title' => '状态列表,多个逗号分割', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'RUNNING,SUCCESS', - ], + 'schema' => ['description' => 'A comma-separated list of pipeline statuses for filtering the results. Valid values: `SUCCESS`, `RUNNING`, `FAIL`, `CANCELED`, and `WAITING`.', 'type' => 'string', 'required' => false, 'example' => 'RUNNING,SUCCESS', 'title' => ''], ], [ 'name' => 'createStartTime', 'in' => 'query', - 'schema' => [ - 'title' => '创建开始时间', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1586863220000', - ], + 'schema' => ['description' => 'The start of the time range to filter pipelines by creation date. Specify the time as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1586863220000', 'title' => ''], ], [ 'name' => 'createEndTime', 'in' => 'query', - 'schema' => [ - 'title' => '创建结束时间', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1586863220000', - ], + 'schema' => ['description' => 'The end of the time range to filter pipelines by creation date. Specify the time as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1586863220000', 'title' => ''], ], [ 'name' => 'executeStartTime', 'in' => 'query', - 'schema' => [ - 'title' => '执行开始时间', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1586863220000', - ], + 'schema' => ['description' => 'The start of the time range to filter pipelines by execution date. Specify the time as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1586863220000', 'title' => ''], ], [ 'name' => 'executeEndTime', 'in' => 'query', - 'schema' => [ - 'title' => '执行结束时间', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1586863220000', - ], + 'schema' => ['description' => 'The end of the time range to filter pipelines by execution date. Specify the time as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1586863220000', 'title' => ''], ], [ 'name' => 'maxResults', 'in' => 'query', - 'schema' => [ - 'title' => '返回的总数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'example' => '20', - ], + 'schema' => ['description' => 'The maximum number of pipelines to return on each page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '20', 'title' => ''], ], [ 'name' => 'nextToken', 'in' => 'query', - 'schema' => [ - 'title' => '分页Token', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'aaaaaaaaaa', - ], + 'schema' => ['description' => 'The token that specifies the next page of results to return.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'aaaaaaaaaa', 'title' => ''], ], ], 'responses' => [ @@ -32686,513 +17806,392 @@ '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', - ], + 'requestId' => ['description' => 'The unique ID for the request, used for troubleshooting.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', 'title' => ''], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'success' => ['description' => 'Indicates whether the API call was successful. A value of `true` indicates success, and `false` indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'totalCount' => ['description' => 'The total number of pipelines.', 'type' => 'integer', 'format' => 'int64', 'example' => '50', 'title' => ''], + 'nextToken' => ['description' => 'The token used to retrieve the next page of results. If this parameter is not returned, there are no more results.', 'type' => 'string', 'example' => 'ssaassasass', 'title' => ''], 'pipelines' => [ - 'title' => '流水线', - 'description' => '', + 'title' => '', + 'description' => 'A list of pipelines.', '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', - ], + 'pipelineName' => ['description' => 'The name of the pipeline.', 'type' => 'string', 'example' => '流水线', 'title' => ''], + 'pipelineId' => ['description' => 'The ID of the pipeline.', 'type' => 'integer', 'format' => 'int64', 'example' => '124', 'title' => ''], + 'createTime' => ['description' => 'The time when the pipeline was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1586863220000', 'title' => ''], + 'creatorAccountId' => ['description' => 'The account ID of the creator.', 'type' => 'string', 'example' => '22121222', 'title' => ''], + 'groupId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + '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.', - ], + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => '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' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], ], [ - [ - 'errorCode' => 'InvalidOrganization.NotFound', - 'errorMessage' => 'The organization is not found.', - ], - [ - 'errorCode' => 'InvalidPipeline.NotFound', - 'errorMessage' => 'The pipeline is not found.', - ], + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], + ['errorCode' => 'InvalidPipeline.NotFound', 'errorMessage' => 'The pipeline is not found.', 'description' => 'The pipeline does not exist.'], ], ], - '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', + 'responseDemo' => '[{"errorExample":"","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 \\"groupId\\": 0\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Obtain Pipeline List ', + 'changeSet' => [ + ['createdAt' => '2022-07-28T13:00:29.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPipelines'], + ], ], + 'ramActions' => [], + ], + 'ListProjectLabels' => [ + 'summary' => 'Retrieves a list of repository labels. This operation supports pagination, sorting, and keyword search.', + 'path' => '/api/v4/projects/labels', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'organizationId', - 'in' => 'path', - 'schema' => [ - 'title' => '企业标识,也称企业id,字符串形式,可在云效访问链接中获取,如https://devops.aliyun.com/organization/【OrganizationId】', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'in' => 'query', + 'schema' => ['title' => 'A short description of struct', 'description' => 'The organization ID. You can obtain the organization ID from the URL of your organization on Alibaba Cloud DevOps. The URL is in the format `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ - 'name' => 'filePath', + 'name' => 'accessToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '/test/test/test.tgz', - 'maxLength' => 1000, - ], + 'schema' => ['description' => 'The personal access token. This parameter is not required if you use an Alibaba Cloud AccessKey pair or STS temporary authorization for authentication.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], ], [ - 'name' => 'fileName', + 'name' => 'repositoryIdentity', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test.tgz', - ], + 'schema' => ['description' => 'The ID or full path of the repository.', 'type' => 'string', 'required' => true, 'example' => '2835387 或 codeup/codeup-demo', 'title' => ''], + ], + [ + 'name' => 'search', + 'in' => 'query', + 'schema' => ['description' => 'A keyword used to filter labels by name.', 'type' => 'string', 'required' => false, 'example' => 'TEST', 'title' => ''], + ], + [ + 'name' => 'page', + 'in' => 'query', + 'schema' => ['description' => 'The page number of the results to return. Starts from 1. Default: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of results per page. The value must be between 1 and 100. Default: 20.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'orderBy', + 'in' => 'query', + 'schema' => ['description' => 'The field to sort the results by. Valid values:'."\n" + ."\n" + .'- `label_name`: Sorts by label name (default).', 'type' => 'string', 'required' => false, 'example' => 'label_name', 'title' => ''], + ], + [ + 'name' => 'sort', + 'in' => 'query', + 'schema' => ['description' => 'The sort order. Default: `desc`. Valid values:'."\n" + ."\n" + .'- `desc`: Descending'."\n" + ."\n" + .'- `asc`: Ascending', 'type' => 'string', 'required' => false, 'example' => 'desc', 'title' => ''], + ], + [ + 'name' => 'withCounts', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to return the count of associated merge requests. Default: `false`.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response body.', '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/', + 'requestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'success' => ['description' => 'Indicates whether the request succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'errorCode' => ['description' => 'The error code if the request fails.', 'type' => 'string', 'example' => 'Openapi.RequestError', 'title' => ''], + 'errorMessage' => ['description' => 'The error message if the request fails.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'total' => ['description' => 'The total count of matching labels.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], + 'result' => [ + 'description' => 'The list of returned labels.', + 'type' => 'array', + 'items' => [ + 'description' => 'A label object.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The unique ID of the label.', 'type' => 'string', 'example' => 'f2bf0e0b4ce34a348b2d971c69a1d11f', 'title' => ''], + 'name' => ['description' => 'The name of the label.', 'type' => 'string', 'example' => '优化', 'title' => ''], + 'color' => ['description' => 'The hexadecimal color code of the label.', 'type' => 'string', 'example' => '#A16AD7', 'title' => ''], + 'description' => ['description' => 'The description of the label.', 'type' => 'string', 'example' => '已有内容的优化或重构', 'title' => ''], + 'openMergeRequestsCount' => ['description' => 'The number of open merge requests associated with this label.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + '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.', - ], + '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"}]', + 'title' => 'Query Label List ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProjectLabels'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\",\\n \\"fileUrl\\": \\"http://aliyun.com/\\"\\n}","type":"json"}]', + 'ramActions' => [], ], - 'GetPipelineEmasArtifactUrl' => [ - 'summary' => '获取emase构建物下载链接', - 'path' => '/organization/{organizationId}/pipeline/{pipelineId}/pipelineRun/{pipelineRunId}/emas/artifact/{emasJobInstanceId}/{md5}', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListProjectMembers' => [ + 'summary' => 'Gets project members.', + 'path' => '/organization/{organizationId}/projects/{projectId}/listMembers', + '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, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['description' => 'The ID of the organization. You can get this ID from the Alibaba Cloud DevOps URL, for example, `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx', 'title' => ''], ], [ - 'name' => 'emasJobInstanceId', + 'name' => 'projectId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'Psaxsa', - ], + 'schema' => ['description' => 'The ID of the project, which is equivalent to `spaceIdentifier`.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'e8bxxxxx2abd6e76aa209b07d23'], ], [ - 'name' => 'md5', - 'in' => 'path', + 'name' => 'targetType', + 'in' => 'query', + 'schema' => ['description' => 'The resource type. The value must be Space.', 'type' => 'string', 'required' => true, 'example' => 'Space', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'A unique identifier for the request, used for troubleshooting.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', 'title' => ''], + 'errorMsg' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'error', 'title' => ''], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Openapi.RequestError', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful. Valid values: `true` and `false`.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'members' => [ + 'title' => '', + 'description' => 'A list of project members.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'account' => ['description' => 'The login account of the project member.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'avatar' => ['description' => 'The URL of the member\'s avatar.', 'type' => 'string', 'example' => 'https://xxxxxx.png', 'title' => ''], + 'dingTalkId' => ['description' => 'The DingTalk ID of the member.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'displayName' => ['description' => 'The display name of the member.', 'type' => 'string', 'example' => '名称', 'title' => ''], + 'displayNickName' => ['description' => 'The display nickname of the member.', 'type' => 'string', 'example' => 'mingcheng', 'title' => ''], + 'displayRealName' => ['description' => 'The display real name of the member.', 'type' => 'string', 'example' => '名称', 'title' => ''], + 'division' => [ + 'title' => '', + 'description' => 'The division to which the member belongs.', + 'type' => 'object', + 'properties' => [ + 'identifier' => ['description' => 'The unique identifier for the division.', 'type' => 'string', 'example' => '1345xxxxxxx947xxxx', 'title' => ''], + ], + 'example' => '', + ], + 'email' => ['description' => 'The email address of the member.', 'type' => 'string', 'example' => 'accountsxxxx@mail.com', 'title' => ''], + 'gender' => ['description' => 'The gender of the member.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'identifier' => ['description' => 'The unique identifier for the member.', 'type' => 'string', 'example' => '19xxxx31947xxxx', 'title' => ''], + 'mobile' => ['description' => 'The mobile number of the member.', 'type' => 'string', 'example' => '135xxxxxxxxx', 'title' => ''], + 'nameEn' => ['description' => 'The English name of the member.', 'type' => 'string', 'example' => 'name', 'title' => ''], + 'nickName' => ['description' => 'The nickname of the member.', 'type' => 'string', 'example' => '昵称', 'title' => ''], + 'nickNamePinyin' => ['description' => 'The pinyin of the nickname.', 'type' => 'string', 'example' => 'nicheng', 'title' => ''], + 'organizationUserInfo' => [ + 'title' => '', + 'description' => 'The organization to which the member belongs.', + 'type' => 'object', + 'properties' => [ + 'organizationIdentifier' => ['description' => 'The unique identifier for the organization.', 'type' => 'string', 'example' => '5e7xxxxb3cd3711dd6xxx2c', 'title' => ''], + ], + 'example' => '', + ], + 'realName' => ['description' => 'The real name of the member.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'realNamePinyin' => ['description' => 'The pinyin of the real name.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'stamp' => ['description' => 'The user type. Valid values: `User` (an individual user) or `UserGroup` (a user group).', 'type' => 'string', 'example' => 'User', 'title' => ''], + 'tbRoleId' => ['description' => 'The role ID of the member.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'roleName' => ['title' => '角色名称', 'description' => 'The role name of the member.', 'type' => 'string', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'assasas', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Openapi.RequestError', 'errorMessage' => 'request error', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'Operate.NoPermission', 'errorMessage' => 'NoPermission', 'description' => 'You are not authorized to perform this operation.'], + ], [ - 'name' => 'pipelineId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1111', - ], + ['errorCode' => 'InvaildSpace.NotInCurrentOrganization', 'errorMessage' => 'space not belong to this organization, please switch organization.', 'description' => ''], ], + ], + 'responseDemo' => '[{"errorExample":"","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\\": \\"accountsxxxx@mail.com\\",\\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}","type":"json"}]', + 'title' => 'Obtain Project Members ', + 'changeSet' => [ + ['createdAt' => '2021-12-10T06:11:05.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProjectMembers'], + ], + ], + 'ramActions' => [], + ], + 'ListProjectTemplates' => [ + 'summary' => 'Retrieve the list of project templates.', + 'path' => '/organization/{organizationId}/projects/listTemplates', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'pipelineRunId', + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, for example: https://devops.aliyun.com/organization/【OrganizationId】 ', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx', 'title' => ''], ], [ - 'name' => 'serviceConnectionId', + 'name' => 'category', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '122', - ], + 'schema' => ['title' => '', 'description' => 'Template type. For this scenario, only "Project" should be specified. ', 'type' => 'string', 'required' => true, 'example' => 'Project'], ], ], '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', + 'requestId' => ['title' => '', 'description' => 'Request ID. Each request has a unique value to facilitate troubleshooting.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMsg' => ['title' => '', 'description' => 'Error message ', 'type' => 'string', 'example' => 'error'], + 'errorCode' => ['title' => '', 'description' => 'Error code ', 'type' => 'string', 'example' => 'Openapi.RequestError'], + 'success' => ['title' => '', 'description' => 'true or false', 'type' => 'boolean', 'example' => 'true'], + 'templates' => [ + 'title' => '', + 'description' => 'Project template information', + 'type' => 'array', + 'items' => [ + 'description' => 'Template information', + 'type' => 'object', + 'properties' => [ + 'creator' => ['title' => '', 'description' => 'Alibaba Cloud account ID of the Creator', 'type' => 'string', 'example' => '19xx7043xxxxxxx914'], + 'description' => ['title' => '', 'description' => 'Description ', 'type' => 'string', 'example' => '迭代的具体信息'], + 'gmtCreate' => ['title' => '', 'description' => 'UNIX timestamp of the creation time, in milliseconds ', 'type' => 'integer', 'format' => 'int64', 'example' => '1623916393000'], + 'gmtModified' => ['title' => '', 'description' => 'UNIX timestamp of the Updated At time, in milliseconds', 'type' => 'integer', 'format' => 'int64', 'example' => '1623916393000'], + 'type' => ['title' => '', 'description' => 'Template type '."\n" + .'0-system '."\n" + .'4-custom '."\n" + .'16-instance ', 'type' => 'integer', 'format' => 'int64', 'example' => '4'], + 'icon' => ['title' => '', 'description' => 'Template thumbnail', 'type' => 'string', 'example' => 'https://img.xxxx.png'], + 'identifier' => ['title' => '', 'description' => 'Unique Identifier of the template', 'type' => 'string', 'example' => 'e8bxxxxxxxxxxxxxxxx23'], + 'modifier' => ['title' => '', 'description' => 'Alibaba Cloud account ID of the Updated By user', 'type' => 'string', 'example' => '19xx7043xxxxxxx914'], + 'name' => ['title' => '', 'description' => 'Template Name ', 'type' => 'string', 'example' => '专用模板'], + 'nameEn' => ['title' => '', 'description' => 'Template English name ', 'type' => 'string', 'example' => 'Test Template'], + 'resourceCategory' => ['title' => '', 'description' => 'Resource type to which the template belongs ', 'type' => 'string', 'example' => 'Project'], + 'copyFrom' => ['description' => 'Deprecated field ', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'resourceType' => ['description' => 'Deprecated field ', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'spaceIdentifier' => ['description' => 'Deprecated field ', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'spaceType' => ['description' => 'Deprecated field', 'type' => 'string', 'example' => 'null', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + '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' => 'Openapi.RequestError', 'errorMessage' => 'request error', 'description' => ''], ], 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' => 'Operate.NoPermission', 'errorMessage' => 'NoPermission', 'description' => 'You are not authorized to perform this 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.', - ], + ], + 'title' => 'Obtain the project template list ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProjectTemplates'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\",\\n \\"fileUrl\\": \\"http://aliyun.com\\"\\n}","type":"json"}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'translator' => 'machine', ], - 'GetPipelineScanReportUrl' => [ - 'summary' => '获取扫描报告下载链接', - 'path' => '/organization/{organizationId}/pipeline/getPipelineScanReportUrl', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListProjectWorkitemTypes' => [ + 'summary' => 'Retrieve the work item types in a project.', + 'path' => '/organization/{organizationId}/projects/{projectId}/getWorkitemType', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -33204,477 +18203,237 @@ [ 'name' => 'organizationId', 'in' => 'path', - 'schema' => [ - 'title' => '企业标识,也称企业id,字符串形式,可在云效访问链接中获取,如https://devops.aliyun.com/organization/【OrganizationId】', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['title' => '', 'description' => 'Organization identifier, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, for example: https://devops.aliyun.com/organization/【OrganizationId】 ', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ - 'name' => 'reportPath', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '/test/test/test.html', - 'maxLength' => 1000, - ], + 'name' => 'projectId', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'Project ID, same as spaceIdentifier, which is the UUID of the project ', 'type' => 'string', 'required' => true, 'example' => 'asd345xxxxx9q9845xxxxx34'], + ], + [ + 'name' => 'spaceType', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Space type. Set this parameter to Project. ', 'type' => 'string', 'required' => true, 'example' => 'Project'], + ], + [ + 'name' => 'category', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Work item type: Req for requirement, Bug for bug, Task for Job, and Risk for threat ', 'type' => 'string', 'required' => true, 'example' => 'Req'], ], ], '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', + 'requestId' => ['title' => '', 'description' => 'Request ID. Each request has a unique value, which facilitates troubleshooting later. ', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorCode' => ['title' => '', 'description' => 'Error return code ', 'type' => 'string', 'example' => '例:Openapi.RequestError'], + 'errorMessage' => ['title' => '', 'description' => 'Error response message', 'type' => 'string', 'example' => 'errormessage'], + 'success' => ['title' => '', 'description' => 'Whether the API returns normally ', 'type' => 'boolean', 'example' => 'true或者false'], + 'workitemTypes' => [ + 'title' => '', + 'description' => 'Work item types', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'identifier' => ['title' => '', 'description' => 'Work item type ID', 'type' => 'string', 'example' => 'dfexxxxxf4fee18xxxxx36'], + 'name' => ['title' => '', 'description' => 'Name of the work item type', 'type' => 'string', 'example' => '例:业务类需求'], + 'nameEn' => ['title' => '', 'description' => 'English name of the work item type ', 'type' => 'string', 'example' => '例:Business Requirement'], + 'categoryIdentifier' => ['title' => '', 'description' => 'Work item type: Req for requirement, Bug for bug, Task for job, Risk for threat ', 'type' => 'string', 'example' => 'Req'], + 'systemDefault' => ['title' => '', 'description' => 'Indicates whether it is a system default. true: system default; false: created by the enterprise.', 'type' => 'boolean', 'example' => 'true'], + 'gmtCreate' => ['title' => '', 'description' => 'Creation Time ', 'type' => 'integer', 'format' => 'int64', 'example' => '1620455467000'], + 'creator' => ['title' => '', 'description' => 'Creator of the work item type', 'type' => 'string', 'example' => '用户阿里云pk,例如19xxxx31947xxxx'], + 'description' => ['title' => '', 'description' => 'Description', 'type' => 'string', 'example' => '该类型的具体信息'], + 'enable' => ['title' => '', 'description' => 'Indicates whether it is enabled.', 'type' => 'boolean', 'example' => 'true或者false'], + 'defaultType' => ['title' => '', 'description' => 'Whether it is the default type in the project ', 'type' => 'boolean', 'example' => 'true或者false'], + 'gmtAdd' => ['title' => '', 'description' => 'Time when added to the project ', 'type' => 'integer', 'format' => 'int64', 'example' => '1641870287000'], + 'addUser' => ['title' => '', 'description' => 'User who added the work item type to the project', 'type' => 'string', 'example' => '用户阿里云pk,例如19xxxx31947xxxx'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + '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.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' => 'Openapi.RequestError', 'errorMessage' => 'request error', 'description' => ''], ], 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' => 'Operate.NoPermission', 'errorMessage' => 'NoPermission', 'description' => 'You are not authorized to perform this 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 \\"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}","type":"json"}]', + 'title' => 'Obtain work item types ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProjectWorkitemTypes'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\",\\n \\"reportUrl\\": \\"http://aliyun.com\\"\\n}","type":"json"}]', + 'ramActions' => [], ], - 'ListPipelineJobHistorys' => [ - 'summary' => '获取流水线运行过的任务历史', - 'path' => '/organization/{organizationId}/pipeline/{pipelineId}/job/historys', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListProjects' => [ + 'summary' => 'Retrieve a list of projects, supporting conditional search.', + 'path' => '/organization/{organizationId}/listProjects', + '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, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, for example: https://devops.aliyun.com/organization/【OrganizationId】', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx', 'title' => ''], ], [ - 'name' => 'pipelineId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123', - 'maxLength' => 1000, - ], + 'name' => 'extraConditions', + 'in' => 'query', + 'schema' => ['description' => '1. The search condition for all projects is: '."\n" + .'{"conditionGroups":[[{"className":"user","fieldIdentifier":"users","format":"multiList","operator":"CONTAINS","value":["5f2bfdacb69d..."]}],[{"className":"string","fieldIdentifier":"scope","format":"list","operator":"CONTAINS","value":["public"]}]]} '."\n" + .'2. The condition for projects I manage is: '."\n" + .'{"conditionGroups":[[{"className":"user","fieldIdentifier":"project.admin","format":"multiList","operator":"CONTAINS","value":["5f2bfdacb69d..."]}]]} '."\n" + .'3. For other specific search conditions, refer to the search parameters of the request /project/search/list in the project List on the Page.'."\n", 'type' => 'string', 'required' => false, 'example' => '附加过滤条件', 'title' => ''], ], [ - 'name' => 'category', + 'name' => 'conditions', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'DEPLOY', - 'enum' => [ - 'DEPLOY', - ], - ], + 'schema' => ['description' => '{"conditionGroups":[[]]}', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "conditionGroups": ['."\n" + .' []'."\n" + .' ]'."\n" + .'}', 'title' => ''], ], [ - 'name' => 'identifier', + 'name' => 'category', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '10_ssasasa', - ], + 'schema' => ['title' => '', 'description' => 'Project Mode; enter "Project" here.', 'type' => 'string', 'required' => true, 'example' => 'Project'], ], [ 'name' => 'nextToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'xsaxsa', - ], + 'schema' => ['title' => '', 'description' => 'Leave this field empty for the first page. For subsequent pages, use the value of this field from the previous response to retrieve the next set of paginated data.', 'type' => 'string', 'required' => false, 'example' => '""'], ], [ 'name' => 'maxResults', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '50', - 'example' => '10', - ], + 'schema' => ['title' => '', 'description' => 'Maximum number of results returned per page, ranging from 0 to 200. Default value is 20.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20'], + ], + [ + 'name' => 'scope', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Visibility Type, with values "all" or "collect", representing all projects or my collected projects, respectively.', 'type' => 'string', 'required' => false, 'example' => 'all'], ], ], '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' => '', + 'totalCount' => ['title' => '', 'description' => 'Total quantity', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'nextToken' => ['title' => '', 'description' => 'Paging token; empty if there is no next page ', 'type' => 'string', 'example' => '""'], + 'maxResults' => ['title' => '', 'description' => 'Number of items per page ', 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'requestId' => ['title' => '', 'description' => 'The request ID. Each request has a unique value, which facilitates troubleshooting later.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMsg' => ['title' => '', 'description' => 'error message', 'type' => 'string', 'example' => 'error'], + 'errorCode' => ['title' => '', 'description' => 'error code', 'type' => 'string', 'example' => 'Openapi.RequestError'], + 'success' => ['title' => '', 'description' => 'true or false', 'type' => 'boolean', 'example' => 'true'], + 'projects' => [ + 'title' => '', + 'description' => 'Project information', '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', - ], + 'creator' => ['title' => '', 'description' => 'Creator aliyunPK', 'type' => 'string', 'example' => '19xx7043xxxxxxx914'], + 'customCode' => ['title' => '', 'description' => 'Custom code, unique within the enterprise ', 'type' => 'string', 'example' => 'OJAY'], + 'deleteTime' => ['title' => '', 'description' => 'Deletion time ', 'type' => 'integer', 'format' => 'int64', 'example' => 'null'], + 'description' => ['title' => '', 'description' => 'Description', 'type' => 'string', 'example' => 'xxx'], + 'gmtCreate' => ['title' => '', 'description' => 'Creation Time', 'type' => 'integer', 'format' => 'int64', 'example' => '1640778694000'], + 'icon' => ['title' => '', 'description' => 'Project thumbnail', 'type' => 'string', 'example' => 'https://xxxxxx.png'], + 'identifier' => ['title' => '', 'description' => 'Project UUID', 'type' => 'string', 'example' => 'e8bxxxxxxxxxxxxxxxx23'], + 'name' => ['title' => '', 'description' => 'Project name ', 'type' => 'string', 'example' => 'xxxx'], + 'scope' => ['title' => '', 'description' => 'Indicates whether the project is public or private ', 'type' => 'string', 'example' => 'public'], + 'typeIdentifier' => ['title' => '', 'description' => 'Type ID ', 'type' => 'string', 'example' => 'null'], + 'statusStageIdentifier' => ['title' => '', 'description' => 'Status stage', 'type' => 'string', 'example' => 'null'], + 'logicalStatus' => ['title' => '', 'description' => 'Logical status ', 'type' => 'string', 'example' => 'null'], + 'categoryIdentifier' => ['title' => '', 'description' => 'Resource category', 'type' => 'string', 'example' => 'Project'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - ], - 'nextToken' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xsxxs', - ], - 'totalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + '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' => 'Openapi.RequestError', 'errorMessage' => 'request error', 'description' => ''], ], 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' => 'Operate.NoPermission', 'errorMessage' => 'NoPermission', 'description' => 'You are not authorized to perform this 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 \\"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}","type":"json"}]', + 'title' => 'Obtain project list', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProjects'], ], ], - '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"}]', + 'ramActions' => [], ], - 'ListPipelineJobs' => [ - 'summary' => '获取流水线运行过的任务', - 'path' => '/organization/{organizationId}/pipeline/{pipelineId}/jobs', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListProtectedBranches' => [ + 'summary' => 'Query the list of protected branches in a code repository.', + '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' => 'path', - 'schema' => [ - 'title' => '企业标识,也称企业id,字符串形式,可在云效访问链接中获取,如https://devops.aliyun.com/organization/【OrganizationId】', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'in' => 'query', + 'schema' => ['title' => 'A short description of struct', 'description' => 'The enterprise identifier, also known as the organization ID, is a string that can be obtained from the Alibaba Cloud DevOps access link, such as https://devops.aliyun.com/organization/【OrganizationId】.', 'type' => 'string', 'required' => true, 'example' => '60de7a6852743a5162b5f957'], ], [ - 'name' => 'pipelineId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1111', - 'maxLength' => 1000, - ], + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => ['description' => 'Personal access token. '."\n" + .'This field is not required when using an Alibaba Cloud AccessKey ID and AccessKey secret or when using temporary authorization via Security Token Service (STS).', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513'."\n", 'title' => ''], ], [ - 'name' => 'category', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'DEPLOY', - 'enum' => [ - 'DEPLOY', - ], - ], + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => ['description' => 'Repository ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2813489', 'title' => ''], ], ], 'responses' => [ @@ -33684,550 +18443,560 @@ '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' => '', + 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID ', 'type' => 'string', 'example' => '313A1BF6-63B7-52D4-A098-952221A65254'], + 'errorMessage' => ['description' => 'Error message ', 'type' => 'string', 'example' => '""', 'title' => ''], + 'errorCode' => ['description' => 'Error code ', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'success' => ['description' => 'Indicates whether the invocation succeeded ', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'result' => [ + 'description' => 'List of return results', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Return Result', 'type' => 'object', 'properties' => [ - 'jobName' => [ - 'description' => '', - 'type' => 'string', + 'id' => ['description' => 'ID of the protected branch rule ', 'type' => 'integer', 'format' => 'int64', 'example' => '19285', 'title' => ''], + 'branch' => ['description' => 'Protected branch name ', 'type' => 'string', 'example' => 'protectedBranch', 'title' => ''], + 'createdAt' => ['description' => 'Creation Time ', 'type' => 'string', 'example' => '2022-03-18 14:24:54', 'title' => ''], + 'updatedAt' => ['description' => 'Update Time ', 'type' => 'string', 'example' => '2022-03-18 14:24:54', 'title' => ''], + 'allowPushRoles' => [ + 'description' => 'List of roles allowed to push ', + 'type' => 'array', + 'items' => ['description' => 'Role '."\n" + .'40: administrator '."\n" + .'30: developer ', 'type' => 'integer', 'format' => 'int32', 'example' => '[40, 30]', 'title' => ''], + 'title' => '', 'example' => '', ], - 'identifier' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ss_saxsxsxs', + 'allowPushUserIds' => [ + 'description' => 'User IDs allowed to push ', + 'type' => 'array', + 'items' => ['description' => 'Codeup User ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '19238', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'lastJobId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', + 'allowPushUsers' => [ + 'description' => 'List of users allowed to push', + 'type' => 'array', + 'items' => [ + 'description' => 'User information', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'Codeup User ID', 'type' => 'integer', 'format' => 'int64', 'example' => '19238', 'title' => ''], + 'name' => ['description' => 'User Name', 'type' => 'string', 'example' => '阿里云云效', 'title' => ''], + 'username' => ['description' => 'User nickname ', 'type' => 'string', 'example' => 'codeup-test', 'title' => ''], + 'email' => ['description' => 'User mailbox', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + 'avatar' => ['description' => 'Profile picture URL', 'type' => 'string', 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'lastJobParams' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{}', + 'allowMergeRoles' => [ + 'description' => 'List of roles allowed to merge ', + 'type' => 'array', + 'items' => ['description' => '40: administrator '."\n" + .'30: developer ', 'type' => 'integer', 'format' => 'int32', 'example' => '[40, 30]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'allowMergeUserIds' => [ + 'description' => 'User IDs allowed to merge', + 'type' => 'array', + 'items' => ['description' => 'Codeup User ID', 'type' => 'integer', 'format' => 'int64', 'example' => '19238', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'allowMergeUsers' => [ + 'description' => 'List of user information allowed to merge ', + 'type' => 'array', + 'items' => [ + 'description' => 'User information ', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'Codeup User ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '19238', 'title' => ''], + 'name' => ['description' => 'User name ', 'type' => 'string', 'example' => '阿里云云效', 'title' => ''], + 'username' => ['description' => 'User nickname ', 'type' => 'string', 'example' => 'codeup-test', 'title' => ''], + 'email' => ['description' => 'User mailbox ', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + 'avatar' => ['description' => 'Profile picture URL ', 'type' => 'string', 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'mergeRequestSetting' => [ + 'description' => 'Code review settings before merge', + 'type' => 'object', + 'properties' => [ + 'isRequired' => ['description' => 'Enabled', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'mrMode' => ['description' => 'Code review pattern '."\n" + .'general: standard '."\n" + .'codeowner: CodeOwner pattern', 'type' => 'string', 'example' => 'general', 'title' => ''], + 'isAllowSelfApproval' => ['description' => 'Whether to allow the creator to pass the code review', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'isRequireDiscussionProcessed' => ['description' => 'Indicates whether all discussions must be resolved before merging ', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'isResetApprovalWhenNewPush' => ['description' => 'Whether to reset code review approval when a new push is submitted', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'minimumApproval' => ['description' => 'Minimum number of approvers required for code review to pass '."\n" + .'Note: Only effective in NAT mode.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'allowMergeRequestRoles' => [ + 'description' => 'List of roles allowed to create merge requests ', + 'type' => 'array', + 'items' => ['description' => '40: administrator (default) '."\n" + .'30: developer ', 'type' => 'integer', 'format' => 'int32', 'example' => '[40, 30]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'defaultAssignees' => [ + 'description' => 'Default reviewers', + 'type' => 'array', + 'items' => [ + 'description' => 'Reviewer information', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'User ID in Codeup', 'type' => 'integer', 'format' => 'int64', 'example' => '19238', 'title' => ''], + 'username' => ['description' => 'User nickname', 'type' => 'string', 'example' => 'codeup-test', 'title' => ''], + 'name' => ['description' => 'User Name', 'type' => 'string', 'example' => '阿里云云效', 'title' => ''], + 'email' => ['description' => 'User mailbox', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + 'avatar' => ['description' => 'Profile picture URL', 'type' => 'string', 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'whiteList' => ['description' => 'Whitelist of review files '."\n" + .'Note: Files added to the whitelist are not subject to the "minimum number of reviewers required for approval" rule and do not require mandatory manual review. ', 'type' => 'string', 'example' => '**.java', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'testSettingDTO' => [ + 'description' => 'Automated status check settings before merging ', + 'type' => 'object', + 'properties' => [ + 'isRequired' => ['description' => 'Enabled ', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'codeGuidelinesDetection' => [ + 'description' => 'Alibaba Coding Guidelines scan', + 'type' => 'object', + 'properties' => [ + 'enabled' => ['description' => 'Enabled', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'message' => ['description' => 'Description', 'type' => 'string', 'example' => 'test_code_guide_lines', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'sensitiveInfoDetection' => [ + 'description' => 'Sensitive Information scan', + 'type' => 'object', + 'properties' => [ + 'enabled' => ['description' => 'Enabled', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'message' => ['description' => 'Description', 'type' => 'string', 'example' => 'test_code_sensitive_info', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'checkTaskQualityConfig' => [ + 'description' => 'Code Quality Detection ', + 'type' => 'object', + 'properties' => [ + 'enabled' => ['description' => 'Enabled', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'bizNo' => ['description' => 'Job stream number ', 'type' => 'string', 'example' => '123456', 'title' => ''], + 'taskName' => ['description' => 'Task Name', 'type' => 'string', 'example' => 'biz-task-quality', 'title' => ''], + 'message' => ['description' => 'Description', 'type' => 'string', 'example' => 'test_task_quality', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'checkConfig' => [ + 'description' => 'MR blocking point pipeline configuration ', + 'type' => 'object', + 'properties' => [ + 'checkItems' => [ + 'description' => 'configuration item ', + 'type' => 'array', + 'items' => [ + 'description' => 'configuration item ', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'stream Name ', 'type' => 'string', 'example' => '测试流水线', 'title' => ''], + 'isRequired' => ['description' => 'is point ', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'matches' => [ + 'description' => 'List of protected branch matches ', + 'type' => 'array', + 'items' => ['description' => 'Matching branch name ', 'type' => 'string', 'example' => '["pb"]', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + '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.', - ], + ['errorCode' => 'Forbidden.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => '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.', 'description' => ''], ], ], - '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', + '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\\": \\"username@example.com\\",\\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\\": \\"username@example.com\\",\\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\\": \\"username@example.com\\",\\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"}]', + 'title' => 'Query protected branch list', + 'changeSet' => [ + ['createdAt' => '2023-07-24T06:14:46.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProtectedBranches'], + ], ], + 'ramActions' => [], + ], + 'ListPushRules' => [ + 'summary' => 'Lists the push rules for a specified repository. This operation does not support pagination.', + 'path' => '/api/v4/projects/{repositoryId}/push_rule/push_rules/list', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'list'], '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', - ], + 'in' => 'query', + 'schema' => ['description' => 'The organization ID. You can find this ID in the URL of your organization\'s page on the Alibaba Cloud DevOps platform: `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'required' => true, 'example' => '60d54f3daccf2bbd6659f3ad', 'title' => ''], ], [ - 'name' => 'jobId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '12', - ], + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => ['description' => 'The personal access token. This parameter is not required if you use an Alibaba Cloud AccessKey pair or a Security Token Service (STS) token for authentication.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], ], [ - 'name' => 'pipelineRunId', + 'name' => 'repositoryId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '12', - ], + 'schema' => ['description' => 'The ID of the repository.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '889910', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response 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', + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Openapi.RequestError', 'title' => ''], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'total' => ['description' => 'The total number of results.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'result' => [ + 'description' => 'The list of results.', + 'type' => 'array', + 'items' => [ + 'description' => 'Details of a push rule.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The ID of the push rule.', 'type' => 'integer', 'format' => 'int64', 'example' => '2077', 'title' => ''], + 'ruleInfos' => [ + 'description' => 'A list of rule details.', + 'type' => 'array', + 'items' => [ + 'description' => 'Details of a rule checker.', + 'type' => 'object', + 'properties' => [ + 'checkerName' => ['description' => 'The name of the rule checker. Valid values include:'."\n" + ."\n" + .'- `CommitMessageChecker`: The commit message rule.'."\n" + ."\n" + .'- `CommitAuthorEmailChecker`: The commit author email rule.'."\n" + ."\n" + .'- `CommitAuthorChecker`: The commit author check.'."\n" + ."\n" + .'- `CommitCommitterChecker`: The committer check.'."\n" + ."\n" + .'- `ForcePushChecker`: The force push check.'."\n" + ."\n" + .'- `CommitFilesChecker`: The committed file restriction rule.', 'type' => 'string', 'example' => 'CommitFilesChecker', 'title' => ''], + 'checkerType' => ['description' => 'Specifies the restriction level. This parameter is valid only for the commit author check and the committer check. It is optional for other rules. Valid values:'."\n" + ."\n" + .'- `warn`: Issues a warning but allows the push.'."\n" + ."\n" + .'- `block`: Blocks the push.', 'type' => 'string', 'example' => 'warn', 'title' => ''], + 'extraMessage' => ['description' => 'Provides additional configuration for certain rule checkers:'."\n" + ."\n" + .'- For a `commit message rule`, this specifies the `regular expression` for the commit message.'."\n" + ."\n" + .'- For a `commit author email rule`, this specifies the `regular expression` for the author\'s email address.'."\n" + ."\n" + .'- For a `force push check`, set this value to `"disabled"`.'."\n" + ."\n" + .'- For a `commit author check`, set this value to `"on"` to enable the check. Omit this parameter to disable the check.'."\n" + ."\n" + .'- For a `committer check`, set this value to `"on"` to enable the check. Omit this parameter to disable the check.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'fileRuleRegexes' => [ + 'description' => 'This parameter is valid only for the committed file restriction rule. You can provide one or more regular expressions to restrict committed files.', + 'type' => 'array', + 'items' => ['description' => 'A regular expression used to restrict file paths.', 'type' => 'string', 'example' => '\\.java$', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'gmtCreate' => ['description' => 'The time when the rule was created.', 'type' => 'string', 'example' => '2023-09-03T18:20:06+08:00', 'title' => ''], + 'gmtModified' => ['description' => 'The time when the rule was last updated.', 'type' => 'string', 'example' => '2023-09-03T18:20:06+08:00', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - ], - 'success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'errorCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => '""', + 'title' => '', + 'example' => '', ], ], + '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.', - ], + '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"}]', + 'title' => 'Query push rule list ', + 'description' => 'This operation requires repository administrator permissions or higher.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPushRules'], ], ], - '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":""}]', + 'ramActions' => [], ], - 'ListPipelineRelations' => [ - 'summary' => '获取流水线关联列表', - 'path' => '/organization/{organizationId}/{pipelineId}/pipelineRelations', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListRepositories' => [ + 'summary' => 'Query the code repository list. Supports paging, sorting, keyword search, and filtering by data archiving status. ', + 'path' => '/repository/list', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'organizationId', - 'in' => 'path', - 'schema' => [ - 'title' => '企业标识,也称企业id,字符串形式,可在云效访问链接中获取,如 https:// devops.aliyun.com/organization/【OrgId】', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, for example: https://devops.aliyun.com/organization/【OrganizationId】 ', 'type' => 'string', 'required' => true, 'example' => '60de7a6852743a5162b5f957'], ], [ - 'name' => 'pipelineId', - 'in' => 'path', - 'schema' => [ - 'title' => '流水线ID,可在流水线链接中获取,如https://flow.aliyun.com/pipelines/【PipelineId】/current', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '11', - ], + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => ['title' => 'accessToken', 'description' => 'Personal access token. '."\n" + .'This field is not required when using Alibaba Cloud AccessKey ID and AccessKey Secret or Security Token Service (STS) temporary authorization.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513'], ], [ - 'name' => 'relObjectType', + 'name' => 'page', 'in' => 'query', - 'schema' => [ - 'title' => '关联的资源类型,暂只支持VARIABLE_GROUP', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'VARIABLE_GROUP', - 'enum' => [ - 'VARIABLE_GROUP', - ], - ], + 'schema' => ['title' => '', 'description' => 'Page number '."\n" + .'Default value is 1, starting from page 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2'], + ], + [ + 'name' => 'perPage', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Page size '."\n" + .'Default value is 20. Valid range: [1, 100]', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20'], + ], + [ + 'name' => 'orderBy', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Sorting field '."\n" + .'Valid values: created_at, id, name, path, updated_at, last_activity_at', 'type' => 'string', 'required' => false, 'example' => 'created_at'], + ], + [ + 'name' => 'sort', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Sorting order '."\n" + .'Default value is desc. '."\n" + .'desc – descending '."\n" + .'asc – ascending', 'type' => 'string', 'required' => false, 'example' => 'desc'], + ], + [ + 'name' => 'search', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Search keyword', 'type' => 'string', 'required' => false, 'example' => 'Demo'], + ], + [ + 'name' => 'archived', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Whether to list archived projects. '."\n" + .'Valid values: true / false', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'minAccessLevel', + 'in' => 'query', + 'schema' => ['description' => 'Least privilege filter. Enumeration values: '."\n" + .'- 20: Viewer '."\n" + .'- 30: Developer '."\n" + .'- 40: Administrator', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '40', 'title' => ''], ], ], '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' => '', + 'requestId' => ['title' => '', 'description' => 'Request ID ', 'type' => 'string', 'example' => '4D6AF7CC-B43B-5454-86AB-023D25E44868'], + 'errorMessage' => ['title' => '', 'description' => 'Error message ', 'type' => 'string', 'example' => '""'], + 'total' => ['title' => '', 'description' => 'Total Quantity ', 'type' => 'integer', 'format' => 'int64', 'example' => '149'], + 'success' => ['title' => '', 'description' => 'Indicates whether the invocation succeeded ', 'type' => 'boolean', 'example' => 'true'], + 'errorCode' => ['title' => '', 'description' => 'Error code ', 'type' => 'integer', 'format' => 'int32', 'example' => 'SYSTEM_UNKNOWN_ERROR'], + 'result' => [ + 'description' => 'Return Result ', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'repository object ', 'type' => 'object', 'properties' => [ - 'refObjectId' => [ - 'title' => '变量组id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12234', - ], - ], + 'lastActivityAt' => ['title' => '', 'description' => 'Last activity time ', 'type' => 'string', 'example' => '2022-01-14T21:08:26+08:00'], + 'namespaceId' => ['title' => '', 'description' => 'ID of the parent path', 'type' => 'integer', 'format' => 'int64', 'example' => '745'], + 'avatarUrl' => ['title' => '', 'description' => 'Profile picture URL ', 'type' => 'string', 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100'], + 'starCount' => ['title' => '', 'description' => 'Quantity of collections', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'archive' => ['title' => '', 'description' => 'is the code repository archived', 'type' => 'boolean', 'example' => 'false'], + 'createdAt' => ['title' => '', 'description' => 'Creation Time', 'type' => 'string', 'example' => '2022-01-14T21:08:26+08:00'], + 'star' => ['title' => '', 'description' => 'is collected ', 'type' => 'boolean', 'example' => 'false'], + 'importStatus' => ['title' => '', 'description' => 'Code repository import status '."\n" + .'Optional values: started / finished / failed / stopping / none ', 'type' => 'string', 'example' => 'started'], + 'webUrl' => ['title' => '', 'description' => 'URL for page visit', 'type' => 'string', 'example' => '""'], + 'description' => ['title' => '', 'description' => 'Code repository description ', 'type' => 'string', 'example' => '测试Codeup托管'], + 'nameWithNamespace' => ['title' => '', 'description' => 'Full name of the code repository (including the complete group name)', 'type' => 'string', 'example' => 'codeup-test-org / test-codeup(斜杠两侧有空格)'], + 'pathWithNamespace' => ['title' => '', 'description' => 'Full path of the code repository (including the full group path) ', 'type' => 'string', 'example' => 'codeup-test-org/test-codeup'], + 'path' => ['title' => '', 'description' => 'Code repository path', 'type' => 'string', 'example' => 'test-codeup'], + 'visibilityLevel' => ['title' => '', 'description' => 'Visibility '."\n" + .'0 - private, visible only to repository members '."\n" + .'10 - internal to the enterprise, visible to enterprise members', 'type' => 'string', 'example' => '0'], + 'accessLevel' => ['title' => '', 'description' => 'Permission Type '."\n" + .'20 – Viewer '."\n" + .'30 – Developer '."\n" + .'40 – Administrator ', 'type' => 'integer', 'format' => 'int32', 'example' => '40'], + 'updatedAt' => ['title' => '', 'description' => 'Update Time ', 'type' => 'string', 'example' => '2022-01-14T21:08:26+08:00'], + 'name' => ['title' => '', 'description' => 'Code repository Name ', 'type' => 'string', 'example' => 'codeupTest'], + 'Id' => ['title' => '', 'description' => 'Code repository ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + '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' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query code repository List ', + 'changeSet' => [ + ['createdAt' => '2024-03-28T08:42:51.000Z', 'description' => 'Request parameters changed, Error codes changed'], + ['createdAt' => '2022-03-18T06:00:14.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRepositories'], ], ], - '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"}]', + 'ramActions' => [], ], - 'WorkitemAttachmentCreate' => [ - 'summary' => '工作项附件创建', - 'path' => '/organization/{organizationId}/workitem/{workitemIdentifier}/attachment', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListRepositoryBranches' => [ + 'summary' => 'Query the list of code repository branches.', + 'path' => '/repository/{repositoryId}/branches', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'organizationId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'in' => 'query', + 'schema' => ['title' => 'A short description of struct', 'description' => 'The enterprise identity, also known as the enterprise ID, is a string that can be obtained from the Alibaba Cloud DevOps access link, for example: https://devops.aliyun.com/organization/【OrganizationId】', 'type' => 'string', 'required' => true, 'example' => '60de7a6852743a5162b5f957'], ], [ - 'name' => 'workitemIdentifier', + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => ['description' => 'Personal access token. '."\n" + .'This field is not required when using Alibaba Cloud AccessKey ID and AccessKey Secret or Security Token Service (STS) temporary authorization.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], + ], + [ + 'name' => 'repositoryId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '11234455454355', - ], + 'schema' => ['description' => 'Code repository ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2709413', 'title' => ''], ], [ - '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, - ], + 'name' => 'page', + 'in' => 'query', + 'schema' => ['description' => 'Page number. Default value is 1, starting from page 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => 'Page size. Default value is 20. Valid range: [1, 100]', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'search', + 'in' => 'query', + 'schema' => ['description' => 'search keyword', 'type' => 'string', 'required' => false, 'example' => 'Demo', 'title' => ''], + ], + [ + 'name' => 'sort', + 'in' => 'query', + 'schema' => ['description' => 'Sorting method. Default value is updated_desc.'."\n" + .'- updated_desc: sort by update time in descending order'."\n" + .'- updated_asc: sort by update time in ascending order', 'type' => 'string', 'required' => false, 'example' => 'updated_desc', 'title' => ''], ], ], 'responses' => [ @@ -34237,1340 +19006,841 @@ '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', + 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => '1F4F342D-493A-5B2C-B133-BA78B30FF834'], + 'errorMessage' => ['description' => 'Error message', 'type' => 'string', 'example' => '""', 'title' => ''], + 'errorCode' => ['description' => 'error code', 'type' => 'string', 'example' => 'Openapi.RequestError', 'title' => ''], + 'success' => ['description' => 'Indicates whether the invocation succeeded', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'total' => ['description' => 'Total number of records', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'result' => [ + 'description' => 'Return Result List', + 'type' => 'array', + 'items' => [ + 'description' => 'Return Result', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'Branch Name', 'type' => 'string', 'example' => 'testBranch', 'title' => ''], + 'protected' => ['description' => 'Is Protected Branch', 'type' => 'string', 'example' => 'false', 'title' => ''], + 'commit' => [ + 'description' => 'Latest Commit Information of the Branch', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'Commit ID', 'type' => 'string', 'example' => 'de02b625ba8488f92eb204bcb3773a40c1b4ddac', 'title' => ''], + 'shortId' => ['description' => 'Short Commit ID', 'type' => 'string', 'example' => 'e0297d8f', 'title' => ''], + 'title' => ['description' => 'Commit title, which is the first line of the commit content', 'type' => 'string', 'example' => '提交标题', 'title' => ''], + 'authorName' => ['description' => 'Author Name', 'type' => 'string', 'example' => 'test-codeup', 'title' => ''], + 'authorEmail' => ['description' => 'Author Mailbox', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + 'createdAt' => ['description' => 'Creation Time', 'type' => 'string', 'example' => '2022-03-18 10:00:00', 'title' => ''], + 'message' => ['description' => 'Commit content', 'type' => 'string', 'example' => '具体的提交内容', 'title' => ''], + 'authoredDate' => ['description' => 'Author Submitted At', 'type' => 'string', 'example' => '2022-03-18 10:00:00', 'title' => ''], + 'committedDate' => ['description' => 'Submitted At by Submitter', 'type' => 'string', 'example' => '2022-03-18 11:00:00', 'title' => ''], + 'committerEmail' => ['description' => 'Mailbox of the committer', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + 'committerName' => ['description' => 'Name of the committer', 'type' => 'string', 'example' => 'commit-codeup', 'title' => ''], + 'parentIds' => [ + 'description' => 'List of parent commit IDs', + 'type' => 'array', + 'items' => ['description' => 'Parent commit ID', 'type' => 'string', 'example' => 'de02b625ba8488f92eb204bcb3773a40c1b4ddac', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => '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.', 'description' => ''], + ], ], - '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', + '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\\": \\"username@example.com\\",\\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\\": \\"username@example.com\\",\\n \\"committerName\\": \\"commit-codeup\\",\\n \\"parentIds\\": [\\n \\"de02b625ba8488f92eb204bcb3773a40c1b4ddac\\"\\n ]\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query the list of code repository branches', + 'changeSet' => [ + ['createdAt' => '2022-11-21T13:16:39.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRepositoryBranches'], + ], ], + 'ramActions' => [], + ], + 'ListRepositoryCommitDiff' => [ + 'summary' => 'You can obtain the content of a single commit in the current code repository by specifying the repository ID (repositoryId), SHA value (sha), and optionally the number of context lines (contextLine).', + 'path' => '/repository/{repositoryId}/commits/{sha}/diff', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'organizationId', + 'in' => 'query', + 'schema' => ['description' => 'The enterprise identity, also known as the enterprise ID, in string format. You can obtain it from the Alibaba Cloud DevOps URL, for example: https://devops.aliyun.com/organization/【OrganizationId】 ', 'example' => '60de7a6852743a5162b5f957', 'required' => true, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => ['description' => 'accessToken', 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'repositoryId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '60de7a6852743a5162b5f957', - ], + 'schema' => ['description' => 'The code repository ID. ', 'example' => '2464454', 'format' => 'int64', 'required' => true, 'type' => 'integer', 'title' => ''], ], [ - 'name' => 'workitemIdentifier', + 'name' => 'sha', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '11234455454355', - ], + 'schema' => ['description' => 'The branch name, tag name, or commit ID. '."\n" + .'Examples: '."\n" + .'Branch name: master '."\n" + .'Tag name: tag001 '."\n" + .'Commit ID: ff4fb5ac6d1f44f452654336d2dba468ae6c8d04 ', 'example' => 'master', 'required' => true, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'contextLine', + 'in' => 'query', + 'schema' => ['description' => 'The number of context lines. ', 'example' => '3', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], ], ], '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' => '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', + 'errorMessage' => ['description' => 'The error message. ', 'example' => '""', 'type' => 'string', 'title' => ''], + 'requestId' => ['description' => 'Id of the request', 'example' => 'AB270BBA-EFB1-5773-B3DC-07CD036F7352', 'title' => 'Id of the request', 'type' => 'string'], + 'errorCode' => ['description' => 'The error code. ', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'type' => 'string', 'title' => ''], + 'success' => ['description' => 'Indicates whether the invocation succeeded. ', 'example' => 'true', 'type' => 'boolean', 'title' => ''], + 'result' => [ + 'description' => 'Response Result', 'items' => [ - 'description' => '', - 'type' => 'object', + 'description' => 'Detailed result returned'."\n" + ."\n", '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', - ], + 'oldId' => ['description' => 'Git object ID of the old file', 'example' => '0000000000000000000000000000000000000000', 'type' => 'string', 'title' => ''], + 'newId' => ['description' => 'Git object ID of the new file', 'example' => '6c268061a546378276559c713d0ad377d4dsjfh', 'type' => 'string', 'title' => ''], + 'isNewLfs' => ['description' => 'Indicates whether the new file is a large file (LFS)', 'example' => 'true', 'type' => 'boolean', 'title' => ''], + 'isOldLfs' => ['description' => 'Indicates whether the old file is a large file (LFS)', 'example' => 'true', 'type' => 'boolean', 'title' => ''], + 'diff' => ['description' => 'Diff Content', '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', 'title' => ''], + 'newPath' => ['description' => 'The new file path. ', 'example' => 'src/test/java/com/aliyun/codeupdemo/CodeupDemoApplicationTests.java', 'type' => 'string', 'title' => ''], + 'oldPath' => ['description' => 'Old File Path', 'example' => 'src/test/java/com/aliyun/codeupExample/CodeupDemoApplicationTests.java', 'type' => 'string', 'title' => ''], + 'aMode' => ['description' => 'The legacy file mode identifier, which includes information such as file type and permissions. ', 'example' => '100644', 'type' => 'string', 'title' => ''], + 'bMode' => ['description' => 'The new file mode identifier, which includes information such as file type and permissions. ', 'example' => '100755', 'type' => 'string', 'title' => ''], + 'newFile' => ['description' => 'Indicates whether the file is newly added', 'example' => 'false', 'type' => 'boolean', 'title' => ''], + 'renamedFile' => ['description' => 'Indicates whether the file has been renamed. ', 'example' => 'false', 'type' => 'boolean', 'title' => ''], + 'deletedFile' => ['description' => 'Indicates whether the file is deleted', 'example' => 'false', 'type' => 'boolean', 'title' => ''], + 'isBinary' => ['description' => 'Indicates whether the file is a binary file', 'example' => 'false', 'type' => 'boolean', 'title' => ''], ], + 'type' => 'object', + 'title' => '', + 'example' => '', ], + 'type' => 'array', + 'title' => '', + 'example' => '', ], ], + 'title' => 'Schema of Response', + 'type' => 'object', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Openapi.RequestError', - 'errorMessage' => 'request error', - ], - ], - 403 => [ - [ - 'errorCode' => 'Operate.NoPermission', - 'errorMessage' => 'NoPermission', - ], - ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query the content of a single commit in a code repository ', + 'description' => 'The repository ID (repositoryId) and SHA value (sha) are Required. The SHA value represents a branch name, tag name, or commit ID.', + 'changeSet' => [ + ['createdAt' => '2023-04-06T03:11:35.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-11-21T13:16:39.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-15T03:28:16.000Z', 'description' => 'OpenAPI offline'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRepositoryCommitDiff'], + ], ], - '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"}]', + 'ramActions' => [], ], - 'CreateWorkitemV2' => [ - 'summary' => '创建工作项', - 'path' => '/organization/{organizationId}/workitem', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListRepositoryCommits' => [ + 'summary' => 'Queries a code repository\'s commit history, with scroll-based pagination.', + 'path' => '/repository/{repositoryId}/commits', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [], - 'produces' => [], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'organizationId', + 'in' => 'query', + 'schema' => ['title' => 'A short description of struct', 'description' => 'The organization ID. You can get this ID from your Alibaba Cloud DevOps organization URL, for example, `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'required' => true, 'example' => '60de7a6852743a5162b5f957'], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => ['description' => 'The personal access token. This parameter is optional when you authenticate by using an Alibaba Cloud AccessKey pair or temporary STS credentials.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], + ], + [ + 'name' => 'repositoryId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['description' => 'The repository ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2334743', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'refName', + 'in' => 'query', + 'schema' => ['description' => 'The branch name, tag name, or commit ID. If this parameter is not specified, the system uses the default branch of the repository.', 'type' => 'string', 'required' => true, 'example' => 'master 或 tag1.0或 sjjfssa', 'title' => ''], + ], + [ + 'name' => 'start', + 'in' => 'query', + 'schema' => ['description' => 'The start time for filtering commits.', 'type' => 'string', 'required' => false, 'example' => '2022-03-18 08:00:00', 'title' => ''], + ], + [ + 'name' => 'end', + 'in' => 'query', + 'schema' => ['description' => 'The end time for filtering commits.', 'type' => 'string', 'required' => false, 'example' => '2022-08-18 08:00:00', 'title' => ''], + ], + [ + 'name' => 'page', + 'in' => 'query', + 'schema' => ['description' => 'The page number of the page to return. The default value is `1`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of results to return on each page. The default value is `20`. The value must be an integer from 1 to 100.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'path', + 'in' => 'query', + 'schema' => ['description' => 'The path of a file in the repository. If you specify this parameter, the operation returns only the commits that affect this path. If you do not specify this parameter, the operation returns the commits of the entire repository.', 'type' => 'string', 'required' => false, 'example' => 'src/cpp/main.cpp', 'title' => ''], + ], + [ + 'name' => 'search', + 'in' => 'query', + 'schema' => ['description' => 'The keyword to use for the search in commits.', 'type' => 'string', 'required' => false, 'example' => 'search', 'title' => ''], + ], + [ + 'name' => 'showSignature', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to include the signature in the response. The default value is `false`.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'showCommentsCount', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to include the number of comments in the response. The default value is `false`.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ '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' => '', + 'title' => 'Schema of Response', + 'description' => 'The response schema.', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F1138237-CF7F-56BF-95D4-9AA937CCE8E5'], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'OpenApi.error', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'total' => ['description' => 'The total number of records.'."\n" + ."\n" + .'><notice>'."\n" + ."\n" + .'The commit list uses scroll-based pagination, so this value is an estimate and not an exact count.'."\n" + ."\n" + .'></notice>', 'type' => 'integer', 'format' => 'int64', 'example' => '145', 'title' => ''], + 'result' => [ + 'description' => 'The list of returned results.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ - 'fieldIdentifier' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '6aexxxxxa1d98c09c60xxxx16', + 'id' => ['description' => 'The commit ID.', 'type' => 'string', 'example' => 'de02b625ba8488f92eb204bcb3773a40c1b4ddac', 'title' => ''], + 'shortId' => ['description' => 'The short commit ID. For example, if the full commit ID is `ff4fb5ac6d1f44f452654336d2dba468ae6c8d04`, the short commit ID is `ff4fb5ac`.', 'type' => 'string', 'example' => 'de02b625', 'title' => ''], + 'title' => ['description' => 'The commit title, which is the first line of the commit message.', 'type' => 'string', 'example' => '提交标题', 'title' => ''], + 'authorName' => ['description' => 'The name of the author.', 'type' => 'string', 'example' => 'test-codeup', 'title' => ''], + 'authorEmail' => ['description' => 'The email address of the author.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + 'createdAt' => ['description' => 'The time when the commit was created.', 'type' => 'string', 'example' => '2022-03-18 14:24:54', 'title' => ''], + 'message' => ['description' => 'The commit message.', 'type' => 'string', 'example' => '提交的具体内容', 'title' => ''], + 'authoredDate' => ['description' => 'The date when the work was originally authored.', 'type' => 'string', 'example' => '2022-03-18 15:00:00', 'title' => ''], + 'committedDate' => ['description' => 'The date when the commit was created.', 'type' => 'string', 'example' => '2022-03-18 16:00:00', 'title' => ''], + 'committerEmail' => ['description' => 'The email address of the committer.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + 'committerName' => ['description' => 'The name of the committer.', 'type' => 'string', 'example' => 'committer-codeup', 'title' => ''], + 'parentIds' => [ + 'description' => 'A list of parent commit IDs.', + 'type' => 'array', + 'items' => ['description' => 'The parent commit ID.', 'type' => 'string', 'example' => 'ff4fb5ac6d1f44f452654336d2dba468ae6c8d04 ', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'value' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '10', + 'author' => [ + 'description' => 'The author information.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The Codeup user ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '7914', 'title' => ''], + 'name' => ['description' => 'The name of the user.', 'type' => 'string', 'example' => '云效', 'title' => ''], + 'username' => ['description' => 'The username of the user.', 'type' => 'string', 'example' => 'nickname', 'title' => ''], + 'state' => ['description' => 'The state of the user. Valid values: `active` and `blocked`. Default value: `active`.', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'avatarUrl' => ['description' => 'The URL of the user\'s avatar.', 'type' => 'string', 'example' => '头像地址'."\n" + ."\n" + .'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', 'title' => ''], + 'websiteUrl' => ['description' => 'The user\'s website URL.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'email' => ['description' => 'The email address of the user.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'committer' => [ + 'description' => 'The committer information.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The Codeup user ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '41031', 'title' => ''], + 'name' => ['description' => 'The name of the user.', 'type' => 'string', 'example' => 'committer-codeup', 'title' => ''], + 'username' => ['description' => 'The username of the user.', 'type' => 'string', 'example' => 'nickname', 'title' => ''], + 'state' => ['description' => 'The state of the user. Valid values: `active` and `blocked`. Default value: `active`.', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'avatarUrl' => ['description' => 'The URL of the user\'s avatar.', 'type' => 'string', 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', 'title' => ''], + 'websiteUrl' => ['description' => 'The user\'s website URL.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'email' => ['description' => 'The email address of the user.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'signature' => [ + 'description' => 'The signature information.', + 'type' => 'object', + 'properties' => [ + 'gpgKeyId' => ['description' => 'The GPG key ID.', 'type' => 'string', 'example' => '”“', 'title' => ''], + 'verificationStatus' => ['description' => 'The GPG verification status.'."\n" + ."\n" + .'- `unverified`: Not verified.'."\n" + ."\n" + .'- `verified`: The signature is verified by a GPG public key, and the email address in the signature matches the committer\'s email address.'."\n" + ."\n" + .'- `same_user_different_email`: The signature is verified by a GPG public key, and the committer\'s email address belongs to the user but does not match the email address in the GPG key.'."\n" + ."\n" + .'- `other_user`: The signature is verified by a GPG public key, but the committer\'s email address does not belong to the user of the key.'."\n" + ."\n" + .'- `unverified_key`: The email address in the GPG key is not one of the user\'s verified email addresses.'."\n" + ."\n" + .'- `unknown_key`: The GPG key used for the signature is unknown.', 'type' => 'string', 'example' => 'verified', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'commentsCount' => ['description' => 'The number of comments.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], - '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', + 'title' => '', + 'example' => '', ], - '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', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Openapi.RequestError', - 'errorMessage' => 'request error', - ], - ], 403 => [ - [ - 'errorCode' => 'Operate.NoPermission', - 'errorMessage' => 'NoPermission', - ], + ['errorCode' => 'Forbidden.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => '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.', 'description' => ''], ], ], - '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', + '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\\": \\"username@example.com\\",\\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\\": \\"username@example.com\\",\\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\\": \\"username@example.com\\"\\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\\": \\"username@example.com\\"\\n },\\n \\"signature\\": {\\n \\"gpgKeyId\\": \\"”“\\",\\n \\"verificationStatus\\": \\"verified\\"\\n },\\n \\"commentsCount\\": 1\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query the commit list of a code repository ', + 'changeSet' => [ + ['createdAt' => '2023-07-24T06:14:55.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRepositoryCommits'], + ], ], + 'ramActions' => [], + ], + 'ListRepositoryGroups' => [ + 'summary' => 'Retrieves a list of code groups with options for pagination, sorting by creation or update time, and keyword search.', + 'path' => '/repository/groups/get/all', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'organizationId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1e9903d8b3f1xxxxxf9286ef5', - ], + 'in' => 'query', + 'schema' => ['title' => 'A short description of struct', 'description' => 'The organization ID. You can find this ID in your organization\'s URL on the Alibaba Cloud DevOps platform, for example: `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'required' => true, 'example' => '60de7a6852743a5162b5f957'], ], [ - '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, - ], + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => ['description' => 'The personal access token. This parameter is not required when you authenticate with an Alibaba Cloud access key (AK/SK) or Security Token Service (STS).', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], + ], + [ + 'name' => 'parentId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the parent namespace.'."\n" + ."\n" + .'- To list all groups in the organization, set this parameter to the namespace ID of the organization (not the `organizationId`).'."\n" + ."\n" + .'- To list all subgroups within a specific group, set this parameter to the namespace ID of that group.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '26842', 'title' => ''], + ], + [ + 'name' => 'page', + 'in' => 'query', + 'schema' => ['description' => 'The page number. The default is `1`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => 'The page size. The value must be between 1 and 100. The default is `20`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'search', + 'in' => 'query', + 'schema' => ['description' => 'The keyword to search for.', 'type' => 'string', 'required' => false, 'example' => 'Demo', 'title' => ''], + ], + [ + 'name' => 'orderBy', + 'in' => 'query', + 'schema' => ['description' => 'The field to sort the results by. The default is `updated_at`.'."\n" + ."\n" + .'- `updated_at`: Sorts by update time.'."\n" + ."\n" + .'- `created_at`: Sorts by creation time.', 'type' => 'string', 'required' => false, 'example' => 'updated_at', 'title' => ''], + ], + [ + 'name' => 'sort', + 'in' => 'query', + 'schema' => ['description' => 'The sort order. The default is `desc`.'."\n" + ."\n" + .'- `desc`: Descending'."\n" + ."\n" + .'- `asc`: Ascending', 'type' => 'string', 'required' => false, 'example' => 'desc', 'title' => ''], + ], + [ + 'name' => 'includePersonal', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to include personal private groups in the results.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response payload.', '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' => 'xxx@xxx.com', - ], - '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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9'], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '”“', 'title' => ''], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Openapi.RequestError', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'total' => ['description' => 'The total number of repository groups found.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'result' => [ + 'description' => 'The list of repository groups.', + 'type' => 'array', + 'items' => [ + 'description' => 'A repository group object.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The ID of the repository group. This ID is also the namespace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '19285', 'title' => ''], + 'path' => ['description' => 'The path of the repository group.', 'type' => 'string', 'example' => 'test-codeup', 'title' => ''], + 'name' => ['description' => 'The name of the repository group.', 'type' => 'string', 'example' => 'test-codeup', 'title' => ''], + 'nameWithNamespace' => ['description' => 'The name of the repository group, prefixed with its parent path. The path and name are separated by a slash with surrounding spaces.', 'type' => 'string', 'example' => '60de7a6852743a5162b5f957 / test-codeup(斜杠两侧有空格)', 'title' => ''], + 'pathWithNamespace' => ['description' => 'The full path of the repository group, including the parent path.', 'type' => 'string', 'example' => '60de7a6852743a5162b5f957/test-codeup', 'title' => ''], + 'visibilityLevel' => ['description' => 'The visibility level of the repository group.'."\n" + ."\n" + .'- `0`: private'."\n" + ."\n" + .'- `10`: internal', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'avatarUrl' => ['description' => 'The avatar URL for the repository group.', 'type' => 'string', 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', 'title' => ''], + 'webUrl' => ['description' => 'The web URL of the repository group.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'type' => ['description' => 'The type of the object. For a repository group, the value is always `Group`.', 'type' => 'string', 'example' => 'Group', 'title' => ''], + 'description' => ['description' => 'The description of the repository group.', 'type' => 'string', 'example' => '描述信息的具体内容', 'title' => ''], + 'parentId' => ['description' => 'The ID of the parent path.', 'type' => 'integer', 'format' => 'int64', 'example' => '26842', 'title' => ''], + 'ownerId' => ['description' => 'The ID of the owner.', 'type' => 'integer', 'format' => 'int64', 'example' => '19230', 'title' => ''], + 'accessLevel' => ['description' => 'The access level. Valid values: `20` (Reporter), `30` (Developer), and `40` (Maintainer).', 'type' => 'integer', 'format' => 'int32', 'example' => '40', 'title' => ''], + 'projectCount' => ['description' => 'The number of repositories in the group.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'groupCount' => ['description' => 'The number of direct subgroups. This count is not recursive.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'createdAt' => ['description' => 'The timestamp indicating when the repository group was created.', 'type' => 'string', 'example' => '2022-03-18 14:24:54', 'title' => ''], + 'updatedAt' => ['description' => 'The timestamp indicating when the repository group was last updated.', 'type' => 'string', 'example' => '2022-03-18 14:24:54', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Openapi.RequestError', - 'errorMessage' => 'request error', - ], - ], 403 => [ - [ - 'errorCode' => 'Operate.NoPermission', - 'errorMessage' => 'NoPermission', - ], + ['errorCode' => 'Forbidden.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => '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.', 'description' => ''], ], ], - '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\\": \\"xxx@xxx.com\\",\\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', + '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"}]', + 'title' => 'Query Code Group List', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRepositoryGroups'], + ], ], + 'ramActions' => [], + ], + 'ListRepositoryMemberWithInherited' => [ + 'summary' => 'Query the list of code repository members without paging.', + 'path' => '/repository/{repositoryId}/members/list', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'organizationId', + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => ['title' => 'accessToken', 'description' => 'Personal access token. '."\n" + .'This field is not required if you use Alibaba Cloud AccessKey ID and AccessKey secret or Security Token Service (STS) temporary authorization.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513'], + ], + [ + 'name' => 'repositoryId', 'in' => 'path', - 'schema' => [ - 'title' => '企业id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['title' => '', 'description' => 'Repository ID ', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '2464454', 'isFileTransferUrl' => false], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, for example: https://devops.aliyun.com/organization/【OrganizationId】 ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '60de7a6852743a5162b5f957'], + ], + ], + 'responses' => [ + 200 => [ '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' => '', + 'errorMessage' => ['description' => 'Error message ', 'type' => 'string', 'example' => '""', 'title' => ''], + 'requestId' => ['description' => 'Request ID ', 'type' => 'string', 'example' => 'AB270BBA-EFB1-5773-B3DC-07CD036F7352', 'title' => ''], + 'errorCode' => ['description' => 'Error code ', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'success' => ['description' => 'Indicates whether the invocation succeeded ', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'result' => [ + 'description' => 'Return parameters', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Return Result', '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', + 'email' => ['description' => 'Mailbox ', 'type' => 'string', 'example' => 'yunxiao-codeup@aliyun.com', 'title' => ''], + 'avatarUrl' => ['description' => 'Profile picture URL', 'type' => 'string', 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', 'title' => ''], + 'state' => ['description' => 'Status '."\n" + .'Valid values: active / blocked ', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'accessLevel' => ['description' => 'Permission Type '."\n" + .'20 - Viewer '."\n" + .'30 - Developer '."\n" + .'40 - Administrator'."\n" + ."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'name' => ['description' => 'Name ', 'type' => 'string', 'example' => 'codeup', 'title' => ''], + 'id' => ['description' => 'Codeup User ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '19285', 'title' => ''], + 'username' => ['description' => 'User nickname ', 'type' => 'string', 'example' => 'yunxiao', 'title' => ''], + 'inherited' => [ + 'description' => 'Inherited code group information', + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => 'Type '."\n" + .'Valid values: Group / OrgNamespace', 'type' => 'string', 'example' => 'Group', 'title' => ''], + 'nameWithNamespace' => ['description' => 'Full name of the code group (including the complete group name)', 'type' => 'string', 'example' => 'test / test-group(斜杠两边有空格)', 'title' => ''], + 'pathWithNamespace' => ['description' => 'Full path of the code group (including the complete group path) ', 'type' => 'string', 'example' => 'test/test-group '."\n", 'title' => ''], + 'visibilityLevel' => ['description' => 'Visibility '."\n" + .'0 - Private '."\n" + .'10 - Public within the enterprise', 'type' => 'string', 'example' => '0', 'title' => ''], + 'path' => ['description' => 'Code group path', 'type' => 'string', 'example' => 'test-group', 'title' => ''], + 'name' => ['description' => 'Code group Name', 'type' => 'string', 'example' => 'test-group', 'title' => ''], + 'id' => ['description' => 'id', 'type' => 'integer', 'format' => 'int64', 'example' => '2022', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], - '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......', + 'title' => '', + 'example' => '', ], - 'required' => false, - ], - 'parent' => [ - 'title' => '所属父工作项的唯一标识', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '3a0c9cdd24ae1e1995b8...', + 'title' => '', + 'example' => '', ], ], - 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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', - ], - ], - ], - ], - ], - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"requestId\\": \\"AB270BBA-EFB1-5773-B3DC-07CD036F7352\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": true,\\n \\"result\\": [\\n {\\n \\"email\\": \\"yunxiao-codeup@aliyun.com\\",\\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}","type":"json"}]', + 'title' => 'Query the list of repository members ', + 'changeSet' => [ + ['createdAt' => '2023-07-24T06:14:50.000Z', 'description' => 'Response parameters changed, Error codes changed'], + ['createdAt' => '2022-03-18T06:00:14.000Z', 'description' => 'OpenAPI offline'], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Openapi.RequestError', - 'errorMessage' => 'request error', - ], - ], - 403 => [ - [ - 'errorCode' => 'Operate.NoPermission', - 'errorMessage' => 'NoPermission', - ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRepositoryMemberWithInherited'], ], ], - '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":""}]', + 'ramActions' => [], ], - 'CreateWorkitemComment' => [ - 'summary' => '创建一个评论', - 'path' => '/organization/{organizationId}/workitems/comment', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListRepositoryTags' => [ + 'summary' => 'List repository tags.', + 'path' => '/repository/{repositoryId}/tag/list', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'organizationId', + 'in' => 'query', + 'schema' => ['title' => 'A short description of struct', 'description' => 'The organization ID. Get this ID from the URL of your organization page in Alibaba Cloud DevOps. Example: https\\://devops.aliyun.com/organization/{organizationId}', 'type' => 'string', 'required' => true, 'example' => '611b75680fc7bf0dbe1dce55'], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => ['description' => 'The personal access token. This parameter is not required if you use an Alibaba Cloud AccessKey pair or temporary authorization with STS.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], + ], + [ + 'name' => 'repositoryId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '60811b5eed6e867404f6xxxx', - ], + 'schema' => ['description' => 'The ID of the repository.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2709413', 'title' => ''], ], [ - '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, - ], + 'name' => 'page', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Pages are numbered starting from 1. Defaults to 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => 'The page size. Defaults to 20. Range: 1–100.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'sort', + 'in' => 'query', + 'schema' => ['description' => 'The sort order. Defaults to updated\\_desc.'."\n" + ."\n" + .'- updated\\_asc: Update time, ascending'."\n" + ."\n" + .'- updated\\_desc: Update time, descending'."\n" + ."\n" + .'- name\\_asc: Tag name, ascending'."\n" + ."\n" + .'- name\\_desc: Tag name, descending', 'type' => 'string', 'required' => false, 'example' => 'updated_desc', 'title' => ''], + ], + [ + 'name' => 'search', + 'in' => 'query', + 'schema' => ['description' => 'The search keyword to match against tag names.', 'type' => 'string', 'required' => false, 'example' => 'Demo', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', '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', + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '”“', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'total' => ['description' => 'The total number of tags found.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], + 'result' => [ + 'description' => 'A list of objects, each representing a tag.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of a tag.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The ID of the tag.', 'type' => 'string', 'example' => '9a494e7b88ca35cde00579af2df4ab46136c022e', 'title' => ''], + 'name' => ['description' => 'The name of the tag.', 'type' => 'string', 'example' => 'tag v1.0', 'title' => ''], + 'message' => ['description' => 'The message associated with the tag.', 'type' => 'string', 'example' => '具体的描述内容', 'title' => ''], + 'commit' => [ + 'description' => 'The details of the commit that the tag points to.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The ID of the commit.', 'type' => 'string', 'example' => 'de02b625ba8488f92eb204bcb3773a40c1b4ddac', 'title' => ''], + 'shortId' => ['description' => 'The short ID of the commit.', 'type' => 'string', 'example' => 'de02b625', 'title' => ''], + 'title' => ['description' => 'The commit title. This is the first line of the commit message.', 'type' => 'string', 'example' => '提交标题', 'title' => ''], + 'message' => ['description' => 'The commit message.', 'type' => 'string', 'example' => '修改main.txt文件', 'title' => ''], + 'createdAt' => ['description' => 'The time when the commit was created.', 'type' => 'string', 'example' => '2022-03-18 10:00:00', 'title' => ''], + 'authorName' => ['description' => 'The name of the author.', 'type' => 'string', 'example' => '阿里云云效', 'title' => ''], + 'authorEmail' => ['description' => 'The email address of the author.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + 'authoredDate' => ['description' => 'The time when the commit was authored.', 'type' => 'string', 'example' => '2022-03-18 10:00:00', 'title' => ''], + 'committerName' => ['description' => 'The name of the committer.', 'type' => 'string', 'example' => '阿里云云效Committer', 'title' => ''], + 'committerEmail' => ['description' => 'The email address of the committer.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + 'committedDate' => ['description' => 'The time when the commit was committed.', 'type' => 'string', 'example' => '2022-03-18 09:00:00', 'title' => ''], + 'parentIds' => [ + 'description' => 'The parent commit IDs.', + 'type' => 'array', + 'items' => ['description' => 'A parent commit ID.', 'type' => 'string', 'example' => '34d2c47c7ce46a5c4639c5ffe208a66dda975a05', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'signature' => [ + 'description' => 'The GPG signature of the commit.', + 'type' => 'object', + 'properties' => [ + 'gpgKeyId' => ['description' => 'The ID of the GPG key used for the signature.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'verificationStatus' => ['description' => 'The GPG verification status.'."\n" + ."\n" + .'- `unverified`: The GPG signature is not verified.'."\n" + ."\n" + .'- `verified`: The GPG signature is verified and the committer\'s email address matches the email address in the GPG key.'."\n" + ."\n" + .'- `same_user_different_email`: The GPG signature is verified, but the committer\'s email address is different from the email address in the GPG key. Both email addresses belong to the same user.'."\n" + ."\n" + .'- `other_user`: The GPG signature is verified, but the committer\'s email address does not belong to the user who owns the GPG key.'."\n" + ."\n" + .'- `unverified_key`: The GPG key is not associated with any of the committer\'s verified email addresses.'."\n" + ."\n" + .'- `unknown_key`: The GPG signing key is not found in the system.', 'type' => 'string', 'example' => 'verified', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], ], + 'title' => '', + 'example' => '', ], ], - '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 ', - ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Openapi.RequestError', - 'errorMessage' => 'request error', - ], - ], 403 => [ - [ - 'errorCode' => 'Operate.NoPermission', - 'errorMessage' => 'NoPermission', - ], + ['errorCode' => 'Forbidden.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => '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.', 'description' => ''], ], ], - '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', + '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\\": \\"username@example.com\\",\\n \\"authoredDate\\": \\"2022-03-18 10:00:00\\",\\n \\"committerName\\": \\"阿里云云效Committer\\",\\n \\"committerEmail\\": \\"username@example.com\\",\\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"}]', + 'title' => 'Query tag list ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRepositoryTags'], + ], ], + 'ramActions' => [], + ], + 'ListRepositoryTree' => [ + 'summary' => 'Query the file tree of a code repository.', + 'path' => '/repository/{repositoryId}/files/tree', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'organizationId', + 'in' => 'query', + 'schema' => ['title' => 'A short description of struct', 'description' => 'The enterprise identifier, also known as the organization ID, is a string that can be obtained from the Alibaba Cloud DevOps access URL, such as https://devops.aliyun.com/organization/【OrganizationId】.'."\n", 'type' => 'string', 'required' => true, 'example' => '624666bd54d036291ae13a36'], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => ['description' => 'Personal access token. '."\n" + .'This field is not required if you use an Alibaba Cloud AccessKey pair (AK+SK) or temporary credentials from Security Token Service (STS).', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], + ], + [ + 'name' => 'repositoryId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['description' => 'The repository ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2851516', 'title' => ''], ], [ - '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, - ], + 'name' => 'path', + 'in' => 'query', + 'schema' => ['description' => 'The file path within the code repository. Specifies the folder whose contents you want to retrieve. By default, the entire structure of the repository\'s file tree is retrieved.', 'type' => 'string', 'required' => false, 'example' => 'module', 'title' => ''], + ], + [ + 'name' => 'refName', + 'in' => 'query', + 'schema' => ['description' => 'The branch name, tag name, or commit ID. Defaults to the repository\'s default branch.', 'type' => 'string', 'required' => false, 'example' => 'master / tag1.0 / sjjfssa', 'title' => ''], + ], + [ + 'name' => 'type', + 'in' => 'query', + 'schema' => ['description' => 'The search strategy: '."\n" + .'DIRECT: Lists only the contents of the current folder. '."\n" + .'RECURSIVE: Recursively retrieves all files under the current path. '."\n" + .'FLATTEN: Flattens the structure (if the path is a folder, recursively traverses it until subdirectories contain files or multiple folders).', 'type' => 'string', 'required' => false, 'example' => 'RECURSIVE', 'title' => ''], ], ], 'responses' => [ @@ -35580,684 +19850,544 @@ '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', + 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => '6557983C-FB08-51A9-AC5A-A7A0D0950A07'], + 'errorMessage' => ['description' => 'Error message', 'type' => 'string', 'example' => '""', 'title' => ''], + 'errorCode' => ['description' => 'Error code', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'success' => ['description' => 'Indicates whether the invocation succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'result' => [ + 'description' => 'List of return results', + 'type' => 'array', + 'items' => [ + 'description' => 'Return result object', + 'type' => 'object', + 'properties' => [ + 'path' => ['description' => 'File Path', 'type' => 'string', 'example' => 'test-codeup', 'title' => ''], + 'isLFS' => ['description' => 'Indicates whether the file is a large file.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'id' => ['description' => 'File version, UUID', 'type' => 'string', 'example' => '76c3f251f414ac31f2e01faf6f2008a9d756a437', 'title' => ''], + 'name' => ['description' => 'Name of the file', 'type' => 'string', 'example' => 'test-codeup', 'title' => ''], + 'type' => ['description' => 'File type '."\n" + .'tree: folder '."\n" + .'blob: file '."\n" + .'commit: commit supports submodule', 'type' => 'string', 'example' => 'blob', 'title' => ''], + 'mode' => ['description' => 'Type and permission information', 'type' => 'string', 'example' => '100644', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Openapi.RequestError', - 'errorMessage' => 'request error', - ], - ], 403 => [ - [ - 'errorCode' => 'Operate.NoPermission', - 'errorMessage' => 'NoPermission', - ], + ['errorCode' => 'Forbidden.UserNotAdminOrOwner', 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', 'description' => ''], + ['errorCode' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], ], ], - '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', + '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"}]', + 'title' => 'Query File Tree', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRepositoryTree'], + ], ], + 'ramActions' => [], + ], + 'ListRepositoryWebhook' => [ + 'summary' => 'Query webhook records configured on a code repository in batch, with support for paging.', + 'path' => '/repository/{repositoryId}/webhooks/list', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => ['title' => 'accessToken', 'description' => 'Personal access token. '."\n" + .'This field is not required if you use an Alibaba Cloud AccessKey pair (AK+SK) or Security Token Service (STS) temporary authorization. ', 'type' => 'string', 'required' => false, 'example' => '0cf2c8458ac44d9481aab2dd6ec10596v3'."\n"], + ], + [ 'name' => 'organizationId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps URL, for example: https://devops.aliyun.com/organization/【OrganizationId】 ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5fbe3118672533690be72b12'], + ], + [ + 'name' => 'repositoryId', 'in' => 'path', - 'schema' => [ - 'title' => '企业id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['title' => '', 'description' => 'Repository ID ', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '2825387', 'isFileTransferUrl' => false], ], [ - 'name' => 'identifier', + 'name' => 'page', 'in' => 'query', - 'schema' => [ - 'title' => '工作项id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'deafe5f33xxxxx6a259d8dafd', - ], + 'schema' => ['title' => '', 'description' => 'Page number. '."\n" + .'Default Value is 1, starting from page 1. ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '1', 'default' => '1'], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Page size. '."\n" + .'Default Value is 20. Valid range: [1, 100] ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '100', 'minimum' => '0', 'example' => '10', 'default' => '20'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Return Result object', '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', + 'errorMessage' => ['description' => 'error message ', 'type' => 'string', 'example' => '“”', 'title' => ''], + 'requestId' => ['description' => 'Request ID ', 'type' => 'string', 'example' => 'HC93CE1A-8D7A-13A9-8306-7465DE2E5C0F', 'title' => ''], + 'total' => ['description' => 'Total number of records. ', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'success' => ['description' => 'Indicates whether the invocation succeeded. ', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'errorCode' => ['description' => 'error code ', 'type' => 'string', 'example' => 'SYSTEM_NOT_FOUND_ERROR', 'title' => ''], + 'result' => [ + 'description' => 'List of dataSet', + 'type' => 'array', + 'items' => [ + 'description' => 'Detailed result returned'."\n" + ."\n", + 'type' => 'object', + 'properties' => [ + 'pushEvents' => ['description' => 'Indicates whether the event is a code push event. '."\n" + .'Valid values: true / false', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'projectId' => ['description' => 'Repository ID', 'type' => 'integer', 'format' => 'int64', 'example' => '2825387', 'title' => ''], + 'createdAt' => ['description' => 'Creation Time', 'type' => 'string', 'example' => '2022-03-18 14:24:54', 'title' => ''], + 'url' => ['description' => 'webhook Link ', 'type' => 'string', 'example' => 'https://xxxx', 'title' => ''], + 'tagPushEvents' => ['description' => 'Indicates whether the event is a tag push event. '."\n" + .'Valid values: true / false', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'lastTestResult' => ['description' => 'Last execution result. '."\n" + .'Valid values: ok / error / "" (empty string) ', 'type' => 'string', 'example' => 'ok', 'title' => ''], + 'mergeRequestsEvents' => ['description' => 'Indicates whether the event is a code merge event. '."\n" + .'Valid values: true / false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'description' => ['description' => 'Description', 'type' => 'string', 'example' => '线下测试', 'title' => ''], + 'noteEvents' => ['description' => 'Indicates whether the event is a comment event. '."\n" + .'Valid values: true / false ', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'secretToken' => ['description' => 'Key, a custom value defined by the user to distinguish hooks', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'id' => ['description' => 'UUID of the webhook', 'type' => 'integer', 'format' => 'int64', 'example' => '16776', 'title' => ''], + 'enableSslVerification' => ['description' => 'Indicates whether SSL authentication is enabled. '."\n" + .'Valid values: true / false', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Openapi.RequestError', - 'errorMessage' => 'request error', - ], - ], - 403 => [ - [ - 'errorCode' => 'Operate.NoPermission', - 'errorMessage' => 'NoPermission', - ], + 500 => [ + ['errorCode' => 'SystemError.UnKnownError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''], ], ], - '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', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query the webhook list of a code repository ', + 'changeSet' => [ + ['createdAt' => '2022-03-18T06:00:13.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRepositoryWebhook'], + ], ], + 'ramActions' => [], + ], + 'ListResourceMembers' => [ + 'summary' => 'You can obtain the resource member list.', + 'path' => '/organization/{organizationId}/{resourceType}/{resourceId}/members', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'The enterprise identifier, also known as the enterprise ID, is a string that can be obtained from the Alibaba Cloud DevOps access link, such as https://devops.aliyun.com/organization/【OrganizationId】.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], + ], + [ + 'name' => 'resourceType', + 'in' => 'path', 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'Resource type: pipeline for pipelines, hostGroup for host groups', 'type' => 'string', 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', + 'example' => 'pipeline', + 'enum' => ['pipeline', 'hostGroup'], ], ], [ - '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, - ], + 'name' => 'resourceId', + 'in' => 'path', + 'schema' => ['description' => 'Resource ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '122', 'title' => ''], ], ], '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' => '', - ], - ], + 'requestId' => ['title' => '', 'description' => 'Request ID. Each request has a unique value to facilitate troubleshooting.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => '""'], + 'errorCode' => ['title' => '', 'description' => 'Error code', 'type' => 'string', 'example' => '""'], + 'success' => ['title' => '', 'description' => 'true indicates success; false indicates failure.', 'type' => 'boolean', 'example' => 'true'], + 'resourceMembers' => [ + 'title' => '', + 'description' => 'Member', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'accountId' => ['title' => '', 'description' => 'Account ID', 'type' => 'string', 'example' => '22212212'], + 'roleName' => ['title' => '', 'description' => 'Role'."\n" + ."\n" + .'Deployment group hostGroup: '."\n" + .'- user: Member with usage permission '."\n" + .'- admin: Administrator with edit permission '."\n" + .'- owner: Owner with all permissions '."\n" + ."\n" + .'Pipeline: '."\n" + .'- owner: Owner with all permissions '."\n" + .'- admin: Permission to view, run, and edit '."\n" + .'- member: Permission to run '."\n" + .'- viewer: Permission to view', 'type' => 'string', 'example' => 'admin'], + 'username' => ['title' => '', 'description' => 'Username', 'type' => 'string', 'example' => '张三'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Openapi.RequestError', - 'errorMessage' => 'request error', - ], + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => 'The user that is invoking the API service is not a registered user.'], ], 403 => [ - [ - 'errorCode' => 'Operate.NoPermission', - 'errorMessage' => 'NoPermission', - ], + ['errorCode' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], ], ], - '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', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Obtain the resource member list', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListResourceMembers'], + ], ], + 'ramActions' => [], + ], + 'ListSearchCommit' => [ + 'summary' => 'Retrieves commit data that matches the filter criteria.', + 'path' => '/search/commit', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'organizationId', - 'in' => 'path', - 'schema' => [ - 'title' => '企业id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'in' => 'query', + 'schema' => ['title' => 'A short description of struct', 'description' => 'The ID of the organization. You can obtain this ID from the URL of your organization page on Alibaba Cloud DevOps, for example: `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'required' => true, 'example' => '60d54f3daccf2bbd6659f3ad'], ], [ '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', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'keyword' => ['description' => 'The search keyword.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], + 'page' => ['description' => 'The page number of the results. Defaults to `1`.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'pageSize' => ['description' => 'The number of results per page, from 1 to 100. Defaults to `20`.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + 'order' => ['description' => 'The field to sort the results by. Defaults to `default`.'."\n" + ."\n" + .'- `default`: Composite sort.'."\n" + ."\n" + .'- `created_at`: Creation time.'."\n" + ."\n" + .'- `updated_at`: Update time.'."\n" + ."\n" + .'- `star`: Number of stars.'."\n" + ."\n" + .'- `like`: Number of likes.'."\n" + ."\n" + .'- `comment`: Number of comments.'."\n" + ."\n" + .'- `reply`: Number of replies.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], + 'sort' => ['description' => 'The sort direction. Defaults to `desc`.'."\n" + ."\n" + .'- `desc`: Descending order.'."\n" + ."\n" + .'- `asc`: Ascending order.', 'type' => 'string', 'required' => false, 'example' => 'desc', 'title' => ''], + 'scope' => ['description' => 'The search scope. The default value is `all`.'."\n" + ."\n" + .'- `all`: Searches all public repositories and private repositories that you can access.'."\n" + ."\n" + .'- `mine`: Searches only within repositories where you are a member and have read permissions.', 'type' => 'string', 'required' => false, 'example' => 'all', 'title' => ''], + 'repoPath' => [ + 'description' => 'The query conditions for the repository path.', + 'type' => 'object', + 'properties' => [ + 'value' => ['description' => 'The full repository path. For example, `organization/group/repo`.'."\n" + ."\n" + .'> To specify multiple paths, separate them with a comma (`,`).', 'type' => 'string', 'required' => false, 'example' => 'orgId/test-group/spring-boot-demo', 'title' => ''], + 'operatorType' => ['description' => 'The operator for the query condition.'."\n" + ."\n" + .'- `equal`: Equals'."\n" + ."\n" + .'- `unequal`: Does not equal'."\n" + ."\n" + .'- `and`: AND'."\n" + ."\n" + .'- `or`: OR'."\n" + ."\n" + .'- `not`: NOT', 'type' => 'string', 'required' => false, 'example' => 'equal', 'title' => ''], + 'matchType' => ['description' => 'The match type for the query.'."\n" + ."\n" + .'- `term`: Exact match.'."\n" + ."\n" + .'- `regex`: Regular expression match.'."\n" + ."\n" + .'- `phrase`: Phrase match (default).'."\n" + ."\n" + .'- `wildcard`: Wildcard match.', 'type' => 'string', 'required' => false, 'example' => 'term', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], - 'required' => false, + 'required' => true, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '工作项请求结果', - 'description' => '', + 'title' => 'Schema of Response', + 'description' => 'The schema of the response.', '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......', + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9'], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'total' => ['description' => 'The total count of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'result' => [ + 'description' => 'The list of returned items.', + 'type' => 'array', + 'items' => [ + 'description' => 'An array of the returned commit data.', + 'type' => 'object', + 'properties' => [ + 'docId' => ['description' => 'The document ID.', 'type' => 'string', 'example' => ' '."\n" + .'60d54f3daccf2bbd6659f3ad/gitlabhq/master/config/environments/test.rb', 'title' => ''], + 'highlightTextMap' => [ + 'description' => 'The highlighted content.', + 'type' => 'object', + 'properties' => [ + 'commitId' => ['description' => 'The commit ID.', 'type' => 'string', 'example' => 'df1b701cb0f3f7ca92320d49d31995821f2d045c', 'title' => ''], + 'title' => ['description' => 'The commit title, which is the first line of the commit message.', 'type' => 'string', 'example' => '提交标题', 'title' => ''], + 'commitMessage' => ['description' => 'The commit message.', 'type' => 'string', 'example' => '提交内容', 'title' => ''], + 'organizationId' => ['description' => 'The organization ID.', 'type' => 'string', 'example' => '60de7a6852743a5162b5f957', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'source' => [ + 'description' => 'The original source data from Elasticsearch.', + 'type' => 'object', + 'properties' => [ + 'commitId' => ['description' => 'The commit ID.', 'type' => 'string', 'example' => 'a748f5ecb17a93900d4808944bfcc96dc158ee2d', 'title' => ''], + 'title' => ['description' => 'The commit title, which is the first line of the commit message.', 'type' => 'string', 'example' => '提交标题', 'title' => ''], + 'commitMessage' => ['description' => 'The commit message.', 'type' => 'string', 'example' => '提交信息', 'title' => ''], + 'authorTime' => ['description' => 'The author time.', 'type' => 'string', 'example' => '2022-11-11 11:11:11', 'title' => ''], + 'repoPath' => ['description' => 'The complete repository path, including the full group path.', 'type' => 'string', 'example' => 'codeup/test-repo', 'title' => ''], + 'organizationId' => ['description' => 'The organization ID. This ID is part of your organization\'s URL in Alibaba Cloud DevOps: `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'example' => '61133b011bd96aa110f1b500', 'title' => ''], + 'author' => [ + 'description' => 'The commit author.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The name of the author.', 'type' => 'string', 'example' => '云效', 'title' => ''], + 'email' => ['description' => 'The email address of the author.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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 \\"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\\": \\"username@example.com\\"\\n }\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Search code commit data', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSearchCommit'], ], ], - '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":""}]', + 'ramActions' => [], ], - 'GetWorkitemAttachmentCreatemeta' => [ - 'summary' => '获取附件上传的元信息', - 'path' => '/organization/{organizationId}/workitem/{workitemIdentifier}/attachment/createmeta', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListSearchRepository' => [ + 'summary' => 'Searches the code repository for data using the search criteria.', + 'path' => '/search/repo', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => [], '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', - ], + 'in' => 'query', + 'schema' => ['title' => 'A short description of struct', 'description' => 'The ID of the organization. You can obtain it from the URL in Alibaba Cloud DevOps, for example, `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'required' => true, 'example' => '61e54b0e0bb300d827e1ae27'], ], [ - 'name' => 'fileName', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'keyword' => ['description' => 'The search keyword.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], + 'aliyunPk' => ['description' => 'The Alibaba Cloud account ID of the repository creator. You can filter by only one account ID.', 'type' => 'string', 'required' => false, 'example' => '1840004904455497', 'title' => ''], + 'visibilityLevel' => ['description' => 'The visibility of the repository.'."\n" + ."\n" + .'- `0`: private'."\n" + ."\n" + .'- `10`: internal', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'page' => ['description' => 'The page number of the results to return. The default value is `1`.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'pageSize' => ['description' => 'The page size. Valid range: 1–100. Default: `20`.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + 'sort' => ['description' => 'The sort direction. The default value is `desc`.'."\n" + ."\n" + .'- `desc`: descending'."\n" + ."\n" + .'- `asc`: ascending', 'type' => 'string', 'required' => false, 'example' => 'desc', 'title' => ''], + 'order' => ['description' => 'The sort field. The default value is `default`.'."\n" + ."\n" + .'- `default`: best match'."\n" + ."\n" + .'- `created_at`: Creation time'."\n" + ."\n" + .'- `updated_at`: Update time'."\n" + ."\n" + .'- `star`: Number of stars'."\n" + ."\n" + .'- `like`: Number of likes'."\n" + ."\n" + .'- `comment`: Number of comments'."\n" + ."\n" + .'- `reply`: Number of replies', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], + 'scope' => ['description' => 'The search scope. The default value is `all`.'."\n" + ."\n" + .'- `all`: All public repositories and all private repositories to which you have access.'."\n" + ."\n" + .'- `mine`: Repositories where you are a member with read access.', 'type' => 'string', 'required' => false, 'example' => 'all', 'title' => ''], + 'repoPath' => [ + 'description' => 'The repository search criteria.', + 'type' => 'object', + 'properties' => [ + 'value' => ['description' => 'The full path of the repository, for example, `organization/group/repo`.'."\n" + ."\n" + .'> Separate multiple repository paths with a comma (,).', 'type' => 'string', 'required' => false, 'example' => 'orgId/test-group/spring-boot-demo', 'title' => ''], + 'operatorType' => ['description' => 'The operator type.'."\n" + ."\n" + .'- `equal`: equal'."\n" + ."\n" + .'- `unequal`: unequal'."\n" + ."\n" + .'- `and`: and'."\n" + ."\n" + .'- `or`: or'."\n" + ."\n" + .'- `not`: not', 'type' => 'string', 'required' => false, 'example' => 'equal', 'title' => ''], + 'matchType' => ['description' => 'The match type.'."\n" + ."\n" + .'- `term`: exact match'."\n" + ."\n" + .'- `regex`: regex match'."\n" + ."\n" + .'- `phrase`: phrase match (default)'."\n" + ."\n" + .'- `wildcard`: wildcard match', 'type' => 'string', 'required' => false, 'example' => 'term', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], 'required' => true, - 'example' => 'application.jar', + 'title' => '', + 'example' => '', ], ], ], @@ -36265,111 +20395,213 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response schema.', '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', + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9'], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Openapi.RequestError', 'title' => ''], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'total' => ['description' => 'The total number of repositories found.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], + 'result' => [ + 'description' => 'The list of repositories found.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of a returned repository.', + 'type' => 'object', + 'properties' => [ + 'docId' => ['description' => 'The document ID.', 'type' => 'string', 'example' => ' '."\n" + .'60d54f3daccf2bbd6659f3ad/gitlabhq/master/config/environments/test.rb', 'title' => ''], + 'highlightTextMap' => [ + 'description' => 'Information about the highlighted text.', + 'type' => 'object', + 'properties' => [ + 'organizationId' => ['description' => 'The highlighted organization ID.', 'type' => 'string', 'example' => '60de7a6852743a5162b5f957', 'title' => ''], + 'creatorUserId' => ['description' => 'The user ID of the creator. This is the user\'s Alibaba Cloud DevOps ID.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'repoPath' => ['description' => 'The full path of the repository, including the full group path.', 'type' => 'string', 'example' => 'codeup/test-repo', 'title' => ''], + 'repoNameWithNamespace' => ['description' => 'The full name of the repository, including the full group name.', 'type' => 'string', 'example' => 'codeup/test-repo', 'title' => ''], + 'readMe' => ['description' => 'Highlighted information from the readme file.', 'type' => 'string', 'example' => 'xx', 'title' => ''], + 'description' => ['description' => 'The description of the repository.', 'type' => 'string', 'example' => '描述内容', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'source' => [ + 'description' => 'The source information returned by Elasticsearch.', + 'type' => 'object', + 'properties' => [ + 'repoName' => ['description' => 'The name of the repository.', 'type' => 'string', 'example' => 'test-repo', 'title' => ''], + 'repoPath' => ['description' => 'The full path of the repository, including the full group path.', 'type' => 'string', 'example' => 'codeup/test-repo', 'title' => ''], + 'description' => ['description' => 'The description of the repository.', 'type' => 'string', 'example' => '描述内容', 'title' => ''], + 'visibilityLevel' => ['description' => 'The visibility of the repository.'."\n" + ."\n" + .'- `0`: Private. Visible only to repository members.'."\n" + ."\n" + .'- `10`: Internal. Visible to all members of the organization.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'createTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2022-10-10 10:10:10', 'title' => ''], + 'lastActivityTime' => ['description' => 'The last activity time.', 'type' => 'string', 'example' => '2022-11-11 11:11:11', 'title' => ''], + 'readMe' => ['description' => 'The content of the readme file.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'organizationId' => ['description' => 'The ID of the organization. You can obtain the organization ID from the URL of your organization\'s page in Alibaba Cloud DevOps, for example, `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'example' => '62a94a8611fc0f0c9e2a7bc1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Openapi.RequestError', - 'errorMessage' => 'request error', - ], - ], 403 => [ - [ - 'errorCode' => 'Operate.NoPermission', - 'errorMessage' => 'NoPermission', - ], + ['errorCode' => 'Forbidden.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => '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.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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"}]', + 'title' => 'Search code repository data ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSearchRepository'], + ], ], - '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"}]', + 'ramActions' => [], ], - 'GetWorkitemTimeTypeList' => [ - 'summary' => '获得一个企业下所有工时类型', - 'path' => '/organization/{organizationId}/workitems/type/list', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListSearchSourceCode' => [ + 'summary' => 'Finds code snippets based on the filter criteria.', + 'path' => '/search/code', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'organizationId', - 'in' => 'path', + 'in' => 'query', + 'schema' => ['title' => 'A short description of struct', 'description' => 'The organization ID. You can find this ID in your Alibaba Cloud DevOps organization URL. The URL format is `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'required' => true, 'example' => '66c0c9fffeb86b450c199fcd'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'keyword' => ['description' => 'The search keyword.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], + 'page' => ['description' => 'The page number of the results to return. The default is `1`.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'pageSize' => ['description' => 'The number of results to return per page. The default is `20`. The value must be between 1 and 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], + 'sort' => ['description' => 'The sort order. The default is `desc`.'."\n" + ."\n" + .'- `desc`: descending order'."\n" + ."\n" + .'- `asc`: ascending order', 'type' => 'string', 'required' => false, 'example' => 'desc', 'title' => ''], + 'order' => ['description' => 'The sort field. The default is `default`.'."\n" + ."\n" + .'- `default`: Sort by relevance.'."\n" + ."\n" + .'- `created_at`: Sort by creation time.'."\n" + ."\n" + .'- `updated_at`: Sort by update time.'."\n" + ."\n" + .'- `star`: Sort by the number of stars.'."\n" + ."\n" + .'- `like`: Sort by the number of likes.'."\n" + ."\n" + .'- `comment`: Sort by the number of comments.'."\n" + ."\n" + .'- `reply`: Sort by the number of replies.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], + 'scope' => ['description' => 'The search scope. The default is `all`.'."\n" + ."\n" + .'- `all`: Searches all public repositories and any private repositories you have access to.'."\n" + ."\n" + .'- `mine`: Searches only in repositories to which you have read access.', 'type' => 'string', 'required' => false, 'example' => 'all', 'title' => ''], + 'repoPath' => [ + 'description' => 'A filter condition for the repository path.', + 'type' => 'object', + 'properties' => [ + 'value' => ['description' => 'The full path of the repository, for example, `organization/group/repo`.'."\n" + ."\n" + .'> To specify multiple paths, separate them with a comma (`,`).', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], + 'operatorType' => ['description' => 'The operator type.'."\n" + ."\n" + .'- `equal`: Equal to'."\n" + ."\n" + .'- `unequal`: Not equal to'."\n" + ."\n" + .'- `and`: AND'."\n" + ."\n" + .'- `or`: OR'."\n" + ."\n" + .'- `not`: NOT', 'type' => 'string', 'required' => false, 'example' => 'equal', 'title' => ''], + 'matchType' => ['description' => 'The match type. The default is `phrase`.'."\n" + ."\n" + .'- `term`: exact match'."\n" + ."\n" + .'- `regex`: regular expression match'."\n" + ."\n" + .'- `phrase`: phrase match'."\n" + ."\n" + .'- `wildcard`: wildcard match', 'type' => 'string', 'required' => false, 'example' => 'term', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'filePath' => [ + 'description' => 'A filter condition for the file path. Regular expressions are supported.', + 'type' => 'object', + 'properties' => [ + 'value' => ['description' => 'The full path of the file, for example, `organization/group/repo/file`.'."\n" + ."\n" + .'> To specify multiple paths, separate them with a comma (`,`).', 'type' => 'string', 'required' => false, 'example' => 'orgId/test-group/spring-boot-demo/test.java', 'title' => ''], + 'operatorType' => ['description' => 'The operator type.'."\n" + ."\n" + .'- `equal`: Equal to'."\n" + ."\n" + .'- `unequal`: Not equal to'."\n" + ."\n" + .'- `and`: AND'."\n" + ."\n" + .'- `or`: OR'."\n" + ."\n" + .'- `not`: NOT', 'type' => 'string', 'required' => false, 'example' => 'equal', 'title' => ''], + 'matchType' => ['description' => 'The match type. The default is `phrase`.'."\n" + ."\n" + .'- `term`: exact match'."\n" + ."\n" + .'- `regex`: regular expression match'."\n" + ."\n" + .'- `phrase`: phrase match'."\n" + ."\n" + .'- `wildcard`: wildcard match', 'type' => 'string', 'required' => false, 'example' => 'term', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'language' => ['description' => 'The programming language.', 'type' => 'string', 'required' => false, 'example' => 'Java', 'title' => ''], + 'isCodeBlock' => ['description' => 'Specifies whether to search within code blocks, such as classes and methods.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', + 'title' => '', + 'example' => '', ], ], ], @@ -36377,143 +20609,104 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', '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' => '', + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => ' '."\n" + .'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'total' => ['description' => 'The total count of matching records.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'result' => [ + 'description' => 'A list of search results.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'A single search result.', 'type' => 'object', 'properties' => [ - 'identifier' => [ - 'description' => '', - 'type' => 'string', - 'example' => '67fb001005aac8d3d2a3372416', - ], - 'name' => [ - 'description' => '', - 'type' => 'string', - ], - 'displayName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'deploy', - ], - 'description' => [ - 'description' => '', - 'type' => 'string', + 'docId' => ['description' => 'The document ID.', 'type' => 'string', 'example' => '60d54f3daccf2bbd6659f3ad/gitlabhq/master/spec/frontend/snippets/test_utils.js', 'title' => ''], + 'highlightTextMap' => [ + 'description' => 'Contains highlighted text from the search results.', + 'type' => 'object', + 'properties' => [ + 'organizationId' => ['description' => 'The organization ID.', 'type' => 'string', 'example' => '60de7a6852743a5162b5f957', 'title' => ''], + 'fileName' => ['description' => 'The matched file name.', 'type' => 'string', 'example' => 'test.java', 'title' => ''], + 'clob' => ['description' => 'A highlighted snippet of the file content.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'language' => ['description' => 'The programming language.', 'type' => 'string', 'example' => 'java', 'title' => ''], + ], + 'title' => '', 'example' => '', ], - 'position' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + 'source' => [ + 'description' => 'The original source object from the search index.', + 'type' => 'object', + 'properties' => [ + 'repoPath' => ['description' => 'The full path to the repository, including the group path.', 'type' => 'string', 'example' => 'codeup/test-repo', 'title' => ''], + 'fileName' => ['description' => 'The file name.', 'type' => 'string', 'example' => 'test_utils.js', 'title' => ''], + 'filePath' => ['description' => 'The file path.', 'type' => 'string', 'example' => 'spec/frontend/snippets/test_utils.js', 'title' => ''], + 'language' => ['description' => 'The programming language.', 'type' => 'string', 'example' => 'JavaScript', 'title' => ''], + 'checkinDate' => ['description' => 'The date and time of the last commit.', 'type' => 'string', 'example' => '2022-10-10 10:00:00', 'title' => ''], + 'branch' => ['description' => 'The branch name.', 'type' => 'string', 'example' => 'master', 'title' => ''], + 'organizationId' => ['description' => 'The organization ID. You can find this ID in your organization\'s URL in Alibaba Cloud DevOps. The URL follows the format: https\\://devops.aliyun.com/organization/{OrganizationId}.', 'type' => 'string', 'example' => '60de7a6852743a5162b5f957', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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 \\"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"}]', + 'title' => 'Search code snippet data', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSearchSourceCode'], ], ], - '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"}]', + 'ramActions' => [], ], - 'GetWorkitemRelations' => [ - 'summary' => '获得一个工作项的指定关联项', - 'path' => '/organization/{organizationId}/workitems/{workitemId}/getRelations', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListServiceAuths' => [ + 'summary' => 'Retrieves a list of service authorizations for an organization.', + 'path' => '/organization/{organizationId}/serviceAuths', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], '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', - ], + 'schema' => ['description' => 'The organization ID. You can find this ID in your browser\'s address bar after logging in to the Alibaba Cloud DevOps console. The URL is in the format `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx', 'title' => ''], ], [ - 'name' => 'relationType', + 'name' => 'serviceAuthType', 'in' => 'query', 'schema' => [ - 'title' => '一共有BLOCKING,BLOCKED,ASSOCIATED, DUPLICATED,SUB, PARENT,一共6个待选值,只会获得工作项类型的关系项', - 'description' => '', + 'description' => 'The service authorization type.', 'type' => 'string', 'required' => true, - 'enumValueTitles' => [ - 'SUB' => 'SUB', - 'PARENT' => 'PARENT', - 'BLOCKED' => 'BLOCKED', - 'DUPLICATED' => 'DUPLICATED', - 'BLOCKING' => 'BLOCKING', - 'ASSOCIATED' => 'ASSOCIATED', - ], - 'example' => '', + 'example' => 'RAM (阿里云RAM类型)', + 'enum' => ['RAM'], + 'title' => '', ], ], ], @@ -36521,349 +20714,204 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', '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' => '', + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful. `true` indicates success, and `false` indicates failure.', 'type' => 'boolean', 'default' => '默认值', 'title' => '', 'example' => 'true'], + 'serviceAuths' => [ + 'title' => '', + 'description' => 'The list of service authorizations.', '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', - ], + 'id' => ['description' => 'The service authorization ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'ownerName' => ['description' => 'The owner name.', 'type' => 'string', 'example' => '张三', 'title' => ''], + 'type' => ['description' => 'The service authorization type.', 'type' => 'string', 'example' => 'Codeup', 'title' => ''], + 'ownerStaffId' => ['description' => 'The staff ID of the owner.', 'type' => 'string', 'example' => '123456789', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Openapi.RequestError', - 'errorMessage' => 'request error', - ], + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => 'The user that is invoking the API service is not a registered user.'], ], 403 => [ - [ - 'errorCode' => 'Operate.NoPermission', - 'errorMessage' => 'NoPermission', - ], + ['errorCode' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], ], ], - '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', + '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"}]', + 'title' => 'Obtain the service access authorization list ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListServiceAuths'], + ], ], + 'ramActions' => [], + ], + 'ListServiceConnections' => [ + 'summary' => 'Retrieves a list of service connections within a specified organization.', + 'path' => '/organization/{organizationId}/serviceConnections', + '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', - ], + 'schema' => ['description' => 'The ID of the organization. You can find this ID in the URL of your organization\'s page in Alibaba Cloud DevOps: `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx', 'title' => ''], ], [ - 'name' => 'workitemId', - 'in' => 'path', - 'schema' => [ - 'title' => '工作项id'."\n", - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ce2xxxx21580baxxxx633f13', - ], + 'name' => 'sericeConnectionType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the service connection. Valid values:'."\n" + ."\n" + .'- `aliyun_code`: Aliyun Code'."\n" + ."\n" + .'- `Codeup`: Codeup'."\n" + ."\n" + .'- `Gitee`: Gitee'."\n" + ."\n" + .'- `github`: GitHub'."\n" + ."\n" + .'- `ack`: Container Service for Kubernetes (ACK)'."\n" + ."\n" + .'- `docker_register_aliyun`: Container Registry (ACR)'."\n" + ."\n" + .'- `ecs`: ECS instance'."\n" + ."\n" + .'- `edas`: Enterprise Distributed Application Service (EDAS)'."\n" + ."\n" + .'- `emas`: Enterprise Mobile Application Studio (EMAS)'."\n" + ."\n" + .'- `fc`: Function Compute (FC)'."\n" + ."\n" + .'- `kubernetes`: self-managed Kubernetes cluster'."\n" + ."\n" + .'- `oss`: Object Storage Service (OSS)'."\n" + ."\n" + .'- `PACKAGES`: artifact repository'."\n" + ."\n" + .'- `ros`: Resource Orchestration Service (ROS)'."\n" + ."\n" + .'- `sae`: Serverless App Engine (SAE)', 'type' => 'string', 'required' => true, 'example' => 'codeup', 'title' => ''], ], ], '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' => '', + 'requestId' => ['description' => 'The unique request ID. Use this ID for troubleshooting.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', 'title' => ''], + 'errorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'errorCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request succeeded. Valid values: `true` and `false`.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'serviceConnections' => [ + 'title' => '', + 'description' => 'The list of service connections.', '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', - ], - ], - ], - ], + 'ownerAccountId' => ['description' => 'The ID of the Alibaba Cloud account that owns the service connection.', 'type' => 'integer', 'format' => 'int64', 'example' => '1212123212121212', 'title' => ''], + 'name' => ['description' => 'The name of the service connection.', 'type' => 'string', 'example' => '张三的oss服务连接', 'title' => ''], + 'id' => ['description' => 'The ID of the service connection.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'type' => ['description' => 'The type of the service connection.', 'type' => 'string', 'example' => 'oss', 'title' => ''], + 'createTime' => ['description' => 'The creation time of the service connection, provided as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1586863220000', 'title' => ''], + 'uuid' => ['title' => 'uuid', 'description' => 'The UUID of the service connection.', 'type' => 'string', 'example' => ''], + ], + 'description' => 'The details of a service connection.', + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'description' => 'The response object.', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Openapi.RequestError', - 'errorMessage' => 'request error', - ], + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => 'The user that is invoking the API service is not a registered user.'], ], 403 => [ - [ - 'errorCode' => 'Operate.NoPermission', - 'errorMessage' => 'NoPermission', - ], + ['errorCode' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], ], ], - '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', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'List service connections', + 'changeSet' => [ + ['createdAt' => '2023-09-20T02:21:17.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListServiceConnections'], + ], ], + 'ramActions' => [], + ], + 'ListServiceCredentials' => [ + 'summary' => 'Retrieves a list of service credentials.', + 'path' => '/organization/{organizationId}/serviceCredentials', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['description' => 'The ID of the organization. You can get the organization ID from the URL of your organization in Alibaba Cloud DevOps, for example, `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'serviceCredentialType', + 'in' => 'query', '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, + 'description' => 'Filters the results by the service credential type.', + 'type' => 'string', + 'required' => true, + 'example' => 'username_password (用户名密码类型)', + 'enum' => ['USERNAME_PASSWORD'], + 'title' => '', ], ], ], @@ -36871,190 +20919,64 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', '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' => 'xxxxxxcc@xxx.com', - ], - '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', - ], - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'default' => '默认值', 'title' => '', 'example' => 'true'], + 'serviceCredentials' => [ + 'description' => 'The list of service credentials.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The ID of the service credential.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'ownerName' => ['description' => 'The owner name.', 'type' => 'string', 'example' => '张三', 'title' => ''], + 'type' => ['description' => 'The service credential type.', 'type' => 'string', 'example' => 'Codeup', 'title' => ''], + 'ownerStaffId' => ['description' => 'The Staff ID of the credential owner.', 'type' => 'string', 'example' => '123456789', 'title' => ''], ], + 'description' => 'An object that contains the details of a service credential.', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Openapi.RequestError', - 'errorMessage' => 'request error', - ], + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => 'The user that is invoking the API service is not a registered user.'], ], 403 => [ - [ - 'errorCode' => 'Operate.NoPermission', - 'errorMessage' => 'NoPermission', - ], + ['errorCode' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], ], ], - '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\\": \\"xxxxxxcc@xxx.com\\",\\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', + '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"}]', + 'title' => 'Obtain the service certificate list ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListServiceCredentials'], + ], ], + 'ramActions' => [], + ], + 'ListSprints' => [ + 'summary' => 'Retrieve the iteration list.', + 'path' => '/organization/{organizationId}/sprints/list', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -37067,56 +20989,27 @@ [ 'name' => 'organizationId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['description' => 'Organization identifier (also known as organization ID), in string format. It can be obtained from the Alibaba Cloud DevOps access URL, for example: https://devops.aliyun.com/organization/【OrganizationId】 ', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx', 'title' => ''], ], [ 'name' => 'spaceIdentifier', 'in' => 'query', - 'schema' => [ - 'title' => '项目id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'e8bxxxxxxxxxxxxxxxx23', - ], + 'schema' => ['title' => '', 'description' => 'Unique project identifier, equivalent to projectId ', 'type' => 'string', 'required' => true, 'example' => 'e8bxxxxxxxxxxxxxxxx23'], ], [ 'name' => 'spaceType', 'in' => 'query', - 'schema' => [ - 'title' => '类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'Project', - ], + 'schema' => ['title' => '', 'description' => 'Type; use "Project" here ', 'type' => 'string', 'required' => true, 'example' => 'Project'], ], [ - 'name' => 'workitemTypeIdentifier', + 'name' => 'nextToken', 'in' => 'query', - 'schema' => [ - 'title' => '工作项类型id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '9uyxxxx1re573f561dxxxxx', - ], + 'schema' => ['title' => '', 'description' => 'Leave empty for the first page. For subsequent pages, use the value of this field from the previous response to retrieve the next page of data ', 'type' => 'string', 'required' => false, 'example' => '""'], ], [ - 'name' => 'fieldId', - 'in' => 'path', - 'schema' => [ - 'title' => '字段id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1019xxxxx5f5c33xxxxx9920d44', - ], + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Maximum number of results per page, ranging from 0 to 200. Default value is 20 ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20'], ], ], 'responses' => [ @@ -37124,143 +21017,86 @@ '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' => '', + 'totalCount' => ['title' => '', 'description' => 'Total quantity ', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'nextToken' => ['title' => '', 'description' => 'Paging token; empty if there is no next page', 'type' => 'string', 'example' => '""'], + 'maxResults' => ['title' => '', 'description' => 'Quantity per page', 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'requestId' => ['title' => '', 'description' => 'Request ID; each request has a unique value to facilitate troubleshooting', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMsg' => ['title' => '', 'description' => 'Error message ', 'type' => 'string', 'example' => 'error'], + 'errorCode' => ['title' => '', 'description' => 'Error code', 'type' => 'string', 'example' => 'Openapi.RequestError'], + 'success' => ['title' => '', 'description' => 'true or false', 'type' => 'boolean', 'example' => 'true'], + 'sprints' => [ + 'title' => '', + 'description' => 'Iteration information', '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', - ], + 'creator' => ['title' => '', 'description' => 'Creator aliyunPk', 'type' => 'string', 'example' => '19xx7043xxxxxxx914'], + 'description' => ['title' => '', 'description' => 'Description ', 'type' => 'string', 'example' => 'xxx'], + 'gmtCreate' => ['title' => '', 'description' => 'Creation Time ', 'type' => 'integer', 'format' => 'int64', 'example' => '1623916393000'], + 'gmtModified' => ['title' => '', 'description' => 'Updated At', 'type' => 'integer', 'format' => 'int64', 'example' => '1623916393000'], + 'endDate' => ['title' => '', 'description' => 'End time', 'type' => 'integer', 'format' => 'int64', 'example' => '1623916393000'], + 'startDate' => ['title' => '', 'description' => 'Start Time ', 'type' => 'integer', 'format' => 'int64', 'example' => '1638403200000'], + 'identifier' => ['title' => '', 'description' => 'Unique Identifier of the iteration', 'type' => 'string', 'example' => 'e8bxxxxxxxxxxxxxxxx23'], + 'modifier' => ['title' => '', 'description' => 'Updated By aliyunPk ', 'type' => 'string', 'example' => '19xx7043xxxxxxx914'], + 'name' => ['title' => '', 'description' => 'Iteration Name ', 'type' => 'string', 'example' => 'demo示例项目'], + 'spaceIdentifier' => ['title' => '', 'description' => 'Project UUID ', 'type' => 'string', 'example' => '5e70xxxxxxcd000xxxxe96'], + 'scope' => ['title' => '', 'description' => 'Visible To ', 'type' => 'string', 'example' => 'public'], + 'status' => ['title' => '', 'description' => 'Status. Valid values: TODO, DOING, and DONE, which indicate that the iteration has not started, is in progress, and has been completed, respectively.', 'type' => 'string', 'example' => 'TODO'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Openapi.RequestError', - 'errorMessage' => 'request error', - ], + ['errorCode' => 'Openapi.RequestError', 'errorMessage' => 'request error', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'Operate.NoPermission', - 'errorMessage' => 'NoPermission', - ], + ['errorCode' => 'Operate.NoPermission', 'errorMessage' => 'NoPermission', 'description' => 'You are not authorized to perform this operation.'], ], ], - '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', + '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 \\"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}","type":"json"}]', + 'title' => 'Retrieve iteration list ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSprints'], + ], ], + 'ramActions' => [], + ], + 'ListTestCaseFields' => [ + 'summary' => 'Retrieves all fields for a test case.', + 'path' => '/organization/{organizationId}/testhub/testcase/fields', + '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', - ], + 'schema' => ['description' => 'The organization ID, also known as the organization id, is a string that you can obtain from the Alibaba Cloud DevOps access URL, such as https\\://devops.aliyun.com/organization/【OrganizationId】.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx', 'title' => ''], ], [ - 'name' => 'workitemId', - 'in' => 'path', - 'schema' => [ - 'title' => '工作项id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'e8bxxxxxxxxxxxxxxxx23', - ], + 'name' => 'spaceIdentifier', + 'in' => 'query', + 'schema' => ['description' => 'The unique identifier of the test case library.', 'type' => 'string', 'required' => true, 'example' => 'e8bxxxxxxxxxxxxxxxx23', 'title' => ''], ], ], 'responses' => [ @@ -37268,1117 +21104,540 @@ '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' => '', + 'requestId' => ['description' => 'The request ID. It is unique for each request and is used for troubleshooting.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', 'title' => ''], + 'errorMsg' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'error', 'title' => ''], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Openapi.RequestError', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'fields' => [ + 'title' => '', + 'description' => 'An array of field objects.', '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' => [ + 'creator' => ['description' => 'The ID of the user who created the field.', 'type' => 'string', 'example' => '19xx7043xxxxxxx914', 'title' => ''], + 'description' => ['description' => 'The description of the field.', 'type' => 'string', 'example' => '字段的具体信息', 'title' => ''], + 'gmtCreate' => ['description' => 'The creation time of the field. The value is a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1623916393000', 'title' => ''], + 'gmtModified' => ['description' => 'The time when the field was last modified. The value is a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1623916393000', 'title' => ''], + 'type' => ['description' => 'The type of the field, which indicates whether it is a system field or a custom field.', 'type' => 'string', 'example' => 'NativeField', 'title' => ''], + 'identifier' => ['description' => 'The unique identifier of the field.', 'type' => 'string', 'example' => 'e8bxxxxxxxxxxxxxxxx23', 'title' => ''], + 'modifier' => ['description' => 'The ID of the user who last modified the field.', 'type' => 'string', 'example' => '19xx7043xxxxxxx914', 'title' => ''], + 'name' => ['description' => 'The name of the field.', 'type' => 'string', 'example' => '负责人', 'title' => ''], + 'format' => ['description' => 'The format of the field.', 'type' => 'string', 'example' => 'list', 'title' => ''], + 'className' => ['description' => 'The data type of the field.', 'type' => 'string', 'example' => '例:date', 'title' => ''], + 'resourceType' => ['description' => 'The type of resource to which the field applies.', 'type' => 'string', 'example' => '例:Workitem', 'title' => ''], + 'defaultValue' => ['description' => 'The default value of the field.', 'type' => 'string', 'example' => '123', 'title' => ''], + 'isRequired' => ['description' => 'Indicates whether the field is required.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'isSystemRequired' => ['description' => 'Indicates whether the field is a system-required field, such as the `assignee` or `status` field.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'linkWithService' => ['description' => 'The service to which the field is linked. For example, this field is added to the relevant template when the iteration service is enabled, and removed when it is disabled. This type of field cannot be manually added to or removed from field templates.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'isShowWhenCreate' => ['description' => 'Indicates whether the field is displayed when a resource is created.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'options' => [ + 'title' => '', + 'description' => 'An array of options available for the field.', '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', - ], + 'identifier' => ['description' => 'The unique identifier of the option.', 'type' => 'string', 'example' => '重复的缺陷', 'title' => ''], + 'fieldIdentifier' => ['description' => 'The unique identifier of the field to which this option belongs.', 'type' => 'string', 'example' => 'e8bxxxxxxxxxxxxxxxx23', 'title' => ''], + 'value' => ['description' => 'The value of the option.', 'type' => 'string', 'example' => '重复的缺陷', 'title' => ''], + 'valueEn' => ['description' => 'The English name of the option.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'displayValue' => ['description' => 'The value displayed for the current locale.', 'type' => 'string', 'example' => '重复的缺陷', 'title' => ''], + 'position' => ['description' => 'The position of the option in the display order.', 'type' => 'integer', 'format' => 'int64', 'example' => 'null', 'title' => ''], + 'level' => ['description' => 'The display level, which ranges from 1 to 9. Higher values correspond to lighter colors.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Openapi.RequestError', - 'errorMessage' => 'request error', - ], + ['errorCode' => 'Openapi.RequestError', 'errorMessage' => 'request error', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'Operate.NoPermission', - 'errorMessage' => 'NoPermission', - ], + ['errorCode' => 'Operate.NoPermission', 'errorMessage' => 'NoPermission', 'description' => 'You are not authorized to perform this operation.'], ], ], - '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', + '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"}]', + 'title' => 'Retrieve the list of test case fields ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTestCaseFields'], + ], ], + 'ramActions' => [], + ], + 'ListUserDrawRecordByPk' => [ + 'summary' => 'Queries the lottery draw results for Yunxiao Lingma operational activities.', + 'path' => '/listUserDrawRecords', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '118506', - 'abilityTreeNodes' => [ - 'FEATURErdcY249FB', - ], - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'organizationId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5e706xxxxxx01xxx96', - ], + 'name' => 'aliyunPk', + 'in' => 'query', + 'schema' => ['description' => 'The Alibaba Cloud account ID.', 'type' => 'string', 'required' => false, 'example' => '1789095186553536', 'title' => ''], ], [ - 'name' => 'workitemId', - 'in' => 'path', - 'schema' => [ - 'title' => '工作项id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ce2xxxx21580baxxxx633f13', - ], + 'name' => 'drawGroup', + 'in' => 'query', + 'schema' => ['description' => 'The draw task group.', 'type' => 'string', 'required' => false, 'example' => 'task_group_0000', 'title' => ''], + ], + [ + 'name' => 'drawPoolName', + 'in' => 'query', + 'schema' => ['description' => 'The draw prize pool.', 'type' => 'string', 'required' => false, 'example' => 'developer-award-draw-pool_123', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '工作项请求结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', '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', - ], - ], - ], - ], + 'data' => [ + 'description' => 'The returned result.', + 'type' => 'array', + 'items' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'uccId' => ['description' => 'The uccId.', 'type' => 'string', 'example' => 'dsadsadasd', 'title' => ''], + 'drawGroup' => ['description' => 'The task group.', 'type' => 'string', 'example' => 'dsadsadsadas', 'title' => ''], + 'drawPoolName' => ['description' => 'The prize pool information.', 'type' => 'string', 'example' => 'dasdsadasdas', 'title' => ''], + 'taskGroupId' => ['description' => 'The task group ID.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'aliyunPk' => ['description' => 'The Alibaba Cloud account ID.', 'type' => 'string', 'example' => '1401072305438324', 'title' => ''], + 'gmtCreate' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '1545726028000', 'title' => ''], + 'drawResult' => ['description' => 'The draw prize result.', 'type' => 'string', 'example' => '2', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', 'title' => ''], + 'success' => ['description' => 'Indicates whether the API call is successful. Valid values:'."\n" + .'- true: The API call is successful.'."\n" + .'- false: The API call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'code' => ['description' => 'The error code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'message' => ['description' => 'The description.', 'type' => 'string', 'example' => 'None', 'title' => ''], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Openapi.RequestError', - 'errorMessage' => 'request error', - ], - ], - 403 => [ - [ - 'errorCode' => 'Operate.NoPermission', - 'errorMessage' => 'NoPermission', - ], + '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"}]', + 'title' => 'Query lottery draw results', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUserDrawRecordByPk'], ], ], - '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":""}]', + 'ramActions' => [], ], - 'GetWorkItemWorkFlowInfo' => [ - 'summary' => '获取工作项工作流信息', - 'path' => '/organization/{organizationId}/workitems/{workitemId}/getWorkflowInfo', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListUserKeys' => [ + 'summary' => 'Lists the SSH keys for the current user.', + 'path' => '/api/v3/user/keys', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'organizationId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'in' => 'query', + 'schema' => ['description' => 'The organization ID. You can obtain this ID from the URL used to access Alibaba Cloud DevOps, which is formatted as `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx', 'title' => ''], ], [ - 'name' => 'configurationId', + 'name' => 'accessToken', 'in' => 'query', - 'schema' => [ - 'title' => '项目id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '711d33c738b9171c45fa......', - ], + 'schema' => ['description' => 'The personal access token. This parameter is not required if you authenticate using an Alibaba Cloud AccessKey pair or temporary credentials from STS.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513'."\n", 'title' => ''], ], [ - 'name' => 'workitemId', - 'in' => 'path', - 'schema' => [ - 'title' => '工作项id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'fd0xxxxx00d355b05df60xxxx', - ], + 'name' => 'page', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return per page. Valid values: 1 to 100. Default value: 20.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'sort', + 'in' => 'query', + 'schema' => ['description' => 'The sort order. Default value: `desc`.'."\n" + ."\n" + .'- `asc`: ascending order.'."\n" + ."\n" + .'- `desc`: descending order.', 'type' => 'string', 'required' => false, 'example' => 'desc', 'title' => ''], + ], + [ + 'name' => 'orderBy', + 'in' => 'query', + 'schema' => ['description' => 'The field to sort the results by. Default value: `created_at`.'."\n" + ."\n" + .'- `created_at`: The creation time.'."\n" + ."\n" + .'- `updated_at`: The update time.', 'type' => 'string', 'required' => false, 'example' => 'created_at', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '工作项请求结果', - 'description' => '', + 'title' => 'Schema of Response', + 'description' => 'The response object.', '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', - ], - ], - ], - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9'], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Openapi.RequestError', 'title' => ''], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Openapi.RequestError', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'result' => [ + 'description' => 'An array of SSH key objects.', + 'type' => 'array', + 'items' => [ + 'description' => 'A single SSH key object.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The primary key ID of the SSH key.', 'type' => 'integer', 'format' => 'int64', 'example' => '5240', 'title' => ''], + 'title' => ['description' => 'The title of the SSH key.', 'type' => 'string', 'example' => 'My Title', 'title' => ''], + 'publicKey' => ['description' => 'The public key.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'fingerPrint' => ['description' => 'The fingerprint of the public key.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'keyScope' => ['description' => 'The scope of the key. Valid values: `ALL` and `READ`.'."\n" + ."\n" + .'- `ALL`: Allows both read and write operations, such as `clone`, `pull`, and `push`.'."\n" + ."\n" + .'- `READ`: Allows only read operations, such as `clone` and `pull`.', 'type' => 'string', 'example' => 'ALL', 'title' => ''], + 'createdAt' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2022-03-18 14:24:54', 'title' => ''], + 'expireTime' => ['description' => 'The expiration time.', 'type' => 'string', 'example' => '2022-03-18 14:24:54', 'title' => ''], + 'lastUsedTime' => ['description' => 'The last used time.', 'type' => 'string', 'example' => '2022-03-18 14:24:54', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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 \\"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"}]', + 'title' => 'Query SSH key list', + 'changeSet' => [ + ['createdAt' => '2024-02-01T06:27:32.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUserKeys'], ], ], - '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":""}]', + 'ramActions' => [], ], - 'ListProjectWorkitemTypes' => [ - 'summary' => '获取项目下开启的工作项类型', - 'path' => '/organization/{organizationId}/projects/{projectId}/getWorkitemType', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListUserResources' => [ + 'summary' => 'Retrieves the accessible code repositories, code groups, and roles for a specified user. This operation supports paging. Only users with enterprise administrator or higher permissions can call this API.', + 'path' => '/api/v4/user/vision/user_resources', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'organizationId', - 'in' => 'path', - 'schema' => [ - 'title' => '企业标识,也称企业id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'in' => 'query', + 'schema' => ['description' => 'The ID of the enterprise. This parameter is a string. You can obtain the enterprise ID from the URL of your enterprise on the Alibaba Cloud DevOps platform. The URL is in the following format: https\\://devops.aliyun.com/organization/{OrganizationId}.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx', 'title' => ''], ], [ - 'name' => 'projectId', - 'in' => 'path', - 'schema' => [ - 'title' => '项目id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'asd345xxxxx9q9845xxxxx34', - ], + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => ['description' => 'The personal access token. You do not need to specify this parameter if you use an AccessKey pair or an STS token for authentication.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513'."\n", 'title' => ''], ], [ - 'name' => 'spaceType', + 'name' => 'userIds', 'in' => 'query', - 'schema' => [ - 'title' => '空间类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'Project', - ], + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The comma-separated list of Alibaba Cloud account IDs of users.', 'type' => 'string', 'required' => false, 'example' => '1,2,3', 'title' => ''], ], [ - 'name' => 'category', + 'name' => 'page', 'in' => 'query', - 'schema' => [ - 'title' => '工作项类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'Req', - ], + 'schema' => ['description' => 'The page number of the page to return. The first page is page 1. The default value is 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page. The valid values are 1 to 100. The default value is 20.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data returned.', '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' => '', + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'A35869D5-BB29-5F84-A4DD-B09985EA2AFA'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '”“', 'title' => ''], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'result' => [ + 'description' => 'The list of results.', 'type' => 'array', 'items' => [ + 'description' => 'Details for a single user resource.', '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', + 'userInfo' => [ + 'description' => 'Details about the user.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The user ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '19230', 'title' => ''], + 'name' => ['description' => 'The user\'s display name.', 'type' => 'string', 'example' => 'test-codeup', 'title' => ''], + 'username' => ['description' => 'The user\'s username.', 'type' => 'string', 'example' => 'test-codeup', 'title' => ''], + 'state' => ['description' => 'The user\'s state. Valid values:'."\n" + ."\n" + .'- `active`'."\n" + ."\n" + .'- `blocked`', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'avatarUrl' => ['description' => 'The URL of the user\'s avatar.', 'type' => 'string', 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', 'title' => ''], + 'email' => ['description' => 'The user\'s email address.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'gmtAdd' => [ - 'title' => '添加到项目中的时间', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1641870287000', + 'groupInfos' => [ + 'description' => 'A list of groups the user can access.', + 'type' => 'array', + 'items' => [ + 'description' => 'Details of a group and the user\'s role within it.', + 'type' => 'object', + 'properties' => [ + 'groupInfo' => [ + 'description' => 'Details about the group.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The group ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '35268', 'title' => ''], + 'name' => ['description' => 'The group\'s name.', 'type' => 'string', 'example' => 'test-group', 'title' => ''], + 'path' => ['description' => 'The group\'s path.', 'type' => 'string', 'example' => 'test-group', 'title' => ''], + 'nameWithNamespace' => ['description' => 'The full name of the group, including the full namespace. Note that the slash `/ `is surrounded by spaces.', 'type' => 'string', 'example' => 'test-org / test-group(斜杠两侧有空格)', 'title' => ''], + 'pathWithNamespace' => ['description' => 'The group\'s full path, including its parent namespace path.', 'type' => 'string', 'example' => 'test-org/test-group', 'title' => ''], + 'parentId' => ['description' => 'The ID of the parent namespace.', 'type' => 'integer', 'format' => 'int64', 'example' => '1183319', 'title' => ''], + 'ownerId' => ['description' => 'The ID of the user who owns the group.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'createdAt' => ['description' => 'The time the group was created.', 'type' => 'string', 'example' => '2022-01-14T21:08:26+08:00'."\n", 'title' => ''], + 'updatedAt' => ['description' => 'The time the group was last updated.', 'type' => 'string', 'example' => '2022-01-14T21:08:26+08:00'."\n", 'title' => ''], + 'visibilityLevel' => ['description' => 'The group\'s visibility level.'."\n" + ."\n" + .'- `0`: Private. The group is visible only to its members.'."\n" + ."\n" + .'- `10`: Internal. The group is visible to all members of the enterprise.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'description' => ['description' => 'The group\'s description.', 'type' => 'string', 'example' => 'test-group', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'groupRole' => [ + 'description' => 'Details about the user\'s role in the group.', + 'type' => 'object', + 'properties' => [ + 'sourceId' => ['description' => 'The ID of the associated resource, which is the group ID or repository ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '35268', 'title' => ''], + 'sourceType' => ['description' => 'The type of the associated resource. Valid values:'."\n" + ."\n" + .'- `Project`: a repository.'."\n" + ."\n" + .'- `Namespace`: a group.', 'type' => 'string', 'example' => 'Namespace', 'title' => ''], + 'accessLevel' => ['description' => 'The access level.'."\n" + ."\n" + .'- `20`: Viewer'."\n" + ."\n" + .'- `30`: Developer'."\n" + ."\n" + .'- `40`: Admin', 'type' => 'integer', 'format' => 'int32', 'example' => '40', 'title' => ''], + 'cnRoleName' => ['description' => 'The role name in Chinese.'."\n" + ."\n" + .'- Viewer'."\n" + ."\n" + .'- Developer'."\n" + ."\n" + .'- Admin', 'type' => 'string', 'example' => '管理员', 'title' => ''], + 'enRoleName' => ['description' => 'The role name in English.'."\n" + ."\n" + .'- Viewer'."\n" + ."\n" + .'- Developer'."\n" + ."\n" + .'- Admin', 'type' => 'string', 'example' => 'Admin', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'addUser' => [ - 'title' => '添加到项目中的添加人', - 'description' => '', - 'type' => 'string', - 'example' => '用户阿里云pk,例如19xxxx31947xxxx', + 'repositoryInfos' => [ + 'description' => 'A list of repositories the user can access.', + 'type' => 'array', + 'items' => [ + 'description' => 'Details of a repository and the user\'s role within it.', + 'type' => 'object', + 'properties' => [ + 'repositoryInfo' => [ + 'description' => 'Details about the repository.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The repository ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '37229', 'title' => ''], + 'name' => ['description' => 'The repository\'s name.', 'type' => 'string', 'example' => 'test-repo', 'title' => ''], + 'path' => ['description' => 'The repository\'s path.', 'type' => 'string', 'example' => 'test-repo', 'title' => ''], + 'description' => ['description' => 'The repository\'s description.', 'type' => 'string', 'example' => '具体的描述内容', 'title' => ''], + 'nameWithNamespace' => ['description' => 'The full name of the repository, including the full namespace. Note that the slash `/ `is surrounded by spaces.', 'type' => 'string', 'example' => 'test-org / test-group / test-repo(斜杠两侧有空格)', 'title' => ''], + 'pathWithNamespace' => ['description' => 'The full path of the repository, including the full namespace path.', 'type' => 'string', 'example' => 'test-org/test-group/test-repo', 'title' => ''], + 'visibilityLevel' => ['description' => 'The repository\'s visibility level.'."\n" + ."\n" + .'- `0`: Private. The repository is visible only to its members.'."\n" + ."\n" + .'- `10`: Internal. The repository is visible to all members of the enterprise.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'lastActivityAt' => ['description' => 'The time of the last activity in the repository.', 'type' => 'string', 'example' => '2022-01-14T21:08:26+08:00'."\n", 'title' => ''], + 'namespaceId' => ['description' => 'The ID of the parent namespace.', 'type' => 'integer', 'format' => 'int64', 'example' => '600002', 'title' => ''], + 'accessLevel' => ['description' => 'The user\'s access level for this repository.'."\n" + ."\n" + .'- `20`: Viewer'."\n" + ."\n" + .'- `30`: Developer'."\n" + ."\n" + .'- `40`: Admin', 'type' => 'integer', 'format' => 'int32', 'example' => '40', 'title' => ''], + 'createdAt' => ['description' => 'The time the repository was created.', 'type' => 'string', 'example' => '2022-01-14T21:08:26+08:00', 'title' => ''], + 'updatedAt' => ['description' => 'The time the repository was last updated.', 'type' => 'string', 'example' => '2022-01-14T21:08:26+08:00', 'title' => ''], + 'archived' => ['description' => 'Indicates whether the repository is archived.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'creatorId' => ['description' => 'The ID of the user who created the repository.', 'type' => 'integer', 'format' => 'int64', 'example' => '12679', 'title' => ''], + 'encrypted' => ['description' => 'Indicates whether the repository is encrypted.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'repositoryRole' => [ + 'description' => 'Details about the user\'s role in the repository.', + 'type' => 'object', + 'properties' => [ + 'sourceId' => ['description' => 'The ID of the associated resource. For a repository role, this is the repository ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '37229', 'title' => ''], + 'sourceType' => ['description' => 'The type of the associated resource. Valid values:'."\n" + ."\n" + .'- `Project`: a repository.'."\n" + ."\n" + .'- `Namespace`: a group.', 'type' => 'string', 'example' => 'Project', 'title' => ''], + 'accessLevel' => ['description' => 'The access level.'."\n" + ."\n" + .'- `20`: Viewer'."\n" + ."\n" + .'- `30`: Developer'."\n" + ."\n" + .'- `40`: Admin', 'type' => 'integer', 'format' => 'int32', 'example' => '40', 'title' => ''], + 'cnRoleName' => ['description' => 'The role name in Chinese.'."\n" + ."\n" + .'- Viewer'."\n" + ."\n" + .'- Developer'."\n" + ."\n" + .'- Admin', 'type' => 'string', 'example' => '管理员', 'title' => ''], + 'enRoleName' => ['description' => 'The role name in English.'."\n" + ."\n" + .'- Viewer'."\n" + ."\n" + .'- Developer'."\n" + ."\n" + .'- Admin', 'type' => 'string', 'example' => 'Admin', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Openapi.RequestError', - 'errorMessage' => 'request error', - ], - ], - 403 => [ - [ - 'errorCode' => 'Operate.NoPermission', - 'errorMessage' => 'NoPermission', - ], + '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\\": \\"username@example.com\\"\\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"}]', + 'title' => 'Obtain resources to which the user has permission ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUserResources'], ], ], - '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":""}]', + 'ramActions' => [], ], - 'ListWorkItemAllFields' => [ - 'summary' => '获取项目下工作项的所有字段', - 'path' => '/organization/{organizationId}/workitems/fields/listAll', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListVariableGroups' => [ + 'summary' => 'You can obtain a list of variable groups.', + 'path' => '/organization/{organizationId}/variableGroups', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -38390,45 +21649,27 @@ [ 'name' => 'organizationId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['title' => '', 'description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access Link, such as https://devops.aliyun.com/organization/【OrganizationId】', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ - 'name' => 'spaceType', + 'name' => 'pageSort', 'in' => 'query', - 'schema' => [ - 'title' => '资源类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'Project', - ], + 'schema' => ['title' => '', 'description' => 'Sorting condition; default is id', 'type' => 'string', 'required' => false, 'example' => 'ID'], ], [ - 'name' => 'spaceIdentifier', + 'name' => 'pageOrder', 'in' => 'query', - 'schema' => [ - 'title' => '项目id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'e8bxxxxxxxxxxxxxxxx23', - ], + 'schema' => ['title' => '', 'description' => 'Sorting order: DESC for descending, ASC for ascending', 'type' => 'string', 'required' => false, 'example' => 'DESC'], ], [ - 'name' => 'workitemTypeIdentifier', + 'name' => 'nextToken', 'in' => 'query', - 'schema' => [ - 'title' => '工作项类型id,工作项类型的列表和id可以从ListProjectWorkitemType中获取', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'dfexxxxxf4fee18xxxxx36', - ], + 'schema' => ['title' => '', 'description' => 'Paging token; the response parameter nextToken from the previous Request', 'type' => 'string', 'required' => false, 'example' => 'aaaaaa'], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Maximum number of returned results', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], ], 'responses' => [ @@ -38436,284 +21677,132 @@ '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' => '', + 'requestId' => ['title' => '', 'description' => 'The request ID. Each request has a unique value, which facilitates troubleshooting later.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => '""'], + 'errorCode' => ['title' => '', 'description' => 'Error code', 'type' => 'string', 'example' => '""'], + 'success' => ['title' => '', 'description' => 'true if the API call succeeded, false if the API call failed.', 'type' => 'boolean', 'example' => 'true'], + 'variableGroups' => [ + 'title' => '', + 'description' => 'Variable groups', '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', + 'creatorAccountId' => ['title' => '', 'description' => 'Alibaba Cloud account ID of the creator', 'type' => 'string', 'example' => '13232343434343'], + 'updateTime' => ['title' => '', 'description' => 'Update Time', 'type' => 'integer', 'format' => 'int64', 'example' => '1586863220000'], + 'modifierAccountId' => ['title' => '', 'description' => 'Alibaba Cloud account ID of the updater', 'type' => 'string', 'example' => '13232343434343'], + 'description' => ['title' => '', 'description' => 'Variable group Description', 'type' => 'string', 'example' => '变量组'], + 'name' => ['title' => '', 'description' => 'Variable group Name', 'type' => 'string', 'example' => '变量组'], + 'id' => ['title' => '', 'description' => 'Variable group ID', 'type' => 'integer', 'format' => 'int64', 'example' => '12234'], + 'relatedPipelines' => [ + 'title' => '', + 'description' => 'Associated pipelines', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'id' => ['title' => '', 'description' => 'ID of the associated pipeline', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'], + 'name' => ['title' => '', 'description' => 'Name of the associated pipeline', 'type' => 'string', 'example' => '流水线'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', ], - 'options' => [ - 'title' => '待选值', - 'description' => '', + 'variables' => [ + 'title' => '', + 'description' => 'Variables', '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', - ], + 'value' => ['title' => '', 'description' => 'Variable value', 'type' => 'string', 'example' => 'value1'], + 'name' => ['title' => '', 'description' => 'Variable name', 'type' => 'string', 'example' => 'name1'], + 'isEncrypted' => ['title' => '', 'description' => 'Indicates whether the variable is encrypted.', 'type' => 'boolean', 'example' => 'true'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], + 'createTime' => ['title' => '', 'description' => 'Creation Time', 'type' => 'integer', 'format' => 'int64', 'example' => '1586863220000'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], + 'totalCount' => ['title' => '', 'description' => 'Total number of variable groups', 'type' => 'integer', 'format' => 'int64', 'example' => '30'], + 'nextToken' => ['title' => '', 'description' => 'Token for the next query; empty indicates the last page', 'type' => 'string', 'example' => 'assassa'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Openapi.RequestError', - 'errorMessage' => 'request error', - ], + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => 'The user that is invoking the API service is not a registered user.'], ], 403 => [ - [ - 'errorCode' => 'Operate.NoPermission', - 'errorMessage' => 'NoPermission', - ], + ['errorCode' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], ], ], - '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', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Retrieve the variable group list', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListVariableGroups'], + ], ], + 'ramActions' => [], + ], + 'ListWorkItemAllFields' => [ + 'summary' => 'Retrieve the list of work item fields.', + 'path' => '/organization/{organizationId}/workitems/fields/listAll', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURErdc3GIDZJ'], + ], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'path', - 'schema' => [ - 'title' => '企业标识,也称企业id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['description' => 'Organization identifier, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, for example: https://devops.aliyun.com/organization/【OrganizationId】'."\n", 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx', 'title' => ''], ], [ 'name' => 'spaceType', 'in' => 'query', - 'schema' => [ - 'title' => '空间类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'Project', - ], + 'schema' => ['title' => '', 'description' => 'resource type', 'type' => 'string', 'required' => true, 'example' => 'Project'], ], [ - 'name' => 'workitemCategoryIdentifier', + 'name' => 'spaceIdentifier', 'in' => 'query', - 'schema' => [ - 'title' => '工作项大类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'Req', - ], + 'schema' => ['title' => '', 'description' => 'UUID of the project, equivalent to projectId', 'type' => 'string', 'required' => true, 'example' => 'e8bxxxxxxxxxxxxxxxx23'], ], [ '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', - ], + 'schema' => ['title' => '', 'description' => 'Work item type ID. The list of work item types and their IDs can be retrieved from ListProjectWorkitemTypes.', 'type' => 'string', 'required' => true, 'example' => 'dfexxxxxf4fee18xxxxx36'], ], ], 'responses' => [ @@ -38721,266 +21810,129 @@ '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' => '', + 'requestId' => ['title' => '', 'description' => 'Request ID. Each request has a unique value, which facilitates troubleshooting later.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMsg' => ['title' => '', 'description' => 'error message', 'type' => 'string', 'example' => 'error'], + 'errorCode' => ['title' => '', 'description' => 'error code', 'type' => 'string', 'example' => 'Openapi.RequestError'], + 'success' => ['title' => '', 'description' => 'true or false', 'type' => 'boolean', 'example' => 'true'], + 'fields' => [ + 'title' => '', + 'description' => 'Field information', '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', + 'creator' => ['title' => '', 'description' => 'Alibaba Cloud account ID of the Creator', 'type' => 'string', 'example' => '19xx7043xxxxxxx914'], + 'description' => ['title' => '', 'description' => 'Description ', 'type' => 'string', 'example' => '字段的具体信息'], + 'gmtCreate' => ['title' => '', 'description' => 'UNIX timestamp of the creation time, in milliseconds ', 'type' => 'integer', 'format' => 'int64', 'example' => '1623916393000'], + 'gmtModified' => ['title' => '', 'description' => 'UNIX timestamp of the Updated At time, in milliseconds', 'type' => 'integer', 'format' => 'int64', 'example' => '1623916393000'], + 'type' => ['title' => '', 'description' => 'Distinguishes between different types, such as system fields (NativeField) and custom fields (CustomField). ', 'type' => 'string', 'example' => 'NativeField'], + 'identifier' => ['title' => '', 'description' => 'Unique Identifier of the field', 'type' => 'string', 'example' => 'e8bxxxxxxxxxxxxxxxx23'], + 'modifier' => ['title' => '', 'description' => 'Alibaba Cloud account ID of the user who updated the field ', 'type' => 'string', 'example' => '19xx7043xxxxxxx914'], + 'name' => ['title' => '', 'description' => 'Column Name', 'type' => 'string', 'example' => '负责人'], + 'format' => ['title' => '', 'description' => 'Field format ', 'type' => 'string', 'example' => 'list'], + 'className' => ['title' => '', 'description' => 'Field Type ', 'type' => 'string', 'example' => '例:date'], + 'resourceType' => ['title' => '', 'description' => 'Distinguishes different applicable objects', 'type' => 'string', 'example' => '例:Workitem'], + 'defaultValue' => ['title' => '', 'description' => 'Default Value', 'type' => 'string', 'example' => '123'], + 'isRequired' => ['title' => '', 'description' => 'Indicates whether the field is Required', 'type' => 'boolean', 'example' => 'false'], + 'isSystemRequired' => ['title' => '', 'description' => 'Indicates whether the field is a system-required field, such as owner or status. ', 'type' => 'boolean', 'example' => 'false'], + 'linkWithService' => ['title' => '', 'description' => 'The linked service, such as iteration. When the iteration service is enabled or disabled, this field is added to or removed from the corresponding template. In field templates, fields of this type cannot be manually added or deleted.', 'type' => 'string', 'example' => 'null'], + 'isShowWhenCreate' => ['title' => '', 'description' => 'Whether to display during creation', 'type' => 'boolean', 'example' => 'false'], + 'options' => [ + 'title' => '', + 'description' => 'Available values', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'identifier' => ['title' => '', 'description' => 'UUID of the available value', 'type' => 'string', 'example' => '重复的缺陷'], + 'fieldIdentifier' => ['title' => '', 'description' => 'UUID of the field', 'type' => 'string', 'example' => 'e8bxxxxxxxxxxxxxxxx23'], + 'value' => ['title' => '', 'description' => 'Display Name in Chinese of the option', 'type' => 'string', 'example' => '重复的缺陷'], + 'valueEn' => ['title' => '', 'description' => 'Display Name in English of the option', 'type' => 'string', 'example' => 'null'], + 'displayValue' => ['title' => '', 'description' => 'The value displayed based on the current language environment', 'type' => 'string', 'example' => '重复的缺陷'], + 'position' => ['title' => '', 'description' => 'Option order', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'level' => ['title' => '', 'description' => 'Display level, ranging from 1 to 9. A higher number indicates a lighter color.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Openapi.RequestError', - 'errorMessage' => 'request error', - ], + ['errorCode' => 'Openapi.RequestError', 'errorMessage' => 'request error', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'Operate.NoPermission', - 'errorMessage' => 'NoPermission', - ], + ['errorCode' => 'Operate.NoPermission', 'errorMessage' => 'NoPermission', 'description' => 'You are not authorized to perform this operation.'], ], ], - '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', + '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\\": 1,\\n \\"level\\": 1\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Obtain the List of Work Item Fields', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWorkItemAllFields'], + ], ], + 'ramActions' => [], + 'operationType' => 'read', + ], + 'ListWorkItemWorkFlowStatus' => [ + 'summary' => 'Obtain the List of pipeline statuses for work items.', + 'path' => '/organization/{organizationId}/workitems/workflow/listWorkflowStatus', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURErdc3GIDZJ'], + ], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'path', - 'schema' => [ - 'title' => '企业id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['title' => '', 'description' => 'The enterprise identifier, also known as the enterprise ID, is a string that can be obtained from the Alibaba Cloud DevOps access link, such as https://devops.aliyun.com/organization/【OrganizationId】.', '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' => '""', - ], + 'schema' => ['title' => '', 'description' => 'Space Type', 'type' => 'string', 'required' => true, 'example' => 'Project'], ], [ - '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', + 'name' => 'workitemCategoryIdentifier', 'in' => 'query', - 'schema' => [ - 'title' => '额外条件', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{"conditionGroups":[]}', - ], + 'schema' => ['title' => '', 'description' => 'Work item category. Use "Req" for requirements, "Bug" for bugs, "Task" for jobs, and "Risk" for threats.', 'type' => 'string', 'required' => true, 'example' => 'Req'], ], [ - 'name' => 'groupCondition', - 'in' => 'query', - 'schema' => [ - 'title' => '分组条件', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{"fieldIdentifier":"tag","className":"tag","format":"multiList","value":["c76e0e4bf64801cfad73......"],"operator":"EQUALS"}', - ], - ], - [ - 'name' => 'orderBy', + 'name' => 'workitemTypeIdentifier', 'in' => 'query', - 'schema' => [ - 'title' => '排序顺序', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{"fieldIdentifier":"status","format":"list","order":"desc","className":"status"}', - ], + 'schema' => ['title' => '', 'description' => 'Work item sub-type ID, which can be retrieved from ListProjectWorkitemTypes (corresponding field: identifier). If not specified, the default pipeline is used.', 'type' => 'string', 'required' => false, 'example' => '例:5e7xxxxb3cd3711dd6xxx2c'], ], [ - 'name' => 'searchType', + 'name' => 'spaceIdentifier', 'in' => 'query', - 'schema' => [ - 'title' => '查询类型', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'LIST', - ], + 'schema' => ['title' => '', 'description' => 'Project ID, equivalent to the projectId field, which is the UUID of the project.', 'type' => 'string', 'required' => true, 'example' => '例:5e70xxxxxxcd000xxxxe96'], ], ], 'responses' => [ @@ -38988,424 +21940,178 @@ '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' => '', + 'requestId' => ['title' => '', 'description' => 'Request ID. Each request has a Unique value.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorCode' => ['title' => '', 'description' => 'Fault return code', 'type' => 'string', 'example' => '例:Openapi.RequestError'], + 'errorMessage' => ['title' => '', 'description' => 'Fault return message', 'type' => 'string', 'example' => 'errormessage'], + 'success' => ['title' => '', 'description' => 'Indicates whether the API returned Normally.', 'type' => 'boolean', 'example' => 'true或者false'], + 'statuses' => [ + 'title' => '', + 'description' => 'pipeline statuses', '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', - ], + 'identifier' => ['title' => '', 'description' => 'pipeline status ID', 'type' => 'string', 'example' => 'dfexxxxxf4fee18xxxxx36'], + 'name' => ['title' => '', 'description' => 'Workflow status name', 'type' => 'string', 'example' => '例:待处理'], + 'workflowStageName' => ['title' => '', 'description' => 'segment information - Name', 'type' => 'string', 'example' => '例:确认阶段'], + 'workflowStageIdentifier' => ['title' => '', 'description' => 'Stage information – UUID of the stage', 'type' => 'string', 'example' => '例如:1'], + 'source' => ['title' => '', 'description' => 'Status source. System: system default. Custom: created by an enterprise, project, or team.', 'type' => 'string', 'example' => 'system'], + 'gmtCreate' => ['title' => '', 'description' => 'Creation Time', 'type' => 'integer', 'format' => 'int64', 'example' => '1620455467000'], + 'creator' => ['title' => '', 'description' => 'Creator of the status', 'type' => 'string', 'example' => '用户阿里云pk,例如19xxxx31947xxxx'], + 'description' => ['title' => '', 'description' => 'Description', 'type' => 'string', 'example' => '该状态的具体信息'], + 'modifier' => ['title' => '', 'description' => 'Updated By', 'type' => 'string', 'example' => '用户阿里云pk,例如19xxxx31947xxxx'], + 'gmtModified' => ['title' => '', 'description' => 'Update Time', 'type' => 'integer', 'format' => 'int64', 'example' => '1641870287000'], + 'resourceType' => ['title' => '', 'description' => 'Resource type to which the status applies: Project or Workitem', 'type' => 'string', 'example' => 'Workitem'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Openapi.RequestError', - 'errorMessage' => 'request error', - ], + ['errorCode' => 'Openapi.RequestError', 'errorMessage' => 'request error', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'Operate.NoPermission', - 'errorMessage' => 'NoPermission', - ], + ['errorCode' => 'Operate.NoPermission', 'errorMessage' => 'NoPermission', 'description' => 'You are not authorized to perform this operation.'], ], ], - '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', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Retrieve the list of workflow statuses for work items', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWorkItemWorkFlowStatus'], + ], ], + 'ramActions' => [], + 'operationType' => 'read', + ], + 'ListWorkitemAttachments' => [ + 'path' => '/organization/{organizationId}/workitem/{workitemIdentifier}/attachments', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURErdc3GIDZJ'], + ], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'path', - 'schema' => [ - 'title' => '企业id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['description' => 'The ID of the enterprise. You can view the ID of an enterprise in the URL of the enterprise homepage in CloudFlow. The URL is in the format of https\\://devops.aliyun.com/organization/{organizationId}.', 'type' => 'string', 'required' => false, 'example' => '60de7a6852743a5162b5f957', 'title' => ''], ], [ - 'name' => 'workitemId', + 'name' => 'workitemIdentifier', 'in' => 'path', - 'schema' => [ - 'title' => '工作项唯一标识', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5daa9a15c7fd55523996......', - ], + 'schema' => ['description' => 'The unique identifier of the work item.', 'type' => 'string', 'required' => false, 'example' => '11234455454355', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The schema of the response.', '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' => '', + 'requestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9'], + 'errorMsg' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'error', 'title' => ''], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'- true: The request was successful.'."\n" + ."\n" + .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'attachments' => [ + 'description' => 'The list of attachments.', 'type' => 'array', 'items' => [ + 'description' => 'The attachment.', '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', - ], - ], + 'fileIdentifier' => ['description' => 'The unique identifier of the file.', 'type' => 'string', 'example' => 'dflkjlsdddsdl234lkjfg', 'title' => ''], + 'fileName' => ['description' => 'The name of the file.', 'type' => 'string', 'example' => 'Artifacts_1565193_1.tgz', 'title' => ''], + 'fileSuffix' => ['description' => 'The file name extension.', 'type' => 'string', 'example' => 'tgz', 'title' => ''], + 'size' => ['description' => 'The file size. Unit: bytes.', 'type' => 'string', 'example' => '50', 'title' => ''], + 'url' => ['description' => 'The download URL.', 'type' => 'string', 'example' => 'http://grace-share.oss-cn-hangzhou.aliyuncs.com/qf%2Fheap.bin?Expires=1675750082&OSSAccessKeyId=xxxxxxxx&Signature=xxxxx%3D', 'title' => ''], + 'gmtCreate' => ['description' => 'The time when the attachment was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1545726028000', 'title' => ''], + 'creator' => ['description' => 'The Alibaba Cloud account ID of the user who created the attachment.', 'type' => 'string', 'example' => '237109', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - ], - 'code' => [ - 'title' => '接口返回code', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Openapi.RequestError', - 'errorMessage' => 'request error', - ], + ['errorCode' => 'Openapi.RequestError', 'errorMessage' => 'request error', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'Operate.NoPermission', - 'errorMessage' => 'NoPermission', - ], + ['errorCode' => 'Operate.NoPermission', 'errorMessage' => 'NoPermission', 'description' => 'You are not authorized to perform this operation.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Obtain the attachment list of a work item', + 'summary' => 'Retrieves a list of attachments for a workitem.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWorkitemAttachments'], ], ], - '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":""}]', + 'ramActions' => [], + '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"}]', ], 'ListWorkitemEstimate' => [ - 'summary' => '获取工作项预计工时明细列表', 'path' => '/organization/{organizationId}/workitems/{workitemId}/estimate/list', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURErdc3GIDZJ'], ], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'path', - 'schema' => [ - 'title' => '企业id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['description' => 'The organization ID.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx', 'title' => ''], ], [ 'name' => 'workitemId', 'in' => 'path', - 'schema' => [ - 'title' => '工作项唯一标识', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5daa9a15c7fd55523996......', - ], + 'schema' => ['description' => 'The ID of the work item.', 'type' => 'string', 'required' => true, 'example' => '5daa9a15c7fd55523996......', 'title' => ''], ], ], 'responses' => [ @@ -39413,219 +22119,99 @@ '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', - ], + 'requestId' => ['description' => 'The request ID. A unique value is generated for each request. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', 'title' => ''], + 'errorMsg' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'error', 'title' => ''], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Openapi.RequestError', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful. Valid values: `true` and `false`.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'workitemTimeEstimate' => [ - 'title' => '工时信息', - 'description' => '', + 'title' => '', + 'description' => 'A list of time estimate entries.', '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' => '开发代码等', - ], + 'workitemIdentifier' => ['description' => 'The ID of the work item.', 'type' => 'string', 'example' => '5daa9a15c7fd55523996......', 'title' => ''], + 'identifier' => ['description' => 'The time entry ID.', 'type' => 'string', 'example' => 'a4ac3a81e90217db32b7......', 'title' => ''], + 'gmtStart' => ['description' => 'The start time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1653235200000', 'title' => ''], + 'gmtEnd' => ['description' => 'The end time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1653235200000', 'title' => ''], + 'spentTime' => ['description' => 'The time estimate, in hours.', 'type' => 'number', 'format' => 'float', 'example' => '8', 'title' => ''], + 'type' => ['description' => 'The work type.', 'type' => 'string', 'example' => '研发', 'title' => ''], + 'description' => ['description' => 'The description of the time entry.', 'type' => 'string', 'example' => '开发代码等', 'title' => ''], 'recordUser' => [ - 'description' => '', + 'description' => 'The user who recorded the entry.', 'type' => 'object', 'properties' => [ - 'identifier' => [ - 'description' => '', - 'type' => 'string', - 'example' => '132xxxx123', - ], - 'name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], + 'identifier' => ['description' => 'The user\'s ID (also known as AliyunPK).', 'type' => 'string', 'example' => '132xxxx123', 'title' => ''], + 'name' => ['description' => 'The user\'s name.', 'type' => 'string', 'example' => '张三', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'gmtCreate' => [ - 'title' => '工时记录的创建时间', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1653235200000', - ], - 'gmtModified' => [ - 'title' => '工时记录的修改时间', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1653235200000', - ], + 'gmtCreate' => ['description' => 'The time when the time entry was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1653235200000', 'title' => ''], + 'gmtModified' => ['description' => 'The time when the time entry was last modified.', 'type' => 'integer', 'format' => 'int64', 'example' => '1653235200000', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], - 'code' => [ - 'title' => '接口返回code', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], + 'code' => ['description' => 'The API response code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], ], + 'description' => 'The response object.', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Openapi.RequestError', - 'errorMessage' => 'request error', - ], + ['errorCode' => 'Openapi.RequestError', 'errorMessage' => 'request error', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'Operate.NoPermission', - 'errorMessage' => 'NoPermission', - ], + ['errorCode' => 'Operate.NoPermission', 'errorMessage' => 'NoPermission', 'description' => 'You are not authorized to perform this operation.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve the list of estimated work hours for a work item', + 'summary' => 'Retrieves a list of time estimate entries for a work item.', + 'description' => 'Retrieves a list of time estimate entries for a work item.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWorkitemEstimate'], + ], ], + 'ramActions' => [], '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', - ], + 'ListWorkitemTime' => [ + 'summary' => 'Retrieve the list of work item time details.', + 'path' => '/organization/{organizationId}/workitems/{workitemId}/time/list', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURErdc3GIDZJ'], + ], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'path', - 'schema' => [ - 'title' => '企业id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '60ee8a814690c27532d412f8', - ], + 'schema' => ['title' => '', 'description' => 'Organization identity, also known as organization ID, in string format. You can obtain it from the Alibaba Cloud DevOps access link, for example: https://devops.aliyun.com/organization/【OrganizationId】', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ - '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, - ], + 'name' => 'workitemId', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'The work item ID, which is the same as the workitemIdentifier field and serves as the UUID of the work item.', 'type' => 'string', 'required' => true, 'example' => '5daa9a15c7fd55523996......'], ], ], 'responses' => [ @@ -39633,2444 +22219,1117 @@ '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......', + 'requestId' => ['title' => '', 'description' => 'Request ID. Each request has a unique value to facilitate troubleshooting.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMsg' => ['title' => '', 'description' => 'error message', 'type' => 'string', 'example' => 'error'], + 'errorCode' => ['title' => '', 'description' => 'error code', 'type' => 'string', 'example' => 'Openapi.RequestError'], + 'success' => ['title' => '', 'description' => 'true or false', 'type' => 'boolean', 'example' => 'true'], + 'workitemTime' => [ + 'title' => '', + 'description' => 'Time tracking information', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'workitemIdentifier' => ['title' => '', 'description' => 'Work item ID, UUID', 'type' => 'string', 'example' => '5daa9a15c7fd55523996......'], + 'identifier' => ['title' => '', 'description' => 'UUID of the time record', 'type' => 'string', 'example' => 'a4ac3a81e90217db32b7......'], + 'gmtStart' => ['title' => '', 'description' => 'Start Time', 'type' => 'integer', 'format' => 'int64', 'example' => '1653235200000'], + 'gmtEnd' => ['title' => '', 'description' => 'End Time', 'type' => 'integer', 'format' => 'int64', 'example' => '1653235200000'], + 'actualTime' => ['description' => 'Actual hours, accurate to one decimal place', 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''], + 'type' => ['title' => '', 'description' => 'Time entry type, such as design, development, Testing, document, or other', 'type' => 'string', 'example' => '研发'], + 'description' => ['title' => '', 'description' => 'Time entry description', 'type' => 'string', 'example' => '开发代码等'], + 'recordUser' => ['title' => '', 'description' => 'Account ID of the person who logged the time', 'type' => 'string', 'example' => '1967043931......'], + 'gmtCreate' => ['title' => '', 'description' => 'Creation Time of the time entry record', 'type' => 'integer', 'format' => 'int64', 'example' => '1653235200000'], + 'gmtModified' => ['title' => '', 'description' => 'Updated At of the time record', 'type' => 'integer', 'format' => 'int64', 'example' => '1653235200000'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], + 'code' => ['title' => '', 'description' => 'The code returned by the API', 'type' => 'integer', 'format' => 'int64', 'example' => '200'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Openapi.RequestError', - 'errorMessage' => 'request error', - ], + ['errorCode' => 'Openapi.RequestError', 'errorMessage' => 'request error', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'Operate.NoPermission', - 'errorMessage' => 'NoPermission', - ], + ['errorCode' => 'Operate.NoPermission', 'errorMessage' => 'NoPermission', 'description' => 'You are not authorized to perform this operation.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Obtain the List of Work Item Time Entry Details', + 'changeSet' => [ + ['createdAt' => '2022-12-05T14:50:20.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-05-26T11:26:38.000Z', 'description' => 'OpenAPI offline'], ], - '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', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWorkitemTime'], + ], ], + 'ramActions' => [], + 'operationType' => 'read', + ], + 'ListWorkitems' => [ + 'summary' => 'Retrieve the work item list.', + 'path' => '/organization/{organizationId}/listWorkitems', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURErdc3GIDZJ'], + ], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'path', - 'schema' => [ - 'title' => '企业id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['title' => '', 'description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, such as https://devops.aliyun.com/organization/【OrganizationId】 '."\n", 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ - 'name' => 'identifier', + 'name' => 'spaceType', 'in' => 'query', - 'schema' => [ - 'title' => '工作项id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3ef2ef6018d254d660e65f87a6', - ], + 'schema' => ['title' => '', 'description' => 'Resource type ', 'type' => 'string', 'required' => true, 'example' => 'Project'], + ], + [ + 'name' => 'spaceIdentifier', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Project ID, equivalent to projectId. This is the unique identifier of the project. ', 'type' => 'string', 'required' => true, 'example' => '8fb83debd69a6c7c6626......'], + ], + [ + 'name' => 'category', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The main category of work items: Req for requirements, Bug for defects, Task for tasks, Risk for threats, Request for original requests, and Topic for subjects. ', 'type' => 'string', 'required' => true, 'example' => 'Req'], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'This field does not need to be specified for the first page. For subsequent pages, obtain this field from the result of the previous invocation to retrieve the next set of paginated data. ', 'type' => 'string', 'required' => false, 'example' => '""'], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The maximum number of results returned per page, ranging from 0 to 200. Default value: 20. ', 'type' => 'string', 'required' => false, 'example' => '20'], + ], + [ + 'name' => 'conditions', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Filter conditions. You can refer to the search parameters of the workitem/list request in the work item list on the page. '."\n" + .'Note: The user IDs included must be Alibaba Cloud Account IDs. ', 'type' => 'string', 'required' => false, 'example' => '{"conditionGroups":[]}'], + ], + [ + 'name' => 'extraConditions', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Extra conditions. When this field is not empty, the conditions field cannot be empty. ', 'type' => 'string', 'required' => false, 'example' => '{"conditionGroups":[]}'], + ], + [ + 'name' => 'groupCondition', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => "\n" + .'Grouping condition. You can refer to the search parameters of the workitem/list request in the work item list on the page. '."\n" + .'Note: The user ID specified must be an Alibaba Cloud Account ID. ', 'type' => 'string', 'required' => false, 'example' => '{"fieldIdentifier":"tag","className":"tag","format":"multiList","value":["c76e0e4bf64801cfad73......"],"operator":"EQUALS"}'], + ], + [ + 'name' => 'orderBy', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Sorting order. You can refer to the search parameters of the workitem/list request in the work item list on the page. '."\n" + .'Note: The user IDs included must be Alibaba Cloud Account IDs. ', 'type' => 'string', 'required' => false, 'example' => '{"fieldIdentifier":"status","format":"list","order":"desc","className":"status"}'], + ], + [ + 'name' => 'searchType', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The search type. The default value is LIST. It also supports other types such as TREE. For more details, refer to the parameters in the page request. ', 'type' => 'string', 'required' => false, 'example' => 'LIST'], ], ], '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', + 'totalCount' => ['title' => '', 'description' => 'Total count ', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'nextToken' => ['title' => '', 'description' => 'Paging token; empty if there is no next page ', 'type' => 'string', 'example' => '""'], + 'maxResults' => ['title' => '', 'description' => 'Quantity per page ', 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'requestId' => ['title' => '', 'description' => 'Request ID; each request has a unique value to facilitate troubleshooting ', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMsg' => ['title' => '', 'description' => 'Error message ', 'type' => 'string', 'example' => 'error'], + 'errorCode' => ['title' => '', 'description' => 'Error code ', 'type' => 'string', 'example' => 'Openapi.RequestError'], + 'success' => ['title' => '', 'description' => 'true or false ', 'type' => 'boolean', 'example' => 'true'], + 'workitems' => [ + 'title' => '', + 'description' => 'Work item information', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'identifier' => ['title' => '', 'description' => 'UUID of the work item', 'type' => 'string', 'example' => 'e8bxxxxxxxxxxxxxxxx23'], + 'subject' => ['title' => '', 'description' => 'Work item title ', 'type' => 'string', 'example' => '测试工作项'], + 'document' => ['title' => '', 'description' => 'Work item content. This field is deprecated. Please invoke the get details API to retrieve it. ', 'type' => 'string', 'example' => 'xxx'], + 'assignedTo' => ['title' => '', 'description' => 'Alibaba Cloud account ID of the owner', 'type' => 'string', 'example' => '19xx7043xxxxxxx914'], + 'status' => ['title' => '', 'description' => 'Status name', 'type' => 'string', 'example' => '待处理'], + 'statusStageIdentifier' => ['title' => '', 'description' => 'Status stage ID', 'type' => 'string', 'example' => '1'], + 'spaceIdentifier' => ['title' => '', 'description' => 'Project ID to which the work item belongs ', 'type' => 'string', 'example' => 'e8b26xxxxx6e76aa20xxxxx23'], + 'spaceName' => ['title' => '', 'description' => 'Name of the project to which the work item belongs', 'type' => 'string', 'example' => '需求项目'], + 'spaceType' => ['title' => '', 'description' => 'Project Mode', 'type' => 'string', 'example' => 'Project'], + 'logicalStatus' => ['title' => '', 'description' => 'Logical status', 'type' => 'string', 'example' => 'NORMAL'], + 'categoryIdentifier' => ['title' => '', 'description' => 'Category ID of the work item ', 'type' => 'string', 'example' => 'Req'], + 'parentIdentifier' => ['title' => '', 'description' => 'Parent work item ID ', 'type' => 'string', 'example' => 'e8bxxxxxxxxxxxxxxxx24'], + 'workitemTypeIdentifier' => ['title' => '', 'description' => 'Work item type ID ', 'type' => 'string', 'example' => '9uxxxxxxre573f5xxxxxx0'], + 'updateStatusAt' => ['title' => '', 'description' => 'Time when the status was updated', 'type' => 'integer', 'format' => 'int64', 'example' => '1640850328000'], + 'serialNumber' => ['title' => '', 'description' => 'Serial number', 'type' => 'string', 'example' => 'ABCD-1'], + 'gmtCreate' => ['title' => '', 'description' => 'UNIX timestamp of the Creation Time, in milliseconds', 'type' => 'integer', 'format' => 'int64', 'example' => '1640850318000'], + 'gmtModified' => ['title' => '', 'description' => 'UNIX timestamp of the modification time, in milliseconds', 'type' => 'integer', 'format' => 'int64', 'example' => '1640850318000'], + 'creator' => ['title' => '', 'description' => 'Alibaba Cloud account ID of the creator', 'type' => 'string', 'example' => '19xx7043xxxxxxx914'], + 'modifier' => ['title' => '', 'description' => 'Alibaba Cloud account ID of the Updated By user ', 'type' => 'string', 'example' => '19xx7043xxxxxxx914'], + 'statusIdentifier' => ['title' => '', 'description' => 'UUID of the status', 'type' => 'string', 'example' => '100005'], + 'sprintIdentifier' => ['title' => '', 'description' => 'Iteration ID', 'type' => 'string', 'example' => '75528f17703e92e5a568......'], + 'finishTime' => ['description' => 'Completion time', 'type' => 'integer', 'format' => 'int64', 'example' => '1699366778000', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Openapi.RequestError', - 'errorMessage' => 'request error', - ], + ['errorCode' => 'Openapi.RequestError', 'errorMessage' => 'request error', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'Operate.NoPermission', - 'errorMessage' => 'NoPermission', - ], + ['errorCode' => 'Operate.NoPermission', 'errorMessage' => 'NoPermission', 'description' => 'You are not authorized to perform this operation.'], ], ], - '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', + '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 \\"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}","type":"json"}]', + 'title' => 'Retrieve work item list ', + 'changeSet' => [ + ['createdAt' => '2023-11-07T14:17:19.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-02-24T08:23:16.000Z', 'description' => 'OpenAPI offline'], + ['createdAt' => '2022-02-24T08:23:16.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-02-24T08:23:16.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-02-24T08:23:16.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWorkitems'], + ], ], + 'ramActions' => [], + 'operationType' => 'read', + ], + 'LogPipelineJobRun' => [ + 'summary' => 'You can query job runtime logs. ', + 'path' => '/organization/{organizationId}/pipeline/{pipelineId}/pipelineRun/{pipelineRunId}/job/{jobId}/logs', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '60811b5eed6e867404f6xxxx', - ], + 'schema' => ['title' => '', 'description' => 'Organization identity, also known as organization ID, in string format. You can obtain it from the Alibaba Cloud DevOps access link, such as https://devops.aliyun.com/organization/【OrganizationId】 ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ - 'name' => 'workitemIdentifier', + 'name' => 'pipelineId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '11234455454355', - ], + 'schema' => ['title' => '', 'description' => 'Pipeline ID. You can obtain it from the pipeline link, such as https://flow.aliyun.com/pipelines/【PipelineId】/current ', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '12222'], ], [ - 'name' => 'fileIdentifier', + 'name' => 'jobId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'dfsdfdsgdsfdsfff', - ], + 'schema' => ['description' => 'Job ID. You can obtain the job ID through the API at https://help.aliyun.com/document_detail/460565.html ', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12', 'title' => ''], + ], + [ + 'name' => 'pipelineRunId', + 'in' => 'path', + 'schema' => ['description' => 'Pipeline run instance ID ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12', 'title' => ''], ], ], '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' => '', + 'requestId' => ['description' => 'Request ID. Each request has a unique value, which facilitates troubleshooting. ', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', 'title' => ''], + 'errorMessage' => ['description' => 'Error message ', 'type' => 'string', 'example' => '""', 'title' => ''], + 'log' => [ + 'description' => 'Log ', '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', - ], + 'more' => ['description' => 'Indicates whether more recent logs are available. ', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'content' => ['description' => 'Log content ', 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'success' => ['description' => 'true if the API call succeeded; false if the API call failed. ', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'errorCode' => ['description' => 'Error code ', 'type' => 'string', 'example' => '""', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParam.ParamNotPresent', - 'errorMessage' => 'The parameter is invalid.', - ], + ['errorCode' => 'InvalidCluster.NotFound', 'errorMessage' => 'No cluster is available to generate the workspace.', 'description' => 'No cluster is available to generate the workspace.'], + ['errorCode' => 'InvalidCodeUrl.NotSupportSVN', 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', 'description' => 'The parameter codeUrl is invalid. SVN is not supported.'], + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidResource.NotFound', 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', 'description' => 'No resource is found. You cannot create the workspace. Please try again later.'], + ['errorCode' => 'InvalidResourceRole.NotFoun', 'errorMessage' => 'The member role is invalid.', 'description' => 'The member role is invalid.'], + ['errorCode' => 'InvalidResourceRole.NotFound', 'errorMessage' => 'The member role is invalid.', 'description' => ''], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => 'The user that is invoking the API service is not a registered user.'], + ['errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', 'errorMessage' => 'Resource owner cannot be deleted.', 'description' => 'The resource owner cannot be deleted.'], + ['errorCode' => 'InvalidUser.ResourceMemberNotExists', 'errorMessage' => 'The resource member does not exist.', 'description' => 'The resource member does not exist.'], + ['errorCode' => 'InvalidUser.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization.', 'description' => '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.', 'description' => 'The workspace status is invalid. You can only operate workspaces with the SUCCESS status.'], + ['errorCode' => 'InvalidWorkspaceTemplate.NotFound', 'errorMessage' => 'The parameter workspaceTemplate is not found.', 'description' => 'The parameter workspaceTemplate is not found.'], ], - 404 => [ - [ - 'errorCode' => 'InvalidOrganization.NotFound', - 'errorMessage' => 'The organization is not found.', - ], + 403 => [ + ['errorCode' => 'Forbidden.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], + ['errorCode' => 'InvalidPipeline.NotFound', 'errorMessage' => 'The pipeline is not found.', 'description' => 'The pipeline does not exist.'], + ['errorCode' => 'InvalidPipelineRun.NotFound', 'errorMessage' => 'The pipeline execution instance is not found.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'InvalidWorkspace.NotFound', 'errorMessage' => 'The workspace is not found.', 'description' => 'The workspace is not found.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"log\\": {\\n \\"more\\": true,\\n \\"content\\": \\"success\\"\\n },\\n \\"success\\": true,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', + 'title' => 'Query job runtime logs ', + 'changeSet' => [ + ['createdAt' => '2021-11-25T13:19:47.000Z', 'description' => 'OpenAPI offline'], ], - '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', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'LogPipelineJobRun'], + ], ], + 'ramActions' => [], + ], + 'LogVMDeployMachine' => [ + 'summary' => 'You can query machine deployment logs.', + 'path' => '/organization/{organizationId}/pipelines/{pipelineId}/deploy/{deployOrderId}/machine/{machineSn}/log', + 'methods' => ['get'], + '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', - ], + 'schema' => ['title' => '', 'description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, such as https://devops.aliyun.com/organization/【OrganizationId】.', '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, - ], + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => ['title' => '12222', 'description' => 'Pipeline ID, which can be obtained from the pipeline link, such as https://flow.aliyun.com/pipelines/【PipelineId】/current.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1111'], + ], + [ + 'name' => 'deployOrderId', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'Deployment order ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1111'], + ], + [ + 'name' => 'machineSn', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'Machine serial number (SN)', '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', - ], - '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' => '', + 'requestId' => ['title' => '', 'description' => 'Request ID. Each request has a Unique value, which facilitates troubleshooting later.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['title' => '', 'description' => 'error message', 'type' => 'string', 'example' => '”“'], + 'success' => ['title' => '', 'description' => 'true indicates the API Call Succeeded; false indicates the API Call failed.', 'type' => 'boolean', 'example' => 'true 接口调用成功,false 接口调用失败'], + 'errorCode' => ['title' => '', 'description' => 'error code', 'type' => 'string', 'example' => '”“'], + 'deployMachineLog' => [ + 'title' => '', + 'description' => 'Deployment record', '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', - ], + 'deployLog' => ['title' => '', 'description' => 'Deployment log', 'type' => 'string', 'example' => 'success'], + 'aliyunRegion' => ['title' => '', 'description' => 'Deployment Region', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'deployLogPath' => ['title' => '', 'description' => 'Deployment log path', 'type' => 'string', 'example' => '/tmp/log'], + 'deployBeginTime' => ['title' => '', 'description' => 'Deployment Start Time', 'type' => 'integer', 'format' => 'int64', 'example' => '11111111111'], + 'deployEndTime' => ['title' => '', 'description' => 'Deployment End Time', 'type' => 'integer', 'format' => 'int64', 'example' => '1719312026'], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Openapi.RequestError', - 'errorMessage' => 'request error', - ], + ['errorCode' => 'InvalidCluster.NotFound', 'errorMessage' => 'No cluster is available to generate the workspace.', 'description' => 'No cluster is available to generate the workspace.'], + ['errorCode' => 'InvalidCodeUrl.NotSupportSVN', 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', 'description' => 'The parameter codeUrl is invalid. SVN is not supported.'], + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidResource.NotFound', 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', 'description' => 'No resource is found. You cannot create the workspace. Please try again later.'], + ['errorCode' => 'InvalidResourceRole.NotFoun', 'errorMessage' => 'The member role is invalid.', 'description' => 'The member role is invalid.'], + ['errorCode' => 'InvalidResourceRole.NotFound', 'errorMessage' => 'The member role is invalid.', 'description' => ''], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => 'The user that is invoking the API service is not a registered user.'], + ['errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', 'errorMessage' => 'Resource owner cannot be deleted.', 'description' => 'The resource owner cannot be deleted.'], + ['errorCode' => 'InvalidUser.ResourceMemberNotExists', 'errorMessage' => 'The resource member does not exist.', 'description' => 'The resource member does not exist.'], + ['errorCode' => 'InvalidUser.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization.', 'description' => '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.', 'description' => 'The workspace status is invalid. You can only operate workspaces with the SUCCESS status.'], + ['errorCode' => 'InvalidWorkspaceTemplate.NotFound', 'errorMessage' => 'The parameter workspaceTemplate is not found.', 'description' => 'The parameter workspaceTemplate is not found.'], ], 403 => [ - [ - 'errorCode' => 'Operate.NoPermission', - 'errorMessage' => 'NoPermission', - ], + ['errorCode' => 'Forbidden.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], + ['errorCode' => 'InvalidPipeline.NotFound', 'errorMessage' => 'The pipeline is not found.', 'description' => 'The pipeline does not exist.'], + ['errorCode' => 'InvalidPipelineRun.NotFound', 'errorMessage' => 'The pipeline execution instance is not found.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'InvalidWorkspace.NotFound', 'errorMessage' => 'The workspace is not found.', 'description' => 'The workspace is not found.'], ], ], - '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', + '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"}]', + 'title' => 'Query machine deployment logs', + 'changeSet' => [ + ['createdAt' => '2021-11-25T13:20:39.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'LogVMDeployMachine'], + ], ], + 'ramActions' => [], + ], + 'MergeMergeRequest' => [ + 'summary' => 'Merges a specified merge request.', + 'path' => '/api/v4/projects/{repositoryId}/merge_requests/{localId}/merge', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [], - 'produces' => [], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'organizationId', + 'in' => 'query', + 'schema' => ['title' => 'A short description of struct', 'description' => 'The ID of your organization. To get this ID, log in to the Alibaba Cloud DevOps console and copy it from your browser\'s address bar. For example, in the URL `https://devops.aliyun.com/organization/{organizationId}`, `{organizationId}` is the organization ID.', 'type' => 'string', 'required' => true, 'example' => '60de7a6852743a5162b5f957'], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => ['title' => 'A short description of struct', 'description' => 'The personal access token. This parameter is not required if you use an Alibaba Cloud AK/SK or STS temporary authorization for authentication.', 'type' => 'string', 'required' => false, 'example' => '0cf2c8458ac44d9481aab2dd6ec10596v3'."\n"], + ], + [ + 'name' => 'repositoryId', 'in' => 'path', - 'schema' => [ - 'title' => '企业id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['description' => 'The ID of the repository.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2709413', 'title' => ''], + ], + [ + 'name' => 'localId', + 'in' => 'path', + 'schema' => ['description' => 'The local ID of the merge request. This ID is unique within a repository.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', '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, - ], + 'mergeType' => ['description' => 'The merge type. Valid values:'."\n" + ."\n" + .'- `no-fast-forward`: Creates a merge commit, even if a fast-forward merge is possible. This is the default value.'."\n" + ."\n" + .'- `squash`: Squashes all commits from the source branch into a single commit on the target branch.'."\n" + ."\n" + .'- `rebase`: Rebases the commits from the source branch onto the target branch.'."\n" + ."\n" + .'- `ff-only`: The merge is accepted only if it can be resolved as a fast-forward.', 'type' => 'string', 'required' => true, 'example' => 'no-fast-forward', 'title' => ''], + 'mergeMessage' => ['description' => 'The message for the merge commit.', 'type' => 'string', 'required' => false, 'example' => '""', 'title' => ''], + 'removeSourceBranch' => ['description' => 'Specifies whether to delete the source branch after a successful merge.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response 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' => '', + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '9ED5E382-3A58-51E4-8A81-CE25D1756025'], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'result' => [ + 'description' => 'The result of the operation.', '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', - ], + 'result' => ['description' => 'Indicates if the merge was successful.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'mergedRevision' => ['description' => 'The commit SHA of the merged revision.', 'type' => 'string', 'example' => '1a072f5367c21f9de3464b8c0ee8546e47764d2d', 'title' => ''], + 'bizId' => ['description' => 'The business ID of the merge request.', 'type' => 'string', 'example' => 'bca90244c4b749e0b109df52ac0eb570', 'title' => ''], + 'projectId' => ['description' => 'The ID of the repository.', 'type' => 'integer', 'format' => 'int64', 'example' => '2369234', 'title' => ''], + 'localId' => ['description' => 'The local ID of the merge request. This ID is unique within a repository.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Openapi.RequestError', - 'errorMessage' => 'request error', - ], - ], - 403 => [ - [ - 'errorCode' => 'Operate.NoPermission', - 'errorMessage' => 'NoPermission', - ], + '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"}]', + 'title' => 'Merge Merge Request', + 'description' => 'This operation applies only to organizations that use the new merge request interface. To verify which interface you are using, check the Merge Request page in the Alibaba Cloud DevOps console.', + 'changeSet' => [ + ['createdAt' => '2024-01-23T02:19:11.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MergeMergeRequest'], ], ], - '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":""}]', + 'ramActions' => [], ], - 'DeleteProject' => [ - 'summary' => '删除项目', - 'path' => '/organization/{organizationId}/projects/delete', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'PassPipelineValidate' => [ + 'summary' => 'You can pass through a manual checkpoint. ', + 'path' => '/organization/{organizationId}/pipelines/{pipelineId}/pipelineRuns/{pipelineRunId}/jobs/{jobId}/pass', + 'methods' => ['post'], + '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', - ], + 'schema' => ['title' => '', 'description' => 'Enterprise identity, also known as enterprise ID, in string format. You can obtain it from the Alibaba Cloud DevOps access link, for example: https://devops.aliyun.com/organization/【OrganizationId】 ', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ - 'name' => 'identifier', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '7fb72727f32143574f7a...', - ], + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'Pipeline ID. You can obtain it from the pipeline link, for example: https://flow.aliyun.com/pipelines/【PipelineId】/current ', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11222'], + ], + [ + 'name' => 'pipelineRunId', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'Pipeline run instance ID ', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1111'], + ], + [ + 'name' => 'jobId', + 'in' => 'path', + 'schema' => ['title' => '1111', 'description' => 'Job ID. You can obtain the job ID through the API at https://help.aliyun.com/document_detail/460565.html. ', 'type' => 'string', 'required' => true, 'example' => '111'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '接口返回数据', - 'description' => '', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', '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', - ], + 'requestId' => ['title' => '', 'description' => 'Request ID. Each request has a unique value, which facilitates troubleshooting later. ', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['title' => '', 'description' => 'error message ', 'type' => 'string', 'example' => '""'], + 'success' => ['title' => '', 'description' => 'true if the API call succeeded; false if the API call failed. ', 'type' => 'boolean', 'example' => 'true'], + 'errorCode' => ['title' => '', 'description' => 'error code ', 'type' => 'string', 'example' => '""'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Openapi.RequestError', - 'errorMessage' => 'request error', - ], + ['errorCode' => 'InvalidCluster.NotFound', 'errorMessage' => 'No cluster is available to generate the workspace.', 'description' => 'No cluster is available to generate the workspace.'], + ['errorCode' => 'InvalidCodeUrl.NotSupportSVN', 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', 'description' => 'The parameter codeUrl is invalid. SVN is not supported.'], + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidResource.NotFound', 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', 'description' => 'No resource is found. You cannot create the workspace. Please try again later.'], + ['errorCode' => 'InvalidResourceRole.NotFoun', 'errorMessage' => 'The member role is invalid.', 'description' => 'The member role is invalid.'], + ['errorCode' => 'InvalidResourceRole.NotFound', 'errorMessage' => 'The member role is invalid.', 'description' => ''], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => 'The user that is invoking the API service is not a registered user.'], + ['errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', 'errorMessage' => 'Resource owner cannot be deleted.', 'description' => 'The resource owner cannot be deleted.'], + ['errorCode' => 'InvalidUser.ResourceMemberNotExists', 'errorMessage' => 'The resource member does not exist.', 'description' => 'The resource member does not exist.'], + ['errorCode' => 'InvalidUser.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization.', 'description' => '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.', 'description' => 'The workspace status is invalid. You can only operate workspaces with the SUCCESS status.'], + ['errorCode' => 'InvalidWorkspaceTemplate.NotFound', 'errorMessage' => 'The parameter workspaceTemplate is not found.', 'description' => 'The parameter workspaceTemplate is not found.'], ], 403 => [ - [ - 'errorCode' => 'Operate.NoPermission', - 'errorMessage' => 'NoPermission', - ], + ['errorCode' => 'Forbidden.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], + ['errorCode' => 'InvalidPipeline.NotFound', 'errorMessage' => 'The pipeline is not found.', 'description' => 'The pipeline does not exist.'], + ['errorCode' => 'InvalidPipelineRun.NotFound', 'errorMessage' => 'The pipeline execution instance is not found.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'InvalidWorkspace.NotFound', 'errorMessage' => 'The workspace is not found.', 'description' => 'The workspace is not found.'], ], ], - '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', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', + 'title' => 'Pass Through a Manual Checkpoint ', + 'changeSet' => [ + ['createdAt' => '2021-11-16T13:30:17.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PassPipelineValidate'], + ], ], + 'ramActions' => [], + ], + 'PassReleaseStagePipelineValidate' => [ + 'summary' => 'Approves a manual checkpoint in a release stage pipeline.', + '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' => [], + 'systemTags' => ['operationType' => 'update', 'autoTest' => false, 'notSupportAutoTestReason' => '数据面 api 经安全评估统一不做处理,后续逐步安排下线', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'organizationId', + 'in' => 'query', + 'schema' => ['description' => 'The organization ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '66c0c9fffeb86b450c199***', 'title' => ''], + ], + [ + 'name' => 'appName', 'in' => 'path', - 'schema' => [ - 'title' => '企业id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'example' => 'testApp', 'title' => ''], ], [ - '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' => 'releaseWorkflowSn', + 'in' => 'path', + 'schema' => ['description' => 'The unique ID of the release workflow.', 'type' => 'string', 'required' => true, 'example' => 'ce51b31b996246ecaf8747368383****', 'title' => ''], ], [ - 'name' => 'projectId', + 'name' => 'releaseStageSn', 'in' => 'path', - 'schema' => [ - 'title' => '项目id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5e70xxxxxxcd000xxxxe96', - ], + 'schema' => ['description' => 'The unique ID of the release stage.', 'type' => 'string', 'required' => true, 'example' => 'e173f3c11db5445eb426ca33c922****', 'title' => ''], + ], + [ + 'name' => 'executionNumber', + 'in' => 'path', + 'schema' => ['description' => 'The execution number for the release stage.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'jobId', + 'in' => 'query', + 'schema' => ['description' => 'The job ID. To obtain this ID, call the API operation described at https\\://help.aliyun.com/document\\_detail/2839080.html.', 'type' => 'string', 'required' => true, 'example' => '226241***', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'PassPipelineValidateResponse', + 'description' => 'PassPipelineValidateResponse', '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', - ], - ], - ], + 'success' => ['description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Openapi.RequestError', - 'errorMessage' => 'request error', - ], - ], - 403 => [ - [ - 'errorCode' => 'Operate.NoPermission', - 'errorMessage' => 'NoPermission', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"success\\": true\\n}","type":"json"}]', + 'title' => 'Pass the manual checkpoint in the R&D phase pipeline', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PassReleaseStagePipelineValidate'], ], ], - '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":""}]', + 'ramActions' => [], ], - 'UpdateProjectField' => [ - 'summary' => '更新项目属性与字段', - 'path' => '/organization/{organizationId}/project/{identifier}', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'RefusePipelineValidate' => [ + 'summary' => 'You can deny a manual checkpoint.', + 'path' => '/organization/{organizationId}/pipelines/{pipelineId}/pipelineRuns/{pipelineRunId}/jobs/{jobId}/refuse', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'path', - 'schema' => [ - 'title' => '企业id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['title' => '', 'description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, such as https://devops.aliyun.com/organization/【OrganizationId】.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ - 'name' => 'identifier', + 'name' => 'pipelineId', 'in' => 'path', - 'schema' => [ - 'title' => '更新项目的唯一标识,项目id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'deafe5f33xxxxx6a259d8dafd', - ], + 'schema' => ['title' => '12222', 'description' => '12222', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '流水线ID,可在流水线链接中获取,如https://flow.aliyun.com/pipelines/【PipelineId】/current'], ], [ - '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, - ], + 'name' => 'pipelineRunId', + 'in' => 'path', + 'schema' => ['title' => '1', 'description' => 'Pipeline run instance ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '流水线运行实例id'], + ], + [ + 'name' => 'jobId', + 'in' => 'path', + 'schema' => ['title' => '11111', 'description' => 'Job ID. You can obtain the job ID through the API at https://help.aliyun.com/document_detail/460565.html.', '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', - ], - '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', - ], - ], - ], - ], - ], - ], + 'requestId' => ['title' => '', 'description' => 'Request ID. Each request has a unique value, which facilitates troubleshooting later.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['title' => '', 'description' => 'error message', 'type' => 'string', 'example' => '”“'], + 'success' => ['title' => '', 'description' => 'true indicates that the API call succeeded; false indicates that the API call failed.', 'type' => 'boolean', 'example' => 'true'], + 'errorCode' => ['title' => '', 'description' => 'error code', 'type' => 'string', 'example' => '""'], ], + 'example' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidCluster.NotFound', 'errorMessage' => 'No cluster is available to generate the workspace.', 'description' => 'No cluster is available to generate the workspace.'], + ['errorCode' => 'InvalidCodeUrl.NotSupportSVN', 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', 'description' => 'The parameter codeUrl is invalid. SVN is not supported.'], + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidResource.NotFound', 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', 'description' => 'No resource is found. You cannot create the workspace. Please try again later.'], + ['errorCode' => 'InvalidResourceRole.NotFoun', 'errorMessage' => 'The member role is invalid.', 'description' => 'The member role is invalid.'], + ['errorCode' => 'InvalidResourceRole.NotFound', 'errorMessage' => 'The member role is invalid.', 'description' => ''], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => 'The user that is invoking the API service is not a registered user.'], + ['errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', 'errorMessage' => 'Resource owner cannot be deleted.', 'description' => 'The resource owner cannot be deleted.'], + ['errorCode' => 'InvalidUser.ResourceMemberNotExists', 'errorMessage' => 'The resource member does not exist.', 'description' => 'The resource member does not exist.'], + ['errorCode' => 'InvalidUser.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization.', 'description' => '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.', 'description' => 'The workspace status is invalid. You can only operate workspaces with the SUCCESS status.'], + ['errorCode' => 'InvalidWorkspaceTemplate.NotFound', 'errorMessage' => 'The parameter workspaceTemplate is not found.', 'description' => 'The parameter workspaceTemplate is not found.'], + ], 403 => [ - [ - 'errorCode' => 'Operate.NoPermission', - 'errorMessage' => 'NoPermission', - ], + ['errorCode' => 'Forbidden.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], + ['errorCode' => 'InvalidPipeline.NotFound', 'errorMessage' => 'The pipeline is not found.', 'description' => 'The pipeline does not exist.'], + ['errorCode' => 'InvalidPipelineRun.NotFound', 'errorMessage' => 'The pipeline execution instance is not found.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'InvalidWorkspace.NotFound', 'errorMessage' => 'The workspace is not found.', 'description' => 'The workspace is not found.'], ], ], - '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', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', + 'title' => 'Deny Manual Checkpoint', + 'changeSet' => [ + ['createdAt' => '2021-11-16T13:30:17.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RefusePipelineValidate'], + ], ], + 'ramActions' => [], + ], + 'RefuseReleaseStagePipelineValidate' => [ + 'summary' => 'Rejects a manual gate in a development stage pipeline.', + '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' => [], + 'systemTags' => ['operationType' => 'update', 'autoTest' => false, 'notSupportAutoTestReason' => '数据面 api 经安全评估统一不做处理,后续逐步安排下线', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'organizationId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the organization.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '66c0c9fffeb86b450c19****', 'title' => ''], + ], + [ + 'name' => 'appName', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'example' => 'testApp', 'title' => ''], ], [ - 'name' => 'projectId', + 'name' => 'releaseWorkflowSn', 'in' => 'path', - 'schema' => [ - 'title' => '项目id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'e8b2xxxxxxx09b07d23', - ], + 'schema' => ['description' => 'The serial number (sn) of the release workflow.', 'type' => 'string', 'required' => true, 'example' => 'ce51b31b996246ecaf8747368383****', 'title' => ''], + ], + [ + 'name' => 'releaseStageSn', + 'in' => 'path', + 'schema' => ['description' => 'The serial number (sn) of the release stage.', 'type' => 'string', 'required' => true, 'example' => 'e173f3c11db5445eb426ca33c922****', 'title' => ''], + ], + [ + 'name' => 'executionNumber', + 'in' => 'path', + 'schema' => ['description' => 'The execution number of the release stage.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'jobId', + 'in' => 'query', + 'schema' => ['description' => 'The job ID. You can call the `ListReleaseStageJobs` operation to get the job ID.', 'type' => 'string', 'required' => true, 'example' => '226241***', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'title' => 'RefusePipelineValidateResponse', + 'description' => 'The response object.', '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', - ], - ], - ], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Operate.NoPermission', - 'errorMessage' => 'NoPermission', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"success\\": true\\n}","type":"json"}]', + 'title' => 'Deny a Manual Checkpoint in the R&D Pipeline', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RefuseReleaseStagePipelineValidate'], ], ], - '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":""}]', + 'ramActions' => [], ], - 'ListProjectMembers' => [ - 'summary' => '根据项目id获取项目所以成员', - 'path' => '/organization/{organizationId}/projects/{projectId}/listMembers', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ReopenMergeRequest' => [ + 'summary' => 'Reopens a closed merge request. Merge requests that have already been merged cannot be reopened.', + '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' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'in' => 'query', + 'schema' => ['title' => 'A short description of struct', 'description' => 'The ID of the organization. You can find it in your Alibaba Cloud DevOps URL, for example, https\\://devops.aliyun.com/organization/{organizationId}.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ - 'name' => 'projectId', + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => ['title' => 'A short description of struct', 'description' => 'The personal access token. This parameter is not required when authenticating with an Alibaba Cloud AccessKey pair (AK and SK) or Security Token Service (STS).', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513'], + ], + [ + 'name' => 'repositoryId', 'in' => 'path', - 'schema' => [ - 'title' => '项目id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'e8bxxxxx2abd6e76aa209b07d23', - ], + 'schema' => ['description' => 'The repository ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2464454', 'title' => ''], ], [ - 'name' => 'targetType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'Space', - ], + 'name' => 'localId', + 'in' => 'path', + 'schema' => ['description' => 'The sequential ID of the merge request within the repository.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of the response.', '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' => 'accountsxxxx@mail.com', - ], - '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', - ], - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '313A1BF6-63B7-52D4-A098-952221A65254'], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Openapi.RequestError', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'result' => [ + 'description' => 'The result of the operation.', + 'type' => 'object', + 'properties' => [ + 'result' => ['description' => 'Indicates whether the merge request was successfully reopened.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Openapi.RequestError', - 'errorMessage' => 'request error', - ], - ], 403 => [ - [ - 'errorCode' => 'Operate.NoPermission', - 'errorMessage' => 'NoPermission', - ], + ['errorCode' => 'Forbidden.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => 'The user is not authorized to perform the operation.'], ], - [ - [ - 'errorCode' => 'InvaildSpace.NotInCurrentOrganization', - 'errorMessage' => 'space not belong to this organization, please switch organization.', - ], + ], + '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"}]', + 'title' => 'Reopen Merge Request', + 'description' => 'This API requires that your organization uses the new version of the merge request feature. You can verify this on your organization\'s merge request page.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReopenMergeRequest'], ], ], - '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\\": \\"accountsxxxx@mail.com\\",\\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":""}]', + 'ramActions' => [], ], - 'GetSprintInfo' => [ - 'summary' => '获取迭代详情', - 'path' => '/organization/{organizationId}/sprints/{sprintId}/getSprintinfo', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ResetSshKey' => [ + 'summary' => 'You can reset the enterprise public key.', + 'path' => '/organization/{organizationId}/sshKey', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'deprecated' => false, '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...', - ], + 'schema' => ['title' => '', 'description' => 'Enterprise identity, also known as enterprise ID, in string format. You can obtain it from the Alibaba Cloud DevOps access link, such as https://devops.aliyun.com/organization/【OrganizationId】', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], ], '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' => '', + 'requestId' => ['title' => '', 'description' => 'Request ID. Each request has a unique value, which facilitates troubleshooting later.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => '""'], + 'errorCode' => ['title' => '', 'description' => 'Error code', 'type' => 'string', 'example' => '""'], + 'success' => ['title' => '', 'description' => 'true indicates that the API call succeeded; false indicates that the API call failed.', 'type' => 'boolean', 'example' => 'true'], + 'sshKey' => [ + 'title' => '', + 'description' => 'Enterprise public key', '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', - ], - ], + 'publicKey' => ['title' => '', 'description' => 'Enterprise public key', 'type' => 'string', 'example' => 'saaaaaaaaaaaaaaaa'], + 'id' => ['title' => '', 'description' => 'Enterprise public key ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1212'], ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Openapi.RequestError', - 'errorMessage' => 'request error', - ], + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => 'The user that is invoking the API service is not a registered user.'], ], 403 => [ - [ - 'errorCode' => 'Operate.NoPermission', - 'errorMessage' => 'NoPermission', - ], + ['errorCode' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], ], ], - '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', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"sshKey\\": {\\n \\"publicKey\\": \\"saaaaaaaaaaaaaaaa\\",\\n \\"id\\": 1212\\n }\\n}","type":"json"}]', + 'title' => 'Reset Enterprise Public Key', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetSshKey'], + ], ], + 'ramActions' => [], + ], + 'ResumeVMDeployOrder' => [ + 'summary' => 'You can continue the deployment order run.', + 'path' => '/organization/{organizationId}/pipelines/{pipelineId}/deploy/{deployOrderId}/resume', + 'methods' => ['put'], + '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', - ], + 'schema' => ['title' => '', 'description' => 'The enterprise identity, also known as the enterprise ID, is a string that can be obtained from the Alibaba Cloud DevOps access link, such as https://devops.aliyun.com/organization/【OrganizationId】.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ - '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' => 'pipelineId', + 'in' => 'path', + 'schema' => ['title' => '12222', 'description' => 'Pipeline ID, which can be obtained from the pipeline link, such as https://flow.aliyun.com/pipelines/【PipelineId】/current.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '111111'], ], [ - 'name' => 'scope', - 'in' => 'query', - 'schema' => [ - 'title' => '公开类型', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'public', - ], + 'name' => 'deployOrderId', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'Deployment order ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11111'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', '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', - ], - ], - ], - ], + 'requestId' => ['title' => '', 'description' => 'The request ID. Each request has a unique value, which facilitates troubleshooting later.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['title' => '', 'description' => 'error message', 'type' => 'string', 'example' => '”“'], + 'success' => ['title' => '', 'description' => 'true if the API call succeeded; false if the API call failed.', 'type' => 'boolean', 'example' => 'true 接口调用成功,false 接口调用失败'], + 'errorCode' => ['title' => '', 'description' => 'error code', 'type' => 'string', 'example' => '”“'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Openapi.RequestError', - 'errorMessage' => 'request error', - ], + ['errorCode' => 'InvalidCluster.NotFound', 'errorMessage' => 'No cluster is available to generate the workspace.', 'description' => 'No cluster is available to generate the workspace.'], + ['errorCode' => 'InvalidCodeUrl.NotSupportSVN', 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', 'description' => 'The parameter codeUrl is invalid. SVN is not supported.'], + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidResource.NotFound', 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', 'description' => 'No resource is found. You cannot create the workspace. Please try again later.'], + ['errorCode' => 'InvalidResourceRole.NotFoun', 'errorMessage' => 'The member role is invalid.', 'description' => 'The member role is invalid.'], + ['errorCode' => 'InvalidResourceRole.NotFound', 'errorMessage' => 'The member role is invalid.', 'description' => ''], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => 'The user that is invoking the API service is not a registered user.'], + ['errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', 'errorMessage' => 'Resource owner cannot be deleted.', 'description' => 'The resource owner cannot be deleted.'], + ['errorCode' => 'InvalidUser.ResourceMemberNotExists', 'errorMessage' => 'The resource member does not exist.', 'description' => 'The resource member does not exist.'], + ['errorCode' => 'InvalidUser.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization.', 'description' => '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.', 'description' => 'The workspace status is invalid. You can only operate workspaces with the SUCCESS status.'], + ['errorCode' => 'InvalidWorkspaceTemplate.NotFound', 'errorMessage' => 'The parameter workspaceTemplate is not found.', 'description' => 'The parameter workspaceTemplate is not found.'], ], 403 => [ - [ - 'errorCode' => 'Operate.NoPermission', - 'errorMessage' => 'NoPermission', - ], + ['errorCode' => 'Forbidden.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], + ['errorCode' => 'InvalidPipeline.NotFound', 'errorMessage' => 'The pipeline is not found.', 'description' => 'The pipeline does not exist.'], + ['errorCode' => 'InvalidPipelineRun.NotFound', 'errorMessage' => 'The pipeline execution instance is not found.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'InvalidWorkspace.NotFound', 'errorMessage' => 'The workspace is not found.', 'description' => 'The workspace is not found.'], ], ], - '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', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\"\\n}","type":"json"}]', + 'title' => 'Continue Deployment Order Run', + 'changeSet' => [ + ['createdAt' => '2021-11-25T13:20:39.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResumeVMDeployOrder'], + ], ], + 'ramActions' => [], + ], + 'RetryPipelineJobRun' => [ + 'summary' => 'You can retry a pipeline job run. ', + '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, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['description' => 'The enterprise identity (also called enterprise ID), in string format. You can obtain it from the Alibaba Cloud DevOps access link, for example: https://devops.aliyun.com/organization/【OrgId】 ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5ebbc0228123212b59xxxxx', 'title' => ''], ], [ - 'name' => 'category', - 'in' => 'query', - 'schema' => [ - 'title' => '模板类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'Project', - ], + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => ['description' => 'The pipeline ID. You can obtain it from the pipeline link, for example: https://flow.aliyun.com/pipelines/【PipelineId】/current ', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'pipelineRunId', + 'in' => 'path', + 'schema' => ['description' => 'The pipeline run instance ID. ', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'jobId', + 'in' => 'path', + 'schema' => ['description' => 'The job ID. You can obtain the job ID by using the API at https://help.aliyun.com/document_detail/460565.html. ', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -42078,552 +23337,193 @@ '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', - ], - ], - ], - ], + 'requestId' => ['description' => 'The request ID. Each request has a unique value, which facilitates troubleshooting. ', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', 'title' => ''], + 'errorMessage' => ['description' => 'Error message ', 'type' => 'string', 'example' => '""', 'title' => ''], + 'errorCode' => ['description' => 'Error code ', 'type' => 'string', 'example' => '""', 'title' => ''], + 'success' => ['description' => 'true indicates the invocation succeeded; false indicates the invocation failed. ', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Openapi.RequestError', - 'errorMessage' => 'request error', - ], + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => 'The user that is invoking the API service is not a registered user.'], ], 403 => [ - [ - 'errorCode' => 'Operate.NoPermission', - 'errorMessage' => 'NoPermission', - ], + ['errorCode' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], + ['errorCode' => 'InvalidPipelineRun.NotFound', 'errorMessage' => 'The pipeline execution instance is not found.', 'description' => 'The pipeline execution instance is not found.'], + ['errorCode' => 'InvalidPipeline.NotFound', 'errorMessage' => 'The pipeline is not found.', 'description' => 'The pipeline does not exist.'], ], ], - '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', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true\\n}","type":"json"}]', + 'title' => 'Retry a pipeline job run ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RetryPipelineJobRun'], + ], ], + 'ramActions' => [], + ], + 'RetryVMDeployMachine' => [ + 'summary' => 'You can retry machine deployment.', + 'path' => '/organization/{organizationId}/pipelines/{pipelineId}/deploy/{deployOrderId}/machine/{machineSn}/retry', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['title' => '', 'description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, such as https://devops.aliyun.com/organization/【OrganizationId】.', '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' => 'pipelineId', + 'in' => 'path', + 'schema' => ['title' => '12222', 'description' => 'Pipeline ID, which can be obtained from the pipeline link, such as https://flow.aliyun.com/pipelines/【PipelineId】/current.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1111'], ], [ - 'name' => 'nextToken', - 'in' => 'query', - 'schema' => [ - 'title' => '分页中的起始序列', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '""', - ], + 'name' => 'deployOrderId', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'Deployment order ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11111111'], ], [ - 'name' => 'maxResults', - 'in' => 'query', - 'schema' => [ - 'title' => '每页最大返回数量,0-200,默认值20', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20', - ], + 'name' => 'machineSn', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'Machine SN', 'type' => 'string', 'required' => true, 'example' => 'assssssss'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', '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', - ], - ], - ], - ], + 'requestId' => ['title' => '', 'description' => 'Request ID. Each request has a unique value, which facilitates troubleshooting later.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['title' => '', 'description' => 'error message', 'type' => 'string', 'example' => '”“'], + 'success' => ['title' => '', 'description' => 'true indicates that the API call succeeded; false indicates that the API call failed.', 'type' => 'boolean', 'example' => 'true 接口调用成功,false 接口调用失败'], + 'errorCode' => ['title' => '', 'description' => 'error code', 'type' => 'string', 'example' => '”“'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Openapi.RequestError', - 'errorMessage' => 'request error', - ], + ['errorCode' => 'InvalidCluster.NotFound', 'errorMessage' => 'No cluster is available to generate the workspace.', 'description' => 'No cluster is available to generate the workspace.'], + ['errorCode' => 'InvalidCodeUrl.NotSupportSVN', 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', 'description' => 'The parameter codeUrl is invalid. SVN is not supported.'], + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidResource.NotFound', 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', 'description' => 'No resource is found. You cannot create the workspace. Please try again later.'], + ['errorCode' => 'InvalidResourceRole.NotFoun', 'errorMessage' => 'The member role is invalid.', 'description' => 'The member role is invalid.'], + ['errorCode' => 'InvalidResourceRole.NotFound', 'errorMessage' => 'The member role is invalid.', 'description' => ''], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => 'The user that is invoking the API service is not a registered user.'], + ['errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', 'errorMessage' => 'Resource owner cannot be deleted.', 'description' => 'The resource owner cannot be deleted.'], + ['errorCode' => 'InvalidUser.ResourceMemberNotExists', 'errorMessage' => 'The resource member does not exist.', 'description' => 'The resource member does not exist.'], + ['errorCode' => 'InvalidUser.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization.', 'description' => '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.', 'description' => 'The workspace status is invalid. You can only operate workspaces with the SUCCESS status.'], + ['errorCode' => 'InvalidWorkspaceTemplate.NotFound', 'errorMessage' => 'The parameter workspaceTemplate is not found.', 'description' => 'The parameter workspaceTemplate is not found.'], ], 403 => [ - [ - 'errorCode' => 'Operate.NoPermission', - 'errorMessage' => 'NoPermission', - ], + ['errorCode' => 'Forbidden.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], + ['errorCode' => 'InvalidPipeline.NotFound', 'errorMessage' => 'The pipeline is not found.', 'description' => 'The pipeline does not exist.'], + ['errorCode' => 'InvalidPipelineRun.NotFound', 'errorMessage' => 'The pipeline execution instance is not found.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'InvalidWorkspace.NotFound', 'errorMessage' => 'The workspace is not found.', 'description' => 'The workspace is not found.'], ], ], - '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', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\"\\n}","type":"json"}]', + 'title' => 'Retry Machine Deployment', + 'changeSet' => [ + ['createdAt' => '2021-11-25T13:20:39.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RetryVMDeployMachine'], + ], ], + 'ramActions' => [], + ], + 'ReviewMergeRequest' => [ + 'summary' => 'Submits a review for a merge request.', + 'path' => '/api/v4/projects/{repositoryId}/merge_requests/{localId}/submit_review_opinion', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'organizationId', + 'in' => 'query', + 'schema' => ['title' => 'A short description of struct', 'description' => 'The ID of the organization. You can find the organization ID in the URL after you log on to the Alibaba Cloud DevOps console. For example, in the URL `https://devops.aliyun.com/organization/{OrganizationId}`, `{OrganizationId}` is the organization ID.', 'type' => 'string', 'required' => true, 'example' => '60de7a6852743a5162b5f957'], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => ['description' => 'The personal access token. This parameter is not required if you use an Alibaba Cloud AccessKey pair or a Security Token Service (STS) token for authentication.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], + ], + [ + 'name' => 'repositoryId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['description' => 'The ID of the repository.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2334743', 'title' => ''], + ], + [ + 'name' => 'localId', + 'in' => 'path', + 'schema' => ['description' => 'The local ID of the merge request.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', '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' => '', + 'reviewOpinion' => ['description' => 'The review opinion.'."\n" + ."\n" + .'- `PASS`: Approve the merge request.'."\n" + ."\n" + .'- `NOT_PASS`: Request changes.', 'type' => 'string', 'required' => true, 'example' => 'PASS', 'title' => ''], + 'reviewComment' => ['description' => 'The review comment.', 'type' => 'string', 'required' => false, 'example' => '评论意见具体内容', 'title' => ''], + 'draftCommentIds' => [ + 'description' => 'The IDs of draft comments to submit with the review.', '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, - ], + 'items' => ['description' => 'The ID of a draft comment.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], '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, + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -42631,648 +23531,119 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', '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' => '', + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Openapi.RequestError', 'title' => ''], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'result' => [ + 'description' => 'The returned data.', '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', - ], - ], - ], - ], - ], + 'result' => ['description' => 'Indicates whether the review was submitted successfully.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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\\": \\"Openapi.RequestError\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"result\\": true\\n }\\n}","type":"json"}]', + 'title' => 'Review Merge Request', + 'description' => 'This API is for organizations that use the new merge request feature. You can verify this by checking if the merge request page in your organization is the new version.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReviewMergeRequest'], ], ], - '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"}]', + 'ramActions' => [], ], - 'UpdateTestCase' => [ - 'summary' => '更新测试用例字段', - 'path' => '/organization/{organizationId}/testhub/testcase/{testcaseIdentifier}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'SkipPipelineJobRun' => [ + 'summary' => 'You can skip running a pipeline job.', + 'path' => '/organization/{organizationId}/pipelines/{pipelineId}/pipelineRuns/{pipelineRunId}/jobs/{jobId}/skip', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'path', - 'schema' => [ - 'title' => '企业id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, such as https://devops.aliyun.com/organization/【OrganizationId】.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5ebbc0228123212b59xxxxx', 'title' => ''], ], [ - 'name' => 'testcaseIdentifier', + 'name' => 'pipelineId', 'in' => 'path', - 'schema' => [ - 'title' => '测试用例id,测试用例唯一标识', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '4e22xxxxxxxxc64c16037fe76', - ], + 'schema' => ['description' => 'Pipeline ID. It can be obtained from the pipeline link, such as https://flow.aliyun.com/pipelines/【PipelineId】/current.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ - '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, - ], + 'name' => 'pipelineRunId', + 'in' => 'path', + 'schema' => ['description' => 'Pipeline run instance ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'jobId', + 'in' => 'path', + 'schema' => ['description' => 'Job ID. You can obtain the job ID through the API at https://help.aliyun.com/document_detail/460565.html.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], ], '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', - ], - ], - ], - ], - ], - ], - ], + 'requestId' => ['description' => 'Request ID. Each request has a unique value, which facilitates troubleshooting later.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', 'title' => ''], + 'errorMessage' => ['description' => 'Error message', 'type' => 'string', 'example' => '""', 'title' => ''], + 'errorCode' => ['description' => 'Error code', 'type' => 'string', 'example' => '""', 'title' => ''], + 'success' => ['description' => 'true indicates the invocation succeeded; false indicates the invocation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Openapi.RequestError', - 'errorMessage' => 'request error', - ], + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => 'The user that is invoking the API service is not a registered user.'], ], 403 => [ - [ - 'errorCode' => 'Operate.NoPermission', - 'errorMessage' => 'NoPermission', - ], + ['errorCode' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], + ['errorCode' => 'InvalidPipeline.NotFound', 'errorMessage' => 'The pipeline is not found.', 'description' => 'The pipeline does not exist.'], + ['errorCode' => 'InvalidPipelineRun.NotFound', 'errorMessage' => 'The pipeline execution instance is not found.', 'description' => 'The pipeline execution instance is not found.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true\\n}","type":"json"}]', + 'title' => 'Skip pipeline job run', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SkipPipelineJobRun'], + ], ], - '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"}]', + 'ramActions' => [], ], - 'ListTestCaseFields' => [ - 'summary' => '获取测试用例全部字段', - 'path' => '/organization/{organizationId}/testhub/testcase/fields', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'SkipVMDeployMachine' => [ + 'summary' => 'You can skip machine deployment.', + 'path' => '/organization/{organizationId}/pipelines/{pipelineId}/deploy/{deployOrderId}/machine/{machineSn}/skip', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -43284,315 +23655,140 @@ [ 'name' => 'organizationId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['title' => '', 'description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, such as https://devops.aliyun.com/organization/【OrganizationId】.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ - 'name' => 'spaceIdentifier', - 'in' => 'query', - 'schema' => [ - 'title' => '测试用例库id,测试用例库唯一标识', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'e8bxxxxxxxxxxxxxxxx23', - ], + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => ['title' => '12222', 'description' => 'Pipeline ID, which can be obtained from the pipeline link, such as https://flow.aliyun.com/pipelines/【PipelineId】/current.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '111111111'], + ], + [ + 'name' => 'deployOrderId', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'Deployment order ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '111111111'], + ], + [ + 'name' => 'machineSn', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'Machine SN', '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', - ], - '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', - ], - ], - ], - ], - ], - ], - ], + 'requestId' => ['title' => '', 'description' => 'Request ID. Each request has a unique value, which facilitates troubleshooting later.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['title' => '', 'description' => 'error message', 'type' => 'string', 'example' => '”“'], + 'success' => ['title' => '', 'description' => 'true if the API call succeeded; false if the API call failed.', 'type' => 'boolean', 'example' => 'true 接口调用成功,false 接口调用失败'], + 'errorCode' => ['title' => '', 'description' => 'error code', 'type' => 'string', 'example' => '”“'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Openapi.RequestError', - 'errorMessage' => 'request error', - ], + ['errorCode' => 'InvalidCluster.NotFound', 'errorMessage' => 'No cluster is available to generate the workspace.', 'description' => 'No cluster is available to generate the workspace.'], + ['errorCode' => 'InvalidCodeUrl.NotSupportSVN', 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', 'description' => 'The parameter codeUrl is invalid. SVN is not supported.'], + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidResource.NotFound', 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', 'description' => 'No resource is found. You cannot create the workspace. Please try again later.'], + ['errorCode' => 'InvalidResourceRole.NotFoun', 'errorMessage' => 'The member role is invalid.', 'description' => 'The member role is invalid.'], + ['errorCode' => 'InvalidResourceRole.NotFound', 'errorMessage' => 'The member role is invalid.', 'description' => ''], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => 'The user that is invoking the API service is not a registered user.'], + ['errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', 'errorMessage' => 'Resource owner cannot be deleted.', 'description' => 'The resource owner cannot be deleted.'], + ['errorCode' => 'InvalidUser.ResourceMemberNotExists', 'errorMessage' => 'The resource member does not exist.', 'description' => 'The resource member does not exist.'], + ['errorCode' => 'InvalidUser.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization.', 'description' => '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.', 'description' => 'The workspace status is invalid. You can only operate workspaces with the SUCCESS status.'], + ['errorCode' => 'InvalidWorkspaceTemplate.NotFound', 'errorMessage' => 'The parameter workspaceTemplate is not found.', 'description' => 'The parameter workspaceTemplate is not found.'], ], 403 => [ - [ - 'errorCode' => 'Operate.NoPermission', - 'errorMessage' => 'NoPermission', - ], + ['errorCode' => 'Forbidden.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], + ['errorCode' => 'InvalidPipeline.NotFound', 'errorMessage' => 'The pipeline is not found.', 'description' => 'The pipeline does not exist.'], + ['errorCode' => 'InvalidPipelineRun.NotFound', 'errorMessage' => 'The pipeline execution instance is not found.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'InvalidWorkspace.NotFound', 'errorMessage' => 'The workspace is not found.', 'description' => 'The workspace is not found.'], ], ], - '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', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\"\\n}","type":"json"}]', + 'title' => 'Skip Machine Deployment', + 'changeSet' => [ + ['createdAt' => '2021-11-25T13:20:39.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SkipVMDeployMachine'], + ], ], + 'ramActions' => [], + ], + 'StartPipelineRun' => [ + 'summary' => 'You can run a pipeline.', + 'path' => '/organizations/{organizationId}/pipelines/{pipelineId}/run', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'path', - 'schema' => [ - 'title' => '企业id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['title' => '', 'description' => 'Organization identity, also known as organization ID, in string format. You can obtain it from the Alibaba Cloud DevOps access link, such as https://devops.aliyun.com/organization/【OrganizationId】.', 'type' => 'string', 'required' => true, 'docRequired' => 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, - ], + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'Pipeline ID. You can obtain it from the pipeline link, such as https://flow.aliyun.com/pipelines/【PipelineId】/current '."\n" + .'5ebbc0228123212b59xxxxx', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '123'], + ], + [ + 'name' => 'params', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Pipeline runtime parameters. '."\n" + .'branchModeBranchs: branches to run in branch mode '."\n" + .'envs: environment variables '."\n" + .'runningBranchs: running branches, with keys as repository URLs '."\n" + .'runningTags: running tags, with keys as repository URLs '."\n" + .'runningPipelineArtifacts: keys are source URLs of flow-type artifacts '."\n" + .'runningAcrArtifacts: keys are source URLs of ACR-type artifacts '."\n" + .'runningPackagesArtifacts: keys are source URLs of package-type artifacts '."\n" + .'comment: run comment', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "branchModeBranchs": ["branch1", "branch2"],'."\n" + .' "envs": {'."\n" + .' "k1": "v1",'."\n" + .' "k2": "v2",'."\n" + .' "k3": "v3"'."\n" + .' },'."\n" + .' "runningBranchs": {'."\n" + .' "https://codeup.aliyun.com/60c1abb32c5969c370c5fcd0/Codeup-Demo.git": "master1"'."\n" + .' },'."\n" + .' "runningTags": {'."\n" + .' "https://codeup.aliyun.com/60c1abb32c5969c370c5fcd0/Codeup-Demo.git": "1.0"'."\n" + .' },'."\n" + .' "runningPipelineArtifacts": {'."\n" + .' "3184679": "12"'."\n" + .' },'."\n" + .' "runningAcrArtifacts": {'."\n" + .' "yunxiao-registry.cn-beijing.cr.aliyuncs.com/build-steps/tool-registry": "89b20155-2024-05-14-21-52-44"'."\n" + .' },'."\n" + .' "runningPackagesArtifacts": {'."\n" + .' "generic/flow_generic_repo/Artifacts_3183732": "2024-06-04-17-58-34"'."\n" + .' },'."\n" + .' "comment":"222"'."\n" + .'}'], ], ], 'responses' => [ @@ -43600,273 +23796,75 @@ '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' => '', - ], - ], - ], - ], - ], - ], - ], + 'requestId' => ['title' => '', 'description' => 'Request ID. Each request has a unique value, which facilitates troubleshooting later.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['title' => '', 'description' => 'Error message.', 'type' => 'string', 'example' => '""'], + 'pipelineRunId' => ['title' => '', 'description' => 'Pipeline run instance ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'success' => ['title' => '', 'description' => 'true if the API call succeeded; false if the API call failed.', 'type' => 'boolean', 'example' => 'true'], + 'errorCode' => ['title' => '', 'description' => 'Error code.', 'type' => 'string', 'example' => '""'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Openapi.RequestError', - 'errorMessage' => 'request error', - ], + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => 'The user that is invoking the API service is not a registered user.'], ], 403 => [ - [ - 'errorCode' => 'Operate.NoPermission', - 'errorMessage' => 'NoPermission', - ], + ['errorCode' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], + ['errorCode' => 'InvalidPipeline.NotFound', 'errorMessage' => 'The pipeline is not found.', 'description' => 'The pipeline does not exist.'], + ['errorCode' => 'InvalidPipelineRun.NotFound', 'errorMessage' => 'The pipeline execution instance is not found.', 'description' => 'The pipeline execution instance is not found.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"pipelineRunId\\": 1,\\n \\"success\\": true,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', + 'title' => 'Run Pipeline', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartPipelineRun'], + ], ], - '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"}]', + 'ramActions' => [], ], - 'UpdateTestResult' => [ - 'summary' => '更新了测试计划中测试用例的执行人与状态', - 'path' => '/organization/{organizationId}/testhub/testplan/{testPlanIdentifier}/testresult/{testcaseIdentifier}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StopPipelineJobRun' => [ + 'summary' => 'You can stop a pipeline job from running. ', + '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', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['title' => '', 'description' => 'Organization identity, also known as organization ID, in string format. You can obtain it from the Alibaba Cloud DevOps access link, such as https://devops.aliyun.com/organization/【OrgId】. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ - 'name' => 'testPlanIdentifier', + 'name' => 'pipelineId', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['title' => '', 'description' => 'Pipeline ID. You can obtain it from the pipeline link, such as https://flow.aliyun.com/pipelines/【PipelineId】/current. ', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '123'], ], [ - 'name' => 'testcaseIdentifier', + 'name' => 'pipelineRunId', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['title' => '', 'description' => 'Pipeline run instance ID ', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '3'], ], [ - '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, - ], + 'name' => 'jobId', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'Pipeline job ID. You can obtain the job ID through the API at https://help.aliyun.com/document_detail/460565.html. ', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2324334'], ], ], 'responses' => [ @@ -43874,115 +23872,69 @@ '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', - ], + 'requestId' => ['title' => '', 'description' => 'The request ID. Each request has a unique value, which facilitates troubleshooting later. ', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['title' => '', 'description' => 'Error message ', 'type' => 'string', 'example' => '"\''], + 'errorCode' => ['title' => '', 'description' => 'Error code ', 'type' => 'string', 'example' => '""'], + 'success' => ['title' => '', 'description' => 'true if the API call succeeded; false if the API call failed. ', 'type' => 'boolean', 'example' => 'true'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Openapi.RequestError', - 'errorMessage' => 'request error', - ], + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => 'The user that is invoking the API service is not a registered user.'], ], 403 => [ - [ - 'errorCode' => 'Operate.NoPermission', - 'errorMessage' => 'NoPermission', - ], + ['errorCode' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], + ['errorCode' => 'InvalidPipeline.NotFound', 'errorMessage' => 'The pipeline is not found.', 'description' => 'The pipeline does not exist.'], + ['errorCode' => 'InvalidPipelineRun.NotFound', 'errorMessage' => 'The pipeline execution instance is not found.', 'description' => 'The pipeline execution instance is not found.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\'\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true\\n}","type":"json"}]', + 'title' => 'Stop a pipeline job from running ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopPipelineJobRun'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true\\n}","type":"json"}]', + 'ramActions' => [], ], - 'GetTestResultList' => [ - 'summary' => '获取测试计划中的测试用例列表', - 'path' => '/organization/{organizationId}/testhub/testplan/{testPlanIdentifier}/testresults', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StopPipelineRun' => [ + 'summary' => 'You can stop a pipeline run.', + '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', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5ebbc0228123212b59xxxxx', - ], + 'schema' => ['title' => '', 'description' => 'Organization identity, also known as organization ID, in string format. You can obtain it from the Alibaba Cloud DevOps access link, such as https://devops.aliyun.com/organization/【OrganizationId】.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ - 'name' => 'testPlanIdentifier', + 'name' => 'pipelineId', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['title' => '', 'description' => 'Pipeline ID. You can obtain it from the pipeline link, such as https://flow.aliyun.com/pipelines/【PipelineId】/current.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '12'], ], [ - '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, - ], + 'name' => 'pipelineRunId', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'Pipeline run instance ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '223'], ], ], 'responses' => [ @@ -43990,1342 +23942,638 @@ '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', - ], - ], - ], - ], - ], - ], - ], + 'requestId' => ['title' => '', 'description' => 'The request ID. Each request has a unique value, which facilitates troubleshooting later.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => '”“'], + 'errorCode' => ['title' => '', 'description' => 'Error code', 'type' => 'string', 'example' => '”“'], + 'success' => ['title' => '', 'description' => 'true if the API call succeeded; false if the API call failed.', 'type' => 'boolean', 'example' => 'true'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Openapi.RequestError', - 'errorMessage' => 'request error', - ], + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => 'The user that is invoking the API service is not a registered user.'], ], 403 => [ - [ - 'errorCode' => 'Operate.NoPermission', - 'errorMessage' => 'NoPermission', - ], + ['errorCode' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], + ['errorCode' => 'InvalidPipeline.NotFound', 'errorMessage' => 'The pipeline is not found.', 'description' => 'The pipeline does not exist.'], + ['errorCode' => 'InvalidPipelineRun.NotFound', 'errorMessage' => 'The pipeline execution instance is not found.', 'description' => 'The pipeline execution instance is not found.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"errorCode\\": \\"”“\\",\\n \\"success\\": true\\n}","type":"json"}]', + 'title' => 'Stop a pipeline run', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopPipelineRun'], + ], ], - '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"}]', + 'ramActions' => [], ], - 'ExportWorkitemActivity' => [ - 'summary' => '导出Insight workitem_activity表数据', - 'path' => '/organization/{organizationId}/data/workitemActivities', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'StopVMDeployOrder' => [ + 'summary' => 'You can stop a machine deployment.', + 'path' => '/organization/{organizationId}/pipelines/{pipelineId}/deploy/{deployOrderId}/stop', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '61db9af2148974246bexxxx', - ], + 'schema' => ['title' => '', 'description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, such as https://devops.aliyun.com/organization/【OrganizationId】.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => ['title' => '12222', 'description' => 'Pipeline ID, which can be obtained from the pipeline link, such as https://flow.aliyun.com/pipelines/【PipelineId】/current.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12222'], + ], + [ + 'name' => 'deployOrderId', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'Deployment order ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1111'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', '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', - ], + 'requestId' => ['title' => '', 'description' => 'Request ID. Each request has a unique value, which facilitates troubleshooting later.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['title' => '', 'description' => 'error message', 'type' => 'string', 'example' => '”“'], + 'success' => ['title' => '', 'description' => 'true if the API call succeeded; false if the API call failed.', 'type' => 'boolean', 'example' => 'true 接口调用成功,false 接口调用失败'], + 'errorCode' => ['title' => '', 'description' => 'error code', 'type' => 'string', 'example' => '”“'], ], - 'required' => false, + 'example' => '', ], ], ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidCluster.NotFound', 'errorMessage' => 'No cluster is available to generate the workspace.', 'description' => 'No cluster is available to generate the workspace.'], + ['errorCode' => 'InvalidCodeUrl.NotSupportSVN', 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', 'description' => 'The parameter codeUrl is invalid. SVN is not supported.'], + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidResource.NotFound', 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', 'description' => 'No resource is found. You cannot create the workspace. Please try again later.'], + ['errorCode' => 'InvalidResourceRole.NotFoun', 'errorMessage' => 'The member role is invalid.', 'description' => 'The member role is invalid.'], + ['errorCode' => 'InvalidResourceRole.NotFound', 'errorMessage' => 'The member role is invalid.', 'description' => ''], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => 'The user that is invoking the API service is not a registered user.'], + ['errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', 'errorMessage' => 'Resource owner cannot be deleted.', 'description' => 'The resource owner cannot be deleted.'], + ['errorCode' => 'InvalidUser.ResourceMemberNotExists', 'errorMessage' => 'The resource member does not exist.', 'description' => 'The resource member does not exist.'], + ['errorCode' => 'InvalidUser.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization.', 'description' => '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.', 'description' => 'The workspace status is invalid. You can only operate workspaces with the SUCCESS status.'], + ['errorCode' => 'InvalidWorkspaceTemplate.NotFound', 'errorMessage' => 'The parameter workspaceTemplate is not found.', 'description' => 'The parameter workspaceTemplate is not found.'], + ], + 403 => [ + ['errorCode' => 'Forbidden.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], + ['errorCode' => 'InvalidPipeline.NotFound', 'errorMessage' => 'The pipeline is not found.', 'description' => 'The pipeline does not exist.'], + ['errorCode' => 'InvalidPipelineRun.NotFound', 'errorMessage' => 'The pipeline execution instance is not found.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'InvalidWorkspace.NotFound', 'errorMessage' => 'The workspace is not found.', 'description' => 'The workspace is not found.'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\"\\n}","type":"json"}]', + 'title' => 'Stop Machine Deployment', + 'changeSet' => [ + ['createdAt' => '2021-11-25T13:20:39.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopVMDeployOrder'], + ], + ], + 'ramActions' => [], + ], + 'TransferRepository' => [ + 'summary' => 'You can transfer a repository to a group using a full path for both `groupId` and `repositoryId`.', + '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' => 'The organization ID. You can find this ID in the URL of Alibaba Cloud DevOps, for example, `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => ['description' => 'The personal access token. This parameter is optional if you authenticate by using an AccessKey pair or temporary credentials from the Security Token Service (STS).', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], + ], + [ + 'name' => 'repositoryId', + 'in' => 'query', + 'schema' => ['description' => 'The ID or full path of the repository.', 'type' => 'string', 'required' => true, 'example' => '2080972 或 orgId/test-group-1/test-repo', 'title' => ''], + ], + [ + 'name' => 'groupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID or full path of the target group.', 'type' => 'string', 'required' => true, 'example' => '34839 或 orgId/transfer-group', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The schema of the 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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorCode' => ['description' => 'The error code returned on failure.', 'type' => 'string', 'example' => 'Openapi.RequestError', 'title' => ''], + 'errorMessage' => ['description' => 'The error message returned on failure.', 'type' => 'string', 'example' => '”“', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], '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', - ], - ], + 'description' => 'Contains details of the transferred repository.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The ID of the repository.', 'type' => 'integer', 'format' => 'int64', 'example' => '19285', 'title' => ''], + 'path' => ['description' => 'The path of the repository.', 'type' => 'string', 'example' => 'test-repo', 'title' => ''], + 'name' => ['description' => 'The name of the repository.', 'type' => 'string', 'example' => 'test-repo', 'title' => ''], + 'description' => ['description' => 'The description of the repository.', 'type' => 'string', 'example' => '描述信息的具体内容'."\n", 'title' => ''], + 'pathWithNamespace' => ['description' => 'The full path of the repository, including the namespace.', 'type' => 'string', 'example' => 'codeup-test-org/test-create-codeup', 'title' => ''], + 'nameWithNamespace' => ['description' => 'The full name of the repository, including the namespace.', 'type' => 'string', 'example' => 'codeup-test-org / test-create-group (斜杠两侧有空格)', 'title' => ''], + 'visibilityLevel' => ['description' => 'The visibility level of the repository. Valid values:'."\n" + ."\n" + .'- `0`: private. Visible only to repository members.'."\n" + ."\n" + .'- `10`: internal. Visible to all members of the enterprise.'."\n" + ."\n" + .'- `20`: public. Visible to everyone.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'lastActivityAt' => ['description' => 'Timestamp of the last repository activity.', 'type' => 'string', 'example' => '2022-01-14T21:08:26+08:00', 'title' => ''], + 'starCount' => ['description' => 'The number of stars the repository has received.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'webUrl' => ['description' => 'The web URL of the repository.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'starred' => ['description' => 'Indicates if the current user has starred the repository.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'namespaceId' => ['description' => 'The ID of the namespace to which the repository belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '100003', 'title' => ''], + 'accessLevel' => ['description' => 'The access level of the current user for the repository. Valid values:'."\n" + ."\n" + .'- `20`: reporter'."\n" + ."\n" + .'- `30`: developer'."\n" + ."\n" + .'- `40`: maintainer', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'demoProject' => ['description' => 'Indicates whether the repository is a demo project.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'createdAt' => ['description' => 'Timestamp of the repository\'s creation.', 'type' => 'string', 'example' => '2022-01-14T21:08:26+08:00', 'title' => ''], + 'updatedAt' => ['description' => 'Timestamp of the repository\'s last update.', 'type' => 'string', 'example' => '2022-01-14T21:08:26+08:00', 'title' => ''], + 'archived' => ['description' => 'Indicates whether the repository is archived.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'creatorId' => ['description' => 'The ID of the repository\'s creator.', 'type' => 'integer', 'format' => 'int64', 'example' => '19238', 'title' => ''], + 'encrypted' => ['description' => 'Indicates whether the repository is encrypted.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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"}]', + 'title' => 'Transfer Code Repository', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TransferRepository'], + ], ], - '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"}]', + 'ramActions' => [], ], - 'ExportInsightWorkitemVersion' => [ - 'summary' => '导出Insight workitem_version表数据', - 'path' => '/organization/{organizationId}/data/workitemVersions', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'TriggerRepositoryMirrorSync' => [ + 'summary' => 'Trigger synchronization of a Codeup repository from a remote source after importing it from another platform.', + 'path' => '/repository/{repositoryId}/mirror', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], + 'systemTags' => [], 'parameters' => [ [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Personal access token. '."\n" + .'This field is not required when using Alibaba Cloud AccessKey (AK) and SecretKey (SK) or Security Token Service (STS) temporary authorization.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513'."\n"], + ], + [ 'name' => 'organizationId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, such as https://devops.aliyun.com/organization/', 'type' => 'string', 'required' => true, 'example' => '60de7a6852743a5162b5f957'], + ], + [ + 'name' => 'repositoryId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '61db9af2148974246bexxxx', - ], + 'schema' => ['title' => '', 'description' => 'Code repository ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '100'], ], [ - '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, - ], + 'name' => 'account', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Clone account for remote synchronization repository', 'type' => 'string', 'required' => false, 'example' => 'test-account'], + ], + [ + 'name' => 'token', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Remote synchronization repository clone token ', 'type' => 'string', 'required' => false, 'example' => 'asd12e44827fe2444f952e931e51xxxx'], ], ], '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', - ], + 'errorMessage' => ['title' => '', 'description' => 'error message', 'type' => 'string', 'example' => '企业不存在'], + 'requestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '37294673-00CA-5B8B-914F-A8B35511E90A'], + 'success' => ['title' => '', 'description' => 'Request Result', 'type' => 'boolean', 'example' => 'true'], + 'errorCode' => ['title' => '', 'description' => 'error code', 'type' => 'string', 'example' => 'SYSTEM_ILLEGAL_ARGUMENT_ERROR'], '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', - ], - ], + 'title' => '', + 'description' => 'Response Result', + 'type' => 'object', + 'properties' => [ + 'result' => ['title' => '', 'description' => 'Repository synchronization trigger result', 'type' => 'boolean', 'example' => 'true'], ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Openapi.RequestError', 'errorMessage' => 'request error', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'Operate.NoPermission', 'errorMessage' => 'NoPermission', 'description' => 'You are not authorized to perform this operation.'], + ], + [ + ['errorCode' => 'InvalidWorkspace.NotFound', 'errorMessage' => 'The workspace is not found.', 'description' => 'The workspace is not found.'], + ], ], - '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', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Trigger Repository Synchronization', + 'changeSet' => [ + ['createdAt' => '2022-10-14T08:38:55.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-03-18T06:00:14.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TriggerRepositoryMirrorSync'], + ], ], + 'ramActions' => [], + ], + 'UpdateAppMember' => [ + 'summary' => 'Updates an application member.', + 'path' => '/appstack/apps/{appName}/members', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], + 'tags' => ['应用'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'organizationId', + 'in' => 'query', + 'schema' => ['description' => 'The organization ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '66c0c9fffeb86b450c199fcd', 'title' => ''], + ], + [ + 'name' => 'appName', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '61db9af2148974246bexxxx'."\n", - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'testApp', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', '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', + 'roleNames' => [ + 'title' => '', + 'description' => 'A list of roles to assign to the member.', + 'type' => 'array', + 'items' => [ + 'description' => 'The role name.', + 'enumValueTitles' => ['owner' => 'The owner role.', 'tester' => 'The tester role.', 'admin' => 'The admin role.', 'developer' => 'The developer role.', 'operator' => 'The operator role.'], + 'type' => 'string', + 'example' => 'developer', + 'required' => false, + 'title' => '', + ], 'required' => false, - 'example' => '1', + 'example' => '', ], - 'maxResults' => [ - 'title' => '最大结果条数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'player' => [ + 'title' => '', + 'description' => 'The member to update.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The member ID. If the member type is `User`, this is the member\'s Alibaba Cloud UID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '1332695887xxxxxx', 'title' => ''], + 'type' => ['description' => 'The member type. Currently, only `User` is supported.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'User', 'default' => 'User', 'title' => ''], + ], 'required' => false, - 'example' => '10', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], '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', - ], - ], - ], - ], - ], - ], + 'description' => '更新应用成员角色成功', + 'schema' => ['description' => 'A unique ID for the request that you can use for troubleshooting.', 'type' => 'string', 'example' => 'FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F', 'title' => ''], ], + 404 => ['description' => '应用角色未找到'], + 500 => ['description' => '服务端内部异常'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"\\"FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F\\"","type":"json"}]', + 'title' => 'Update application members.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAppMember'], + ], ], - '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"}]', + 'ramActions' => [], ], - 'ExportInsightWorkitemStatus' => [ - 'summary' => '导出Insight workitem_stauts表数据', - 'path' => '/organization/{organizationId}/data/workitemStatuses', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateApplication' => [ + 'summary' => 'Updates the owner of an application.', + 'path' => '/appstack/apps/{appName}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], + 'tags' => ['应用'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'organizationId', + 'in' => 'query', + 'schema' => ['description' => 'The organization ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '66c0c9fffeb86b450c199fcd', 'title' => ''], + ], + [ + 'name' => 'appName', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '61db9af2148974246bexxxx'."\n", - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'testApp', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', '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', - ], + 'ownerAccountId' => ['description' => 'The owner Alibaba Cloud UID.', 'type' => 'string', 'docRequired' => false, 'example' => '1332695887xxxxxx', 'title' => '', 'required' => false], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ + 'description' => '更新成功', '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', - ], - ], - ], - ], + 'creatorAccountId' => ['description' => 'The creator Alibaba Cloud UID.', 'type' => 'string', 'example' => '1332695887xxxxxx', 'title' => ''], + 'requestId' => ['description' => 'The unique ID of the request, used to troubleshoot issues.', 'type' => 'string', 'example' => 'FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F', 'title' => ''], + 'name' => ['description' => 'The application name.', 'type' => 'string', 'example' => 'testApp', 'title' => ''], + 'gmtCreate' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2024-01-01T00:00:00.000+00:00', 'title' => ''], + 'description' => ['description' => 'The application description.', 'type' => 'string', 'example' => '应用描述', 'title' => ''], ], + 'description' => 'The response object.', + 'title' => '', + 'example' => '', ], ], + 404 => ['description' => '未查找到指定的应用'], + 500 => ['description' => '服务端内部异常'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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"}]', + 'title' => 'Update Application', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateApplication'], + ], ], - '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"}]', + 'ramActions' => [], ], - 'ExportInsightWorkTime' => [ - 'summary' => '导出Insight work_time表数据', - 'path' => '/organization/{organizationId}/data/workTimes', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateCheckRun' => [ + 'summary' => 'Only the writer of a check run can update it.', + 'path' => '/api/v4/projects/check_runs/update_check_run', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'organizationId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '61db9af2148974246bexxxx', - ], + 'in' => 'query', + 'schema' => ['title' => 'A short description of struct', 'description' => 'The ID of the organization. You can obtain it from the URL of your Alibaba Cloud DevOps organization page, for example, `https://devops.aliyun.com/organization/{OrganizationId}`.', 'type' => 'string', 'required' => true, 'example' => '60de7a6852743a5162b5f957'], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => ['description' => 'The personal access token. This parameter is optional when authenticating with an AccessKey or STS temporary authorization.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], + ], + [ + 'name' => 'repositoryIdentity', + 'in' => 'query', + 'schema' => ['description' => 'The ID or full path of the repository.', 'type' => 'string', 'required' => true, 'example' => '2835387 或 codeup/codeup-demo', 'title' => ''], + ], + [ + 'name' => 'checkRunId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the check run.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2', 'title' => ''], ], [ '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', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The name of the check run.', 'type' => 'string', 'required' => false, 'example' => 'my-check-ci'."\n", 'title' => ''], + 'startedAt' => ['description' => 'The time when the check run started.'."\n" + ."\n" + .'> The time must be in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. For example, `2023-03-15T08:00:00Z`.', 'type' => 'string', 'required' => false, 'example' => '2023-03-15T08:00:00Z'."\n", 'title' => ''], + 'completedAt' => ['description' => 'The time when the check run completed.'."\n" + ."\n" + .'> The time must be in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. For example, `2023-03-15T08:00:00Z`.', 'type' => 'string', 'required' => false, 'example' => '2023-03-15T08:00:00Z'."\n", 'title' => ''], + 'externalId' => ['description' => 'The ID from an external system.'."\n" + ."\n" + .'> This ID comes from your external check system. You can specify any string as the ID, and the platform stores it as a string.', 'type' => 'string', 'required' => false, 'example' => '42', 'title' => ''], + 'detailsUrl' => ['description' => 'The URL of a page with more details about the check run. The platform will link to this URL.', 'type' => 'string', 'required' => false, 'example' => 'xx', 'title' => ''], + 'status' => ['description' => 'The current status of the check run. Valid values:'."\n" + ."\n" + .'- `queued`: The check run is queued.'."\n" + ."\n" + .'- `in_progress`: The check run is in progress.'."\n" + ."\n" + .'- `completed`: The check run is completed.', 'type' => 'string', 'required' => false, 'example' => 'completed', 'title' => ''], + 'conclusion' => ['description' => 'The final conclusion of the check run. This parameter is required if `status` is set to `completed`. Valid values:'."\n" + ."\n" + .'- `cancelled`: The check run was canceled.'."\n" + ."\n" + .'- `failure`: The check run failed.'."\n" + ."\n" + .'- `neutral`: The check run is neutral. This is treated as a success.'."\n" + ."\n" + .'- `success`: The check run succeeded.'."\n" + ."\n" + .'- `skipped`: The check run was skipped. This is treated as a success.'."\n" + ."\n" + .'- `timed_out`: The check run timed out.', 'type' => 'string', 'required' => false, 'example' => 'success', 'title' => ''], + 'output' => [ + 'description' => 'Contains output to display on the check run page.', + 'type' => 'object', + 'properties' => [ + 'title' => ['description' => 'The title of the UI module. This is different from the `name` parameter.', 'type' => 'string', 'required' => false, 'example' => 'Mighty Readme report', 'title' => ''], + 'summary' => ['description' => 'A short summary of the check run.'."\n" + ."\n" + .'> This field supports Markdown. The maximum length is 65,535 characters (64 KB).', 'type' => 'string', 'required' => true, 'example' => '摘要信息内容'."\n", 'title' => ''], + 'text' => ['description' => 'The detailed information about the check run.'."\n" + ."\n" + .'> This field supports Markdown. The maximum length is 65,535 characters (64 KB).', 'type' => 'string', 'required' => false, 'example' => '详情信息内容'."\n", 'title' => ''], + 'images' => [ + 'description' => 'A list of image objects to display in the output.'."\n" + ."\n" + .'> A check run can display images in the output module.', + 'type' => 'array', + 'items' => [ + 'description' => 'An object containing information for a single image.', + 'type' => 'object', + 'properties' => [ + 'alt' => ['description' => 'The alternative text for the image.', 'type' => 'string', 'required' => true, 'example' => 'test-image-alt'."\n", 'title' => ''], + 'imageUrl' => ['description' => 'The URL of the image. The URL must be publicly accessible, or the image will not be displayed.', 'type' => 'string', 'required' => true, 'example' => 'xxx', 'title' => ''], + 'caption' => ['description' => 'A short description of the image.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], 'required' => false, - 'example' => '1', + 'title' => '', + 'example' => '', ], - 'maxResults' => [ - 'title' => '最大结果条数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'annotations' => [ + 'description' => 'A list of annotations.'."\n" + ."\n" + .'> - You can display code quality results from third-party systems as annotations on the check run.'."\n" + .'>'."\n" + .'> - This field is append-only during updates. To avoid duplicates, do not resubmit existing annotations.', + 'type' => 'array', + 'items' => [ + 'description' => 'An object representing a single annotation.', + 'type' => 'object', + 'properties' => [ + 'path' => ['description' => 'The path of the file to which the annotation applies.', 'type' => 'string', 'required' => true, 'example' => 'demo/test.txt'."\n", 'title' => ''], + 'startLine' => ['description' => 'The start line of the annotation.'."\n" + ."\n" + .'> Line numbering starts at 1. Ensure the line number is valid for the specified file; otherwise, the annotation will not be displayed.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], + 'endLine' => ['description' => 'The end line of the annotation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2', 'title' => ''], + 'startColumn' => ['description' => 'The start column of the annotation.'."\n" + ."\n" + .'> This parameter is valid only when `startLine` is the same as `endLine`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3', 'title' => ''], + 'endColumn' => ['description' => 'The end column of the annotation.'."\n" + ."\n" + .'> This parameter is valid only when `startLine` is the same as `endLine`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5', 'title' => ''], + 'annotationLevel' => ['description' => 'The level of the annotation. Valid values:'."\n" + ."\n" + .'- `notice`: A minor issue.'."\n" + ."\n" + .'- `warning`: Warning.'."\n" + ."\n" + .'- `failure`: A severe issue.', 'type' => 'string', 'required' => true, 'example' => 'failure', 'title' => ''], + 'message' => ['description' => 'A short description of the annotation.', 'type' => 'string', 'required' => true, 'example' => '回写检查注释的简要描述信息'."\n", 'title' => ''], + 'title' => ['description' => 'The title of the annotation.', 'type' => 'string', 'required' => false, 'example' => '检查注释的标题', 'title' => ''], + 'rawDetails' => ['description' => 'Detailed information about the annotation, limited to 64 KB in size.', 'type' => 'string', 'required' => false, 'example' => '详情信息内容'."\n", 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => '10', + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -45333,226 +24581,213 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response schema.', '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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''], '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', + 'description' => 'The result.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The unique ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '524836', 'title' => ''], + 'createdAt' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2022-01-14T21:08:26+08:00'."\n", 'title' => ''], + 'updatedAt' => ['description' => 'The last update time.', 'type' => 'string', 'example' => '2022-01-14T21:08:26+08:00'."\n", 'title' => ''], + 'startedAt' => ['description' => 'The start time.', 'type' => 'string', 'example' => '2023-03-15T08:00:00Z'."\n", 'title' => ''], + 'completedAt' => ['description' => 'The completion time.', 'type' => 'string', 'example' => '2023-03-15T08:00:00Z'."\n", 'title' => ''], + 'externalId' => ['description' => 'The external system ID.', 'type' => 'string', 'example' => '42', 'title' => ''], + 'name' => ['description' => 'The name.', 'type' => 'string', 'example' => 'my-check-ci'."\n", 'title' => ''], + 'headSha' => ['description' => 'The commit ID.', 'type' => 'string', 'example' => '40f4ccfe019cdd4a62d4acb0c57130106fc7e1be'."\n", 'title' => ''], + 'status' => ['description' => 'The status. Valid values:'."\n" + ."\n" + .'- `queued`: In the queue.'."\n" + ."\n" + .'- `in_progress`: In progress.'."\n" + ."\n" + .'- `completed`: Completed.', 'type' => 'string', 'example' => 'completed', 'title' => ''], + 'conclusion' => ['description' => 'The conclusion. Valid values:'."\n" + ."\n" + .'- `cancelled`: Cancelled.'."\n" + ."\n" + .'- `failure`: Failed.'."\n" + ."\n" + .'- `neutral`: Neutral. This is considered a success.'."\n" + ."\n" + .'- `success`: Successful.'."\n" + ."\n" + .'- `skipped`: Skipped. This is considered a success.'."\n" + ."\n" + .'- `timed_out`: Timed out.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'detailsUrl' => ['description' => 'The details URL for the third-party system. The platform only provides redirection.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'checkSuite' => [ + 'description' => 'The check suite.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The unique ID of the check suite.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], - 'actualValue' => [ - 'title' => '工时拆分后的值', - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '120', + 'title' => '', + 'example' => '', + ], + 'writer' => [ + 'description' => 'The writer information.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The Alibaba Cloud account ID.', 'type' => 'string', 'example' => 'xxx'."\n", 'title' => ''], + 'type' => ['description' => 'The type of the writer. Valid values:'."\n" + ."\n" + .'- `User`: user.', 'type' => 'string', 'example' => 'User', 'title' => ''], + 'name' => ['description' => 'The name of the writer.', 'type' => 'string', 'example' => 'test-codeup'."\n", 'title' => ''], + 'slug' => ['description' => 'The alias.', 'type' => 'string', 'example' => 'test-codeup'."\n", 'title' => ''], + 'logoUrl' => ['description' => 'The avatar URL of the writer.', 'type' => 'string', 'example' => 'xxx'."\n", 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'output' => [ + 'description' => 'The information to display on the page.', + 'type' => 'object', + 'properties' => [ + 'title' => ['description' => 'The title of the UI module, which is different from the `name` parameter.', 'type' => 'string', 'example' => 'Mighty Readme report'."\n", 'title' => ''], + 'summary' => ['description' => 'The summary of the check run.'."\n" + ."\n" + .'> This field supports Markdown. The maximum length is 65,535 characters (64 KB).', 'type' => 'string', 'example' => '摘要信息内容'."\n", 'title' => ''], + 'text' => ['description' => 'The details.'."\n" + ."\n" + .'> This field supports Markdown. The maximum length is 65,535 characters (64 KB).', 'type' => 'string', 'example' => '详情信息内容', 'title' => ''], + 'images' => [ + 'description' => 'The image information.'."\n" + ."\n" + .'> A check run can display images in the output module.', + 'type' => 'array', + 'items' => [ + 'description' => 'The image information.', + 'type' => 'object', + 'properties' => [ + 'alt' => ['description' => 'The alt text.', 'type' => 'string', 'example' => 'test-image-alt'."\n", 'title' => ''], + 'imageUrl' => ['description' => 'The image URL. The URL must be accessible to display the image.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'caption' => ['description' => 'The image caption.', 'type' => 'string', 'example' => 'test'."\n", 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], ], - 'description' => [ - 'title' => '工时描述', - 'description' => '', - 'type' => 'string', + 'title' => '', + 'example' => '', + ], + 'annotations' => [ + 'description' => 'A list of annotations.'."\n" + ."\n" + .'> Third-party systems can provide code quality results. To display these results, use the API to add them to the check run as annotations.', + 'type' => 'array', + 'items' => [ + 'description' => 'An annotation.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The unique ID of the annotation.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'path' => ['description' => 'The file path.', 'type' => 'string', 'example' => 'demo/test.txt'."\n", 'title' => ''], + 'startLine' => ['description' => 'The start line of the annotation.'."\n" + ."\n" + .'> The line number is 1-based. It must be a valid line number in the file. Otherwise, the annotation is not displayed.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'endLine' => ['description' => 'The end line of the annotation.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'startColumn' => ['description' => 'The start column of the annotation.'."\n" + ."\n" + .'> This parameter is valid only when `startLine` and `endLine` have the same value.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'endColumn' => ['description' => 'The end column of the annotation.'."\n" + ."\n" + .'> This parameter is valid only when `startLine` and `endLine` have the same value.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], + 'annotationLevel' => ['description' => 'The level of the annotation. Valid values:'."\n" + ."\n" + .'- `notice`: notice'."\n" + ."\n" + .'- `warning`: warning'."\n" + ."\n" + .'- `failure`: failure', 'type' => 'string', 'example' => 'warning', 'title' => ''], + 'message' => ['description' => 'The brief description.', 'type' => 'string', 'example' => '回写检查注释的简要描述信息'."\n", 'title' => ''], + 'title' => ['description' => 'The title of the annotation.', 'type' => 'string', 'example' => '检查注释的标题'."\n", 'title' => ''], + 'rawDetails' => ['description' => 'The details, limited to 64 KB in size.', 'type' => 'string', 'example' => '详情信息'."\n", 'title' => ''], + ], + 'title' => '', 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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"}]', + 'title' => 'Update check run ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCheckRun'], + ], ], - '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"}]', + 'ramActions' => [], ], - 'ExportInsightTagRef' => [ - 'summary' => '导出Insight tag_ref表数据', - 'path' => '/organization/{organizationId}/data/tagRefs', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateFile' => [ + 'summary' => 'Modify a file in the code repository.', + 'path' => '/repository/{repositoryId}/files/update', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'organizationId', + 'in' => 'query', + 'schema' => ['title' => 'A short description of struct', 'description' => 'Organization identity, also known as organization ID, in string format. You can obtain it from the Alibaba Cloud DevOps access link, for example: https://devops.aliyun.com/organization/【OrganizationId】', 'type' => 'string', 'required' => true, 'example' => '60de7a6852743a5162b5f957'], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => ['description' => 'Personal access token. '."\n" + .'This field is not required if you use an Alibaba Cloud AccessKey pair (AK+SK) or temporary authorization via Security Token Service (STS).', 'type' => 'string', 'required' => false, 'example' => '0cf2c8458ac44d9481aab2dd6ec10596v3'."\n", 'title' => ''], + ], + [ + 'name' => 'repositoryId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '61db9af2148974246bexxxx', - ], + 'schema' => ['description' => 'Code repository ID', 'type' => 'string', 'required' => true, 'example' => '2813489', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Request Body', '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', - ], + 'oldPath' => ['description' => 'Old File Path ', 'type' => 'string', 'required' => true, 'example' => 'src/main/update.txt', 'title' => ''], + 'newPath' => ['description' => 'New File Path ', 'type' => 'string', 'required' => true, 'example' => 'src/main/update.txt', 'title' => ''], + 'branchName' => ['description' => 'Branch name', 'type' => 'string', 'required' => true, 'example' => 'master', 'title' => ''], + 'encoding' => ['description' => 'Codec '."\n" + .'Optional: text / base64. Default Value is text. ', 'type' => 'string', 'required' => false, 'example' => 'text', 'title' => ''], + 'content' => ['description' => 'File Content ', 'type' => 'string', 'required' => true, 'example' => '修改文件的内容', 'title' => ''], + 'commitMessage' => ['description' => 'Commit message when updating the file', 'type' => 'string', 'required' => true, 'example' => '修改update.txt文件内容', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -45563,180 +24798,175 @@ '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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => 'C2F153F6-BB43-50C4-9F4F-40593203E19A'], + 'errorMessage' => ['description' => 'Error message', 'type' => 'string', 'example' => '""', 'title' => ''], + 'errorCode' => ['description' => 'Error code', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'success' => ['description' => 'Indicates whether the invocation succeeded', 'type' => 'boolean', 'example' => 'true', 'title' => ''], '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', - ], - ], + 'description' => 'Return Result', + 'type' => 'object', + 'properties' => [ + 'branchName' => ['description' => 'Branch Name', 'type' => 'string', 'example' => 'master', 'title' => ''], + 'filePath' => ['description' => 'File Path', 'type' => 'string', 'example' => 'src/main/update.txt', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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', + '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.', 'description' => ''], + ['errorCode' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], + ], ], - 'schemes' => [ - 'https', + '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"}]', + 'title' => 'Modify File', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateFile'], + ], ], + 'ramActions' => [], + ], + 'UpdateFlowTag' => [ + 'summary' => 'Update a tag.', + 'path' => '/organization/{organizationId}/flow/tags/{id}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, such as https://devops.aliyun.com/organization/【OrganizationId】.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], + ], + [ + 'name' => 'id', + 'in' => 'path', + 'schema' => ['description' => 'Tag ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1111', 'title' => ''], + ], + [ + 'name' => 'color', + 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => '- \\#1F9AEF Blue '."\n" + .'- \\#E63A3A Red '."\n" + .'- \\#FA8C15 Yellow '."\n" + .'- \\#15AD31 Green '."\n" + .'- \\#7978E5 Purple '."\n" + .'- \\#8C8C8C Gray', 'type' => 'string', 'required' => true, - 'example' => '61db9af2148974246bexxxx', + 'example' => '#1F9AEF', + 'enum' => ['#1F9AEF', '#E63A3A', '#FA8C15', '#15AD31', '#7978E5', '#8C8C8C'], + 'title' => '', ], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'flowTagGroupId', + 'in' => 'query', + 'schema' => ['description' => 'Tag categorization ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11', 'title' => ''], + ], + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => ['description' => 'Tag Name', 'type' => 'string', 'required' => true, 'example' => '标签名称', 'maxLength' => 20, 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', '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', - ], + 'requestId' => ['title' => '', 'description' => 'Request ID. Each request has a unique value, which facilitates troubleshooting later.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['title' => '', 'description' => 'error message', 'type' => 'string', 'example' => '”“'], + 'success' => ['title' => '', 'description' => 'true indicates that the API call succeeded; false indicates that the API call failed.', 'type' => 'boolean', 'example' => 'true 接口调用成功,false 接口调用失败'], + 'errorCode' => ['title' => '', 'description' => 'error code', 'type' => 'string', 'example' => '”“'], ], - 'required' => false, + 'example' => '', ], ], ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidCodeUrl.NotSupportSVN', 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', 'description' => 'The parameter codeUrl is invalid. SVN is not supported.'], + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidResource.NotFound', 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', 'description' => 'No resource is found. You cannot create the workspace. Please try again later.'], + ['errorCode' => 'InvalidResourceRole.NotFoun', 'errorMessage' => 'The member role is invalid.', 'description' => 'The member role is invalid.'], + ['errorCode' => 'InvalidResourceRole.NotFound', 'errorMessage' => 'The member role is invalid.', 'description' => ''], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => 'The user that is invoking the API service is not a registered user.'], + ['errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', 'errorMessage' => 'Resource owner cannot be deleted.', 'description' => 'The resource owner cannot be deleted.'], + ['errorCode' => 'InvalidUser.ResourceMemberNotExists', 'errorMessage' => 'The resource member does not exist.', 'description' => 'The resource member does not exist.'], + ['errorCode' => 'InvalidUser.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization.', 'description' => 'The user is not in the organization.'], + ], + 403 => [ + ['errorCode' => 'Forbidden.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidIdentifier.NotFound', 'errorMessage' => 'space id is error or not exist.', 'description' => ''], + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], + ['errorCode' => 'InvalidPipeline.NotFound', 'errorMessage' => 'The pipeline is not found.', 'description' => 'The pipeline does not exist.'], + ['errorCode' => 'InvalidPipelineRun.NotFound', 'errorMessage' => 'The pipeline execution instance is not found.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'InvalidWorkspace.NotFound', 'errorMessage' => 'The workspace is not found.', 'description' => 'The workspace is not found.'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\"\\n}","type":"json"}]', + 'title' => 'Update a tag', + 'changeSet' => [ + ['createdAt' => '2021-12-15T03:07:17.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateFlowTag'], + ], + ], + 'ramActions' => [], + ], + 'UpdateFlowTagGroup' => [ + 'summary' => 'Update tag categorization.', + 'path' => '/organization/{organizationId}/flow/tagGroups/{id}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'Enterprise identity, also known as enterprise ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, such as https://devops.aliyun.com/organization/【OrganizationId】.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], + ], + [ + 'name' => 'id', + 'in' => 'path', + 'schema' => ['description' => 'Tag categorization ID', 'type' => 'string', 'required' => true, 'example' => '111', 'title' => ''], + ], + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => ['description' => 'Tag categorization name', 'type' => 'string', 'required' => true, 'example' => '标签分类名称', 'maxLength' => 20, 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ @@ -45744,213 +24974,103 @@ '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', - ], - ], - ], - ], + 'requestId' => ['title' => '', 'description' => 'Request ID. Each request has a unique value, which facilitates troubleshooting later.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['title' => '', 'description' => 'error message', 'type' => 'string', 'example' => '”“'], + 'success' => ['title' => '', 'description' => 'true if the API call succeeded; false if the API call failed.', 'type' => 'boolean', 'example' => 'true 接口调用成功,false 接口调用失败'], + 'errorCode' => ['title' => '', 'description' => 'error code', 'type' => 'string', 'example' => '”“'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidCluster.NotFound', 'errorMessage' => 'No cluster is available to generate the workspace.', 'description' => 'No cluster is available to generate the workspace.'], + ['errorCode' => 'InvalidCodeUrl.NotSupportSVN', 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', 'description' => 'The parameter codeUrl is invalid. SVN is not supported.'], + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidResource.NotFound', 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', 'description' => 'No resource is found. You cannot create the workspace. Please try again later.'], + ['errorCode' => 'InvalidResourceRole.NotFoun', 'errorMessage' => 'The member role is invalid.', 'description' => 'The member role is invalid.'], + ['errorCode' => 'InvalidResourceRole.NotFound', 'errorMessage' => 'The member role is invalid.', 'description' => ''], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => 'The user that is invoking the API service is not a registered user.'], + ['errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', 'errorMessage' => 'Resource owner cannot be deleted.', 'description' => 'The resource owner cannot be deleted.'], + ['errorCode' => 'InvalidUser.ResourceMemberNotExists', 'errorMessage' => 'The resource member does not exist.', 'description' => 'The resource member does not exist.'], + ['errorCode' => 'InvalidUser.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization.', 'description' => '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.', 'description' => 'The workspace status is invalid. You can only operate workspaces with the SUCCESS status.'], + ['errorCode' => 'InvalidWorkspaceTemplate.NotFound', 'errorMessage' => 'The parameter workspaceTemplate is not found.', 'description' => 'The parameter workspaceTemplate is not found.'], + ], + 403 => [ + ['errorCode' => 'Forbidden.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], + ['errorCode' => 'InvalidPipeline.NotFound', 'errorMessage' => 'The pipeline is not found.', 'description' => 'The pipeline does not exist.'], + ['errorCode' => 'InvalidPipelineRun.NotFound', 'errorMessage' => 'The pipeline execution instance is not found.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'InvalidWorkspace.NotFound', 'errorMessage' => 'The workspace is not found.', 'description' => 'The workspace is not found.'], + ], ], - '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', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\"\\n}","type":"json"}]', + 'title' => 'Update tag categorization', + 'changeSet' => [ + ['createdAt' => '2021-12-15T03:07:17.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateFlowTagGroup'], + ], ], + 'ramActions' => [], + ], + 'UpdateGroup' => [ + 'summary' => 'Updates a single group, identified by its `pathWithNamespace`.', + 'path' => '/groups/modify', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'organizationId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '61db9af2148974246bexxxx', - ], + 'in' => 'query', + 'schema' => ['title' => 'A short description of struct', 'description' => 'The ID of the organization. You can get this ID from your Alibaba Cloud DevOps organization URL, for example, https\\://devops.aliyun.com/organization/{OrganizationId}.', 'type' => 'string', 'required' => true, 'example' => '1e9903d8b3f1xxxxxf9286ef5'], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => ['description' => 'A personal access token. This parameter is optional if you authenticate with an Alibaba Cloud AccessKey pair (AK/SK) or STS temporary authorization.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61dxxxxxxx975a93f9129d2513', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', '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', - ], + 'pathWithNamespace' => ['description' => 'The full path of the group, including its namespace.', 'type' => 'string', 'required' => true, 'example' => 'org/group/subgroup/here', 'title' => ''], + 'name' => ['description' => 'The name of the group.', 'type' => 'string', 'required' => true, 'example' => 'codeup_group', 'title' => ''], + 'path' => ['description' => 'The path of the group.', 'type' => 'string', 'required' => true, 'example' => 'codeup_group', 'title' => ''], + 'visibilityLevel' => ['description' => 'The visibility level of the group.'."\n" + ."\n" + .'- 0: private'."\n" + ."\n" + .'- 10: internal', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + 'description' => ['description' => 'The description of the group.', 'type' => 'string', 'required' => false, 'example' => '描述信息的具体内容', 'title' => ''], + 'avatarUrl' => ['description' => 'The URL of the group\'s avatar.', 'type' => 'string', 'required' => false, 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', 'title' => ''], ], - 'required' => false, + 'required' => true, + 'title' => '', + 'example' => '', ], ], ], @@ -45958,186 +25078,114 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The schema of the response body.', '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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'InvalidParam.NoPermission', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], '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', - ], - ], + 'description' => 'The detailed response.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The primary key ID of the code group.', 'type' => 'integer', 'format' => 'int64', 'example' => '30815', 'title' => ''], + 'pathWithNamespace' => ['description' => 'The full path of the code group, including the parent path.', 'type' => 'string', 'example' => 'codeup-test-org/test-codeup', 'title' => ''], + 'nameWithNamespace' => ['description' => 'The full name of the code group, including the parent path.', 'type' => 'string', 'example' => 'codeup-test-org / codeup(斜杠两侧有空格)', 'title' => ''], + 'name' => ['description' => 'The name of the code group.', 'type' => 'string', 'example' => 'codeup', 'title' => ''], + 'path' => ['description' => 'The path of the code group.', 'type' => 'string', 'example' => 'test-codeup', 'title' => ''], + 'ownerId' => ['description' => 'The owner ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '19230', 'title' => ''], + 'parentId' => ['description' => 'The ID of the parent group.', 'type' => 'integer', 'format' => 'int64', 'example' => '26842', 'title' => ''], + 'description' => ['description' => 'The description of the code group.', 'type' => 'string', 'example' => '描述信息的具体内容', 'title' => ''], + 'avatarUrl' => ['description' => 'The URL of the code group\'s avatar.', 'type' => 'string', 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c4ef67f1bea827c4/w/100/h/100', 'title' => ''], + 'webUrl' => ['description' => 'The web URL for the code group.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'type' => ['description' => 'The resource type. The default is Group.', 'type' => 'string', 'example' => 'Group', 'title' => ''], + 'visibilityLevel' => ['description' => 'The visibility of the code group.'."\n" + ."\n" + .'- 0: private'."\n" + ."\n" + .'- 10: enterprise', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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', + '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.', 'description' => ''], + ], ], - 'schemes' => [ - 'https', + '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"}]', + 'title' => 'Update code group information ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateGroup'], + ], ], + 'ramActions' => [], + ], + 'UpdateGroupMember' => [ + 'summary' => 'Modifies the access level of a group member.', + 'path' => '/repository/groups/{groupId}/members/update/aliyun_pk', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'organizationId', + 'in' => 'query', + 'schema' => ['title' => 'A short description of struct', 'description' => 'The organization ID. You can obtain this ID from the URL of your organization\'s page on Alibaba Cloud DevOps. The URL is in the format of `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'required' => true, 'example' => '632bbfdf419338aaa2b1360a'], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => ['description' => 'The personal access token. This parameter is not required if you use an Alibaba Cloud AccessKey pair or STS temporary authorization for authentication.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], + ], + [ + 'name' => 'groupId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '61db9af2148974246bexxxx'."\n", - ], + 'schema' => ['description' => 'The ID of the code group.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '22901', 'title' => ''], + ], + [ + 'name' => 'aliyunPk', + 'in' => 'query', + 'schema' => ['description' => 'The Alibaba Cloud account ID of the group member.', 'type' => 'string', 'required' => true, 'example' => '1789095186553536', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', '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', - ], + 'accessLevel' => ['description' => 'The access level of the group member.'."\n" + ."\n" + .'- `20`: Reporter'."\n" + ."\n" + .'- `30`: Developer'."\n" + ."\n" + .'- `40`: Maintainer', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '30', 'title' => ''], + 'memberType' => ['description' => 'The member type. The value must be `USERS`.', 'type' => 'string', 'required' => false, 'example' => 'USERS', 'title' => ''], ], - 'required' => false, + 'required' => true, + 'title' => '', + 'example' => '', ], ], ], @@ -46145,204 +25193,141 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response schema.', '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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], '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', - ], - ], + 'description' => 'The details of the updated group member.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The ID of the user in Codeup.', 'type' => 'integer', 'format' => 'int64', 'example' => '24661', 'title' => ''], + 'name' => ['description' => 'The display name of the user.', 'type' => 'string', 'example' => 'codeup', 'title' => ''], + 'username' => ['description' => 'The unique username of the user.', 'type' => 'string', 'example' => 'test-codeup', 'title' => ''], + 'state' => ['description' => 'The state of the user. Valid values are `active` and `blocked`.', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'avatarUrl' => ['description' => 'The URL of the user\'s avatar.', 'type' => 'string', 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', 'title' => ''], + 'email' => ['description' => 'The email address of the user.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + 'accessLevel' => ['description' => 'The access level of the group member. Valid values: `20` (Reporter), `30` (Developer), and `40` (Maintainer).', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'memberType' => ['description' => 'The member type. The value is `USERS`.', 'type' => 'string', 'example' => 'USERS', 'title' => ''], + 'sourceId' => ['description' => 'The ID of the code group.', 'type' => 'integer', 'format' => 'int64', 'example' => '223241', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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', + '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\\": \\"username@example.com\\",\\n \\"accessLevel\\": 30,\\n \\"memberType\\": \\"USERS\\",\\n \\"sourceId\\": 223241\\n }\\n}","type":"json"}]', + 'title' => 'Modify group member ', + 'changeSet' => [ + ['createdAt' => '2023-07-24T06:14:50.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateGroupMember'], + ], ], + 'ramActions' => [], + ], + 'UpdateHostGroup' => [ + 'summary' => 'You can update a host group.', + 'path' => '/organization/{organizationId}/hostGroups/{id}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURErdcI0DEJM'], ], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'path', + 'schema' => ['description' => 'Organization identifier, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access URL, for example: https://devops.aliyun.com/organization/【OrganizationId】', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx', 'title' => ''], + ], + [ + 'name' => 'type', + 'in' => 'formData', 'schema' => [ - 'description' => '', + 'description' => 'Currently supports only ECS ', 'type' => 'string', 'required' => true, - 'example' => '61db9af2148974246bexxxx'."\n", + 'example' => 'ECS', + 'enum' => ['ECS'], + 'title' => '', ], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'envId', + 'in' => 'formData', + 'schema' => ['description' => 'Environment ID', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'name', + 'in' => 'formData', + 'schema' => ['description' => 'Host group name', 'type' => 'string', 'required' => true, 'example' => '主机组', 'title' => ''], + ], + [ + 'name' => 'serviceConnectionId', + 'in' => 'formData', + 'schema' => ['description' => 'Service connection ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123', 'title' => ''], + ], + [ + 'name' => 'tagIds', + 'in' => 'formData', + 'schema' => ['description' => 'Tag IDs, separated by commas if multiple', 'type' => 'string', 'required' => false, 'example' => '12,23', 'title' => ''], + ], + [ + 'name' => 'ecsType', + 'in' => 'formData', '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', - ], - ], + 'description' => 'Currently supports only ECS_ALIYUN ', + 'type' => 'string', 'required' => false, + 'example' => 'ECS_ALIYUN', + 'enum' => ['ECS_ALIYUN'], + 'title' => '', ], ], + [ + 'name' => 'ecsLabelKey', + 'in' => 'formData', + 'schema' => ['description' => 'ECS label key', 'type' => 'string', 'required' => false, 'example' => 'ecs', 'title' => ''], + ], + [ + 'name' => 'ecsLabelValue', + 'in' => 'formData', + 'schema' => ['description' => 'ECS label value', 'type' => 'string', 'required' => false, 'example' => 'ecs', 'title' => ''], + ], + [ + 'name' => 'aliyunRegion', + 'in' => 'formData', + 'schema' => ['description' => 'Alibaba Cloud region ', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'machineInfos', + 'in' => 'formData', + 'schema' => ['description' => 'Machine information: aliyunRegionId is the Alibaba Cloud region where the machine resides; machineSn is the machine\'s serial number; instanceName is the hostname; ip is the host IP address.', 'type' => 'string', 'required' => false, 'example' => '[{"aliyunRegionId":"cn-beijing","machineSn":"i-sssssss","instanceName":"ceshi","ip":"120.0.0.0"}]', 'title' => ''], + ], + [ + 'name' => 'id', + 'in' => 'path', + 'schema' => ['description' => 'Host group ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123', 'title' => ''], + ], ], 'responses' => [ 200 => [ @@ -46351,214 +25336,87 @@ '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', - ], - ], - ], - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID. Each request has a unique value, which facilitates troubleshooting later.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['description' => 'error message', 'type' => 'string', 'example' => '”“', 'title' => ''], + 'errorCode' => ['description' => 'error code', 'type' => 'string', 'example' => '""', 'title' => ''], + 'success' => ['description' => 'true indicates the invocation succeeded; false indicates the invocation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - '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', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => '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.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], + ], ], - 'schemes' => [ - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true\\n}","type":"json"}]', + 'title' => 'Update Host Group', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateHostGroup'], + ], ], + 'ramActions' => [], + ], + 'UpdateMergeRequest' => [ + 'summary' => 'This API only supports updating the title and description of a merge request.', + 'path' => '/api/v4/projects/{repositoryId}/merge_requests/{localId}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'organizationId', + 'in' => 'query', + 'schema' => ['title' => 'A short description of struct', 'description' => 'The ID of the organization. You can find the organization ID in the URL of the organization\'s page on Alibaba Cloud DevOps, such as `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => ['title' => 'A short description of struct', 'description' => 'The personal access token. This parameter is not required if you use an Alibaba Cloud AccessKey pair or Security Token Service (STS).', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513'], + ], + [ + 'name' => 'repositoryId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '61db9af2148974246bexxxx'."\n", - ], + 'schema' => ['description' => 'The ID of the repository.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '889910', 'title' => ''], + ], + [ + 'name' => 'localId', + 'in' => 'path', + 'schema' => ['description' => 'The local ID of the merge request, which is a sequential ID unique within a repository.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', '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', - ], + 'title' => ['description' => 'The new title of the merge request.', 'type' => 'string', 'required' => false, 'example' => 'test-更新标题', 'title' => ''], + 'description' => ['description' => 'The new description of the merge request.', 'type' => 'string', 'required' => false, 'example' => 'test-描述信息', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -46566,193 +25424,104 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response schema.', '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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9'], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], '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', - ], - ], + 'description' => 'The result of the operation.', + 'type' => 'object', + 'properties' => [ + 'result' => ['description' => 'Indicates whether the update was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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"}]', + 'title' => 'Update Merge Request', + 'description' => 'This API is available only if your organization has the new merge request feature enabled. To verify this, check if your merge request page uses the new interface.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateMergeRequest'], + ], ], - '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"}]', + 'ramActions' => [], ], - 'ExportInsightCustomValue' => [ - 'summary' => '导出Insight custom_value表', - 'path' => '/organization/{organizationId}/data/customValues', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateMergeRequestPersonnel' => [ + 'summary' => 'Updates the personnel, such as reviewers or subscribers, for a merge request.', + 'path' => '/api/v4/projects/{repositoryId}/merge_requests/{localId}/person/{personType}', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'organizationId', + 'in' => 'query', + 'schema' => ['title' => 'A short description of struct', 'description' => 'The ID of the organization. You can find the organization ID in the URL for your organization\'s homepage on Alibaba Cloud DevOps, which is structured as `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => ['title' => 'A short description of struct', 'description' => 'The access token. This parameter is not required if you use an Alibaba Cloud AccessKey pair or Security Token Service (STS) for authentication.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513'], + ], + [ + 'name' => 'repositoryId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '61db9af2148974246bexxxx'."\n", - ], + 'schema' => ['description' => 'The ID of the repository.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1233456', 'title' => ''], + ], + [ + 'name' => 'localId', + 'in' => 'path', + 'schema' => ['description' => 'The local ID of the merge request. This ID is unique within the repository.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'personType', + 'in' => 'path', + 'schema' => ['description' => 'The type of personnel.'."\n" + ."\n" + .'- `REVIEWER`: A reviewer.'."\n" + ."\n" + .'- `SUBSCRIBER`: A subscriber.', 'type' => 'string', 'required' => true, 'example' => 'REVIEWER', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', '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', + 'newUserIdList' => [ + 'description' => 'An array of Alibaba Cloud account IDs to set as the specified personnel type.', + 'type' => 'array', + 'items' => ['description' => 'An Alibaba Cloud account ID.', 'type' => 'string', 'required' => false, 'example' => '249286812078239123', 'title' => ''], 'required' => false, - 'example' => '10', + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -46760,283 +25529,132 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', '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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '4D6AF7CC-B43B-5454-86AB-023D25E44868'], + 'errorMessage' => ['description' => 'The returned error message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'errorCode' => ['description' => 'The returned error code.', 'type' => 'string', 'example' => 'Openapi.RequestError', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], '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', - ], - ], + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'result' => ['description' => 'Indicates whether the personnel were updated successfully.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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"}]', + 'title' => 'Update stakeholders of a merge request', + 'description' => 'This API applies only to organizations using the new version of merge requests. To confirm your version, check the merge request page for your organization.', + 'changeSet' => [ + ['createdAt' => '2023-08-18T05:52:40.000Z', 'description' => 'Request parameters changed'], ], - '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"}]', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateMergeRequestPersonnel'], + ], + ], + 'ramActions' => [], ], 'UpdateOrganizationMember' => [ - 'summary' => '当前用户加入的企业列表', + 'summary' => 'Updates the details of a specified organization member.', 'path' => '/organization/{organizationId}/members/{accountId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => false, - 'notSupportAutoTestReason' => '数据面 api 经安全评估统一不做处理,后续逐步安排下线', - 'tenantRelevance' => 'tenant', - ], + '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', - ], + 'schema' => ['description' => 'The ID of the organization.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx', 'title' => ''], ], [ 'name' => 'accountId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '243721251830762xxx', - ], + 'schema' => ['description' => 'The ID of the member\'s Alibaba Cloud account.', 'type' => 'string', 'required' => true, 'example' => '243721251830762xxx', 'title' => ''], ], [ 'name' => 'organizationMemberName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], + 'schema' => ['description' => 'The new display name for the member.', 'type' => 'string', 'required' => true, 'example' => '名字1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ApiGenericResult', - 'description' => '', + 'description' => 'The response information.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9', - ], - 'errorCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => '""', - ], - 'errorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => '""', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9', 'title' => ''], + 'errorCode' => ['description' => 'The error code. Empty if the request is successful.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'errorMessage' => ['description' => 'The error message. Empty if the request is successful.', 'type' => 'string', 'example' => '""', 'title' => ''], 'member' => [ - 'description' => '', + 'description' => 'An object that contains the updated member\'s details.', 'type' => 'object', 'properties' => [ - 'accountId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '292035769476261xxx', - ], - 'organizationMemberName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], + 'accountId' => ['description' => 'The ID of the member\'s Alibaba Cloud account.', 'type' => 'string', 'example' => '292035769476261xxx', 'title' => ''], + 'organizationMemberName' => ['description' => 'The display name of the member.', 'type' => 'string', 'example' => '名字1', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'success' => ['description' => 'Indicates whether the request succeeded.'."\n" + ."\n" + .'- `true`: The request succeeded.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], '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.', - ], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => 'The user that is invoking the API service is not a registered user.'], + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], ], 403 => [ - [ - 'errorCode' => 'InvalidParam.NoPermission', - 'errorMessage' => 'param value is not permission.', - ], + ['errorCode' => 'InvalidParam.NoPermission', 'errorMessage' => 'param value is not permission.', 'description' => 'The current parameter has no 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.', - ], + ['errorCode' => 'InvalidUser.UserNotInCurrentOrganization', 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', 'description' => ''], + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + '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', + 'title' => 'Update enterprise member information', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateOrganizationMember'], + ], ], + 'ramActions' => [], + ], + 'UpdatePipeline' => [ + 'summary' => 'This operation updates only YAML-based pipelines.', + 'path' => '/organization/{organizationId}/pipelines/update', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -47044,343 +25662,167 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '66c0c9fffeb86b450c199fcd', - ], + 'schema' => ['description' => 'The unique identifier of the organization. You can get this ID from the URL in Alibaba Cloud DevOps, for example, `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx', 'title' => ''], ], [ - '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' => 'name', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the pipeline.', 'type' => 'string', 'required' => true, 'example' => '示例流水线', 'title' => ''], ], [ - 'name' => 'joinTimeTo', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1631845101798', - ], + 'name' => 'content', + 'in' => 'formData', + 'schema' => ['description' => 'The definition of the pipeline in YAML format. For more information about how to write the YAML content, see https\\://help.aliyun.com/document\\_detail/2249317.html.', 'type' => 'string', 'required' => true, 'example' => 'sources: # sources 配置流水线源节点'."\n" + .' my_repo: # 流水线源唯一标识 id'."\n" + .' type: codeup # 流水线源类型'."\n" + .' name: 代码源名称 # 代码源的展示名称 '."\n" + .' endpoint: <your-codeup-repository-url> # 代码源的 url'."\n" + .' branch: master # 代码源的默认分支'."\n" + .' triggerEvents: push # 代码源监听事件'."\n" + .' certificate: # certificate 认证信息'."\n" + .' type: serviceConnection # 认证类型为服务连接'."\n" + .' serviceConnection: <your-service-connection-id> # 服务连接 id'."\n" + .'stages: # stages 配置流水线阶段'."\n" + .' build_stage: # 流水线阶段标识 id'."\n" + .' name: 构建阶段 # 流水线阶段的展示名称'."\n" + .' jobs: # jobs 配置流水线任务'."\n" + .' build_job: # 流水线任务标识 id'."\n" + .' name: 构建任务 # 流水线任务的展示名称'."\n" + .' runsOn: public/cn-beijing # 流水线任务运行的集群环境'."\n" + .' steps: # steps 配置流水线步骤'."\n" + .' build_step: # 流水线步骤标识 id'."\n" + .' step: JavaBuild # 选择执行步骤'."\n" + .' name: java构建 # 流水线执行步骤的展示名称'."\n" + .' with: # 步骤的参数'."\n" + .' run: |'."\n" + .' mvn -B clean package -Dmaven.test.skip=true -Dautoconfig.skip'."\n" + .' upload_step:'."\n" + .' step: ArtifactUpload'."\n" + .' name: 构建物上传'."\n" + .' with:'."\n" + .' uploadType: flowPublic'."\n" + .' artifact: default'."\n" + .' filePath:'."\n" + .' - target/'."\n" + .' - deploy.sh'."\n" + .' deploy_stage:'."\n" + .' name: 部署阶段'."\n" + .' jobs:'."\n" + .' deploy_job:'."\n" + .' name: 主机组部署任务'."\n" + .' component: VMDeploy # 选择执行组件'."\n" + .' with: # 执行组件的参数'."\n" + .' artifact: $[stages.build_stage.build_job.upload_step.artifacts.default]'."\n" + .' machineGroup: <your-machine-group-id>'."\n" + .' artifactDownloadPath: /home/admin/app/package.tgz'."\n" + .' executeUser: root'."\n" + .' run: |'."\n" + .' mkdir -p /home/admin/application/'."\n" + .' tar zxvf /home/admin/app/package.tgz -C /home/admin/application/'."\n" + .' sh /home/admin/application/deploy.sh restart', 'title' => ''], ], [ - 'name' => 'containsExternInfo', - 'in' => 'query', - 'schema' => [ - 'title' => '返回信息中是否包含第三方信息,默认不包含。', - 'description' => '返回信息中是否包含第三方信息,默认不包含。', - 'type' => 'boolean', - 'required' => false, - ], + 'name' => 'pipelineId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the pipeline. You can get this ID from the pipeline URL, for example, `https://flow.aliyun.com/pipelines/{pipelineId}/current`.', 'type' => 'string', 'required' => true, 'example' => '111xxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response body.', '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***', - ], - ], - ], - ], + 'success' => ['description' => 'Indicates whether the request was successful. `true` indicates success, while `false` indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'errorCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'requestId' => ['description' => 'The request ID. This ID is unique to each request and can be used for troubleshooting.', 'type' => 'string', 'title' => '', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', - 'errorMessage' => 'The user is not in the organization.', - ], + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => 'The user that is invoking the API service is not a registered user.'], ], 403 => [ - [ - 'errorCode' => 'InvalidParam.NoPermission', - 'errorMessage' => 'No Permission.', - ], + ['errorCode' => 'Forbidden.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], ], [ - [ - 'errorCode' => 'InvalidOrganization.NotFound', - 'errorMessage' => 'The organization is not found.', - ], + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], + ['errorCode' => 'InvalidPipeline.NotFound', 'errorMessage' => 'The pipeline is not found.', 'description' => 'The pipeline does not exist.'], + ['errorCode' => 'InvalidPipelineRun.NotFound', 'errorMessage' => 'The pipeline execution instance is not found.', 'description' => 'The pipeline execution instance 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\\": \\"123@mail.com\\",\\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>123@mail.com</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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"success\\": true,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\"\\n}","type":"json"}]', + 'title' => 'Update Pipeline ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePipeline'], + ], ], + 'ramActions' => [], + ], + 'UpdatePipelineBaseInfo' => [ + 'summary' => 'Update basic pipeline information.', + 'path' => '/organization/{organizationId}/pipelines/{pipelineId}/baseInfo', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '66c0c9fffeb86b450c199fcd', - ], + 'schema' => ['title' => '', 'description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, for example: https://devops.aliyun.com/organization/【OrganizationId】', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ - 'name' => 'accountId', + 'name' => 'pipelineId', 'in' => 'path', + 'schema' => ['description' => 'Pipeline ID, which can be obtained from the pipeline link, for example: https://flow.aliyun.com/pipelines/【PipelineId】/current', 'type' => 'string', 'required' => false, 'example' => '12', 'title' => ''], + ], + [ + 'name' => 'pipelineName', + 'in' => 'query', + 'schema' => ['description' => 'Pipeline Name', 'type' => 'string', 'required' => true, 'example' => '流水线名称', 'title' => ''], + ], + [ + 'name' => 'envId', + 'in' => 'query', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123456677888', + 'description' => '- 0 Daily environment '."\n" + .'- 1 Staging environment '."\n" + .'- 2 Production environment', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + 'enum' => ['0', '1', '2'], + 'title' => '', ], ], + [ + 'name' => 'tagList', + 'in' => 'query', + 'schema' => ['description' => 'Tag IDs, separated by commas', 'type' => 'string', 'required' => false, 'example' => '"11,222,33"', 'title' => ''], + ], ], 'responses' => [ 200 => [ @@ -47389,3360 +25831,3121 @@ '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', - ], + 'requestId' => ['title' => '', 'description' => 'Request ID. Each request has a unique value, which facilitates troubleshooting later.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['title' => '', 'description' => 'error message', 'type' => 'string', 'example' => '”“'], + 'success' => ['title' => '', 'description' => 'true if the API call succeeded, false if the API call failed', 'type' => 'boolean', 'example' => 'true 接口调用成功,false 接口调用失败'], + 'errorCode' => ['title' => '', 'description' => 'error code', 'type' => 'string', 'example' => '”“'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', - 'errorMessage' => 'The user is not in the organization.', - ], + ['errorCode' => 'InvalidCluster.NotFound', 'errorMessage' => 'No cluster is available to generate the workspace.', 'description' => 'No cluster is available to generate the workspace.'], + ['errorCode' => 'InvalidCodeUrl.NotSupportSVN', 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', 'description' => 'The parameter codeUrl is invalid. SVN is not supported.'], + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidResource.NotFound', 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', 'description' => 'No resource is found. You cannot create the workspace. Please try again later.'], + ['errorCode' => 'InvalidResourceRole.NotFoun', 'errorMessage' => 'The member role is invalid.', 'description' => 'The member role is invalid.'], + ['errorCode' => 'InvalidResourceRole.NotFound', 'errorMessage' => 'The member role is invalid.', 'description' => ''], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => 'The user that is invoking the API service is not a registered user.'], + ['errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', 'errorMessage' => 'Resource owner cannot be deleted.', 'description' => 'The resource owner cannot be deleted.'], + ['errorCode' => 'InvalidUser.ResourceMemberNotExists', 'errorMessage' => 'The resource member does not exist.', 'description' => 'The resource member does not exist.'], + ['errorCode' => 'InvalidUser.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization.', 'description' => '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' => 'Forbidden.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], ], [ - [ - 'errorCode' => 'InvalidOrganization.NotFound', - 'errorMessage' => 'The organization is not found.', - ], + ['errorCode' => 'InvalidIdentifier.NotFound', 'errorMessage' => 'space id is error or not exist.', 'description' => ''], + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], + ['errorCode' => 'InvalidPipeline.NotFound', 'errorMessage' => 'The pipeline is not found.', 'description' => 'The pipeline does not exist.'], + ['errorCode' => 'InvalidPipelineRun.NotFound', 'errorMessage' => 'The pipeline execution instance is not found.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'InvalidWorkspace.NotFound', 'errorMessage' => 'The workspace is not found.', 'description' => 'The workspace 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\\": \\"123@mail.com\\",\\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>123@mail.com</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', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\"\\n}","type":"json"}]', + 'title' => 'Update basic pipeline information', + 'changeSet' => [ + ['createdAt' => '2021-12-15T03:07:17.000Z', 'description' => 'OpenAPI offline'], ], - 'security' => [ - [ - 'AK' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePipelineBaseInfo'], ], ], - '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"}]', + 'ramActions' => [], ], - 'GetApplication' => [ - 'summary' => '查找应用详情', - 'path' => '/appstack/apps/{appName}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - '应用', - ], + 'UpdatePipelineGroup' => [ + 'summary' => 'Update pipeline group.', + 'path' => '/organization/{organizationId}/pipelineGroups/{groupId}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => [], + 'produces' => [], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => false, - 'notSupportAutoTestReason' => '数据面 api 经安全评估统一不做处理,后续逐步安排下线', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'appName', + 'name' => 'organizationId', 'in' => 'path', - 'schema' => [ - 'title' => '应用名', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'testApp', - ], + 'schema' => ['description' => 'Enterprise identity, also known as enterprise ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, for example: https://devops.aliyun.com/organization/【OrganizationId】'."\n" + ."\n", 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx', 'title' => ''], ], [ - 'name' => 'organizationId', + 'name' => 'name', 'in' => 'query', - 'schema' => [ - 'title' => '企业标识,也称企业id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '66c0c9fffeb86b450c199fcd', - ], + 'schema' => ['description' => 'Pipeline group name', 'type' => 'string', 'required' => true, 'example' => '流水线分组名称', 'maxLength' => 40, 'title' => ''], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => ['description' => 'Pipeline group ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '111', 'title' => ''], ], ], 'responses' => [ 200 => [ - 'description' => '已按名称查找到应用详情', + 'headers' => [], 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', '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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID. Each request has a unique value, which facilitates troubleshooting later.'."\n" + ."\n", 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['description' => 'error message', 'type' => 'string', 'example' => '""', 'title' => ''], + 'success' => ['description' => 'true indicates the API call succeeded; false indicates the API call failed.'."\n" + ."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'errorCode' => ['description' => 'error code', 'type' => 'string', 'example' => '""', 'title' => ''], ], + 'example' => '', ], ], - 404 => [ - 'description' => '未查找到应用详情', + ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], ], - 500 => [ - 'description' => '服务端内部异常', + [ + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], + ['errorCode' => 'InvalidUser.UserNotInCurrentOrganization', 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', + 'title' => 'Update pipeline group', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePipelineGroup'], + ], ], - '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"}]', + 'ramActions' => [], ], - 'UpdateApplication' => [ - 'summary' => '更新应用', - 'path' => '/appstack/apps/{appName}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - '应用', - ], + 'UpdateProjectField' => [ + 'summary' => 'Update the project properties, custom fields, and project status.', + 'path' => '/organization/{organizationId}/project/{identifier}', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'organizationId', - 'in' => 'query', - 'schema' => [ - 'title' => '企业标识,也称企业id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '66c0c9fffeb86b450c199fcd', - ], + 'in' => 'path', + 'schema' => ['description' => 'The organization ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '5ebbc0228123212b59xxxxx'], ], [ - 'name' => 'appName', + 'name' => 'identifier', 'in' => 'path', - 'schema' => [ - 'title' => '应用名', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'testApp', - ], + 'schema' => ['description' => 'The unique identifier of the project to update.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'deafe5f33xxxxx6a259d8dafd'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'ownerAccountId' => [ - 'title' => '拥有者阿里云UID', - 'description' => '', - 'type' => 'string', + 'updateBasicFieldRequestList' => [ + 'title' => '', + 'description' => 'An array of basic fields to update.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'An object that specifies a project property to update.', + 'type' => 'object', + 'properties' => [ + 'propertyKey' => [ + 'description' => 'The key of the basic property.', + 'enumValueTitles' => ['scope' => 'scope', 'name' => 'name', 'description' => 'description', 'customCode' => 'customCode'], + 'type' => 'string', + 'title' => '', + 'required' => false, + 'example' => 'name', + ], + 'propertyValue' => ['description' => 'The new value for the property.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '名称'], + ], + 'required' => false, + 'example' => '', + ], 'required' => false, - 'docRequired' => false, - 'example' => '1332695887xxxxxx', + 'example' => '', ], + 'updateForOpenApiList' => [ + 'title' => '', + 'description' => 'An array of custom fields to update.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'An object that specifies a custom field to update.', + 'type' => 'object', + 'properties' => [ + 'fieldIdentifier' => ['description' => 'The identifier for the custom field.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'c4fd21xxxxxxxx9oj8jk'], + 'value' => ['description' => 'The new value for the custom field.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '字段值'], + ], + 'required' => false, + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + 'statusIdentifier' => ['description' => 'The identifier for the status.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'fdsaadsfasxxxxdddd'], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], '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' => '应用描述', + 'requestId' => ['description' => 'The request ID. It is unique to each request and helps with troubleshooting.', 'type' => 'string', 'title' => '', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => 'Openapi.RequestError'], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'errormessage'], + 'success' => ['title' => 'true/false', 'description' => 'Indicates whether the request was successful. Valid values: `true` and `false`.', 'type' => 'boolean', 'example' => 'True'], + 'project' => [ + 'title' => '', + 'description' => 'The project information.', + 'type' => 'object', + 'properties' => [ + 'category' => ['description' => 'The category of the project.', 'type' => 'string', 'title' => '', 'example' => 'Project'], + 'categoryIdentifier' => ['description' => 'The category ID. The value is always `Project`.', 'type' => 'string', 'title' => '', 'example' => 'Project'], + 'creator' => ['description' => 'The creator\'s Alibaba Cloud account ID.', 'type' => 'string', 'title' => '', 'example' => '19xx7043xxxxxxx914'], + 'customCode' => ['description' => 'A unique custom code within the organization.', 'type' => 'string', 'title' => '', 'example' => 'OJAY'], + 'description' => ['description' => 'The description of the project.', 'type' => 'string', 'title' => '', 'example' => 'api测试-创建'], + 'gmtCreate' => ['description' => 'The creation time in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1623916393000'], + 'gmtModified' => ['description' => 'The modification time in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1684134690000'], + 'iconGroup' => ['description' => 'The icon group, provided as a JSON-formatted string.', 'type' => 'string', 'title' => '', 'example' => '{"small":"https://xxxxxx.png","big":"https://img.yyyyyy.png"}'], + 'icon' => ['description' => 'The icon for the project.', 'type' => 'string', 'title' => '', 'example' => 'https://xxxxxx.png'], + 'iconBig' => ['description' => 'The large icon for the project.', 'type' => 'string', 'title' => '', 'example' => 'https://xxxxxx.png'], + 'iconSmall' => ['description' => 'The small icon for the project.', 'type' => 'string', 'title' => '', 'example' => 'https://img.yyyyyy.png'], + 'id' => ['description' => 'The project ID.', 'type' => 'string', 'title' => '', 'example' => '66893'], + 'identifier' => ['description' => 'The project\'s unique identifier.', 'type' => 'string', 'title' => '', 'example' => '1e2ea73d24652d5874d001b351'], + 'identifierPath' => ['description' => 'The identifier path.', 'type' => 'string', 'title' => '', 'example' => 'e8b2xxxxxx2abdxxxxxxxx23'], + 'logicalStatus' => ['description' => 'The project status.', 'type' => 'string', 'title' => '', 'example' => 'NORMAL'], + 'modifier' => ['description' => 'The modifier\'s Alibaba Cloud account ID.', 'type' => 'string', 'title' => '', 'example' => '19xx7043xxxxxxx914'], + 'name' => ['description' => 'The project name.', 'type' => 'string', 'title' => '', 'example' => 'demo示例项目'], + 'organizationIdentifier' => ['description' => 'The organization ID.', 'type' => 'string', 'title' => '', 'example' => '5e70xxxxxxcd000xxxxe96'], + 'parentIdentifier' => ['description' => 'The parent project ID.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'scope' => ['description' => 'The scope of the project.', 'type' => 'string', 'title' => '', 'example' => 'public'], + 'statusIdentifier' => ['description' => 'The status ID.', 'type' => 'string', 'title' => '', 'example' => '8a40xxxxxxxxxxxxx64'], + 'statusStageIdentifier' => ['description' => 'The ID of the status stage. Default stages include Not Started, In Progress, and Completed.', 'type' => 'string', 'title' => '', 'example' => '8a4058a71159b68254......'], + 'subType' => ['description' => 'The subtype of the project.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'typeIdentifier' => ['description' => 'The subtype ID. This field is deprecated.', 'type' => 'string', 'title' => '', 'example' => 'CustomProject'], + 'statusName' => ['description' => 'The status name.', 'type' => 'string', 'title' => '', 'example' => '进行中'], + 'fieldList' => [ + 'title' => '', + 'description' => 'The field list.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'A field object.', + 'type' => 'object', + 'properties' => [ + 'identifier' => ['description' => 'The field ID.', 'type' => 'string', 'title' => '', 'example' => 'b787ff504c0b36f8b71d15a4fd'], + 'displayName' => ['description' => 'The display name.', 'type' => 'string', 'title' => '', 'example' => '进行时'], + 'valueType' => ['description' => 'The field type.', 'type' => 'string', 'title' => '', 'example' => 'user'], + 'value' => ['description' => 'The field value.', 'type' => 'string', 'title' => '', 'example' => 'ace3wxxxxxxx7rff3ee'], + ], + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 404 => [ - 'description' => '未查找到指定的应用', - ], - 500 => [ - 'description' => '服务端内部异常', + ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Operate.NoPermission', 'errorMessage' => 'NoPermission', 'description' => 'You are not authorized to perform this operation.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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"}]', + 'title' => 'Update project properties and fields ', + 'description' => 'Update a project\'s attributes, custom fields, and project status.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateProjectField'], + ], ], - '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"}]', + 'ramActions' => [], ], - 'ListApplications' => [ - 'summary' => '分页查找应用详情', - 'path' => '/appstack/apps:search', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - '应用', - ], + 'UpdateProjectLabel' => [ + 'summary' => 'Updates a label in a repository.', + 'path' => '/api/v4/projects/labels/{labelId}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'pagination', - 'in' => 'query', - 'schema' => [ - 'title' => '分页模式参数,目前只支持键集分页 keyset 模式', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'keyset', - ], - ], - [ - 'name' => 'perPage', + 'name' => 'organizationId', 'in' => 'query', - 'schema' => [ - 'title' => '分页尺寸参数,决定一页最多返回多少对象', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'example' => '20', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The ID of the organization. You can obtain the organization ID from your browser\'s URL after logging in to the Alibaba Cloud DevOps console. The URL is formatted as `https://devops.aliyun.com/organization/{organizationId}`.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ - 'name' => 'orderBy', + 'name' => 'accessToken', 'in' => 'query', - 'schema' => [ - 'title' => '分页排序属性,决定根据何种属性进行记录排序;推荐在实现严格遍历时,使用 id 属性', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'asc', - ], + 'schema' => ['description' => 'The personal access token. This parameter is not required if you authenticate using an Alibaba Cloud AccessKey pair or Security Token Service (STS) credentials.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], ], [ - 'name' => 'sort', - 'in' => 'query', - 'schema' => [ - 'title' => '分页排序升降序,asc 为升序,desc 为降序;推荐在实现严格遍历时,使用升序', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'id', - ], + 'name' => 'labelId', + 'in' => 'path', + 'schema' => ['description' => 'The unique ID of the label.', 'type' => 'string', 'required' => true, 'example' => '54e2699e538b4ba985177d6eb4d16cee', 'title' => ''], ], [ - 'name' => 'nextToken', + 'name' => 'repositoryIdentity', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '键集分页 token,获取第一页数据时无需传入,否则需要传入前一页查询结果中的 nextToken 字段', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'vxc2341gfssad12', - ], + 'schema' => ['description' => 'The ID or full path of the repository.', 'type' => 'string', 'required' => true, 'example' => '2835387 或 codeup/codeup-demo', 'title' => ''], ], [ - 'name' => 'organizationId', - 'in' => 'query', - 'schema' => [ - 'title' => '企业标识,也称企业id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '66c0c9fffeb86b450c199fcd', - ], - ], - ], - 'responses' => [ - 200 => [ - 'description' => '分页查找完成(包括未查找到对象的情况)', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ + 'description' => 'The request body.', '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', - ], + 'name' => ['description' => 'The name of the label.', 'type' => 'string', 'required' => false, 'example' => '缺陷', 'title' => ''], + 'color' => ['description' => 'The color of the label.', 'type' => 'string', 'required' => false, 'example' => '#EF433B', 'title' => ''], + 'description' => ['description' => 'The description of the label.', 'type' => 'string', 'required' => false, 'example' => '需要进行修复的缺陷', 'title' => ''], ], - ], - ], - 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', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ - 'description' => '分页查找完成(包括未查找到对象的情况)', 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response object.', '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 of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'result' => [ + 'description' => 'Details of the updated label.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The unique ID of the label.', 'type' => 'string', 'example' => '8d84d73cf315473683400760f02dbfc1', 'title' => ''], + 'name' => ['description' => 'The name of the label.', 'type' => 'string', 'example' => '缺陷', 'title' => ''], + 'color' => ['description' => 'The color of the label.', 'type' => 'string', 'example' => '#EF433B', 'title' => ''], + 'description' => ['description' => 'The description of the label.', 'type' => 'string', 'example' => '需要进行修复的缺陷', 'title' => ''], ], - ], - 'requestId' => [ - 'title' => '请求id,每次请求都是唯一值,便于后续排查问题', - 'description' => '', - 'type' => 'string', - 'example' => 'FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], - 500 => [ - 'description' => '服务端内部异常', - ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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"}]', + 'title' => 'Update Category', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateProjectLabel'], + ], ], - '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"}]', + 'ramActions' => [], ], - 'CreateAppMembers' => [ - 'summary' => '添加应用成员', - 'path' => '/appstack/apps/{appName}/members', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - '应用', - ], + 'UpdateProjectMember' => [ + 'summary' => 'Add a project member.', + 'path' => '/organization/{organizationId}/projects/{projectId}/updateMember', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'deprecated' => false, + 'systemTags' => [], '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', - ], + 'schema' => ['title' => '', 'description' => 'Organization identifier, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access URL, such as https://devops.aliyun.com/organization/【OrganizationId】. ', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'User information to be added ', '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, - ], + 'roleIdentifier' => ['title' => '', 'description' => 'Role ID, for example, administrator: project.admin, participant: project.participant, or other Custom Roles. The ID can be retrieved from the API https://devops.aliyun.com/projex/api/workspace/role/list?targetType=Space&targetIdentifier=【spaceIdentifier】, where spaceIdentifier is the project ID to query. ', 'type' => 'string', 'required' => true, 'example' => 'project.admin'], + 'userIdentifier' => ['title' => '', 'description' => 'User aliyunPk, which is the Alibaba Cloud account ID ', 'type' => 'string', 'required' => true, 'example' => '19xx7043xxxxxxx914'], + 'userType' => ['title' => '', 'description' => 'User type, which is single user "user" here', 'type' => 'string', 'required' => true, 'example' => 'user'], + 'targetType' => ['title' => '', 'description' => 'Resource type, which is Space', 'type' => 'string', 'required' => true, 'example' => 'Space'], + 'targetIdentifier' => ['title' => '', 'description' => 'Resource ID, which is the project ID ', 'type' => 'string', 'required' => true, 'example' => '5e70xxxxxxcd000xxxxe96'], ], - 'required' => false, + 'required' => true, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'project ID, same as spaceIdentifier', 'type' => 'string', 'required' => true, 'example' => '5e70xxxxxxcd000xxxxe96'], + ], ], 'responses' => [ 200 => [ - 'description' => '添加应用成员成功', 'schema' => [ - 'title' => '请求id,每次请求都是唯一值,便于后续排查问题', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '', 'description' => 'Request ID. Each request has a unique value to facilitate troubleshooting.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMsg' => ['title' => '', 'description' => 'Error Message ', 'type' => 'string', 'example' => 'error'], + 'errorCode' => ['title' => '', 'description' => 'Error Code ', 'type' => 'string', 'example' => 'Openapi.RequestError'], + 'success' => ['title' => '', 'description' => 'true or false', 'type' => 'boolean', 'example' => 'true'], + 'member' => [ + 'title' => '', + 'description' => 'Member information', + 'type' => 'object', + 'properties' => [ + 'id' => ['title' => 'id', 'description' => 'ID, currently unused', 'type' => 'string', 'example' => '1124382'], + 'roleIdentifier' => ['title' => '', 'description' => 'Role ID', 'type' => 'string', 'example' => 'project.admin'], + 'userIdentifier' => ['title' => '', 'description' => 'User ID, which is the Alibaba Cloud account ID (aliyunPk).', 'type' => 'string', 'example' => '19xx7043xxxxxxx914'], + 'userType' => ['title' => '', 'description' => 'User Type ', 'type' => 'string', 'example' => 'user'], + 'targetType' => ['title' => '', 'description' => 'Resource type', 'type' => 'string', 'example' => 'Space'], + 'gmtCreate' => ['title' => '', 'description' => 'Creation Time ', 'type' => 'integer', 'format' => 'int64', 'example' => '1623916393000'], + 'gmtModified' => ['title' => '', 'description' => 'Updated At', 'type' => 'integer', 'format' => 'int64', 'example' => '1623916393000'], + 'targetIdentifier' => ['title' => '', 'description' => 'Resource ID, which is the project ID.', 'type' => 'string', 'example' => '5e70xxxxxxcd000xxxxe96'], + ], + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'example' => 'FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F', + 'title' => '', + 'example' => '', ], ], - 403 => [ - 'description' => '没权限设置拥有者', - ], - [ - 'description' => '角色未找到', + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Openapi.RequestError', 'errorMessage' => 'request error', 'description' => ''], ], - 500 => [ - 'description' => '服务端内部异常', + 403 => [ + ['errorCode' => 'Operate.NoPermission', 'errorMessage' => 'NoPermission', 'description' => 'You are not authorized to perform this operation.'], ], ], - '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', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Add or Update Project Member ', + 'changeSet' => [ + ['createdAt' => '2022-02-24T08:23:15.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-01-06T13:27:07.000Z', 'description' => 'OpenAPI offline'], ], - 'tags' => [ - '应用', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateProjectMember'], + ], ], + 'ramActions' => [], + ], + 'UpdateProtectedBranches' => [ + 'summary' => 'Modify protected branch settings. Supports detailed configuration of protected branch rules, including branch, push rules, merge rules, requiring code review before merging, and requiring automated status checks before merging.', + 'path' => '/{repositoryId}/protect_branches/{id}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'query', - 'schema' => [ - 'title' => '企业标识,也称企业id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '66c0c9fffeb86b450c199fcd', - ], + 'schema' => ['description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access URL, for example: https://devops.aliyun.com/organization/【OrganizationId】', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], ], [ - 'name' => 'appName', + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Personal access token. '."\n" + .'This field is not required when using Alibaba Cloud AccessKey ID and AccessKey Secret (AK+SK) or Security Token Service (STS) temporary authorization.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513'], + ], + [ + 'name' => 'repositoryId', 'in' => 'path', - 'schema' => [ - 'title' => '应用名', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'testApp', - ], + 'schema' => ['description' => 'Repository ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2835387', 'title' => ''], + ], + [ + 'name' => 'id', + 'in' => 'path', + 'schema' => ['description' => 'Protected branch rule ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '19224', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Request body', 'type' => 'object', 'properties' => [ - 'roleNames' => [ - 'title' => '更新成员的角色列表', - 'description' => '', + 'id' => ['description' => 'Protected branch rule ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '19224', 'title' => ''], + 'branch' => ['description' => 'Code branch name (if the protected branch is not modified, retain the original branch name; if the protected branch needs to be modified, provide the new branch name)', 'type' => 'string', 'required' => true, 'example' => 'master', 'title' => ''], + 'allowPushRoles' => [ + 'description' => 'List of roles allowed to push', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'developer', + 'items' => ['description' => '40: administrator '."\n" + .'30: Developer', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '[40, 30]', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'allowPushUserIds' => [ + 'description' => 'List of User IDs allowed to push', + 'type' => 'array', + 'items' => ['description' => 'Alibaba Cloud account ID', 'type' => 'string', 'required' => false, 'example' => '[19258, 19262]', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'allowMergeRoles' => [ + 'description' => 'List of roles allowed to merge', + 'type' => 'array', + 'items' => ['description' => '40: administrator '."\n" + .'30: Developer', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '[40, 30]', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'allowMergeUserIds' => [ + 'description' => 'List of User IDs allowed to merge', + 'type' => 'array', + 'items' => ['description' => 'Alibaba Cloud account ID', 'type' => 'string', 'required' => false, 'example' => '[19258, 19262]', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'mergeRequestSetting' => [ + 'description' => 'Code review settings before merge', + 'type' => 'object', + 'properties' => [ + 'isRequired' => ['description' => 'Whether enabled', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'mrMode' => ['description' => 'Code review pattern '."\n" + .'general - General '."\n" + .'codeowner - CodeOwner pattern', 'type' => 'string', 'required' => false, 'example' => 'general', 'title' => ''], + 'isAllowSelfApproval' => ['description' => 'Whether to allow the creator to pass code review '."\n" + .'Valid values: true / false', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'isRequireDiscussionProcessed' => ['description' => 'Whether all comments must be resolved '."\n" + .'Valid values: true / false', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'isResetApprovalWhenNewPush' => ['description' => 'Whether to reset approval when a new commit is pushed '."\n" + .'Valid values: true / false', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'minimumApproval' => ['description' => 'Minimum number of approvals required for code review to pass '."\n" + .'Note: This setting takes effect only in NAT mode.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'allowMergeRequestRoles' => [ + 'description' => 'List of roles allowed to approve merge requests', + 'type' => 'array', + 'items' => ['description' => '40: administrator (default) '."\n" + .'30: Developer', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '[40, 30]', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'defaultAssignees' => [ + 'description' => 'List of default reviewer IDs', + 'type' => 'array', + 'items' => ['description' => 'User ID', 'type' => 'string', 'required' => false, 'example' => '1234', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'whiteList' => ['description' => 'Whitelist of files for code review '."\n" + .'Note: Files added to the whitelist are not subject to the "minimum number of required approvals" rule and do not require mandatory manual review.', 'type' => 'string', 'required' => false, 'example' => '**.java', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], - 'player' => [ - 'title' => '更新的成员', - 'description' => '', + 'testSettingDTO' => [ + 'description' => 'Status Check configuration before merging', 'type' => 'object', 'properties' => [ - 'id' => [ - 'title' => '成员id,类型为User时为成员的阿里云UID', - 'description' => '', - 'type' => 'string', + 'isRequired' => ['description' => 'Is enabled ', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'codeGuidelinesDetection' => [ + 'description' => 'Alibaba Coding Guidelines scan', + 'type' => 'object', + 'properties' => [ + 'enabled' => ['description' => 'Whether it is enabled', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'message' => ['description' => 'Description', 'type' => 'string', 'required' => false, 'example' => 'test_code_guide_lines', 'title' => ''], + ], 'required' => false, - 'docRequired' => true, - 'example' => '1332695887xxxxxx', + 'title' => '', + 'example' => '', ], - 'type' => [ - 'title' => '成员类型,目前只支持User', - 'description' => '', - 'type' => 'string', + 'sensitiveInfoDetection' => [ + 'description' => 'Sensitive Information scan', + 'type' => 'object', + 'properties' => [ + 'enabled' => ['description' => 'Whether Sensitive Information scanning is enabled', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'message' => ['description' => 'Description', 'type' => 'string', 'required' => false, 'example' => 'test_code_sensitive_info', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'checkTaskQualityConfig' => [ + 'description' => 'Code quality detection ', + 'type' => 'object', + 'properties' => [ + 'enabled' => ['description' => 'Whether code quality detection is enabled', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'bizNo' => ['description' => 'Job serial number ', 'type' => 'string', 'required' => false, 'example' => '123456', 'title' => ''], + 'taskName' => ['description' => 'Task Name ', 'type' => 'string', 'required' => false, 'example' => 'bz-task-quality', 'title' => ''], + 'message' => ['description' => 'Message', 'type' => 'string', 'required' => false, 'example' => 'test_task_quality', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'checkConfig' => [ + 'description' => 'MR blocking pipeline configuration', + 'type' => 'object', + 'properties' => [ + 'checkItems' => [ + 'description' => 'List of configuration items ', + 'type' => 'array', + 'items' => [ + 'description' => 'Configuration item ', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'Pipeline name ', 'type' => 'string', 'required' => false, 'example' => '测试流水线', 'title' => ''], + 'isRequired' => ['description' => 'Is a blocking point ', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], 'required' => false, - 'docRequired' => true, - 'example' => 'User', - 'default' => 'User', + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], - 'required' => false, + 'required' => true, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ - 'description' => '更新应用成员角色成功', 'schema' => [ - 'title' => '请求id,每次请求都是唯一值,便于后续排查问题', - 'description' => '', - 'type' => 'string', - 'example' => 'FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => 'A35869D5-BB29-5F84-A4DD-B09985EA2AFA'], + 'errorMessage' => ['description' => 'error message', 'type' => 'string', 'example' => '""', 'title' => ''], + 'errorCode' => ['description' => 'error code', 'type' => 'string', 'example' => ' '."\n" + .'SYSTEM_UNKNOWN_ERROR'."\n", 'title' => ''], + 'success' => ['description' => 'Whether the invocation succeeded', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'result' => [ + 'description' => 'Detailed Result returned'."\n" + ."\n", + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'Protected branch rule ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', 'title' => ''], + 'branch' => ['description' => 'Code branch name', 'type' => 'string', 'example' => 'master', 'title' => ''], + 'allowPushRoles' => [ + 'description' => 'List of roles allowed to push', + 'type' => 'array', + 'items' => ['description' => '40: administrator '."\n" + .'30: developer', 'type' => 'integer', 'format' => 'int32', 'example' => '[40, 30]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'allowPushUserIds' => [ + 'description' => 'User IDs allowed to push', + 'type' => 'array', + 'items' => ['description' => 'User ID', 'type' => 'integer', 'format' => 'int64', 'example' => '[19258, 19262]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'allowMergeRoles' => [ + 'description' => 'List of roles allowed to merge', + 'type' => 'array', + 'items' => ['description' => '40: administrator '."\n" + .'30: developer', 'type' => 'integer', 'format' => 'int32', 'example' => '[40, 30]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'allowMergeUserIds' => [ + 'description' => 'List of User IDs allowed to merge', + 'type' => 'array', + 'items' => ['description' => 'User ID', 'type' => 'integer', 'format' => 'int64', 'example' => '[19258, 19262]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'mergeRequestSetting' => [ + 'description' => 'Code review settings before merge', + 'type' => 'object', + 'properties' => [ + 'isRequired' => ['description' => 'Whether enabled ', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'mrMode' => ['description' => 'Code review pattern '."\n" + .'general: NAT mode '."\n" + .'codeowner: CodeOwner pattern ', 'type' => 'string', 'example' => 'general', 'title' => ''], + 'isAllowSelfApproval' => ['description' => 'Whether to allow the creator to Pass code review ', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'isRequireDiscussionProcessed' => ['description' => 'Whether all reviews must be resolved', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'isResetApprovalWhenNewPush' => ['description' => 'Whether to reset approval when a new submit is pushed ', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'minimumApproval' => ['description' => 'Minimum number of approvers required for code review to pass '."\n" + .'Note: Only effective in NAT mode ', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'allowMergeRequestRoles' => [ + 'description' => 'List of roles allowed to pass merge requests', + 'type' => 'array', + 'items' => ['description' => '40: administrator (default) '."\n" + .'30: developer', 'type' => 'integer', 'format' => 'int32', 'example' => '[40, 30]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'defaultAssignees' => [ + 'description' => 'List of User IDs for default reviewers ', + 'type' => 'array', + 'items' => ['description' => 'User ID ', 'type' => 'string', 'example' => '1234', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'whiteList' => ['description' => 'Whitelist of files for code review '."\n" + .'Note: Files in the whitelist are not subject to the "minimum number of approvers required" restriction and do not require mandatory manual review ', 'type' => 'string', 'example' => '**.java', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'testSettingDTO' => [ + 'description' => 'Automated status check settings before merging', + 'type' => 'object', + 'properties' => [ + 'isRequired' => ['description' => 'Is Enabled', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'codeGuidelinesDetection' => [ + 'description' => 'Alibaba Coding Guidelines scan', + 'type' => 'object', + 'properties' => [ + 'enabled' => ['description' => 'Whether enabled', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'message' => ['description' => 'Description', 'type' => 'string', 'example' => 'test_code_guide_lines', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'sensitiveInfoDetection' => [ + 'description' => 'Sensitive Information scan', + 'type' => 'object', + 'properties' => [ + 'enabled' => ['description' => 'Same as above', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'message' => ['description' => 'Same as above', 'type' => 'string', 'example' => 'test_code_sensitive_info', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'checkTaskQualityConfig' => [ + 'description' => 'Code Quality Detection', + 'type' => 'object', + 'properties' => [ + 'enabled' => ['description' => 'Whether enabled', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'bizNo' => ['description' => 'Job Stream Number', 'type' => 'string', 'example' => '123456', 'title' => ''], + 'taskName' => ['description' => 'Task Name.', 'type' => 'string', 'example' => 'biz-task-quality', 'title' => ''], + 'message' => ['description' => 'Message', 'type' => 'string', 'example' => 'test_task_quality', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'checkConfig' => [ + 'description' => 'MR blocking point pipeline configuration', + 'type' => 'object', + 'properties' => [ + 'checkItems' => [ + 'description' => 'List of configuration items', + 'type' => 'array', + 'items' => [ + 'description' => 'Configuration item', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'Pipeline Name', 'type' => 'string', 'example' => '测试流水线', 'title' => ''], + 'isRequired' => ['description' => 'Is point blocked', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], - 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', + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => 'The user is not authorized to perform the operation.'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Modify protected branch settings', + 'description' => 'The organizationId and the branch parameter in the body are Required.', + 'requestParamsDescription' => 'If you only need to modify specific fields, query the current settings first, directly update the query result, and use the updated query result as the parameter for the change.', + 'changeSet' => [ + ['createdAt' => '2023-04-06T03:11:33.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-11-21T13:16:40.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-09-20T02:35:46.000Z', 'description' => 'Request parameters changed'], ], - 'tags' => [ - '应用', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateProtectedBranches'], + ], ], + 'ramActions' => [], + ], + 'UpdatePushReviewOnOff' => [ + 'summary' => 'Enables or disables the push review setting for a specified repository. This operation requires administrator permissions.', + 'path' => '/repository/{repositoryId}/settings/trunk_mode', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'query', - 'schema' => [ - 'title' => '企业标识,也称企业id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '66c0c9fffeb86b450c199fcd', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The organization ID. You can find this string in the URL for Alibaba Cloud DevOps. For example, in https\\://devops.aliyun.com/organization/{organizationId}, {organizationId} is the organization ID.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ - 'name' => 'appName', + 'name' => 'repositoryId', 'in' => 'path', - 'schema' => [ - 'title' => '应用名', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'testApp', - ], + 'schema' => ['description' => 'The repository ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2813489', 'title' => ''], ], [ - 'name' => 'subjectType', + 'name' => 'trunkMode', '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', - ], + 'schema' => ['description' => 'Specifies whether to enable or disable push review. You need administrator permissions to change this setting.'."\n" + ."\n" + .'- true: On'."\n" + ."\n" + .'- false: Off', 'type' => 'boolean', 'required' => true, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ - 'description' => '删除应用成员成功', 'schema' => [ - 'title' => '请求id,每次请求都是唯一值,便于后续排查问题', - 'description' => '', - 'type' => 'string', - 'example' => 'FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F', + 'title' => 'Schema of Response', + 'description' => 'The response schema.', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '6177543A-8D54-5736-A93B-E0195A1512CB'], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Openapi.RequestError', 'title' => ''], + 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful. A value of `true` indicates success, and a value of `false` indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'result' => [ + 'description' => 'The result of the operation.', + 'type' => 'object', + 'properties' => [ + 'result' => ['description' => 'Indicates whether the setting was updated successfully. A value of `true` indicates success, and a value of `false` indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], - 500 => [ - 'description' => '服务端内部异常', - ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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"}]', + 'title' => 'Toggle Push Review Mode', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePushReviewOnOff'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"\\"FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F\\"","type":"json"}]', + 'ramActions' => [], ], - 'GetReleaseStagePipelineRun' => [ - 'summary' => '获取研发阶段流水线运行实例', - 'path' => '/appstack/apps/{appName}/releaseWorkflows/{releaseWorkflowSn}/releaseStages/{releaseStageSn}/executions/{executionNumber}:getPipelineRun', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'UpdatePushRule' => [ + 'summary' => 'This operation overwrites the specified push rule with the provided content. Therefore, to add a new rule item, you must include all existing rule items in the request; otherwise, they will be deleted.', + 'path' => '/api/v4/projects/{repositoryId}/push_rule/{pushRuleId}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'autoTest' => false, - 'notSupportAutoTestReason' => '数据面 api 经安全评估统一不做处理,后续逐步安排下线', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'query', - 'schema' => [ - 'title' => '企业标识,也称企业id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '66c0c9fffeb86b450c199fcd', - ], + 'schema' => ['description' => 'The organization ID. You can find this ID in the URL on your Alibaba Cloud DevOps page. Example: https\\://devops.aliyun.com/organization/{organizationId}.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx', 'title' => ''], ], [ - 'name' => 'appName', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'testApp', - ], + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => ['description' => 'The personal access token. This parameter is optional if you authenticate with an Alibaba Cloud AccessKey pair (AK/SK) or STS temporary authorization.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], ], [ - 'name' => 'releaseWorkflowSn', + 'name' => 'repositoryId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ce51b31b996246ecaf8747368383****', - ], + 'schema' => ['description' => 'The ID of the repository that contains the push rule.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2709413', 'title' => ''], ], [ - 'name' => 'releaseStageSn', + 'name' => 'pushRuleId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'e173f3c11db5445eb426ca33c922****', - ], + 'schema' => ['description' => 'The ID of the push rule to update.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2077', 'title' => ''], ], [ - 'name' => 'executionNumber', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'ruleInfos' => [ + 'description' => 'A list of rule configurations.', + 'type' => 'array', + 'items' => [ + 'description' => 'A rule configuration object.', + 'type' => 'object', + 'properties' => [ + 'checkerName' => ['description' => 'The name of the rule. Valid values:'."\n" + ."\n" + .'- CommitMessageChecker: The commit message rule.'."\n" + ."\n" + .'- CommitAuthorEmailChecker: The commit author email rule.'."\n" + ."\n" + .'- CommitAuthorChecker: The commit author check.'."\n" + ."\n" + .'- CommitCommitterChecker: The committer check.'."\n" + ."\n" + .'- ForcePushChecker: The force push check.'."\n" + ."\n" + .'- CommitFilesChecker: The committed file restriction.', 'type' => 'string', 'required' => false, 'example' => 'CommitAuthorChecker', 'title' => ''], + 'extraMessage' => ['description' => 'Additional rule configuration. The expected value depends on the checkerName:'."\n" + ."\n" + .'- CommitMessageChecker: The regular expression for validation.'."\n" + ."\n" + .'- CommitAuthorEmailChecker: The regular expression for the email address.'."\n" + ."\n" + .'- ForcePushChecker: Set to "disabled".'."\n" + ."\n" + .'- CommitAuthorChecker: Set to "on" to enable the check.'."\n" + ."\n" + .'- CommitCommitterChecker: Set to "on" to enable the check.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], + 'checkerType' => ['description' => 'The restriction level for author and committer checks. This parameter applies only when checkerName is CommitAuthorChecker or CommitCommitterChecker. Valid values:'."\n" + ."\n" + .'- warn: Displays a warning but allows the push.'."\n" + ."\n" + .'- block: Blocks the push.', 'type' => 'string', 'required' => false, 'example' => 'warn', 'title' => ''], + 'fileRuleRegexes' => [ + 'description' => 'An array of regular expressions to restrict committed files. This parameter applies only when checkerName is CommitFilesChecker.', + 'type' => 'array', + 'items' => ['description' => 'A regular expression for the file restriction.', 'type' => 'string', 'required' => false, 'example' => '\\.java$', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'GetPipelineRunResponse', - 'description' => 'GetPipelineRunResponse', + 'title' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'pipelineRun' => [ - 'description' => '', + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorCode' => ['description' => 'The error code returned on failure.', 'type' => 'string', 'example' => 'Openapi.RequestError', 'title' => ''], + 'errorMessage' => ['description' => 'The error message returned on failure.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful. `true` indicates success; `false` indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'result' => [ + 'description' => 'The data returned for the request.', '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' => '', + 'id' => ['description' => 'The push rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '30815', 'title' => ''], + 'ruleInfos' => [ + 'description' => 'The rule information list.', 'type' => 'array', 'items' => [ + 'description' => 'A rule information object.', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => '', - 'type' => 'string', + 'checkerName' => ['description' => 'The checker name. Valid values are:'."\n" + ."\n" + .'- `CommitMessageChecker`: The commit message rule.'."\n" + ."\n" + .'- `CommitAuthorEmailChecker`: The commit author email rule.'."\n" + ."\n" + .'- `CommitAuthorChecker`: The commit author check.'."\n" + ."\n" + .'- `CommitCommitterChecker`: The committer check.'."\n" + ."\n" + .'- `ForcePushChecker`: The force push check.'."\n" + ."\n" + .'- `CommitFilesChecker`: The commit file restriction rule.', 'type' => 'string', 'example' => 'CommitAuthorChecker', 'title' => ''], + 'checkerType' => ['description' => 'The restriction level. This parameter applies only to the commit author check and committer check. Valid values:'."\n" + ."\n" + .'- `warn`: Displays a warning but allows the push.'."\n" + ."\n" + .'- `block`: Blocks the push.', 'type' => 'string', 'example' => 'warn', 'title' => ''], + 'extraMessage' => ['description' => 'Additional configuration for the rule. The value of this parameter depends on the selected `checkerName`:'."\n" + ."\n" + .'- For the commit message rule, this is the regular expression for validation.'."\n" + ."\n" + .'- For the commit author email rule, this is the regular expression for the author\'s email address.'."\n" + ."\n" + .'- For the force push check, use `disabled`.'."\n" + ."\n" + .'- For the commit author check, use `on`. This setting is optional.'."\n" + ."\n" + .'- For the committer check, use `on`. This setting is optional.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'fileRuleRegexes' => [ + 'description' => 'An array of regular expressions that define restrictions on committed files. This parameter applies only when the checker name is `CommitFilesChecker`.', + 'type' => 'array', + 'items' => ['description' => 'A regular expression that specifies which files are restricted.', 'type' => 'string', 'example' => '\\.java$', 'title' => ''], + 'title' => '', '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', - ], - ], - ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'gmtCreate' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2023-09-03T18:20:06+08:00', 'title' => ''], + 'gmtModified' => ['description' => 'The modification time.', 'type' => 'string', 'example' => '2023-09-03T18:20:06+08:00', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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"}]', + 'title' => 'Update Push Rule ', + 'description' => 'This operation requires at least repository administrator permissions.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePushRule'], + ], ], - '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"}]', + 'ramActions' => [], ], - 'ExecuteChangeRequestReleaseStage' => [ - 'summary' => '执行研发阶段流水线', - 'path' => '/appstack/apps/{appName}/releaseWorkflows/{releaseWorkflowSn}/releaseStages/{releaseStageSn}:execute', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateRepository' => [ + 'summary' => 'Update basic information and common settings of the code repository.', + 'path' => '/repository/{repositoryId}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'autoTest' => false, - 'notSupportAutoTestReason' => '数据面 api 经安全评估统一不做处理,后续逐步安排下线', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'organizationId', 'in' => 'query', - 'schema' => [ - 'title' => '企业标识,也称企业id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '66c0c9fffeb86b450c199fcd', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps URL, for example: https://devops.aliyun.com/organization/【OrganizationId】', 'type' => 'string', 'required' => true, 'example' => '60de7a6852743a5162b5f957'], ], [ - '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' => 'accessToken', + 'in' => 'query', + 'schema' => ['description' => 'Personal access token. '."\n" + .'This field is not required when using Alibaba Cloud AccessKey ID and AccessKey Secret or Security Token Service (STS) temporary authorization.', 'type' => 'string', 'required' => false, 'example' => 'c3c09f1230187a879678da43c973d069', 'title' => ''], ], [ - 'name' => 'releaseStageSn', + 'name' => 'repositoryId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'e173f3c11db5445eb426ca33c922****', - ], + 'schema' => ['description' => 'Code repository ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2080398', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'params' => [ - 'description' => '', - 'type' => 'object', + 'description' => 'Request Body', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'Code repository ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2080398', 'title' => ''], + 'name' => ['description' => 'Code repository Name', 'type' => 'string', 'required' => false, 'example' => 'codeup', 'title' => ''], + 'path' => ['description' => 'Repository path ', 'type' => 'string', 'required' => false, 'example' => 'codeup-demo', 'title' => ''], + 'description' => ['description' => 'Code repository description', 'type' => 'string', 'required' => false, 'example' => 'codeup描述信息', 'title' => ''], + 'defaultBranch' => ['description' => 'Default branch', 'type' => 'string', 'required' => false, 'example' => 'master', 'title' => ''], + 'issuesEnabled' => ['description' => 'Whether issues are enabled. '."\n" + .'Valid values: true / false', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'mergeRequestsEnabled' => ['description' => 'Whether merge requests are enabled '."\n" + .'Valid values: true / false ', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'buildsEnabled' => ['description' => 'Whether builds are enabled '."\n" + .'Valid values: true / false ', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'wikiEnabled' => ['description' => 'Whether wiki is Enabled '."\n" + .'Valid values: true / false', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'snippetsEnabled' => ['description' => 'Whether snippets are enabled', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'visibilityLevel' => ['description' => 'Repository visibility level '."\n" + .'0: Private, visible only to repository members '."\n" + .'10: Internal, visible to all enterprise members', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'checkEmail' => ['description' => 'Whether mailbox verification is Enabled '."\n" + .'Valid values: true / false', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'avatar' => ['description' => 'Profile picture URL', 'type' => 'string', 'required' => false, 'example' => 'https://xxxx', 'title' => ''], + 'openCloneDownloadControl' => ['description' => 'Whether clone and download control is Enabled '."\n" + .'Valid values: true / false', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'projectCloneDownloadRoleList' => [ + 'description' => 'List of roles allowed to pull code ', + 'type' => 'array', + 'items' => [ + 'description' => 'Role ', + 'type' => 'object', + 'properties' => [ + 'roleCode' => ['description' => 'Role code '."\n" + .'15: Space member '."\n" + .'60: Space administrator '."\n" + .'70: Space owner ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '15', 'title' => ''], + 'allowed' => ['description' => 'Whether allowed '."\n" + .'Valid values: true / false ', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'additionalProperties' => [ - 'type' => 'any', - 'description' => '', + 'title' => '', + 'example' => '', + ], + 'projectCloneDownloadMethodList' => [ + 'description' => 'List of allowed methods for pulling code', + 'type' => 'array', + 'items' => [ + 'description' => 'Allowed method for pulling code', + 'type' => 'object', + 'properties' => [ + 'permissionCode' => ['description' => 'Permission code for clone and download '."\n" + .'`project:ssh-clone`: Allows SSH clone '."\n" + .'`project:http-clone`: Allows HTTP clone '."\n" + .'`project:download`: Allows download '."\n", 'type' => 'string', 'required' => false, 'example' => 'project:download', 'title' => ''], + 'allowed' => ['description' => 'Whether allowed '."\n" + .'Valid values: true / false ', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + 'required' => false, + 'title' => '', 'example' => '', ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'adminSettingLanguage' => ['description' => 'Primary programming language of the repository (requires administrator permission) ', 'type' => 'string', 'required' => false, 'example' => 'Java', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'ExecutePipelineResult', - 'description' => 'ExecutePipelineResult', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', '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', + 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => 'EAE03103-5497-58D1-9169-E524DDE8604C'], + 'errorMessage' => ['description' => 'error message', 'type' => 'string', 'example' => '“”', 'title' => ''], + 'errorCode' => ['description' => 'error code', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR'."\n", 'title' => ''], + 'success' => ['description' => 'Whether the invocation Succeeded', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'result' => [ + 'description' => 'Return Result', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'Code repository ID', 'type' => 'integer', 'format' => 'int64', 'example' => '2825387', 'title' => ''], + 'name' => ['description' => 'Repository Name ', 'type' => 'string', 'example' => 'codeup', 'title' => ''], + 'nameWithNamespace' => ['description' => 'Full repository name (including the full group name) ', 'type' => 'string', 'example' => 'codeup-test-org / codeup(斜杠两侧有空格)', 'title' => ''], + 'path' => ['description' => 'Repository path ', 'type' => 'string', 'example' => 'codeup', 'title' => ''], + 'pathWithNamespace' => ['description' => 'Full path of the code repository (including the full group path)', 'type' => 'string', 'example' => 'codeup-test-org / codeup', 'title' => ''], + 'description' => ['description' => 'Description of the code repository', 'type' => 'string', 'example' => 'codeup代码库描述', 'title' => ''], + 'defaultBranch' => ['description' => 'Default branch', 'type' => 'string', 'example' => 'master', 'title' => ''], + 'visibilityLevel' => ['description' => 'Visibility '."\n" + .'0: private, visible only to repository members '."\n" + .'10: internal to the enterprise, visible to enterprise members ', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'sshUrlToRepo' => ['description' => 'SSH clone URL of the code repository', 'type' => 'string', 'example' => 'git@codeup.aliyun.com:xxx/test/test.git'."\n", 'title' => ''], + 'httpUrlToRepo' => ['description' => 'HTTP clone URL of the code repository', 'type' => 'string', 'example' => 'https://codeup.aliyun.com/xxx/test/test.git'."\n", 'title' => ''], + 'webUrl' => ['description' => 'Page visit URL of the repository '."\n", 'type' => 'string', 'example' => 'https://codeup.aliyun.com/xxx/test/test'."\n", 'title' => ''], + 'issuesEnabled' => ['description' => 'Whether issues are enabled. '."\n" + .'Valid values: true / false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'mergeRequestsEnabled' => ['description' => 'Whether merge requests are enabled. '."\n" + .'Valid values: true / false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'buildsEnabled' => ['description' => 'Whether build is enabled. '."\n" + .'Valid values: true / false ', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'wikiEnabled' => ['description' => 'Whether wiki is Enabled '."\n" + .'Valid values: true / false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'snippetsEnabled' => ['description' => 'Whether snippets are enabled. '."\n" + .'Valid values: true / false', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'createdAt' => ['description' => 'Creation Time ', 'type' => 'string', 'example' => '2022-03-18 14:24:54', 'title' => ''], + 'lastActivityAt' => ['description' => 'Time of last activity', 'type' => 'string', 'example' => '2022-03-20 14:24:54', 'title' => ''], + 'creatorId' => ['description' => 'Creator ID', 'type' => 'integer', 'format' => 'int64', 'example' => '19238', 'title' => ''], + 'namespace' => [ + 'description' => 'Information about the group or enterprise Space to which the repository belongs ', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'ID of the group or enterprise Space', 'type' => 'integer', 'format' => 'int64', 'example' => '29322', 'title' => ''], + 'name' => ['description' => 'Name of the group or enterprise Space', 'type' => 'string', 'example' => 'codeup', 'title' => ''], + 'path' => ['description' => 'Group or enterprise path (determine whether the parent path is a group or an enterprise) ', 'type' => 'string', 'example' => '地址:https://codeup.aliyun.com/60d54f3daccf2bbd6659f3ad/blank923/repo-test'."\n" + .'组路径:blank923'."\n" + .'企业路径:60d54f3daccf2bbd6659f3ad', 'title' => ''], + 'ownerId' => ['description' => 'Owner ID of the group or enterprise Space', 'type' => 'integer', 'format' => 'int64', 'example' => '19238', 'title' => ''], + 'createdAt' => ['description' => 'Creation Time ', 'type' => 'string', 'example' => '2022-02-18 14:24:54', 'title' => ''], + 'updatedAt' => ['description' => 'Update Time', 'type' => 'string', 'example' => '2022-03-18 14:24:54', 'title' => ''], + 'description' => ['description' => 'Description', 'type' => 'string', 'example' => '组或企业空间的描述信息', 'title' => ''], + 'avatar' => ['description' => 'Avatar URL of the Space', 'type' => 'string', 'example' => 'https://xxx', 'title' => ''], + 'visibilityLevel' => ['description' => 'Code repository visibility '."\n" + .'0: private '."\n" + .'10: internal to the enterprise, visible to enterprise members', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'archived' => ['description' => 'Data archiving identity ', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'avatarUrl' => ['description' => 'Profile picture URL of the code repository', 'type' => 'string', 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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', + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.AccessDenied', 'errorMessage' => 'The user is not authorized to perform the operation.', 'description' => '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.', 'description' => ''], + ['errorCode' => 'Forbidden.UserNotInCurrentOrganization', 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', 'description' => ''], + ], ], - 'schemes' => [ - 'https', + '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\\": \\"git@codeup.aliyun.com: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"}]', + 'title' => 'Update Code Repository', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateRepository'], + ], ], + 'ramActions' => [], + ], + 'UpdateRepositoryMember' => [ + 'summary' => 'Updates the permission or role of a member in the current code repository based on the repository ID, User ID, and update content. '."\n" + .'Note: In the future, User ID will be unified as Alibaba Cloud account ID (aliyunPk). Please stay tuned.'."\n", + 'path' => '/repository/{repositoryId}/members/{aliyunPk}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'autoTest' => false, - 'notSupportAutoTestReason' => '数据面 api 经安全评估统一不做处理,后续逐步安排下线', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => [], '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', + 'name' => 'repositoryId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ce51b31b996246ecaf8747368383****', - ], + 'schema' => ['description' => 'Repository ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '889910', 'title' => ''], ], [ - 'name' => 'releaseStageSn', + 'name' => 'aliyunPk', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'e173f3c11db5445eb426ca33c922****', - ], + 'schema' => ['description' => 'Alibaba Cloud account ID', 'type' => 'string', 'required' => true, 'example' => '1232456789123467', 'title' => ''], ], [ - 'name' => 'executionNumber', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - ], - ], - 'responses' => [ - 200 => [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => 'CancelExecutionResponse', - 'description' => 'CancelExecutionResponse', + 'description' => 'Input parameters of the request', 'type' => 'object', 'properties' => [ - 'success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'accessLevel' => ['description' => 'Permission Type '."\n" + .'20 – Viewer '."\n" + .'30 – Developer '."\n" + .'40 – Administrator'."\n" + ."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], + 'expireAt' => ['description' => 'Job expiration time.', 'type' => 'string', 'required' => false, 'example' => '2020-08-08 08:08:08', 'title' => ''], + 'memberType' => ['description' => 'Member Type '."\n" + .'TEAMS – Department '."\n" + .'USERS – Employee', 'type' => 'string', 'required' => false, 'example' => 'USERS', 'title' => ''], + 'relatedId' => ['description' => 'Associated ID', 'type' => 'string', 'required' => false, 'example' => '10010', 'title' => ''], + 'relatedInfos' => [ + 'description' => 'Information about the target repository to be modified', + 'type' => 'array', + 'items' => [ + 'description' => 'Specific information', + 'type' => 'object', + 'properties' => [ + 'relatedId' => ['description' => 'The associated ID.', 'type' => 'string', 'required' => false, 'example' => '10011', 'title' => ''], + 'sourceId' => ['description' => 'Associated sourceId', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '24790', 'title' => ''], + 'sourceType' => ['description' => 'The associated sourceType. '."\n" + .'Valid values: Project, Namespace, Organization.', 'type' => 'string', 'required' => false, 'example' => 'Project', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], - ], - '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', - ], + 'schema' => ['description' => 'Organization identity, also known as organization ID, in string format. You can obtain it from the Alibaba Cloud DevOps URL, for example: https://devops.aliyun.com/organization/【OrganizationId】'."\n", 'type' => 'string', 'required' => true, 'example' => '60de7a6852743a5162b5f957', 'title' => ''], ], [ - 'name' => 'appName', - 'in' => 'path', - 'schema' => [ - 'title' => '应用名', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'testApp', - ], + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => ['description' => 'Personal access token. '."\n" + .'You do not need to provide this field if you use an Alibaba Cloud AccessKey pair (AK+SK) or Security Token Service (STS) temporary authorization.', 'type' => 'string', 'required' => false, 'example' => 'f0b1e61db5961df5975a93f9129d2513', 'title' => ''], ], ], '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' => '""', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => 'F590C9D8-E908-5B6C-95AC-56B7E8011FFA'], + 'errorMessage' => ['description' => 'Error message', 'type' => 'string', 'example' => '""', 'title' => ''], + 'errorCode' => ['description' => 'Error code.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'success' => ['description' => 'true indicates that the API call succeeded; false indicates that the API call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'result' => [ + 'description' => 'Detailed result returned'."\n" + ."\n", + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'User ID in the management platform', 'type' => 'integer', 'format' => 'int64', 'example' => '30815', 'title' => ''], + 'state' => ['description' => 'User status', 'type' => 'string', 'example' => 'normal', 'title' => ''], + 'avatarUrl' => ['description' => 'Profile picture URL.', 'type' => 'string', 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', 'title' => ''], + 'webUrl' => ['description' => 'web url', 'type' => 'string', 'example' => '""', 'title' => ''], + 'email' => ['description' => 'Mailbox', 'type' => 'string', 'example' => 'test@alibaba.com', 'title' => ''], + 'memberName' => ['description' => 'Member name.', 'type' => 'string', 'example' => 'test_memeber_name', 'title' => ''], + 'accessLevel' => ['description' => 'Permission level', 'type' => 'integer', 'format' => 'int32', 'example' => '40', 'title' => ''], + 'expireAt' => ['description' => 'Expiration time', 'type' => 'string', 'example' => '2020-08-08 08:08:08', 'title' => ''], + 'memberType' => ['description' => 'Member type '."\n" + .'TEAMS - Department '."\n" + .'USERS - Employee'."\n", 'type' => 'string', 'example' => 'USERS', 'title' => ''], + 'sourceId' => ['description' => 'Associated source ID', 'type' => 'integer', 'format' => 'int64', 'example' => '223241', 'title' => ''], + 'sourceType' => ['description' => 'Associated source type '."\n" + .'Valid values: Project / Namespace / Organization'."\n" + ."\n", 'type' => 'string', 'example' => 'Project', 'title' => ''], + 'name' => ['description' => 'Username', 'type' => 'string', 'example' => 'codeup', 'title' => ''], + 'username' => ['description' => 'User nickname', 'type' => 'string', 'example' => 'codeup-test', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + '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', + 'responseDemo' => '[{"errorExample":"","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\\": \\"test@alibaba.com\\",\\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}","type":"json"}]', + 'title' => 'Modify permissions of repository members', + 'description' => 'Repository ID and User ID are Required. The update content must include at least accessLevel and memberType.'."\n", + 'changeSet' => [ + ['createdAt' => '2023-07-24T06:14:51.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-04-06T03:11:35.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-11-21T13:16:40.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-24T09:16:37.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-08-18T10:11:42.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateRepositoryMember'], + ], ], + 'ramActions' => [], + ], + 'UpdateResourceMember' => [ + 'summary' => 'You can update resource members.', + 'path' => '/organization/{organizationId}/{resourceType}/{resourceId}/members/{accountId}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], + 'systemTags' => [], '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', - ], + 'schema' => ['title' => '', 'description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, for example: https://devops.aliyun.com/organization/【OrganizationId】', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ - 'name' => 'releaseStageSn', + 'name' => 'resourceType', 'in' => 'path', 'schema' => [ - 'title' => '研发阶段sn', - 'description' => '', + 'title' => '', + 'description' => 'Resource type: pipeline (pipeline) or hostGroup (host group)', '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', + 'docRequired' => true, + 'maximum' => '999999999999999', + 'minimum' => '1', + 'example' => 'pipeline', + 'enum' => ['pipeline', 'hostGroup'], ], ], [ - 'name' => 'sort', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'asc' => 'asc', - 'desc' => 'desc', - ], - 'example' => 'desc', - ], + 'name' => 'roleName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Role'."\n" + ."\n" + .'For deployment group (deployGroup):'."\n" + .'- user: member with usage permission '."\n" + .'- admin: administrator with edit permission '."\n" + .'- owner: owner with all permissions '."\n" + ."\n" + .'For pipeline:'."\n" + .'- owner: owner with all permissions '."\n" + .'- admin: View, Run, and Edit permissions '."\n" + .'- member: Run permission '."\n" + .'- viewer: View permission', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'admin'], ], [ - 'name' => 'nextToken', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '""', - ], + 'name' => 'resourceId', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'Resource ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '111111'], ], [ - 'name' => 'page', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'name' => 'accountId', + 'in' => 'path', + 'schema' => ['description' => 'Alibaba Cloud account ID', 'type' => 'string', 'required' => false, 'example' => '11111', 'title' => ''], ], ], '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', - ], + 'requestId' => ['title' => '', 'description' => 'Request ID. Each request has a unique value, which facilitates troubleshooting later.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => '""'], + 'errorCode' => ['title' => '', 'description' => 'Error code', 'type' => 'string', 'example' => '""'], + 'success' => ['title' => '', 'description' => 'true if the API call succeeded; false if the API call failed.', 'type' => 'boolean', 'example' => 'true'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => 'The user that is invoking the API service is not a registered user.'], + ['errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', 'errorMessage' => 'Resource owner cannot be deleted.', 'description' => 'The resource owner cannot be deleted.'], + ['errorCode' => 'InvalidUser.ResourceMemberNotExists', 'errorMessage' => 'The resource member does not exist.', 'description' => 'The resource member does not exist.'], + ['errorCode' => 'InvalidResourceRole.NotFoun', 'errorMessage' => 'The member role is invalid.', 'description' => '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.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], + ['errorCode' => 'InvalidPipeline.NotFound', 'errorMessage' => 'The pipeline is not found.', 'description' => 'The pipeline does not exist.'], + ], ], - 'schemes' => [ - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true\\n}","type":"json"}]', + 'title' => 'Update resource members', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateResourceMember'], + ], ], + 'ramActions' => [], + ], + 'UpdateTestCase' => [ + 'summary' => 'Updates a test case\'s attributes in a test case library, including its title, directory, and custom fields, but not its test content.', + 'path' => '/organization/{organizationId}/testhub/testcase/{testcaseIdentifier}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], + 'systemTags' => [], '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', - ], + 'schema' => ['description' => 'The organization ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '5ebbc0228123212b59xxxxx'], ], [ - 'name' => 'releaseWorkflowSn', + 'name' => 'testcaseIdentifier', 'in' => 'path', - 'schema' => [ - 'title' => '研发流程sn', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ce51b31b996246ecaf874736838360b2', - ], + 'schema' => ['description' => 'The unique identifier for the test case.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '4e22xxxxxxxxc64c16037fe76'], ], [ - 'name' => 'releaseStageSn', - 'in' => 'path', - 'schema' => [ - 'title' => '研发阶段sn', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'e173f3c11db5445eb426ca33c92207c8', - ], - ], - [ - 'name' => 'executionNumber', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '研发阶段的执行记录编号', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'updateWorkitemPropertyRequest' => [ + 'title' => '', + 'description' => 'The properties of the test case to update.', + 'type' => 'array', + 'items' => [ + 'description' => 'An entity property.', + 'type' => 'object', + 'properties' => [ + 'fieldIdentifier' => ['description' => 'The ID of the test case field to update.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'tc.type'], + 'fieldValue' => ['description' => 'The new field value. For a user type field, use the user\'s aliyunPK. For fields with option values, use the corresponding option ID. To enter multiple values, use a comma-separated string.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '0a032xx28107xxxx53e87a9'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], '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' => [ + 'title' => 'Schema of Response', + 'description' => 'Response schema', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMsg' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'error'], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'Testcase' => [ + 'description' => 'The test case object.', + 'type' => 'object', + 'properties' => [ + 'identifier' => ['description' => 'The ID of the test case.', 'type' => 'string', 'title' => '', 'example' => 'c7f7033b021ead52cc42721382'], + 'subject' => ['description' => 'The subject of the test case.', 'type' => 'string', 'title' => '', 'example' => '测试用例标题'], + 'assignedTo' => [ + 'title' => '', + 'description' => 'Information about the assignee.', 'type' => 'object', 'properties' => [ - 'sn' => [ - 'title' => '变更请求编号', - 'description' => '', - 'type' => 'string', - 'example' => 'fcd37726a6f84c60b7eb9c5856007c2f', - ], - 'name' => [ - 'title' => '变更请求名称', - 'description' => '', - 'type' => 'string', + 'assignIdentifier' => ['description' => 'The ID of the assignee.', 'type' => 'string', 'title' => '', 'example' => '1316xxxxxx8624xxx'], + 'name' => ['description' => 'The name of the assignee.', 'type' => 'string', 'title' => '', 'example' => '用户姓名'], + 'tbRoleId' => ['description' => 'The role ID of the assignee.', 'type' => 'string', 'title' => '', 'example' => 'xxxxxxxewdds12xxx'."\n"], + ], + 'example' => '', + ], + 'spaceIdentifier' => ['description' => 'The ID of the test repository.', 'type' => 'string', 'title' => '', 'example' => '1e7d7a412b91a2144ec4aa8411'], + 'spaceType' => ['description' => 'The type of the space. The value is `TestRepo`.', 'type' => 'string', 'title' => '', 'example' => 'TestRepo'], + 'categoryIdentifier' => ['description' => 'The ID of the work item type. The value is typically `TestCase`.', 'type' => 'string', 'title' => '', 'example' => 'TestCase'."\n" + ."\n"], + 'creator' => [ + 'title' => '', + 'description' => 'Information about the creator.', + 'type' => 'object', + 'properties' => [ + 'createIdentifier' => ['description' => 'The ID of the creator.', 'type' => 'string', 'title' => '', 'example' => '1316xxxxxx8624xxx'], + 'name' => ['description' => 'The name of the creator.', 'type' => 'string', 'title' => '', 'example' => 'xxxxxxx'], + ], + 'example' => '', + ], + 'modifier' => [ + 'title' => '', + 'description' => 'Information about the modifier.', + 'type' => 'object', + 'properties' => [ + 'modifyIdentifier' => ['description' => 'The ID of the modifier.', 'type' => 'string', 'title' => '', 'example' => '1316xxxxxx8624xxx'], + 'name' => ['description' => 'The name of the modifier.', 'type' => 'string', 'title' => '', 'example' => 'xxxxxxx'], + ], + 'example' => '', + ], + 'directory' => [ + 'title' => '', + 'description' => 'Information about the directory.', + 'type' => 'object', + 'properties' => [ + 'directoryIdentifier' => ['description' => 'The ID of the directory.', 'type' => 'string', 'title' => '', 'example' => 'e27b8eace6501ce51cf5d56784'], + 'name' => ['description' => 'The name of the directory.', 'type' => 'string', 'title' => '', 'example' => '全部用例目录'], + 'pathName' => [ + 'title' => '', + 'description' => 'The full directory path of the test case, represented as an array of directory names.', + 'type' => 'array', + 'items' => ['description' => 'A directory name in the path.', 'type' => 'string', 'example' => '[目录一,目录二]', 'title' => ''], 'example' => '', ], - 'branchName' => [ - 'title' => '变更请求分支', - 'description' => '', - 'type' => 'string', - 'example' => 'feature/20240625', + 'childIdentifier' => ['description' => 'The ID of the subdirectory.', 'type' => 'string', 'title' => '', 'example' => '2973f597c14c6f533fffdcd05c'], + ], + 'example' => '', + ], + 'detailInfo' => [ + 'title' => '', + 'description' => 'Detailed information about the test case.', + 'type' => 'object', + 'properties' => [ + 'stepType' => ['description' => 'The type of the test step. Valid values: `TEXT` and `TABLE`.', 'type' => 'string', 'title' => '', 'example' => 'TEXT/TABLE'], + 'precondition' => [ + 'title' => '', + 'description' => 'The precondition object.', + 'type' => 'object', + 'properties' => [ + 'preIdentifier' => ['description' => 'The ID of the precondition.', 'type' => 'string', 'title' => '', 'example' => '3354596c7b3004480b635acf95'], + 'preContent' => ['description' => 'The content of the precondition.', 'type' => 'string', 'title' => '', 'example' => '前置条件内容'], + 'preContentType' => ['description' => 'The format of the precondition content.', 'type' => 'string', 'title' => '', 'example' => 'MARKDOWN'], + ], + 'example' => '', ], - 'commitId' => [ - 'title' => '变更请求commitId', - 'description' => '', - 'type' => 'string', - 'example' => 'a66cfa8c6869b96bb7d111ba2144c9c764d556b7', + 'stepContent' => [ + 'title' => '', + 'description' => 'The test step object.', + 'type' => 'object', + 'properties' => [ + 'stepIdentifier' => ['description' => 'The ID of the test step.', 'type' => 'string', 'title' => '', 'example' => 'ad504e6cdcd2165b28eb1e1b9f'], + 'stepContent' => ['description' => 'The content of the test step.', 'type' => 'string', 'title' => '', 'example' => '测试步骤内容'], + 'stepContentType' => ['description' => 'The format of the test step content.', 'type' => 'string', 'title' => '', 'example' => 'RICHTEXT'], + ], + 'example' => '', ], - 'ownerAccountId' => [ - 'title' => '变更请求拥有者的阿里云pk', - 'description' => '', - 'type' => 'string', - 'example' => '262579140573491041', + 'expectedResult' => [ + 'title' => '', + 'description' => 'The expected result object.', + 'type' => 'object', + 'properties' => [ + 'expectIdentifier' => ['description' => 'The ID of the expected result.', 'type' => 'string', 'title' => '', 'example' => '685340d13127b01185335bd360'], + 'expectContent' => ['description' => 'The content of the expected result.', 'type' => 'string', 'title' => '', 'example' => '预期结果内容'], + 'expectContentType' => ['description' => 'The format of the expected result content.', 'type' => 'string', 'title' => '', 'example' => 'MARKDOWN'], + ], + 'example' => '', ], ], + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Openapi.RequestError', 'errorMessage' => 'request error', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'Operate.NoPermission', 'errorMessage' => 'NoPermission', 'description' => 'You are not authorized to perform this operation.'], + ], ], - 'schemes' => [ - 'https', + '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"}]', + 'title' => 'Update properties of a test case in the test case library ', + 'description' => 'Call GetTestCaseFieldList to retrieve the field list for a test case, and use this list to update the test case.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateTestCase'], + ], ], + 'ramActions' => [], + ], + 'UpdateTestResult' => [ + 'summary' => 'This operation updates the execution status and executor for a test case in a test plan.', + 'path' => '/organization/{organizationId}/testhub/testplan/{testPlanIdentifier}/testresult/{testcaseIdentifier}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'autoTest' => false, - 'notSupportAutoTestReason' => '数据面 api 经安全评估统一不做处理,后续逐步安排下线', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => [], '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', - ], + 'schema' => ['description' => 'The unique identifier for the organization.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx', 'title' => ''], ], [ - 'name' => 'releaseWorkflowSn', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ce51b31b996246ecaf8747368383****', - ], - ], - [ - 'name' => 'releaseStageSn', + 'name' => 'testPlanIdentifier', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'e173f3c11db5445eb426ca33c922****', - ], + 'schema' => ['description' => 'The unique identifier for the test plan.', 'type' => 'string', 'required' => true, 'example' => '1d79xxxxxx86181xx6c5b', 'title' => ''], ], [ - 'name' => 'executionNumber', + 'name' => 'testcaseIdentifier', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The unique identifier for the test case in the test case library.', 'type' => 'string', 'required' => true, 'example' => '4e22xxxxxxxxc64c16037fe76', 'title' => ''], ], [ - 'name' => 'jobId', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '226241***', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'executor' => ['description' => 'The user ID of the executor.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '131xxx38624xxxx68'], + 'status' => ['description' => 'The execution status of the test case.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'TO DO'], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RefusePipelineValidateResponse', - 'description' => 'RefusePipelineValidateResponse', 'type' => 'object', 'properties' => [ - 'success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'requestId' => ['description' => 'The request ID. Use this ID to track and troubleshoot the request.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', 'title' => ''], + 'errorMsg' => ['description' => 'The error message returned on failure.', 'type' => 'string', 'example' => 'error', 'title' => ''], + 'errorCode' => ['description' => 'The error code returned on failure.', 'type' => 'string', 'example' => 'Openapi.RequestError', 'title' => ''], + 'success' => ['description' => 'Indicates whether the operation succeeded. A value of `true` indicates success, and `false` indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Openapi.RequestError', 'errorMessage' => 'request error', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'Operate.NoPermission', 'errorMessage' => 'NoPermission', 'description' => 'You are not authorized to perform this operation.'], + ], ], - 'schemes' => [ - 'https', + '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"}]', + 'title' => 'Update test case result in test plan ', + 'description' => 'This operation updates the execution status and executor for a test case in a test plan.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateTestResult'], + ], ], + 'ramActions' => [], + ], + 'UpdateVariableGroup' => [ + 'summary' => 'You can update a variable group.', + 'path' => '/organization/{organizationId}/variableGroups/{id}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'autoTest' => false, - 'notSupportAutoTestReason' => '数据面 api 经安全评估统一不做处理,后续逐步安排下线', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => [], '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', - ], + 'schema' => ['title' => '', 'description' => 'Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, such as https://devops.aliyun.com/organization/【OrganizationId】.', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ - 'name' => 'releaseWorkflowSn', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ce51b31b996246ecaf8747368383****', - ], + 'name' => 'name', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Variable group name', 'type' => 'string', 'required' => true, 'example' => '变量组'], ], [ - 'name' => 'releaseStageSn', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'e173f3c11db5445eb426ca33c922****', - ], + 'name' => 'description', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Variable group description', 'type' => 'string', 'required' => false, 'example' => '变量组描述'], ], [ - 'name' => 'executionNumber', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'name' => 'variables', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'JSON string of variable information: isEncrypted (whether encrypted), name (variable name), value (variable value).', 'type' => 'string', 'required' => true, 'example' => '[{"isEncrypted":true,"name":"name1","value":"vaue1"}]'], ], [ - 'name' => 'jobId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '226241***', - ], + 'name' => 'id', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'Variable group ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'PassPipelineValidateResponse', - 'description' => 'PassPipelineValidateResponse', 'type' => 'object', 'properties' => [ - 'success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'requestId' => ['title' => '', 'description' => 'Request ID. Each request has a unique value, which facilitates troubleshooting later.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorMessage' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => '”“'], + 'errorCode' => ['title' => '', 'description' => 'Error code', 'type' => 'string', 'example' => '”“'], + 'success' => ['title' => '', 'description' => 'true if the API call succeeded; false if the API call failed.', 'type' => 'boolean', 'example' => 'true'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"success\\": true\\n}","type":"json"}]', - ], - 'CreateChangeRequest' => [ - 'summary' => '创建变更', - 'path' => '/appstack/apps/{appName}/changeRequests', - 'methods' => [ - 'post', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParam.ParamNotPresent', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The user that is invoking the API service is not a registered user.', 'description' => '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.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidOrganization.NotFound', 'errorMessage' => 'The organization is not found.', 'description' => 'The organization is not found. Please check the organization ID.'], + ], ], - 'schemes' => [ - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"errorCode\\": \\"”“\\",\\n \\"success\\": true\\n}","type":"json"}]', + 'title' => 'Update Variable Group', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateVariableGroup'], + ], ], + 'ramActions' => [], + ], + 'UpdateWorkItem' => [ + 'path' => '/organization/{organizationId}/workitems/update', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'autoTest' => false, - 'notSupportAutoTestReason' => '数据面 api 经安全评估统一不做处理,后续逐步安排下线', - 'tenantRelevance' => 'tenant', + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURErdc3GIDZJ'], ], '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', - ], + 'schema' => ['title' => '', 'description' => 'Organization identifier, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access URL, for example: https://devops.aliyun.com/organization/【OrganizationId】 ', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'Information to update ', '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', - ], + 'propertyKey' => ['title' => '', 'description' => 'The identifier of the field to update. This can be retrieved from ListWorkItemAllFields. When the value is set to "description", the fieldType can specify the format of the description. The default is RICHTEXT, and both RICHTEXT and MARKDOWN are supported. ', 'type' => 'string', 'required' => true, 'example' => 'subject'], + 'propertyValue' => ['title' => '', 'description' => 'Updated value ', 'type' => 'string', 'required' => true, 'example' => 'newValue'], + 'identifier' => ['title' => '', 'description' => 'Work item ID, equivalent to workitemIdentifier or workitemId, which is the UUID of the work item. ', 'type' => 'string', 'required' => true, 'example' => 'e8b2xxxxxx2abdxxxxxxxx23'], + 'fieldType' => ['title' => '', 'description' => 'Type of the field being updated: "subject" indicates updating the title; "status" indicates updating a status field; "document" indicates updating the description field; "user" indicates updating a user-type field (including owner, participants, etc.); "customField" indicates updating a custom field. For "user", the corresponding propertyKey values include "workitem.tracker", "ak.issue.member", and "assignedTo". For "customField", the property value must be obtained via ListWorkItemAllFields by identifying the customField type and its corresponding identifier. For all other cases, the propertyKey matches the fieldType. '."\n" + .'When propertyKey is "description", this value specifies the format of the description and supports RICHTEXT and MARKDOWN. ', 'type' => 'string', 'required' => true, 'example' => 'subject'], ], 'required' => false, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'ChangeRequestVO', - 'description' => 'ChangeRequestVO', + 'title' => '', + 'description' => 'Work item request result', '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', + 'requestId' => ['title' => '', 'description' => 'Request ID. Each request has a unique value to facilitate troubleshooting.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'], + 'errorCode' => ['title' => '', 'description' => 'error code', 'type' => 'string', 'example' => 'Openapi.RequestError'], + 'errorMessage' => ['title' => '', 'description' => 'error message', 'type' => 'string', 'example' => 'error'], + 'success' => ['title' => '', 'description' => 'true or false', 'type' => 'boolean', 'example' => 'true'], + 'workitem' => [ + 'title' => '', + 'description' => 'Work item information', + 'type' => 'object', + 'properties' => [ + 'identifier' => ['title' => '', 'description' => 'UUID of the work item', 'type' => 'string', 'example' => 'e8bxxxxxxxxxxxxxxxx23'], + 'subject' => ['title' => '', 'description' => 'Work item title ', 'type' => 'string', 'example' => '测试工作项'], + 'document' => ['title' => '', 'description' => 'Work item content ', 'type' => 'string', 'example' => 'html格式'], + 'documentFormat' => ['description' => 'Format of the description content, either RICHTEXT or MARKDOWN', 'type' => 'string', 'example' => 'RICHTEXT', 'title' => ''], + 'assignedTo' => ['title' => '', 'description' => 'Owner ', 'type' => 'string', 'example' => '19xx7043xxxxxxx914'], + 'status' => ['title' => '', 'description' => 'Status name ', 'type' => 'string', 'example' => '待处理'], + 'statusStageIdentifier' => ['title' => '', 'description' => 'Status stage ID', 'type' => 'string', 'example' => '1'], + 'spaceIdentifier' => ['title' => '', 'description' => 'ID of the project to which the work item belongs ', 'type' => 'string', 'example' => 'e8b26xxxxx6e76aa20xxxxx23'], + 'spaceName' => ['title' => '', 'description' => 'Project Name ', 'type' => 'string', 'example' => '需求项目'], + 'spaceType' => ['title' => '', 'description' => 'Project Mode ', 'type' => 'string', 'example' => 'Project'], + 'logicalStatus' => ['title' => '', 'description' => 'Logical Status ', 'type' => 'string', 'example' => 'NORMAL'], + 'categoryIdentifier' => ['title' => '', 'description' => 'Category ID of the work item', 'type' => 'string', 'example' => 'Req'], + 'parentIdentifier' => ['title' => '', 'description' => 'Parent work item ID ', 'type' => 'string', 'example' => 'e8bxxxxxxxxxxxxxxxx24'], + 'workitemTypeIdentifier' => ['title' => '', 'description' => 'Work item type ID ', 'type' => 'string', 'example' => '9uxxxxxxre573f5xxxxxx0'], + 'updateStatusAt' => ['title' => '', 'description' => 'Status Update Time ', 'type' => 'integer', 'format' => 'int64', 'example' => '1640850328000'], + 'serialNumber' => ['title' => '', 'description' => 'Work item serial number ', 'type' => 'string', 'example' => 'ACFS-1'], + 'gmtCreate' => ['title' => '', 'description' => 'Creation Time ', 'type' => 'integer', 'format' => 'int64', 'example' => '1640850318000'], + 'gmtModified' => ['title' => '', 'description' => 'Updated At', 'type' => 'integer', 'format' => 'int64', 'example' => '1640850318000'], + 'creator' => ['title' => '', 'description' => 'Creator', 'type' => 'string', 'example' => '19xx7043xxxxxxx914'], + 'modifier' => ['title' => '', 'description' => 'Updated By ', 'type' => 'string', 'example' => '19xx7043xxxxxxx914'], + 'statusIdentifier' => ['title' => '', 'description' => 'Status ID ', 'type' => 'string', 'example' => '111000'], + 'sprintIdentifier' => ['title' => '', 'description' => 'Iteration ID ', 'type' => 'string', 'example' => '75528f17703e92e5a568......'], + ], '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', - ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Openapi.RequestError', 'errorMessage' => 'request error', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'Operate.NoPermission', 'errorMessage' => 'NoPermission', 'description' => 'You are not authorized to perform this operation.'], + ], ], - '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', + 'title' => 'Update work item information ', + 'summary' => 'Update work item information.', + 'changeSet' => [ + ['createdAt' => '2024-04-19T13:00:42.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-06-07T02:05:18.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-02-24T08:23:15.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-02-24T08:23:15.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-01-06T13:27:07.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateWorkItem'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'UpdateWorkitemComment' => [ + 'summary' => 'Update a work item comment.', + 'path' => '/organization/{organizationId}/workitems/commentUpdate', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'autoTest' => false, - 'notSupportAutoTestReason' => '数据面 api 经安全评估统一不做处理,后续逐步安排下线', - 'tenantRelevance' => 'tenant', + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURErdc3GIDZJ'], ], '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', - ], + 'schema' => ['description' => 'Organization identifier, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, such as https://devops.aliyun.com/organization/【OrganizationId】', 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx', 'title' => ''], ], [ - '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', + 'name' => 'body', + 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => '按应用名称进行搜索', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'app-name', + 'description' => 'Request body', + 'type' => 'object', + 'properties' => [ + 'content' => ['title' => '', 'description' => 'Comment content', 'type' => 'string', 'required' => true, 'example' => '这是更新后的评论内容'], + 'formatType' => ['title' => '', 'description' => 'Content format. Currently supports MARKDOWN/RICHTEXT.', 'type' => 'string', 'required' => true, 'example' => 'MARKDOWN/RICHTEXT'], + 'workitemIdentifier' => ['title' => '', 'description' => 'Work item ID, same as workitemId, which is the UUID of the work item.', 'type' => 'string', 'required' => true, 'example' => '9144ef6b72d8exxxxx9e61a4d0'], + 'commentId' => ['title' => '', 'description' => 'Comment ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1964584'], ], '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', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'PageList<ChangeRequestVO>', - 'description' => 'PageList<ChangeRequestVO>', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', '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}', + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9'], + 'errorMsg' => ['description' => 'Error message.', 'type' => 'string', 'example' => 'error', 'title' => ''], + 'errorCode' => ['description' => '- When success is false, returns an error code. '."\n" + .'- When success is true, returns an empty value.', 'type' => 'string', 'example' => 'InvalidParam.NotFound', 'title' => ''], + 'success' => ['description' => 'true or false', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'comment' => [ + 'description' => 'Comment', + 'type' => 'object', + 'properties' => [ + 'id' => ['title' => '', 'description' => 'Unique comment ID'."\n", 'type' => 'string', 'example' => '1964584'], + 'content' => ['description' => 'Comment content', 'type' => 'string', 'example' => '这是更新后的评论内容', 'title' => ''], + 'targetType' => ['description' => 'Resource type', 'type' => 'string', 'example' => 'workitem', 'title' => ''], + 'targetIdentifier' => ['description' => 'Resource ID, work item ID', 'type' => 'string', 'example' => 'deafe5f33xxxxx6a259d8dafd', 'title' => ''], + 'parentId' => ['description' => 'Parent job ID', 'type' => 'integer', 'format' => 'int64', 'example' => '2684432', 'title' => ''], + 'createTime' => ['description' => 'Creation Time', 'type' => 'integer', 'format' => 'int64', 'example' => '1667205617061', 'title' => ''], + 'modifiedTime' => ['description' => 'Updated At', 'type' => 'integer', 'format' => 'int64', 'example' => '1646323200000', 'title' => ''], + 'isTop' => ['description' => 'Is pinned', 'type' => 'boolean', 'example' => 'true/false', 'title' => ''], + 'topTime' => ['description' => 'Pinned time', 'type' => 'integer', 'format' => 'int64', 'example' => '1667205617089', 'title' => ''], + 'formatType' => ['description' => 'Format type', 'type' => 'string', 'example' => 'MARKDOWN/RICHTEXT', 'title' => ''], + 'user' => [ + 'description' => 'User information', + 'type' => 'object', + 'properties' => [ + 'account' => ['description' => 'Alibaba Cloud account', 'type' => 'string', 'example' => '1316458xxxxx41068', 'title' => ''], + 'identifier' => ['description' => 'User ID', 'type' => 'string', 'example' => '9144ef6b72d8exxxxx9e61a4d0', 'title' => ''], + 'realName' => ['description' => 'User\'s real name', 'type' => 'string', 'example' => '王五', 'title' => ''], + 'nickName' => ['description' => 'User nickname', 'type' => 'string', 'example' => '王五', 'title' => ''], + 'avatar' => ['description' => 'Profile picture', 'type' => 'string', 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112m7150e256dbba0d6456bafbb65c81f90d/w/200/h/200', 'title' => ''], + 'displayName' => ['description' => 'Display name', 'type' => 'string', 'example' => '王五', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], ], - ], - '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', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Openapi.RequestError', 'errorMessage' => 'request error', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'Operate.NoPermission', 'errorMessage' => 'NoPermission', 'description' => 'You are not authorized to perform this operation.'], + ], ], - 'schemes' => [ - 'https', + 'title' => 'Update work item comment', + 'description' => 'Update a work item comment.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateWorkitemComment'], + ], ], + 'ramActions' => [], + '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"}]', + ], + 'UpdateWorkitemField' => [ + 'summary' => 'Batch-update multiple work item fields.', + 'path' => '/organization/{organizationId}/workitems/updateWorkitemField', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'autoTest' => false, - 'notSupportAutoTestReason' => '数据面 api 经安全评估统一不做处理,后续逐步安排下线', - 'tenantRelevance' => 'tenant', + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURErdc3GIDZJ'], ], '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', - ], + 'schema' => ['description' => 'The organization ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '60ee8a814690c27532d412f8'], ], [ - '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', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '分页排序属性,决定根据何种属性进行记录排序;推荐在实现严格遍历时,使用 id 属性', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'id' => 'id', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'workitemIdentifier' => ['description' => 'The unique identifier of the work item. This is the same as `workitemId`.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '9144ef6b72d8exxxxx9e61a4d0'], + 'updateWorkitemPropertyRequest' => [ + 'title' => '', + 'description' => 'A list of work item properties to update.', + 'type' => 'array', + 'items' => [ + 'description' => 'A work item property to update.', + 'type' => 'object', + 'properties' => [ + 'fieldIdentifier' => ['description' => 'The ID of the work item field to update. You can obtain this ID by calling the API to retrieve all work item fields.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'tag'], + 'fieldValue' => ['description' => 'The new value for the field. Note the following: (1) For a user type field, provide the `aliyunPK`. (2) For a field with option values, provide the ID of the selected option. (3) For multiple values, provide a single, comma-separated string.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '个人属性'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'example' => '', + ], ], - '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', + 'title' => '', + 'example' => '', ], ], ], '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"}', + 'requestId' => ['description' => 'The unique identifier of the request. You can use this identifier to troubleshoot issues.', 'type' => 'string', 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', 'title' => ''], + 'errorMsg' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'error', 'title' => ''], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Openapi.RequestError', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful. Valid values are `true` and `false`.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'workitem' => [ + 'title' => '', + 'description' => 'The details of the work item.', + 'type' => 'object', + 'properties' => [ + 'identifier' => ['description' => 'The unique identifier of the work item.', 'type' => 'string', 'example' => 'e8bxxxxxxxxxxxxxxxx23', 'title' => ''], + 'subject' => ['description' => 'The subject of the work item.', 'type' => 'string', 'example' => '测试工作项', 'title' => ''], + 'document' => ['description' => 'The content of the work item, in HTML format.', 'type' => 'string', 'example' => 'html格式', 'title' => ''], + 'assignedTo' => ['description' => 'The assignee of the work item.', 'type' => 'string', 'example' => '19xx7043xxxxxxx914', 'title' => ''], + 'status' => ['description' => 'The name of the status.', 'type' => 'string', 'example' => '待处理', 'title' => ''], + 'statusStageIdentifier' => ['description' => 'The unique identifier of the status stage.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'spaceIdentifier' => ['description' => 'The unique identifier of the space.', 'type' => 'string', 'example' => 'e8b26xxxxx6e76aa20xxxxx23', 'title' => ''], + 'spaceName' => ['description' => 'The name of the space.', 'type' => 'string', 'example' => '需求项目', 'title' => ''], + 'spaceType' => ['description' => 'The type of the space.', 'type' => 'string', 'example' => 'Project', 'title' => ''], + 'logicalStatus' => ['description' => 'The logical status of the work item.', 'type' => 'string', 'example' => 'NORMAL', 'title' => ''], + 'categoryIdentifier' => ['description' => 'The unique identifier of the work item category.', 'type' => 'string', 'example' => 'Req', 'title' => ''], + 'parentIdentifier' => ['description' => 'The unique identifier of the parent work item.', 'type' => 'string', 'example' => 'e8bxxxxxxxxxxxxxxxx24', 'title' => ''], + 'workitemTypeIdentifier' => ['description' => 'The unique identifier of the work item type.', 'type' => 'string', 'example' => '9uxxxxxxre573f5xxxxxx0', 'title' => ''], + 'updateStatusAt' => ['description' => 'The Unix timestamp, in milliseconds, when the status was last updated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1640850328000', 'title' => ''], + 'serialNumber' => ['description' => 'The serial number of the work item.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'gmtCreate' => ['description' => 'The Unix timestamp, in milliseconds, when the work item was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1640850318000', 'title' => ''], + 'gmtModified' => ['description' => 'The Unix timestamp, in milliseconds, when the work item was last modified.', 'type' => 'integer', 'format' => 'int64', 'example' => '1640850318000', 'title' => ''], + 'creator' => ['description' => 'The user who created the work item.', 'type' => 'string', 'example' => '19xx7043xxxxxxx914', 'title' => ''], + 'modifier' => ['description' => 'The user who last modified the work item.', 'type' => 'string', 'example' => '19xx7043xxxxxxx914', 'title' => ''], + 'statusIdentifier' => ['description' => 'The unique identifier of the status.', 'type' => 'string', 'example' => '28', 'title' => ''], + 'sprintIdentifier' => ['description' => 'The unique identifier of the sprint.', 'type' => 'string', 'example' => '75528f17703e92e5a568......', 'title' => ''], ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Openapi.RequestError', 'errorMessage' => 'request error', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'Operate.NoPermission', 'errorMessage' => 'NoPermission', 'description' => 'You are not authorized to perform this operation.'], + ], ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Update work item field ', + 'description' => 'This operation performs a batch update of work item context fields and custom fields. It does not update core work item attributes, such as description, title, or status. To modify these attributes, use the dedicated operation for updating work item attributes.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateWorkitemField'], + ], ], + 'ramActions' => [], + '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"}]', + ], + 'WorkitemAttachmentCreate' => [ + 'summary' => 'Associates a file as an attachment of a work item. This is the third step of uploading an attachment to a work item. For the first two steps, refer to the description of the GetWorkitemAttachmentCreatemeta (obtain the information for uploading attachments to work items) operation.', + 'path' => '/organization/{organizationId}/workitem/{workitemIdentifier}/attachment', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURErdc3GIDZJ'], ], 'parameters' => [ [ - 'name' => 'aliyunPk', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1789095186553536', - ], + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => ['description' => 'The enterprise ID, also known as the organization ID, in string format. You can obtain it from the Yunxiao URL, such as https://devops.aliyun.com/organization/[OrganizationId].'."\n" + ."\n", 'type' => 'string', 'required' => true, 'example' => '5ebbc0228123212b59xxxxx', 'title' => ''], ], [ - 'name' => 'drawGroup', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'task_group_0000', - ], + 'name' => 'workitemIdentifier', + 'in' => 'path', + 'schema' => ['description' => 'The work item ID, which is the same as workitemId. It is the unique identifier of a work item.', 'type' => 'string', 'required' => true, 'example' => '11234455454355', 'title' => ''], ], [ - 'name' => 'drawPoolName', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'fileKey' => ['description' => 'The file key, which corresponds to the dir value returned by the GetWorkitemAttachmentCreatemeta operation. The file must have been uploaded successfully.', 'type' => 'string', 'required' => true, 'example' => '1106473328927498/1106473328927498/5ec071g0e5ij85fche8cddchje.xlsx', 'title' => ''], + 'originalFilename' => ['description' => 'The original full name of the uploaded file.', 'type' => 'string', 'required' => true, 'example' => 'xxx.tgz', 'title' => ''], + ], 'required' => false, - 'example' => 'developer-award-draw-pool_123', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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', - ], + 'requestId' => ['title' => '', 'description' => 'The request ID. Each request has a unique ID for troubleshooting purposes.', 'type' => 'string', 'example' => 'F590C9D8-E908-5B6C-95AC-56B7E8011FFA'], + 'errorCode' => ['description' => '- If success is false, a business error code is returned.'."\n" + .' '."\n" + .'- If success is true, an empty value is returned. ', 'type' => 'string', 'example' => 'SYSTEM_UNKNOWN_ERROR', 'title' => ''], + 'errorMessage' => ['description' => '- If success is false, a business error message is returned.'."\n" + ."\n" + .'- If success is true, an empty value is returned.', 'type' => 'string', 'example' => 'InvalidTagGroup.IdNotFoundntraceId: 2137844496.4337.16624448853053831', 'title' => ''], + 'success' => ['description' => 'Indicates whether the API call is successful. A value of true indicates success. A value of false indicates failure.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Associate a file as a work item attachment', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'WorkitemAttachmentCreate'], + ], ], - '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"}]', + 'ramActions' => [], + '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"}]', ], ], 'endpoints' => [ + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'devops.cn-hangzhou.aliyuncs.com', 'endpoint' => 'devops.cn-hangzhou.aliyuncs.com', 'vpc' => 'devops-vpc.cn-hangzhou.aliyuncs.com'], + ], + 'errorCodes' => [ + ['code' => 'Forbidden.AccessDenied', 'message' => 'The user is not authorized to perform the operation.', 'http_code' => 403, 'description' => 'The user is not authorized to perform the operation.'], + ['code' => 'Forbidden.UserNotAdminOrOwner', 'message' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', 'http_code' => 403, 'description' => ''], + ['code' => 'Forbidden.UserNotInCurrentOrganization', 'message' => 'The user is not in the organization and is not authorized to perform the operation.', 'http_code' => 403, 'description' => ''], + ['code' => 'InvaildSpace.NotInCurrentOrganization', 'message' => 'space not belong to this organization, please switch organization.', 'http_code' => 404, 'description' => ''], + ['code' => 'InvalidCaller.ChangingSystemPipelineIsNotAllowed', 'message' => 'The pipeline is created by system, which is not allowed to change by any user.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidCluster.NotFound', 'message' => 'No cluster is available to generate the workspace.', 'http_code' => 400, 'description' => 'No cluster is available to generate the workspace.'], + ['code' => 'InvalidCodeUrl.NotSupportSVN', 'message' => 'The parameter codeUrl is invalid. SVN is not supported.', 'http_code' => 400, 'description' => 'The parameter codeUrl is invalid. SVN is not supported.'], + ['code' => 'InvalidIdentifier.NotFound', 'message' => 'space id is error or not exist.', 'http_code' => 404, 'description' => ''], + ['code' => 'InvalidOrganization.NotFound', 'message' => 'The organization is not found.', 'http_code' => 404, 'description' => 'The organization is not found. Please check the organization ID.'], + ['code' => 'InvalidParam.NoPermission', 'message' => 'param value is not permission.', 'http_code' => 403, 'description' => 'The current parameter has no permission'], + ['code' => 'InvalidParam.ParamNotPresent', 'message' => 'The parameter is invalid.', 'http_code' => 400, 'description' => 'The parameter is invalid.'], + ['code' => 'InvalidPipeline.NotFound', 'message' => 'The pipeline is not found.', 'http_code' => 404, 'description' => 'The pipeline does not exist.'], + ['code' => 'InvalidPipelineRun.NotFound', 'message' => 'The pipeline execution instance is not found.', 'http_code' => 404, 'description' => 'The pipeline execution instance is not found.'], + ['code' => 'InvalidResource.NotFound', 'message' => 'No resource is found. You cannot create the workspace. Please try again later.', 'http_code' => 400, 'description' => 'No resource is found. You cannot create the workspace. Please try again later.'], + ['code' => 'InvalidResourceRole.NotFoun', 'message' => 'The member role is invalid.', 'http_code' => 400, 'description' => 'The member role is invalid.'], + ['code' => 'InvalidResourceRole.NotFound', 'message' => 'The member role is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidUser.NotFound', 'message' => 'The user that is invoking the API service is not a registered user.', 'http_code' => 400, 'description' => 'The user that is invoking the API service is not a registered user.'], + ['code' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', 'message' => 'Resource owner cannot be deleted.', 'http_code' => 400, 'description' => 'The resource owner cannot be deleted.'], + ['code' => 'InvalidUser.ResourceMemberNotExists', 'message' => 'The resource member does not exist.', 'http_code' => 400, 'description' => 'The resource member does not exist.'], + ['code' => 'InvalidUser.UserNotInCurrentOrganization', 'message' => 'The user is not in the organization.', 'http_code' => 400, 'description' => 'The user is not in the organization.'], + ['code' => 'InvalidUser.UserNotInCurrentOrganization', 'message' => 'The current user is not in the organization and has no permission to operate.', 'http_code' => 404, 'description' => ''], + ['code' => 'InvalidWorkspace.NotFound', 'message' => 'The workspace is not found.', 'http_code' => 404, 'description' => 'The workspace is not found.'], + ['code' => 'InvalidWorkspaceStatus.NotSuccess', 'message' => 'The workspace status is invalid. You can only operate workspaces with the SUCCESS status.', 'http_code' => 400, 'description' => 'The workspace status is invalid. You can only operate workspaces with the SUCCESS status.'], + ['code' => 'InvalidWorkspaceTemplate.NotFound', 'message' => 'The parameter workspaceTemplate is not found.', 'http_code' => 400, 'description' => 'The parameter workspaceTemplate is not found.'], + ['code' => 'Openapi.RequestError', 'message' => 'request error', 'http_code' => 400, 'description' => ''], + ['code' => 'Operate.NoPermission', 'message' => 'NoPermission', 'http_code' => 403, 'description' => 'You are not authorized to perform this operation.'], + ['code' => 'WorkspaceQuotaExceeded', 'message' => 'The maximum number of workspace per user is exceeded.', 'http_code' => 403, 'description' => 'The maximum number of workspace per user is exceeded.'], + ], + 'changeSet' => [ + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateComment'], + ], + 'createdAt' => '2025-02-20T12:25:08.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetWorkItemInfo'], + ], + 'createdAt' => '2024-12-12T13:19:06.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ExportInsightWorkitemStatus'], + ['description' => 'Response parameters changed', 'api' => 'ExportInsightWorkitemStatusJoinWorkitemDefectExtra'], + ], + 'createdAt' => '2024-08-02T13:30:26.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListAppReleaseStageExecutionIntegratedMetadata'], + ], + 'createdAt' => '2024-06-28T02:06:58.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetApplication'], + ], + 'createdAt' => '2024-04-25T03:35:53.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'CreateWorkitem'], + ['description' => 'Response parameters changed', 'api' => 'GetWorkItemInfo'], + ['description' => 'Response parameters changed', 'api' => 'UpdateWorkItem'], + ], + 'createdAt' => '2024-04-19T13:01:03.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListOrganizations'], + ], + 'createdAt' => '2024-04-07T05:00:44.000Z', + 'description' => '', + ], [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'devops.cn-hangzhou.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListJoinedOrganizations'], + ], + 'createdAt' => '2024-03-29T08:50:34.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed, Error codes changed', 'api' => 'ListOrganizations'], + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'ListRepositories'], + ], + 'createdAt' => '2024-03-28T08:43:11.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetWorkItemInfo'], + ], + 'createdAt' => '2024-02-28T13:03:57.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListOrganizationMembers'], + ], + 'createdAt' => '2024-02-27T13:34:08.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListUserKeys'], + ], + 'createdAt' => '2024-02-01T06:27:51.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetMergeRequest'], + ['description' => 'Response parameters changed', 'api' => 'ListMergeRequestComments'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListMergeRequests'], + ], + 'createdAt' => '2024-01-29T11:52:51.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListMergeRequests'], + ['description' => 'Response parameters changed', 'api' => 'MergeMergeRequest'], + ], + 'createdAt' => '2024-01-23T02:19:30.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetMergeRequest'], + ['description' => 'Response parameters changed', 'api' => 'GetProjectMember'], + ['description' => 'Response parameters changed', 'api' => 'ListMergeRequests'], + ], + 'createdAt' => '2024-01-11T02:39:31.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetOrganizationMember'], + ], + 'createdAt' => '2023-11-27T13:01:55.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetWorkItemInfo'], + ['description' => 'Response parameters changed', 'api' => 'ListWorkitems'], + ], + 'createdAt' => '2023-11-07T14:17:37.000Z', + 'description' => '', ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetFileBlobs'], + ], + 'createdAt' => '2023-10-24T02:40:45.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListServiceConnections'], + ], + 'createdAt' => '2023-09-20T02:21:35.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateWorkitemV2'], + ], + 'createdAt' => '2023-09-10T02:08:00.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'AddPipelineRelations'], + ], + 'createdAt' => '2023-08-31T14:29:20.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'UpdateMergeRequestPersonnel'], + ], + 'createdAt' => '2023-08-18T05:53:01.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'AddGroupMember'], + ['description' => 'Response parameters changed', 'api' => 'AddRepositoryMember'], + ['description' => 'Response parameters changed', 'api' => 'DeleteGroupMember'], + ['description' => 'Response parameters changed', 'api' => 'DeleteRepositoryMember'], + ['description' => 'Response parameters changed', 'api' => 'GetBranchInfo'], + ['description' => 'Response parameters changed', 'api' => 'GetCompareDetail'], + ['description' => 'Response parameters changed, Error codes changed', 'api' => 'GetProjectMember'], + ['description' => 'Response parameters changed', 'api' => 'GetRepositoryCommit'], + ['description' => 'Response parameters changed', 'api' => 'GetUserInfo'], + ['description' => 'Response parameters changed', 'api' => 'ListGroupMember'], + ], + 'createdAt' => '2023-07-24T06:15:52.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateProtectdBranch'], + ], + 'createdAt' => '2023-06-05T11:04:45.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed, Request parameters changed', 'api' => 'ListOrganizationMembers'], + ], + 'createdAt' => '2023-04-13T13:22:05.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateProtectdBranch'], + ['description' => 'Response parameters changed', 'api' => 'GetFileLastCommit'], + ], + 'createdAt' => '2023-01-10T09:25:21.000Z', + 'description' => '修改字段的问题', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'AddRepositoryMember'], + ], + 'createdAt' => '2023-01-03T02:18:28.000Z', + 'description' => '调整AddRepositoryMember接口的配置', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateWorkitem'], + ['description' => 'Response parameters changed', 'api' => 'ListWorkitemTime'], + ], + 'createdAt' => '2022-12-05T14:51:32.000Z', + 'description' => '1.修改工时不能为小数 2.创建工作项 优先级不再为必填', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'AddRepositoryMember'], + ['description' => 'Request parameters changed', 'api' => 'AddWebhook'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetCodeupOrganization'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetFileLastCommit'], + ['description' => 'Request parameters changed', 'api' => 'GetProjectMember'], + ['description' => 'Response parameters changed', 'api' => 'ListRepositoryBranches'], + ['description' => 'Request parameters changed', 'api' => 'ListRepositoryCommitDiff'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'UpdateProtectedBranches'], + ['description' => 'Request parameters changed', 'api' => 'UpdateRepositoryMember'], + ], + 'createdAt' => '2022-11-21T13:18:25.000Z', + 'description' => '修改了先前的参数驼峰命名问题,以及客户反馈的字段问题.', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'GetRepositoryCommit'], + ], + 'createdAt' => '2022-11-15T02:21:37.000Z', + 'description' => '新增API- 删除代码库webhook:DeleteWebhook- 查询commit历史:ListRepositoryCommits- 查询代码库提交信息:GetRepositoryCommit- 创建保护分支:createProtectBranch', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetWorkItemActivity'], + ['description' => 'Request parameters changed', 'api' => 'GetWorkItemWorkFlowInfo'], + ], + 'createdAt' => '2022-10-28T14:05:46.000Z', + 'description' => '新增评论相关的接口', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetFileLastCommit'], + ['description' => 'Error codes changed', 'api' => 'TriggerRepositoryMirrorSync'], + ], + 'createdAt' => '2022-10-14T08:40:49.000Z', + 'description' => '校正大驼峰命名方式参数问题。 aliyunPK不在此次发布中处理。', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'UpdateProtectedBranches'], + ], + 'createdAt' => '2022-09-20T02:36:03.000Z', + 'description' => '新增对accessToken的描述', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'UpdateRepositoryMember'], + ], + 'createdAt' => '2022-08-24T09:17:16.000Z', + 'description' => '更新代码库成员角色,此处补上name和username两个返回字段', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'UpdateRepositoryMember'], + ], + 'createdAt' => '2022-08-18T10:12:22.000Z', + 'description' => '「修改库成员权限」接口', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'ListRepositoryCommitDiff'], + ], + 'createdAt' => '2022-08-15T03:29:10.000Z', + 'description' => '查询代码库单个提交(Commit)的提交内容', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetPipelineRun'], + ['description' => 'Response parameters changed', 'api' => 'ListPipelines'], + ], + 'createdAt' => '2022-07-28T13:00:47.000Z', + 'description' => '增加流水线分组api', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateRepository'], + ], + 'createdAt' => '2022-07-27T11:23:50.000Z', + 'description' => '更新创建仓库api', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'GetPipelineScanReportUrl'], + ], + 'createdAt' => '2022-07-19T12:06:10.000Z', + 'description' => '调整文档', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'GetProjectInfo'], + ], + 'createdAt' => '2022-06-07T11:35:25.000Z', + 'description' => '更新Projex OpenAPI的错误码信息', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'ListWorkitemTime'], + ], + 'createdAt' => '2022-05-26T11:27:55.000Z', + 'description' => '新增获取工作项工时明细的OpenAPI接口', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateWorkitem'], + ['description' => 'Response parameters changed', 'api' => 'GetWorkItemInfo'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListWorkitems'], + ['description' => 'Response parameters changed', 'api' => 'UpdateWorkItem'], + ], + 'createdAt' => '2022-05-13T03:09:54.000Z', + 'description' => '更新补充projex相关api参数信息', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateWorkitem'], + ['description' => 'Response parameters changed', 'api' => 'GetWorkItemInfo'], + ['description' => 'Request parameters changed', 'api' => 'ListWorkitems'], + ], + 'createdAt' => '2022-05-05T03:25:28.000Z', + 'description' => '更新工作项的人员信息字段', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateWorkitem'], + ['description' => 'Request parameters changed', 'api' => 'ListWorkitems'], + ], + 'createdAt' => '2022-04-13T06:36:33.000Z', + 'description' => '更新Projex API', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'AddWebhook'], + ['description' => 'OpenAPI offline', 'api' => 'CreateRepository'], + ['description' => 'OpenAPI offline', 'api' => 'GetCodeupOrganization'], + ['description' => 'OpenAPI offline', 'api' => 'GetFileLastCommit'], + ['description' => 'OpenAPI offline', 'api' => 'GetProjectMember'], + ['description' => 'OpenAPI offline', 'api' => 'GetRepository'], + ['description' => 'OpenAPI offline', 'api' => 'ListRepositories'], + ['description' => 'OpenAPI offline', 'api' => 'ListRepositoryMemberWithInherited'], + ['description' => 'OpenAPI offline', 'api' => 'ListRepositoryWebhook'], + ['description' => 'OpenAPI offline', 'api' => 'TriggerRepositoryMirrorSync'], + ], + 'createdAt' => '2022-03-18T09:12:05.000Z', + 'description' => 'Codeup新版api发布', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'AddWebhook'], + ['description' => 'Request parameters changed', 'api' => 'CreateRepository'], + ], + 'createdAt' => '2022-03-18T09:11:44.000Z', + 'description' => 'api参数优化', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateWorkitem'], + ['description' => 'Request parameters changed', 'api' => 'DeleteProject'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetWorkItemInfo'], + ['description' => 'OpenAPI offline', 'api' => 'ListWorkitems'], + ['description' => 'Request parameters changed', 'api' => 'UpdateProjectMember'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'UpdateWorkItem'], + ], + 'createdAt' => '2022-02-24T08:25:13.000Z', + 'description' => '增加获取工作项列表的接口,并扩充了获取工作项、更新工作项的接口能力,并修改部分接口的字段信息', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateProject'], + ['description' => 'OpenAPI offline', 'api' => 'CreateSprint'], + ['description' => 'OpenAPI offline', 'api' => 'DeleteProject'], + ['description' => 'OpenAPI offline', 'api' => 'GetCustomFieldOption'], + ['description' => 'OpenAPI offline', 'api' => 'GetWorkItemActivity'], + ['description' => 'OpenAPI offline', 'api' => 'GetWorkItemInfo'], + ['description' => 'OpenAPI offline', 'api' => 'GetWorkItemWorkFlowInfo'], + ['description' => 'OpenAPI offline', 'api' => 'UpdateProjectMember'], + ['description' => 'OpenAPI offline', 'api' => 'UpdateWorkItem'], + ], + 'createdAt' => '2022-01-06T13:30:08.000Z', + 'description' => '添加工作项和迭代等openapi接口', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'GetPipelineArtifactUrl'], + ['description' => 'OpenAPI offline', 'api' => 'GetPipelineEmasArtifactUrl'], + ['description' => 'OpenAPI offline', 'api' => 'GetPipelineScanReportUrl'], + ['description' => 'OpenAPI offline', 'api' => 'ListPipelineJobHistorys'], + ['description' => 'OpenAPI offline', 'api' => 'ListPipelineJobs'], + ], + 'createdAt' => '2021-12-30T14:21:44.000Z', + 'description' => '增加获取下载地址api', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateFlowTag'], + ['description' => 'OpenAPI offline', 'api' => 'CreateFlowTagGroup'], + ['description' => 'OpenAPI offline', 'api' => 'DeleteFlowTag'], + ['description' => 'OpenAPI offline', 'api' => 'DeleteFlowTagGroup'], + ['description' => 'OpenAPI offline', 'api' => 'GetFlowTagGroup'], + ['description' => 'OpenAPI offline', 'api' => 'ListFlowTagGroups'], + ['description' => 'OpenAPI offline', 'api' => 'UpdateFlowTag'], + ['description' => 'OpenAPI offline', 'api' => 'UpdateFlowTagGroup'], + ['description' => 'OpenAPI offline', 'api' => 'UpdatePipelineBaseInfo'], + ], + 'createdAt' => '2021-12-15T04:01:56.000Z', + 'description' => '增加标签api', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'GetProjectInfo'], + ['description' => 'OpenAPI offline', 'api' => 'ListProjectMembers'], + ], + 'createdAt' => '2021-12-10T06:12:19.000Z', + 'description' => '增加新版云效协作Projex的OpenAPI', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'GetVMDeployOrder'], + ['description' => 'OpenAPI offline', 'api' => 'LogVMDeployMachine'], + ['description' => 'OpenAPI offline', 'api' => 'ResumeVMDeployOrder'], + ['description' => 'OpenAPI offline', 'api' => 'RetryVMDeployMachine'], + ['description' => 'OpenAPI offline', 'api' => 'SkipVMDeployMachine'], + ['description' => 'OpenAPI offline', 'api' => 'StopVMDeployOrder'], + ], + 'createdAt' => '2021-11-25T13:21:16.000Z', + 'description' => '增加部署单相关api', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'LogPipelineJobRun'], + ], + 'createdAt' => '2021-11-25T13:20:24.000Z', + 'description' => '增加LogPIpelineJobRun api', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetPipelineRun'], + ['description' => 'OpenAPI offline', 'api' => 'PassPipelineValidate'], + ['description' => 'OpenAPI offline', 'api' => 'RefusePipelineValidate'], + ], + 'createdAt' => '2021-11-18T05:38:20.000Z', + 'description' => '增加人工卡点api', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetOrganizationMember'], + ['description' => 'Response parameters changed', 'api' => 'ListOrganizationMembers'], + ], + 'createdAt' => '2021-09-28T06:41:34.000Z', + 'description' => '企业成员信息中增加企业角色Id', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListOrganizationMembers'], + ], + 'createdAt' => '2021-09-23T03:53:20.000Z', + 'description' => '更新入参名字jointimeFrom->joinTimeFrom, jointimeTo->joinTimeTo', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'GetOrganizationMember'], + ['description' => 'OpenAPI offline', 'api' => 'ListOrganizationMembers'], + ], + 'createdAt' => '2021-09-22T12:35:59.000Z', + 'description' => '新增云效企业成员查询接口', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSprintInfo'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHostGroup'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExportInsightSpaceRef'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExportInsightTagRef'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteWorkitemAllComment'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateWorkitemRecord'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListFlowTagGroups'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetSshKey'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRepository'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopPipelineRun'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteBranch'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateFlowTagGroup'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListServiceAuths'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteFile'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateProjectLabel'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetWorkitemFile'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCompareDetail'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSshKey'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRepositoryTags'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteProject'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteProtectedBranch'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePipeline'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRepositoryGroup'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWorkItemWorkFlowStatus'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWorkitemTime'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateProtectedBranches'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetProjectInfo'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRepositoryCommit'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetVariableGroup'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRepositoryGroup'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPipelines'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetWorkitemRelations'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMergeRequestLabels'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListGroupMember'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateGroupMember'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExportInsightExpectedWorkTime'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPipelineRelations'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPipelineJobs'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGroupDetail'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReviewMergeRequest'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateVariableGroup'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateServiceConnection'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListGroupRepositories'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMergeRequestPatchSets'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateServiceCredential'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListServiceCredentials'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExportInsightCustomValue'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProjectTemplates'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePipelineGroup'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableDeployKey'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRepositoryWebhook'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteFlowTag'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetVMDeployOrder'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteWorkitem'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateResourceMember'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateProjectMember'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListHostGroups'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePushReviewOnOff'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProjectMembers'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRepositoryTag'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateRepository'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CloseMergeRequest'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAppReleaseStageExecutions'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateHostGroup'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TriggerRepositoryMirrorSync'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePipelineGroup'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateProjectField'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSearchSourceCode'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExportWorkitemActivity'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExecuteChangeRequestReleaseStage'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateOrganizationMember'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateRepositoryMember'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCheckRuns'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddRepositoryMember'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProtectedBranches'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateFlowTag'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateTestResult'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListVariableGroups'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRepositoryTree'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCommitStatuses'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResumeVMDeployOrder'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopVMDeployOrder'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePushRule'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'LogVMDeployMachine'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMergeRequestComments'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePipeline'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'JoinPipelineGroup'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListOrganizations'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteResourceMember'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetProjectMember'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateFile'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRepositoryCommits'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateHostGroup'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCustomFieldOption'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCommitStatus'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOrganizationMember'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFileBlobs'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRepositoryMemberWithInherited'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCodeupOrganization'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteUserKey'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPipeline'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRepositoryBranches'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListApplications'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RefusePipelineValidate'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetWorkItemWorkFlowInfo'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListApplicationMembers'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReopenMergeRequest'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetApplication'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SkipVMDeployMachine'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExportInsightWorkitemStatusJoinWorkitemDefectExtra'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateGroup'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTestCase'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteProjectLabel'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRepositoryMember'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRepository'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAllReleaseWorkflows'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateVariableGroup'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListServiceConnections'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExportInsightField'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAppMember'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDeployKey'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateUserKey'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetReleaseStagePipelineRun'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateResourceMember'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateWorkitemComment'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SkipPipelineJobRun'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExportInsightWorkitemStatus'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateFile'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopPipelineJobRun'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListChangeRequestWorkflowExecutions'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateProtectdBranch'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateTestCase'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMergeRequestFilesReads'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWorkItemAllFields'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateFlowTag'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePipelineRelations'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddWebhook'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteHostGroup'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUserInfo'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRepositoryWebhook'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelExecutionReleaseStage'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'LogPipelineJobRun'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPipelineGroups'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCheckRun'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListResourceMembers'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUserKeys'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRepositoryGroups'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteWorkitemComment'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateWorkitemField'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateProject'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSprint'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListChangeRequests'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRepositories'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateChangeRequest'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTestcaseList'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAppMembers'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TransferRepository'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRepository'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePipeline'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWorkitemAttachments'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetWorkitemCommentList'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMergeRequests'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartPipelineRun'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCheckRun'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPipelineScanReportUrl'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePushRule'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPushRules'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSearchCommit'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMergeRequest'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListOrganizationMembers'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetWorkitemAttachmentCreatemeta'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteFlowTagGroup'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetWorkItemInfo'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPipelineRuns'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RetryPipelineJobRun'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateWorkitem'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProjectWorkitemTypes'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProjects'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMergeRequest'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateComment'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSearchRepository'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PassPipelineValidate'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateMergeRequest'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPipelineArtifactUrl'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPipelineEmasArtifactUrl'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRepositoryCommitDiff'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWorkitemEstimate'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExportInsightSpace'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMergeRequestChangeTree'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddPipelineRelations'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPipelineGroup'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAppReleaseStageExecutionIntegratedMetadata'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListJoinedOrganizations'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFileLastCommit'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSearchCodePreview'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPipelineJobHistorys'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExportInsightSprint'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'LinkMergeRequestLabel'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateServiceAuth'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateWorkitemEstimate'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteVariableGroup'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUserResources'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCommitWithMultipleFiles'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'WorkitemAttachmentCreate'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RefuseReleaseStagePipelineValidate'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUserDrawRecordByPk'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTag'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExportInsightWorkTime'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddGroupMember'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetBranchInfo'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTestResultList'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCheckRun'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProjectLabels'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetWorkItemActivity'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFlowTagGroup'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateMergeRequestPersonnel'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateApplication'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateWorkitemV2'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTag'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePushRule'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MergeMergeRequest'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateFlowTagGroup'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteGroupMember'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePipelineBaseInfo'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetWorkitemTimeTypeList'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateOAuthToken'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateWorkitemComment'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExportInsightWorkitemVersion'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPipelineRun'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPipelineGroupPipelines'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateBranch'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAppMember'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePipelineGroup'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWorkitems'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGroupByPath'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTestCaseFields'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateProjectLabel'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PassReleaseStagePipelineValidate'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RetryVMDeployMachine'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSprints'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateWorkItem'], + ], + ], + 'ram' => [ + 'productCode' => 'RDC', + 'productName' => 'Alibaba Cloud DevOps', + 'ramCodes' => ['rdc'], + 'ramLevel' => 'SERVICE', + 'ramConditions' => [], + 'ramActions' => [], + 'resourceTypes' => [], ], ]; |
